Azure OpenAI-modeller

API-version: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models-API:er

Servervariabler:

Variabel	Standardinställning	Description
endpoint		Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentication

ApiKeyAuth (API-nyckel)

Skicka din API-nyckel i api-key headern.

ApiKeyAuth_ (API-nyckel)

Skicka din API-nyckel i authorization headern.

OAuth2Auth (OAuth 2.0)

Flöde: implicit

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

Scope:

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

Säkerhetskrav

Endpoints accepterar någon av följande autentiseringsmetoder:

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

Lista modeller

GET {endpoint}/openai/v1/models

Visar en lista över tillgängliga modeller och innehåller grundläggande information om var och en, till exempel ägare och tillgänglighet.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-version	query	No	string Möjliga värden: v1, preview	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. v1 om inget annat anges.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ListModelsResponse

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Description	Obligatoriskt	Standardinställning
code	sträng eller null		Ja
inner_error			No
message	string		Ja
Param	sträng eller null		No
type	string		No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Hämta modell

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

Hämtar en modellinstans med grundläggande information om modellen, till exempel ägare och behörighet.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-version	query	No	string Möjliga värden: v1, preview	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. v1 om inget annat anges.
model	path	Ja	string	ID:t för modellen som ska användas för den här begäran.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.Model

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Description	Obligatoriskt	Standardinställning
code	sträng eller null		Ja
inner_error			No
message	string		Ja
Param	sträng eller null		No
type	string		No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Ta bort modell

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

Tar bort en modellinstans.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-version	query	No	string Möjliga värden: v1, preview	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. v1 om inget annat anges.
model	path	Ja	string	ID:t för modellen som ska tas bort.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.DeleteModelResponse

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Description	Obligatoriskt	Standardinställning
code	sträng eller null		Ja
inner_error			No
message	string		Ja
Param	sträng eller null		No
type	string		No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Components

AzureAIFoundryModelsApiVersion

Property	Value
Type	string
Värden	v1 preview

OpenAI.DeleteModelResponse

Name	Type	Description	Obligatoriskt	Standardinställning
borttagen	boolean		Ja
id	string		Ja
object	string		Ja

OpenAI.ListModelsResponse

Name	Type	Description	Obligatoriskt	Standardinställning
data	matris med OpenAI.Model		Ja
object	enum	Möjliga värden: list	Ja

OpenAI.Model

Modell

Beskriver ett OpenAI-modellerbjudande som kan användas med API:et.

Name	Type	Description	Obligatoriskt	Standardinställning
skapad	heltal (Unixtime)	Unix-tidsstämpeln (i sekunder) när modellen skapades.	Ja
id	string	Modellidentifieraren, som kan refereras till i API-slutpunkterna.	Ja
object	enum	Objekttypen, som alltid är "modell". Möjliga värden: model	Ja
ägs_av	string	Den organisation som äger modellen.	Ja