Models - List

Service:: Azure AI Services

Version d'API:: 2024-10-21

Obtient une liste de tous les modèles accessibles par la ressource Azure OpenAI. Celles-ci incluent les modèles de base ainsi que tous les modèles affinés correctement exécutés appartenant à la ressource Azure OpenAI.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (url)	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre compte Azure OpenAI).
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
api-key	True	string	Fournissez votre clé de compte Azure OpenAI Cognitive Services ici.

Réponses

Nom	Type	Description
200 OK	ModelList	Succès
Other Status Codes	ErrorResponse	Une erreur s’est produite.

Sécurité

api-key

Fournissez votre clé de compte Azure OpenAI Cognitive Services ici.

Type: apiKey
Dans: header

Exemples

Getting all models owned by account.

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
Capabilities	Capacités
Deprecation	Dépréciation
Error	Erreur
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modèle
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Objet

Capacités

Nom	Type	Description
chat_completion	boolean	Valeur indiquant si un modèle prend en charge la saisie semi-automatique de conversation.
completion	boolean	Valeur indiquant si un modèle prend en charge l’achèvement.
embeddings	boolean	Valeur indiquant si un modèle prend en charge les incorporations.
fine_tune	boolean	Valeur indiquant si un modèle peut être utilisé pour le réglage précis.
inference	boolean	Valeur indiquant si un modèle peut être déployé.

Deprecation

Objet

Dépréciation

Nom	Type	Description
fine_tune	integer (unixtime)	Date de fin de l’optimisation de la prise en charge de ce modèle. Sera `null` pour ajuster les modèles.
inference	integer (unixtime)	Date de fin de la prise en charge de l’inférence de ce modèle.

Error

Objet

Erreur

Nom	Type	Description
code	ErrorCode	ErrorCode Codes d’erreur tels que définis dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Détails de l’erreur s’il est disponible.
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Message de cette erreur.
target	string	Emplacement où l’erreur s’est produite si disponible.

ErrorCode

Énumération

ErrorCode

Valeur	Description
conflict	L’opération demandée est en conflit avec l’état de ressource actuel.
invalidPayload	Les données de requête ne sont pas valides pour cette opération.
forbidden	L’opération est interdite pour la clé utilisateur/API actuelle.
notFound	La ressource est introuvable.
unexpectedEntityState	L’opération ne peut pas être exécutée dans l’état de la ressource actuelle.
itemDoesAlreadyExist	L’élément existe déjà.
serviceUnavailable	Le service n’est actuellement pas disponible.
internalFailure	Erreur interne. Réessayez.
quotaExceeded	Quota dépassé.
jsonlValidationFailed	Échec de la validation des données jsonl.
fileImportFailed	Échec de l’importation du fichier.
tooManyRequests	Trop de demandes. Réessayez ultérieurement.
unauthorized	La clé utilisateur/API actuelle n’est pas autorisée pour l’opération.
contentFilter	La génération d’images a échoué suite à notre système de sécurité.

ErrorResponse

Objet

ErrorResponse

Nom	Type	Description
error	Error	Erreur Contenu d’erreur tel que défini dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Énumération

FineTuningState

Valeur	Description
created	L’opération a été créée. Cet état n’est pas retourné par Azure OpenAI et n’est exposé qu’à des fins de compatibilité. Il peut être classé comme un état inactif.
pending	L’opération n’est pas encore mise en file d’attente pour être traitée ultérieurement. Il peut être classé comme un état inactif.
running	L’opération a commencé à être traitée. Il peut être classé comme état actif.
succeeded	L’opération a été traitée avec succès et est prête à être consommée. Il peut être classé comme état terminal.
cancelled	L’opération a été annulée et est incomplète. Il peut être classé comme état terminal.
failed	L’opération a terminé le traitement avec un échec et ne peut pas être consommée. Il peut être classé comme état terminal.

InnerError

Objet

InnerError

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Énumération

InnerErrorCode

Valeur	Description
invalidPayload	Les données de requête ne sont pas valides pour cette opération.

LifeCycleStatus

Énumération

LifeCycleStatus

Valeur	Description
preview	Le modèle est en préversion et couvert par les conditions d’aperçu du service.
generally-available	Le modèle est généralement disponible.

Model

Objet

Modèle

Nom	Type	Description
capabilities	Capabilities	Capacités Fonctionnalités d’un modèle de base ou d’optimisation.
created_at	integer (unixtime)	Horodatage lors de la création de ce travail ou de cet élément (dans les époques unix).
deprecation	Deprecation	Dépréciation Définit les dates de dépréciation pour les différents cas d’usage d’un modèle. Généralement, les modèles de base prennent en charge 1 an de réglage précis après la création. L’inférence est généralement prise en charge 2 ans après la création de modèles de base ou affinés. Les dates exactes sont spécifiées dans les propriétés.
fine_tune	string	L’identité de travail affinée (fine-tune-id) s’il s’agit d’un modèle d’optimisation ; sinon, `null`.
id	string	Identité de cet élément.
lifecycle_status	LifeCycleStatus	LifeCycleStatus État du cycle de vie d’un modèle. Remarque : Un modèle peut être promu de « préversion » à « généralement disponible », mais jamais de « généralement disponible » à « préversion ».
model	string	Identité du modèle de base (id de modèle) s’il s’agit d’un modèle affiné ; sinon, `null`.
object	TypeDiscriminator	TypeDiscriminator Définit le type d’un objet.
status	FineTuningState	FineTuningState État d’un objet finetunes ou d’un travail de réglage précis.

ModelList

Objet

ModelList

Nom	Type	Description
data	Model[]	Liste des éléments.
object	TypeDiscriminator	TypeDiscriminator Définit le type d’un objet.

TypeDiscriminator

Énumération

TypeDiscriminator

Valeur	Description
list	Cet objet représente une liste d’autres objets.
fine_tuning.job	Cet objet représente un travail d’optimisation.
file	Cet objet représente un fichier.
fine_tuning.job.event	Cet objet représente un événement d’un travail de réglage précis.
fine_tuning.job.checkpoint	Cet objet représente un point de contrôle d’un travail de réglage précis.
model	Cet objet représente un modèle (il peut s’agir d’un modèle de base ou d’un résultat de travail affiné).
batch	Cet objet représente un lot.
upload	Cet objet représente un chargement de fichier.
upload.part	Cet objet représente une partie d’un chargement de fichier.

Partager via

Models - List

Paramètres URI

En-tête de la demande

Réponses

Sécurité

api-key

Exemples

Getting all models owned by account.

Exemple de requête

Exemple de réponse

Définitions

Capabilities

Deprecation

Error

ErrorCode

ErrorResponse

FineTuningState

InnerError

InnerErrorCode

LifeCycleStatus

Model

ModelList

TypeDiscriminator