Models - List

Service:

Azure AI Services

API Version:

2023-12-01-preview

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

GET {endpoint}/openai/models?api-version=2023-12-01-preview

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 est survenue.

Sécurité

api-key

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

Type: apiKey
In: header

Exemples

Getting all models owned by account.

Sample Request

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2023-12-01-preview

Sample Response

Status code:

200

{
  "data": [
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "model"
    },
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "model"
    }
  ],
  "object": "list"
}

Définitions

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

Capabilities

Fonctionnalités

Nom	Type	Description
chat_completion	boolean	Valeur indiquant si un modèle prend en charge l’achèvement de la 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

Dépréciation

Nom	Type	Description
fine_tune	integer	Date de fin de la prise en charge des réglages précis de ce modèle. null Sera pour affiner les modèles.
inference	integer	Date de fin de la prise en charge de l’inférence de ce modèle.

Error

Erreur

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

ErrorCode

ErrorCode

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

ErrorResponse

ErrorResponse

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

FineTuningState

FineTuningState

Nom	Type	Description
cancelled	string	L’opération a été annulée et est incomplète. Il peut être classé comme état terminal.
created	string	L’opération a été créée. Cet état n’est pas retourné par Azure OpenAI et exposé uniquement à des fins de compatibilité. Il peut être classé comme un état inactif.
failed	string	L’opération s’est terminée avec un échec et ne peut pas être consommée. Il peut être classé comme état terminal.
pending	string	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	string	Le traitement de l’opération a commencé. Il peut être classé comme un état actif.
succeeded	string	L’opération a été traitée avec succès et est prête à être consommée. Il peut être classé comme état terminal.

InnerError

InnerError

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions REST de Microsoft (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 de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Nom	Type	Description
invalidPayload	string	Les données de demande ne sont pas valides pour cette opération.

LifeCycleStatus

LifeCycleStatus

Nom	Type	Description
generally-available	string	Le modèle est généralement disponible.
preview	string	Le modèle est en préversion et couvert par les termes de la préversion du service.

Model

Modéliser

Nom	Type	Description
capabilities	Capabilities	Fonctionnalités Fonctionnalités d’un modèle de base ou de réglage précis.
created_at	integer	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. En règle générale, les modèles de base prennent en charge 1 an de réglage précis après leur 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é du travail d’optimisation (fine-tune-id) s’il s’agit d’un modèle d’optimisation fine ; sinon null, .
id	string	Identité de cet élément.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Cycle de vie status d’un modèle. Remarque : Un modèle peut être promu de « préversion » à « généralement disponible », mais jamais de « disponibilité générale » à « préversion ».
model	string	Identité du modèle de base (model-id) s’il s’agit d’un modèle d’optimisation fine ; sinon null, .
object	TypeDiscriminator	TypeDiscriminator Définit le type d’un objet.
status	FineTuningState	FineTuningState État d’un objet ou d’un travail de réglage précis.
updated_at	integer	Horodatage de la dernière modification de ce travail ou de cet élément (dans les époques Unix).

ModelList

ModelList

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

TypeDiscriminator

TypeDiscriminator

Nom	Type	Description
file	string	Cet objet représente un fichier.
fine-tune	string	Cet objet représente un travail d’optimisation.
fine-tune-event	string	Cet objet représente un événement d’un travail d’optimisation.
fine_tuning.job	string	Cet objet représente un travail d’optimisation.
fine_tuning.job.event	string	Cet objet représente un événement d’un travail de réglage précis.
list	string	Cet objet représente une liste d’autres objets.
model	string	Cet objet représente un modèle (il peut s’agir d’un modèle de base ou d’un résultat de travail d’optimisation).