Azure OpenAI-Modelle

API-Version: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models APIs

Servervariablen:

Variable Vorgabe Description
endpoint Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname.
Beispiel:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentifizierung

ApiKeyAuth (API-Schlüssel)

Gib deinen API-Schlüssel in den Header api-key .

ApiKeyAuth_ (API-Schlüssel)

Gib deinen API-Schlüssel in den Header authorization .

OAuth2Auth (OAuth 2.0)

Fluss: implizit

Autorisierungs-URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche:

  • https://cognitiveservices.azure.com/.default

Sicherheitsanforderungen

Endpunkte akzeptieren eine der folgenden Authentifizierungsmethoden:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (Scopes: https://cognitiveservices.azure.com/.default)

Modelle auflisten

GET {endpoint}/openai/v1/models

Listet die derzeit verfügbaren Modelle auf und enthält grundlegende Informationen zu jedem Modell, z. B. besitzer und Verfügbarkeit.

URI-Parameter

Name In Required Typ Description
endpoint server Ja Schnur Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname.
Beispiel:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-Version query No Schnur
Mögliche Werte: v1, preview		 Die explizite API-Version der Azure AI Foundry Models-API, die für diese Anforderung verwendet werden soll.
v1 wenn nicht anders angegeben.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp Typ Beschreibung
Anwendung/json OpenAI.ListModelsResponse

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp Typ Beschreibung
Anwendung/json Objekt
Name Typ Description Required Vorgabe
Programmcode Zeichenfolge oder null Ja
innerer Fehler No
message Schnur Ja
param Zeichenfolge oder null No
type Schnur No

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Modell abrufen

GET {endpoint}/openai/v1/models/{model}

Ruft eine Modellinstanz ab und stellt grundlegende Informationen zum Modell bereit, z. B. den Besitzer und die Berechtigung.

URI-Parameter

Name In Required Typ Description
endpoint server Ja Schnur Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname.
Beispiel:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-Version query No Schnur
Mögliche Werte: v1, preview		 Die explizite API-Version der Azure AI Foundry Models-API, die für diese Anforderung verwendet werden soll.
v1 wenn nicht anders angegeben.
model path Ja Schnur Die ID des Modells, das für diese Anforderung verwendet werden soll.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp Typ Beschreibung
Anwendung/json OpenAI.Model

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp Typ Beschreibung
Anwendung/json Objekt
Name Typ Description Required Vorgabe
Programmcode Zeichenfolge oder null Ja
innerer Fehler No
message Schnur Ja
param Zeichenfolge oder null No
type Schnur No

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Löschen des Modells

DELETE {endpoint}/openai/v1/models/{model}

Löscht eine Modellinstanz.

URI-Parameter

Name In Required Typ Description
endpoint server Ja Schnur Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname.
Beispiel:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-Version query No Schnur
Mögliche Werte: v1, preview		 Die explizite API-Version der Azure AI Foundry Models-API, die für diese Anforderung verwendet werden soll.
v1 wenn nicht anders angegeben.
model path Ja Schnur Die ID des zu löschenden Modells.

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp Typ Beschreibung
Anwendung/json OpenAI.DeleteModelResponse

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp Typ Beschreibung
Anwendung/json Objekt
Name Typ Description Required Vorgabe
Programmcode Zeichenfolge oder null Ja
innerer Fehler No
message Schnur Ja
param Zeichenfolge oder null No
type Schnur No

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Components

AzureAIFoundryModelsApiVersion

Property Wert
Typ Schnur
Werte v1
preview

OpenAI.DeleteModelResponse

Name Typ Description Required Vorgabe
gelöscht boolean Ja
id Schnur Ja
Objekt Schnur Ja

OpenAI.ListModelsResponse

Name Typ Description Required Vorgabe
data Array von OpenAI.Model Ja
Objekt enum
Mögliche Werte: list		 Ja

OpenAI.Model

Modell

Beschreibt ein OpenAI-Modellangebot, das mit der API verwendet werden kann.

Name Typ Description Required Vorgabe
erstellt Ganzzahl (Unixtime) Der Unix-Zeitstempel (in Sekunden), als das Modell erstellt wurde. Ja
id Schnur Der Modellbezeichner, auf den in den API-Endpunkten verwiesen werden kann. Ja
Objekt enum Der Objekttyp, der immer "Modell" ist.
Mögliche Werte: model		 Ja
owned_by Schnur Die Organisation, die das Modell besitzt. Ja
  • Last updated on