Modèles Azure OpenAI

Version de l’API : v1

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

Variables serveur :

Variable	Par défaut	Description
endpoint		Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentication

ApiKeyAuth (clé API)

Passez votre clé API dans l’en-tête api-key .

ApiKeyAuth_ (clé API)

Passez votre clé API dans l’en-tête authorization .

OAuth2Auth (OAuth 2.0)

Flux : implicite

URL d’autorisation :https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues:

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

Spécifications de sécurité

Les points d’accès acceptent l’une des méthodes d’authentification suivantes :

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

Lister les modèles

GET {endpoint}/openai/v1/models

Répertorie les modèles actuellement disponibles et fournit des informations de base sur chacun d’eux, tels que le propriétaire et la disponibilité.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
version de l'API	query	Non	string Valeurs possibles : v1, preview	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. v1 sauf indication contraire.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ListModelsResponse

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Description	Obligatoire	Par défaut
code	chaîne ou null		Oui
inner_error			Non
message	string		Oui
param	chaîne ou null		Non
type	string		Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Récupérer le modèle

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

Récupère une instance de modèle, fournissant des informations de base sur le modèle, telles que le propriétaire et l’autorisation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
version de l'API	query	Non	string Valeurs possibles : v1, preview	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. v1 sauf indication contraire.
model	path	Oui	string	ID du modèle à utiliser pour cette requête.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.Model

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Description	Obligatoire	Par défaut
code	chaîne ou null		Oui
inner_error			Non
message	string		Oui
param	chaîne ou null		Non
type	string		Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Supprimer le modèle

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

Supprime une instance de modèle.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
version de l'API	query	Non	string Valeurs possibles : v1, preview	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. v1 sauf indication contraire.
model	path	Oui	string	ID du modèle à supprimer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.DeleteModelResponse

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Description	Obligatoire	Par défaut
code	chaîne ou null		Oui
inner_error			Non
message	string		Oui
param	chaîne ou null		Non
type	string		Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Components

AzureAIFoundryModelsApiVersion

Propriété	Valeur
Type	string
Valeurs	v1 preview

OpenAI.DeleteModelResponse

Nom	Type	Description	Obligatoire	Par défaut
supprimé	booléen		Oui
id	string		Oui
Objet	string		Oui

OpenAI.ListModelsResponse

Nom	Type	Description	Obligatoire	Par défaut
data	tableau d’OpenAI.Model		Oui
Objet	enum	Valeurs possibles : list	Oui

OpenAI.Model

Modèle

Décrit une offre de modèle OpenAI qui peut être utilisée avec l’API.

Nom	Type	Description	Obligatoire	Par défaut
créé	entier (unixtime)	Horodatage Unix (en secondes) lors de la création du modèle.	Oui
id	string	Identificateur de modèle, qui peut être référencé dans les points de terminaison d’API.	Oui
Objet	enum	Type d’objet, qui est toujours « model ». Valeurs possibles : model	Oui
owned_by	string	Organisation propriétaire du modèle.	Oui