Models - List

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-10-21

Ruft eine Liste aller Modelle ab, auf die von der Azure OpenAI-Ressource zugegriffen werden kann. Dazu gehören Basismodelle sowie alle erfolgreich abgeschlossenen fein abgestimmten Modelle, die der Azure OpenAI-Ressource gehören.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Kontonamen.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
api-key	True	string	Stellen Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services bereit.

Antworten

Name	Typ	Beschreibung
200 OK	ModelList	Erfolg
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

api-key

Stellen Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services bereit.

Typ: apiKey
In: header

Beispiele

Getting all models owned by account.

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
Capabilities	Fähigkeiten
Deprecation	Missbilligung
Error	Fehler
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modell
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Fähigkeiten

Name	Typ	Beschreibung
chat_completion	boolean	Ein Wert, der angibt, ob ein Modell den Chatabschluss unterstützt.
completion	boolean	Ein Wert, der angibt, ob ein Modell den Abschluss unterstützt.
embeddings	boolean	Ein Wert, der angibt, ob ein Modell Einbettungen unterstützt.
fine_tune	boolean	Ein Wert, der angibt, ob ein Modell zur Feinabstimmung verwendet werden kann.
inference	boolean	Ein Wert, der angibt, ob ein Modell bereitgestellt werden kann.

Deprecation

Missbilligung

Name	Typ	Beschreibung
fine_tune	integer	Das Enddatum der Feinabstimmungsunterstützung für dieses Modell. Wird für Feinabstimmungsmodelle `null`.
inference	integer	Das Enddatum der Ableitungsunterstützung für dieses Modell.

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Fehlercodes gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Die Fehlerdetails, falls verfügbar.
innererror	InnerError	InnerError Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Die Meldung dieses Fehlers.
target	string	Der Ort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang ist mit dem aktuellen Ressourcenstatus in Konflikt.
contentFilter	string	Die Bildgenerierung ist aufgrund unseres Sicherheitssystems fehlgeschlagen.
fileImportFailed	string	Fehler beim Importieren der Datei.
forbidden	string	Der Vorgang ist für den aktuellen Benutzer-/API-Schlüssel verboten.
internalFailure	string	Interner Fehler. Versuchen Sie es erneut.
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.
itemDoesAlreadyExist	string	Das Element ist bereits vorhanden.
jsonlValidationFailed	string	Fehler bei der Überprüfung von JSONL-Daten.
notFound	string	Die Ressource wurde nicht gefunden.
quotaExceeded	string	Das Kontingent wurde überschritten.
serviceUnavailable	string	Der Dienst ist derzeit nicht verfügbar.
tooManyRequests	string	Zu viele Anforderungen. Versuchen Sie es später erneut.
unauthorized	string	Der aktuelle Benutzer-/API-Schlüssel ist für den Vorgang nicht autorisiert.
unexpectedEntityState	string	Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

Name	Typ	Beschreibung
error	Error	Fehler Fehlerinhalte gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Name	Typ	Beschreibung
cancelled	string	Der Vorgang wurde abgebrochen und ist unvollständig. Sie kann als Terminalzustand kategorisiert werden.
created	string	Der Vorgang wurde erstellt. Dieser Zustand wird nicht von Azure OpenAI zurückgegeben und nur aus Kompatibilitätsgründen verfügbar gemacht. Sie kann als inaktiver Zustand kategorisiert werden.
failed	string	Der Vorgang hat die Verarbeitung mit einem Fehler abgeschlossen und kann nicht weiter verbraucht werden. Sie kann als Terminalzustand kategorisiert werden.
pending	string	Der Vorgang wird noch nicht in die Warteschlange gestellt, um in Zukunft verarbeitet zu werden. Sie kann als inaktiver Zustand kategorisiert werden.
running	string	Der Vorgang wurde gestartet, um verarbeitet zu werden. Sie kann als aktiver Zustand kategorisiert werden.
succeeded	string	Der Vorgang wurde erfolgreich verarbeitet und ist einsatzbereit. Sie kann als Terminalzustand kategorisiert werden.

InnerError

Name	Typ	Beschreibung
code	InnerErrorCode	InnerErrorCode Innere Fehlercodes gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Typ	Beschreibung
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.

LifeCycleStatus

Name	Typ	Beschreibung
generally-available	string	Das Modell ist allgemein verfügbar.
preview	string	Das Modell befindet sich in der Vorschau und wird von den Dienstvorschaubedingungen abgedeckt.

Model

Modell

Name	Typ	Beschreibung
capabilities	Capabilities	Fähigkeiten Die Funktionen eines Basis- oder Feinabstimmungsmodells.
created_at	integer	Ein Zeitstempel, zu dem dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen).
deprecation	Deprecation	Missbilligung Definiert die Datumsangaben für den Veraltet für die verschiedenen Anwendungsfälle eines Modells. In der Regel unterstützen Basismodelle nach der Erstellung 1 Jahr Feinabstimmung. Inference wird in der Regel 2 Jahre nach der Erstellung von Basis- oder Feinabstimmungsmodellen unterstützt. Die genauen Datumsangaben werden in den Eigenschaften angegeben.
fine_tune	string	Die Feinabstimmung der Auftragsidentität (Feinabstimmungs-ID), wenn dies ein Feinabstimmungsmodell ist; andernfalls `null`.
id	string	Die Identität dieses Elements.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Der Lebenszyklusstatus eines Modells. Hinweis: Ein Modell kann von "Vorschau" auf "allgemein verfügbar" heraufgestuft werden, aber nie von "allgemein verfügbar" in "Vorschau".
model	string	Die Basismodellidentität (Modell-ID), wenn dies ein Feinabstimmungsmodell ist; andernfalls `null`.
object	TypeDiscriminator	TypeDiscriminator Definiert den Typ eines Objekts.
status	FineTuningState	FineTuningState Der Zustand eines Feinabstimmungsobjekts oder Feinabstimmungsauftrags.

ModelList

Name	Typ	Beschreibung
data	Model[]	Die Liste der Elemente.
object	TypeDiscriminator	TypeDiscriminator Definiert den Typ eines Objekts.

TypeDiscriminator

Name	Typ	Beschreibung
batch	string	Dieses Objekt stellt einen Batch dar.
file	string	Dieses Objekt stellt eine Datei dar.
fine_tuning.job	string	Dieses Objekt stellt einen Feinabstimmungsauftrag dar.
fine_tuning.job.checkpoint	string	Dieses Objekt stellt einen Prüfpunkt eines Feinabstimmungsauftrags dar.
fine_tuning.job.event	string	Dieses Objekt stellt ein Ereignis eines Feinabstimmungsauftrags dar.
list	string	Dieses Objekt stellt eine Liste anderer Objekte dar.
model	string	Dieses Objekt stellt ein Modell dar (kann ein Basismodell oder ein Feinabstimmungsauftragsergebnis sein).
upload	string	Dieses Objekt stellt einen Dateiupload dar.
upload.part	string	Dieses Objekt stellt einen Teil eines Dateiuploads dar.

Freigeben über