Référence : Incorporations d’images | 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 qui représente la paire image et texte d’entrée.
POST /images/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 |
|---|---|---|---|
| input | True | EmbeddingInput[] | Image d’entrée à incorporer. Pour incorporer plusieurs entrées dans une seule requête, transmettez un tableau. L’entrée ne doit pas dépasser le nombre maximal de jetons d’entrée pour le modèle. |
| dimensions | entier | Nombre de dimensions que les incorporations de sortie obtenues doivent avoir. Le passage de nul entraîne l’utilisation de sa valeur par défaut pour le modèle. 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. |
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 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 comprendre le paramètre incriminé.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 préfixe Bearer:, 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 qui représente l’image et le texte d’entrée
Exemple de requête
POST /images/embeddings?api-version=2024-04-01-preview
{
"input": [
{
"text": "A nice picture of a cat",
"image": "data:image/jpeg;base64,iVBORw0KG..."
}
],
"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": "DINO",
"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. |
| CreateEmbeddingResponse | |
| CreateImageEmbeddingRequest | |
| Détails | |
| Intégration | Représente une image générée. |
| 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. |
| EmbeddingObject | Type d’objet, qui est toujours « embedding ». |
| EmbeddingInput | Représente une image avec du texte facultatif. |
| ListObject | Type d’objet, qui est toujours « list ». |
| NotFoundError | |
| TooManyRequestsError | |
| UnauthorizedError | |
| 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. |
CreateEmbeddingResponse
| 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 | Les informations d’utilisation relatives à la requête. |
CreateImageEmbeddingRequest
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| dimensions | entier | Nombre de dimensions que les incorporations de sortie obtenues doivent avoir. Le passage de nul entraîne l’utilisation de sa valeur par défaut pour le modèle. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. | |
| encoding_format | EmbeddingEncodingFormat | virgule flottante | 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 | EmbeddingInput[] | Image d’entrée à incorporer. Pour incorporer plusieurs entrées dans une seule requête, transmettez un tableau. L’entrée ne doit pas dépasser le nombre maximal de jetons d’entrée pour le modèle. |
Détail
| 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 une image générée.
| Nom | Type | Description |
|---|---|---|
| incorporation | number[] | Vecteur d’incorporation, qui est une liste de floats. La longueur du vecteur dépend du modèle utilisé. |
| 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 |
EmbeddingObject
Type d’objet, qui est toujours « embedding ».
| Nom | Type | Description |
|---|---|---|
| incorporation | string |
EmbeddingInput
Représente une image avec du texte facultatif.
| Nom | Type | Description |
|---|---|---|
| image | string | Image d’entrée encodée dans une chaîne base64 en tant qu’URL de données. Exemple : data:image/{format};base64,{data}. |
| texte | string | facultatif. L’entrée de texte à passer au modèle (comme DINO, CLIP). Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. |
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_patches | entier | Le nombre de correctifs d’image utilisés par l’invite d’images. |
| prompt_tokens | entier | Le nombre de jetons utilisés par l’invite. |
| total_patches | entier | Le nombre total de correctifs utilisés par la requête. |
| total_tokens | entier | Nombre total de jetons utilisés par la requête. |