Models - List

Referens

Tjänst:: Azure AI Services

API-version:: 2024-10-21

Hämtar en lista över alla modeller som är tillgängliga för Azure OpenAI-resursen. Dessa inkluderar basmodeller och alla lyckade finjusterade modeller som ägs av Azure OpenAI-resursen.

GET {endpoint}/openai/models?api-version=2024-10-21

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-kontonamn).
api-version	query	True	string	Den begärda API-versionen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
api-key	True	string	Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Svar

Name	Typ	Description
200 OK	ModelList	Framgång
Other Status Codes	ErrorResponse	Ett fel uppstod.

Säkerhet

api-key

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Typ: apiKey
I: header

Exempel

Getting all models owned by account.

Exempelbegäran

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2024-10-21

Exempelsvar

Statuskod:: 200

{
  "data": [
    {
      "status": "succeeded",
      "capabilities": {
        "fine_tune": true,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "fine_tune": 1677662127,
        "inference": 1709284527
      },
      "id": "curie",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "status": "succeeded",
      "model": "curie",
      "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "capabilities": {
        "fine_tune": false,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "inference": 1709284527
      },
      "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

Definitioner

Name	Description
Capabilities	Kapacitet
Deprecation	Avskrivningar
Error	Fel
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modell
ModelList	Modelllista
TypeDiscriminator	TypeDiscriminator

Capabilities

Kapacitet

Name	Typ	Description
chat_completion	boolean	Ett värde som anger om en modell stöder chattens slutförande.
completion	boolean	Ett värde som anger om en modell stöder slutförande.
embeddings	boolean	Ett värde som anger om en modell stöder inbäddningar.
fine_tune	boolean	Ett värde som anger om en modell kan användas för finjustering.
inference	boolean	Ett värde som anger om en modell kan distribueras.

Deprecation

Avskrivningar

Name	Typ	Description
fine_tune	integer	Slutdatumet för finjusteringsstöd för den här modellen. Kommer att vara `null` för finjustera modeller.
inference	integer	Slutdatumet för slutsatsdragningsstöd för den här modellen.

Error

Fel

Name	Typ	Description
code	ErrorCode	ErrorCode Felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Felinformationen om den är tillgänglig.
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Meddelandet om det här felet.
target	string	Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Name	Typ	Description
conflict	string	Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
contentFilter	string	Bildgenereringen misslyckades till följd av vårt säkerhetssystem.
fileImportFailed	string	Det gick inte att importera filen.
forbidden	string	Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
internalFailure	string	Internt fel. Försök igen.
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.
itemDoesAlreadyExist	string	Objektet finns redan.
jsonlValidationFailed	string	Verifieringen av jsonl-data misslyckades.
notFound	string	Det går inte att hitta resursen.
quotaExceeded	string	Kvoten har överskridits.
serviceUnavailable	string	Tjänsten är inte tillgänglig för närvarande.
tooManyRequests	string	För många begäranden. Försök igen senare.
unauthorized	string	Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
unexpectedEntityState	string	Åtgärden kan inte köras i den aktuella resursens tillstånd.

ErrorResponse

Name	Typ	Description
error	Error	Fel Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Name	Typ	Description
cancelled	string	Åtgärden har avbrutits och är ofullständig. Den kan kategoriseras som ett terminaltillstånd.
created	string	Åtgärden skapades. Det här tillståndet returneras inte av Azure OpenAI och exponeras endast för kompatibilitet. Den kan kategoriseras som ett inaktivt tillstånd.
failed	string	Åtgärden har slutfört bearbetningen med ett fel och kan inte förbrukas ytterligare. Den kan kategoriseras som ett terminaltillstånd.
pending	string	Åtgärden har ännu inte placerats i kö för att bearbetas i framtiden. Den kan kategoriseras som ett inaktivt tillstånd.
running	string	Åtgärden har börjat bearbetas. Det kan kategoriseras som ett aktivt tillstånd.
succeeded	string	Åtgärden har bearbetats och är klar för förbrukning. Den kan kategoriseras som ett terminaltillstånd.

InnerError

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Typ	Description
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.

LifeCycleStatus

Name	Typ	Description
generally-available	string	Modellen är allmänt tillgänglig.
preview	string	Modellen är i förhandsversion och omfattas av villkoren för tjänstens förhandsversion.

Model

Modell

Name	Typ	Description
capabilities	Capabilities	Kapacitet Funktionerna i en bas- eller finjusteringsmodell.
created_at	integer	En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).
deprecation	Deprecation	Avskrivningar Definierar datum för utfasning för de olika användningsfallen för en modell. Vanligtvis har basmodeller stöd för 1 års finjustering efter skapandet. Slutsatsdragning stöds vanligtvis 2 år efter skapandet av bas- eller finjusterade modeller. De exakta datumen anges i egenskaperna.
fine_tune	string	Finjustera jobbidentiteten (finjustera id) om det här är en finjusteringsmodell. annars `null`.
id	string	Identiteten för det här objektet.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Livscykelstatus för en modell. Obs! En modell kan höjas upp från "förhandsversion" till "allmänt tillgänglig", men aldrig från "allmänt tillgänglig" till "förhandsversion".
model	string	Basmodellidentiteten (modell-ID) om det här är en finjusteringsmodell. annars `null`.
object	TypeDiscriminator	TypeDiscriminator Definierar typen av ett objekt.
status	FineTuningState	FineTuningState Tillståndet för ett finjusterande objekt eller finjusteringsjobb.

ModelList

Modelllista

Name	Typ	Description
data	Model[]	Listan över objekt.
object	TypeDiscriminator	TypeDiscriminator Definierar typen av ett objekt.

TypeDiscriminator

Name	Typ	Description
batch	string	Det här objektet representerar en batch.
file	string	Det här objektet representerar en fil.
fine_tuning.job	string	Det här objektet representerar ett finjusterat jobb.
fine_tuning.job.checkpoint	string	Det här objektet representerar en kontrollpunkt för ett finjusteringsjobb.
fine_tuning.job.event	string	Det här objektet representerar en händelse av ett finjusteringsjobb.
list	string	Det här objektet representerar en lista över andra objekt.
model	string	Det här objektet representerar en modell (kan vara en basmodell eller finjustera jobbresultatet).
upload	string	Det här objektet representerar en filuppladdning.
upload.part	string	Det här objektet representerar en del av en filuppladdning.

Dela via