Get Embeddings - Get Embeddings

Riferimento

Servizio:: AI Foundry

Versione API:: 2024-05-01-preview

Restituisce i vettori di incorporamento per i prompt di testo specificati. Il metodo effettua una chiamata API REST alla route /embeddings sull'endpoint specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
extra-parameters		ExtraParameters	Controlla cosa accade se parametri aggiuntivi, non definiti dall'API REST, vengono passati nel payload della richiesta JSON. In questo modo viene impostata l'intestazione della richiesta HTTP `extra-parameters`.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
input	True	string[]	Testo di input da incorporare, codificato come stringa o matrice di token. Per incorporare più input in una singola richiesta, passare una matrice di stringhe o una matrice di matrici di token.
dimensions		integer (int32)	Opzionale. Numero di dimensioni che devono essere presenti gli incorporamenti di output risultanti. Se si passa null, il modello usa il valore predefinito. Restituisce un errore 422 se il modello non supporta il valore o il parametro.
encoding_format		EmbeddingEncodingFormat	Opzionale. Formato desiderato per gli incorporamenti restituiti.
input_type		EmbeddingInputType	Opzionale. Tipo dell'input. Restituisce un errore 422 se il modello non supporta il valore o il parametro.
model		string	ID del modello di intelligenza artificiale specifico da usare, se nell'endpoint sono disponibili più modelli.

Risposte

Nome	Tipo	Descrizione
200 OK	EmbeddingsResult	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

EmbeddingsResult

La richiesta ha avuto esito positivo.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://ml.azure.com/.default

Esempio

maximum set embeddings

minimum set embeddings

maximum set embeddings

Esempio di richiesta

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"
}

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat	Specifica i tipi di incorporamenti da generare. I tipi di incorporamento compressi, ad esempio `uint8`, `int8`, `ubinary` e `binary`, possono ridurre i costi di archiviazione senza sacrificare l'integrità dei dati. Restituisce un errore 422 se il modello non supporta il valore o il parametro. Leggere la documentazione del modello per conoscere i valori supportati dal modello.
EmbeddingInputType	Rappresenta i tipi di input utilizzati per la ricerca di incorporamento.
EmbeddingItem	Rappresentazione di un singolo confronto di correlazione tra incorporamenti.
EmbeddingsOptions	Informazioni di configurazione per una richiesta di incorporamento.
EmbeddingsResult	Rappresentazione dei dati della risposta da una richiesta di incorporamento. Gli incorporamenti misurano la correlazione delle stringhe di testo e vengono comunemente usati per la ricerca, il clustering, le raccomandazioni e altri scenari simili.
EmbeddingsUsage	Misurazione della quantità di token usati in questa richiesta e risposta.
ExtraParameters	Controlla cosa accade se parametri aggiuntivi, non definiti dall'API REST, vengono passati nel payload della richiesta JSON.

Azure.Core.Foundations.Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Object

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

EmbeddingEncodingFormat

Enumerazione

Specifica i tipi di incorporamenti da generare. I tipi di incorporamento compressi, ad esempio uint8, int8, ubinary e binary, possono ridurre i costi di archiviazione senza sacrificare l'integrità dei dati. Restituisce un errore 422 se il modello non supporta il valore o il parametro. Leggere la documentazione del modello per conoscere i valori supportati dal modello.

Valore	Descrizione
base64	Ottenere la rappresentazione binaria degli incorporamenti codificati come stringa Base64. La libreria Python OpenAI recupera gli incorporamenti dall'API come dati binari codificati, invece di usare rappresentazioni decimali intermedie come avvieni in genere.
binary	Recupera incorporamenti binari firmati
float	Recupera incorporamenti con precisione completa
int8	Recuperare gli incorporamenti di int8 connessi
ubinary	Recupera incorporamenti binari senza segno
uint8	Recuperare gli incorporamenti int8 senza segno

EmbeddingInputType

Enumerazione

Rappresenta i tipi di input utilizzati per la ricerca di incorporamento.

Valore	Descrizione
document	Indica che l'input rappresenta un documento archiviato in un database vettoriale.
query	Indica che l'input rappresenta una query di ricerca per trovare i documenti più rilevanti nel database vettoriale.
text	Indica che l'input è un input di testo generale.

EmbeddingItem

Object

Rappresentazione di un singolo confronto di correlazione tra incorporamenti.

Nome	Tipo	Descrizione
embedding	number[] (float)	Elenco dei valori di incorporamento per il prompt di input. Questi rappresentano una misura della correlazione basata su vettore dell'input fornito. Oppure una stringa con codifica Base64 del vettore di incorporamento.
index	integer (int32)	Indice del prompt a cui corrisponde EmbeddingItem.
object	enum: embedding	Tipo di oggetto di questo elemento di incorporamento. Sarà sempre `embedding`.

EmbeddingsOptions

Object

Informazioni di configurazione per una richiesta di incorporamento.

Nome	Tipo	Descrizione
dimensions	integer (int32)	Opzionale. Numero di dimensioni che devono essere presenti gli incorporamenti di output risultanti. Se si passa null, il modello usa il valore predefinito. Restituisce un errore 422 se il modello non supporta il valore o il parametro.
encoding_format	EmbeddingEncodingFormat	Opzionale. Formato desiderato per gli incorporamenti restituiti.
input	string[]	Testo di input da incorporare, codificato come stringa o matrice di token. Per incorporare più input in una singola richiesta, passare una matrice di stringhe o una matrice di matrici di token.
input_type	EmbeddingInputType	Opzionale. Tipo dell'input. Restituisce un errore 422 se il modello non supporta il valore o il parametro.
model	string	ID del modello di intelligenza artificiale specifico da usare, se nell'endpoint sono disponibili più modelli.

EmbeddingsResult

Object

Rappresentazione dei dati della risposta da una richiesta di incorporamento. Gli incorporamenti misurano la correlazione delle stringhe di testo e vengono comunemente usati per la ricerca, il clustering, le raccomandazioni e altri scenari simili.

Nome	Tipo	Descrizione
data	EmbeddingItem[]	Incorporamento dei valori per le richieste inviate nella richiesta.
id	string	Identificatore univoco per il risultato degli incorporamenti.
model	string	ID modello usato per generare questo risultato.
object	enum: list	Tipo di oggetto del risultato degli incorporamenti. Sarà sempre `list`.
usage	EmbeddingsUsage	Conteggi di utilizzo per l'input dei token usando l'API embeddings.

EmbeddingsUsage

Object

Misurazione della quantità di token usati in questa richiesta e risposta.

Nome	Tipo	Descrizione
prompt_tokens	integer (int32)	Numero di token nella richiesta.
total_tokens	integer (int32)	Numero totale di token transazionati in questa richiesta/risposta. Deve essere uguale al numero di token nella richiesta.

ExtraParameters

Enumerazione

Controlla cosa accade se parametri aggiuntivi, non definiti dall'API REST, vengono passati nel payload della richiesta JSON.

Valore	Descrizione
drop	Il servizio ignorerà (eliminare) parametri aggiuntivi nel payload della richiesta. Passerà solo i parametri noti al modello di intelligenza artificiale back-end.
error	Il servizio restituisce un errore se ha rilevato parametri aggiuntivi nel payload della richiesta. Si tratta dell'impostazione predefinita del servizio.
pass-through	Il servizio passerà parametri aggiuntivi al modello di intelligenza artificiale back-end.

Condividi tramite

Get Embeddings - Get Embeddings

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

api-key

OAuth2Auth

Ambiti

Esempio

maximum set embeddings

Esempio di richiesta

Risposta di esempio

minimum set embeddings

Esempio di richiesta

Risposta di esempio

Definizioni

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

Risorse aggiuntive