Get Embeddings - Get Embeddings

Référence

Service:: AI Foundry

Version d'API:: 2024-05-01-preview

Retournez les vecteurs d’incorporation pour les invites de texte données. La méthode effectue un appel d’API REST à l’itinéraire /embeddings sur le point de terminaison donné.

POST https:///embeddings?api-version=2024-05-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
extra-parameters		ExtraParameters	Contrôle ce qui se passe si des paramètres supplémentaires, non définis par l’API REST, sont transmis dans la charge utile de requête JSON. Cela définit l’en-tête de requête HTTP `extra-parameters`.

Corps de la demande

Nom	Obligatoire	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		integer (int32)	Optionnel. Nombre de dimensions dont les incorporations de sortie obtenues doivent avoir. Le passage de null 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	Optionnel. Format souhaité pour les incorporations retournées.
input_type		EmbeddingInputType	Optionnel. Type de l’entrée. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre.
model		string	ID du modèle IA spécifique à utiliser, si plusieurs modèles sont disponibles sur le point de terminaison.

Réponses

Nom	Type	Description
200 OK	EmbeddingsResult	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

EmbeddingsResult

La demande a réussi.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

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

Étendues

Nom	Description
https://ml.azure.com/.default

Exemples

maximum set embeddings

minimum set embeddings

maximum set embeddings

Exemple de requête

HTTP

POST https:///embeddings?api-version=2024-05-01-preview


{
  "input": [
    "This is a very good text"
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

Exemple de réponse

Code d’état:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

minimum set embeddings

Exemple de requête

HTTP

POST https:///embeddings?api-version=2024-05-01-preview

{
  "input": [
    "This is a very good text"
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat	Spécifie les types d’incorporations à générer. Les types d’incorporation compressés tels que `uint8`, `int8`, `ubinary` et `binary`, peuvent réduire les coûts de stockage sans sacrifier l’intégrité des données. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. Lisez la documentation du modèle pour connaître les valeurs prises en charge par votre modèle.
EmbeddingInputType	Représente les types d’entrée utilisés pour la recherche incorporée.
EmbeddingItem	Représentation d’une comparaison des liens liés à l’incorporation unique.
EmbeddingsOptions	Informations de configuration pour une demande d’incorporations.
EmbeddingsResult	Représentation des données de réponse à partir d’une demande d’incorporations. Les incorporations mesurent la relation entre les chaînes de texte et sont couramment utilisées pour la recherche, le clustering, les recommandations et d’autres scénarios similaires.
EmbeddingsUsage	Mesure de la quantité de jetons utilisés dans cette demande et cette réponse.
ExtraParameters	Contrôle ce qui se passe si des paramètres supplémentaires, non définis par l’API REST, sont transmis dans la charge utile de requête JSON.

Azure.Core.Foundations.Error

Object

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Object

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

EmbeddingEncodingFormat

Énumération

Spécifie les types d’incorporations à générer. Les types d’incorporation compressés tels que uint8, int8, ubinary et binary, peuvent réduire les coûts de stockage sans sacrifier l’intégrité des données. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre. Lisez la documentation du modèle pour connaître les valeurs prises en charge par votre modèle.

Valeur	Description
base64	Récupérez la représentation binaire des incorporations encodées en tant que chaîne Base64. La bibliothèque Python OpenAI récupère les incorporations de l’API en tant que données binaires encodées, plutôt que d’utiliser des représentations décimales intermédiaires comme c’est généralement le cas.
binary	Récupérer les incorporations binaires signées
float	Récupérer des incorporations complètes de précision
int8	Récupérer les incorporations int8 signées
ubinary	Récupérer les incorporations binaires non signées
uint8	Récupérer les incorporations int8 non signées

EmbeddingInputType

Énumération

Représente les types d’entrée utilisés pour la recherche incorporée.

Valeur	Description
document	Indique que l’entrée représente un document stocké dans une base de données vectorielle.
query	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.
text	Indique que l’entrée est une entrée de texte générale.

EmbeddingItem

Object

Représentation d’une comparaison des liens liés à l’incorporation unique.

Nom	Type	Description
embedding	number[] (float)	Liste des valeurs d’incorporation pour l’invite d’entrée. Elles représentent une mesure de la relation vectorielle de l’entrée fournie. Ou une chaîne encodée en base64 du vecteur d’incorporation.
index	integer (int32)	Index de l’invite à laquelle l’EmbeddingItem correspond.
object	enum: embedding	Type d’objet de cet élément d’incorporation. Sera toujours `embedding`.

EmbeddingsOptions

Object

Informations de configuration pour une demande d’incorporations.

Nom	Type	Description
dimensions	integer (int32)	Optionnel. Nombre de dimensions dont les incorporations de sortie obtenues doivent avoir. Le passage de null 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	Optionnel. Format souhaité pour les incorporations retournées.
input	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.
input_type	EmbeddingInputType	Optionnel. Type de l’entrée. Retourne une erreur 422 si le modèle ne prend pas en charge la valeur ou le paramètre.
model	string	ID du modèle IA spécifique à utiliser, si plusieurs modèles sont disponibles sur le point de terminaison.

EmbeddingsResult

Object

Représentation des données de réponse à partir d’une demande d’incorporations. Les incorporations mesurent la relation entre les chaînes de texte et sont couramment utilisées pour la recherche, le clustering, les recommandations et d’autres scénarios similaires.

Nom	Type	Description
data	EmbeddingItem[]	Incorporation de valeurs pour les invites envoyées dans la demande.
id	string	Identificateur unique pour le résultat de l’incorporation.
model	string	ID de modèle utilisé pour générer ce résultat.
object	enum: list	Type d’objet du résultat de l’incorporation. Sera toujours `list`.
usage	EmbeddingsUsage	Nombre d’utilisations pour les entrées de jetons à l’aide de l’API d’incorporations.

EmbeddingsUsage

Object

Mesure de la quantité de jetons utilisés dans cette demande et cette réponse.

Nom	Type	Description
prompt_tokens	integer (int32)	Nombre de jetons dans la requête.
total_tokens	integer (int32)	Nombre total de jetons traités dans cette requête/réponse. Doit être égal au nombre de jetons dans la requête.

ExtraParameters

Énumération

Contrôle ce qui se passe si des paramètres supplémentaires, non définis par l’API REST, sont transmis dans la charge utile de requête JSON.

Valeur	Description
drop	Le service ignore (supprime) les paramètres supplémentaires dans la charge utile de la requête. Il transmet uniquement les paramètres connus au modèle IA back-end.
error	Le service s’affiche si des paramètres supplémentaires ont été détectés dans la charge utile de la requête. Il s’agit de la valeur par défaut du service.
pass-through	Le service transmet des paramètres supplémentaires au modèle IA back-end.

Partager via

Get Embeddings - Get Embeddings

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

api-key

OAuth2Auth

Étendues

Exemples

maximum set embeddings

Exemple de requête

Exemple de réponse

minimum set embeddings

Exemple de requête

Exemple de réponse

Définitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

Ressources supplémentaires