Azure OpenAI-modellen

API-versie: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API's

Servervariabelen:

Variable Verstek Description
endpoint Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam.
Voorbeeld:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentication

ApiKeyAuth (API-sleutel)

Geef je API-sleutel in de api-key header.

ApiKeyAuth_ (API-sleutel)

Geef je API-sleutel in de authorization header.

OAuth2Auth (OAuth 2.0)

Flow: impliciet

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

Scopes:

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

Beveiligingsvereisten

Eindpunten accepteren een van de volgende authenticatiemethoden:

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

Modellen weergeven

GET {endpoint}/openai/v1/models

Een lijst met de momenteel beschikbare modellen en bevat basisinformatie over elk model, zoals de eigenaar en beschikbaarheid.

URI-parameters

Name In Required Typ Description
endpoint server Yes tekenreeks Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam.
Voorbeeld:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-versie zoekopdracht No tekenreeks
Mogelijke waarden: v1, preview		 De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt.
v1 als dit niet anders is opgegeven.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype Type Description
application/json OpenAI.ListModelsResponse

Antwoordheaders:

Koptekst Typ Description
apim-request-id tekenreeks Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype Type Description
application/json object
Name Typ Description Required Verstek
code tekenreeks of null Yes
inner_error No
message tekenreeks Yes
param tekenreeks of null No
type tekenreeks No

Antwoordheaders:

Koptekst Typ Description
apim-request-id tekenreeks Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Model ophalen

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

Haalt een modelexemplaar op met basisinformatie over het model, zoals de eigenaar en machtigingen.

URI-parameters

Name In Required Typ Description
endpoint server Yes tekenreeks Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam.
Voorbeeld:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-versie zoekopdracht No tekenreeks
Mogelijke waarden: v1, preview		 De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt.
v1 als dit niet anders is opgegeven.
model path Yes tekenreeks De id van het model dat voor deze aanvraag moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype Type Description
application/json OpenAI.Model

Antwoordheaders:

Koptekst Typ Description
apim-request-id tekenreeks Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype Type Description
application/json object
Name Typ Description Required Verstek
code tekenreeks of null Yes
inner_error No
message tekenreeks Yes
param tekenreeks of null No
type tekenreeks No

Antwoordheaders:

Koptekst Typ Description
apim-request-id tekenreeks Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Model verwijderen

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

Hiermee verwijdert u een modelinstantie.

URI-parameters

Name In Required Typ Description
endpoint server Yes tekenreeks Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam.
Voorbeeld:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-versie zoekopdracht No tekenreeks
Mogelijke waarden: v1, preview		 De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt.
v1 als dit niet anders is opgegeven.
model path Yes tekenreeks De id van het model dat moet worden verwijderd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype Type Description
application/json OpenAI.DeleteModelResponse

Antwoordheaders:

Koptekst Typ Description
apim-request-id tekenreeks Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype Type Description
application/json object
Name Typ Description Required Verstek
code tekenreeks of null Yes
inner_error No
message tekenreeks Yes
param tekenreeks of null No
type tekenreeks No

Antwoordheaders:

Koptekst Typ Description
apim-request-id tekenreeks Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Components

AzureAIFoundryModelsApiVersion

Property Value
Type tekenreeks
waarden v1
preview

OpenAI.DeleteModelResponse

Name Typ Description Required Verstek
verwijderd boolean Yes
id tekenreeks Yes
object tekenreeks Yes

OpenAI.ListModelsResponse

Name Typ Description Required Verstek
data matrix van OpenAI.Model Yes
object enum
Mogelijke waarden: list		 Yes

OpenAI.Model

Model

Beschrijft een OpenAI-modelaanbieding die kan worden gebruikt met de API.

Name Typ Description Required Verstek
created geheel getal (Unixtime) De Unix-tijdstempel (in seconden) toen het model werd gemaakt. Yes
id tekenreeks De model-id waarnaar kan worden verwezen in de API-eindpunten. Yes
object enum Het objecttype, dat altijd 'model' is.
Mogelijke waarden: model		 Yes
eigendom van tekenreeks De organisatie die eigenaar is van het model. Yes
  • Last updated on