Référence : Incorporations | Azure AI Studio
Important
Les éléments marqués (préversion) dans cet article sont actuellement en préversion publique. Cette préversion est fournie sans contrat de niveau de service, nous la déconseillons dans des charges de travail de production. Certaines fonctionnalités peuvent être limitées ou non prises en charge. Pour plus d’informations, consultez Conditions d’Utilisation Supplémentaires relatives aux Évaluations Microsoft Azure.
Crée un vecteur d’incorporation représentant le texte d’entrée.
POST /embeddings?api-version=2024-04-01-preview
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
api-version |
query | True | string | Version de l’API au format « AAAA-MM-JJ » ou « AAAA-MM-JJ-preview ». |
En-tête de requête
| Nom | Requise | Type | Description |
|---|---|---|---|
| extra-parameters | string | Comportement de l’API quand des paramètres supplémentaires sont indiqués dans la charge utile. L’utilisation de pass-through oblige l’API à passer le paramètre au modèle sous-jacent. Utilisez cette valeur quand vous souhaitez passer des paramètres dont vous savez qu’ils sont pris en charge par le modèle sous-jacent. L’utilisation de ignore oblige l’API à supprimer tout paramètre non pris en charge. Utilisez cette valeur quand vous devez vous servir de la même charge utile sur différents modèles, mais que l’un des paramètres supplémentaires peut provoquer une erreur dans un modèle s’il n’est pas pris en charge. L’utilisation de error oblige l’API à rejeter tout paramètre supplémentaire dans la charge utile. Seuls les paramètres spécifiés dans cette API peuvent être indiqués, sinon une erreur 400 est retournée. |
|
| azureml-model-deployment | string | Nom du déploiement vers lequel vous souhaitez router la requête. Pris en charge pour les points de terminaison prenant en charge plusieurs déploiements. |
Corps de la demande
| Nom | Requise | Type | Description |
|---|---|---|---|
| modèle | string | Nom du modèle. Ce paramètre est ignoré si le point de terminaison ne sert qu’un seul modèle. | |
| input | True | string[] | Texte d’entrée à incorporer, encodé en tant que chaîne ou tableau de jetons. Pour incorporer plusieurs entrées dans une seule requête, transmettez un tableau de chaînes ou de tableaux de jetons. |
| dimensions | entier | Nombre de dimensions que les incorporations de sortie obtenues doivent avoir. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. | |
| encoding_format | EmbeddingEncodingFormat | Format dans lequel retourner les incorporations. base64, float, int8, uint8, binary ou ubinary. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. | |
| input_type | EmbeddingInputType | Le type de l’entrée. text, query ou document. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK | CreateEmbeddingResponse | Ok |
| 401 Non autorisé | UnauthorizedError | Le jeton d’accès est manquant ou non valide En-têtes x-ms-error-code : chaîne |
| 404 Not Found | NotFoundError | La modalité n’est pas prise en charge par le modèle. Consultez la documentation du modèle pour voir quels itinéraires sont disponibles. En-têtes x-ms-error-code : chaîne |
| 422 Impossible de traiter l’entité | UnprocessableContentError | La requête contient du contenu ne pouvant pas être traité En-têtes x-ms-error-code : chaîne |
| 429 Trop de requêtes | TooManyRequestsError | Vous avez atteint votre limite de taux attribuée et votre requête doit être régulée. En-têtes x-ms-error-code : chaîne |
| Autres codes d’état | ContentFilterError | Demande incorrecte En-têtes x-ms-error-code : chaîne |
Sécurité
Autorisation
Jeton avec le paramètre Bearer: prefix, par exemple Bearer abcde12345
Type : apiKey In : en-tête
AADToken
Authentification OAuth2 Azure Active Directory
Type : oauth2 Flux : application URL du jeton : https://login.microsoftonline.com/common/oauth2/v2.0/token
Exemples
Crée un vecteur d’incorporation représentant le texte d’entrée
Exemple de requête
POST /embeddings?api-version=2024-04-01-preview
{
"input": [
"This is a very good text"
],
"input_type": "text",
"encoding_format": "float",
"dimensions": 1024
}
Exemple de réponse
Code d’état : 200
{
"data": [
{
"index": 0,
"object": "embedding",
"embedding": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
],
"object": "list",
"model": "BERT",
"usage": {
"prompt_tokens": 15,
"total_tokens": 15
}
}
Définitions
| Nom | Description |
|---|---|
| ContentFilterError | L’appel d’API échoue quand l’invite déclenche un filtre de contenu tel que configuré. Modifiez l’invite et réessayez. |
| CreateEmbeddingRequest | Requête de création d’incorporations. |
| CreateEmbeddingResponse | Réponse à une requête de création d’incorporations. |
| Détails | Détails des erreurs. |
| Intégration | Représente l’objet d’incorporation généré. |
| EmbeddingEncodingFormat | Format dans lequel retourner les incorporations. base64, float, int8, uint8, binary ou ubinary. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. |
| EmbeddingInputType | Le type de l’entrée. text, query ou document. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. |
| EmbeddingObject | Type d’objet, qui est toujours « embedding ». |
| ListObject | Type d’objet, qui est toujours « list ». |
| NotFoundError | La route n’est pas valide pour le modèle déployé. |
| TooManyRequestsError | Vous avez atteint la limite de débit qui vous a été affectée, vous devez ralentir vos requêtes. |
| UnauthorizedError | L’authentification est manquante ou non valide. |
| UnprocessableContentError | La requête contient du contenu qui ne peut pas être traité. L’erreur est retournée quand la charge utile indiquée est valide conformément à cette spécification. Toutefois, certaines des instructions indiquées dans la charge utile ne sont pas prises en charge par le modèle sous-jacent. Utilisez la section details pour mieux comprendre le paramètre incriminé. |
| Utilisation | Informations d’utilisation relatives à la requête. |
ContentFilterError
L’appel d’API échoue quand l’invite déclenche un filtre de contenu tel que configuré. Modifiez l’invite et réessayez.
| Nom | Type | Description |
|---|---|---|
| code | string | Code d’erreur. |
| error | string | Description de l’erreur. |
| message | string | Message d’erreur. |
| param | string | Paramètre qui a déclenché le filtre de contenu. |
| statut | entier | Code d’état HTTP. |
CreateEmbeddingRequest
Requête de création d’incorporations.
| Nom | Requise | Type | Description |
|---|---|---|---|
| input | True | string[] | Texte d’entrée à incorporer, encodé en tant que chaîne ou tableau de jetons. Pour incorporer plusieurs entrées dans une seule requête, transmettez un tableau de chaînes ou de tableaux de jetons. |
| dimensions | entier | Nombre de dimensions que les incorporations de sortie obtenues doivent avoir. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. | |
| encoding_format | EmbeddingEncodingFormat | Format dans lequel retourner les incorporations. base64, float, int8, uint8, binary ou ubinary. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. | |
| input_type | EmbeddingInputType | Le type de l’entrée. text, query ou document. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. |
CreateEmbeddingResponse
Réponse à une requête de création d’incorporations.
| Nom | Type | Description |
|---|---|---|
| données | Embedding[] | Liste des incorporations générées par le modèle. |
| modèle | string | Nom du modèle utilisé pour générer l’incorporation. |
| object | ListObject | Type d’objet, qui est toujours « list ». |
| utilisation active | Utilisation | Informations d’utilisation relatives à la requête. |
Détail
Détails de l’erreur UnprocessableContentError.
| Nom | Type | Description |
|---|---|---|
| loc | string[] | Paramètre à l’origine du problème |
| value | string | Valeur transmise au paramètre à l’origine de problèmes. |
Intégration
Représente l’incorporation généré.
| Nom | Type | Description |
|---|---|---|
| incorporation | [] | Vecteur d’incorporation. La longueur du vecteur dépend du modèle utilisé et du type dépend de la encoding_format utilisée. |
| index | entier | Index de l’incorporation dans la liste des incorporations. |
| object | EmbeddingObject | Type d’objet, qui est toujours « embedding ». |
EmbeddingEncodingFormat
Format dans lequel retourner les incorporations. base64, float, int8, uint8, binary ou ubinary. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre.
| Nom | Type | Description |
|---|---|---|
| base64 | string | |
| binary | string | |
| virgule flottante | string | |
| int8 | string | |
| ubinary | string | |
| uint8 | string |
EmbeddingInputType
Le type de l’entrée. text, query ou document. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre.
| Nom | Type | Description |
|---|---|---|
| document | string | Indique que l’entrée représente un document stocké dans une base de données vectorielle. |
| query | string | Indique que l’entrée représente une requête de recherche pour rechercher les documents les plus pertinents dans votre base de données vectorielle. |
| texte | string | Indique que l’entrée est une entrée de texte générale. |
EmbeddingObject
| Nom | Type | Description |
|---|---|---|
| incorporation | string |
ListObject
Type d’objet, qui est toujours « list ».
| Nom | Type | Description |
|---|---|---|
| list | string |
NotFoundError
| Nom | Type | Description |
|---|---|---|
| error | string | Description de l’erreur. |
| message | string | Message d’erreur. |
| statut | entier | Code d’état HTTP. |
TooManyRequestsError
| Nom | Type | Description |
|---|---|---|
| error | string | Description de l’erreur. |
| message | string | Message d’erreur. |
| statut | entier | Code d’état HTTP. |
UnauthorizedError
| Nom | Type | Description |
|---|---|---|
| error | string | Description de l’erreur. |
| message | string | Message d’erreur. |
| statut | entier | Code d’état HTTP. |
UnprocessableContentError
La requête contient du contenu qui ne peut pas être traité. L’erreur est retournée quand la charge utile indiquée est valide conformément à cette spécification. Toutefois, certaines des instructions indiquées dans la charge utile ne sont pas prises en charge par le modèle sous-jacent. Utilisez la section details pour mieux comprendre le paramètre incriminé.
| Nom | Type | Description |
|---|---|---|
| code | string | Code d’erreur. |
| détails | Détails | |
| error | string | Description de l’erreur. |
| message | string | Message d’erreur. |
| statut | entier | Code d’état HTTP. |
Utilisation
Informations d’utilisation relatives à la requête.
| Nom | Type | Description |
|---|---|---|
| prompt_tokens | entier | Nombre de jetons utilisés par l’invite. |
| total_tokens | entier | Nombre total de jetons utilisés par la requête. |