Azure OpenAI Embeddings

Versione API: v1

Server:{endpoint}/openai/v1 — API Azure AI Foundry modelli

Variabili del server:

Variabile Predefinito Description
endpoint Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host.
Per esempio:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Autenticazione

ApiKeyAuth (API Key)

Passa la chiave API nell'intestare api-key .

ApiKeyAuth_ (Chiave API)

Passa la chiave API nell'intestare authorization .

OAuth2Auth (OAuth 2.0)

Flusso: implicito

URL autorizzazione:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti:

  • https://cognitiveservices.azure.com/.default

Requisiti di sicurezza

Gli endpoint accettano uno qualsiasi dei seguenti metodi di autenticazione:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (ambitivi: https://cognitiveservices.azure.com/.default)

Creare incorporazione

POST {endpoint}/openai/v1/embeddings

Crea un vettore di incorporamento che rappresenta il testo di input.

Parametri dell'URI

Name In Obbligatorio Type Description
endpoint server Sì string Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host.
Per esempio:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-version query No string
Valori possibili: v1, preview		 Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Corpo della richiesta

Content-Type: application/json

Name Type Description Obbligatorio Predefinito
dimensions integer Numero di dimensioni che devono essere presenti gli incorporamenti di output risultanti. Supportato solo nei text-embedding-3 modelli e nei modelli successivi.
Vincoli: min: 1		 No
encoding_format enum Formato in cui restituire gli incorporamenti. Può essere float o base64.
Valori possibili: float, base64		 No float
input stringa o matrice di stringhe o matrice di numeri interi o matrice di matrice 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. L'ingresso non deve superare i token di ingresso massimi per il modello (8192 token per tutti i modelli di embedding), non può essere una stringa vuota e qualsiasi array deve avere 2048 dimensioni o meno. Codice Python di esempio per il conteggio dei token. Oltre al limite di token per input, tutti i modelli di incorporamento applicano un massimo di 300.000 token sommati in tutti gli input in una singola richiesta. Sì
model string ID del modello da usare. Puoi utilizzare l'API List Models per vedere tutti i modelli disponibili, oppure consultare la nostra panoramica dei modelli per descriverli. Sì
user string Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.CreateEmbeddingResponse

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json object
Name Type Description Obbligatorio Predefinito
codice stringa o null Sì
inner_error No
message string Sì
param stringa o null No
type string No

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Examples

Example

POST {endpoint}/openai/v1/embeddings?api-version=v1

Components

AzureAIFoundryModelsApiVersion

Proprietà Value
Type string
Valori v1
preview

OpenAI.CreateEmbeddingRequest

Name Type Description Obbligatorio Predefinito
dimensions integer Numero di dimensioni che devono essere presenti gli incorporamenti di output risultanti. Supportato solo nei text-embedding-3 modelli e nei modelli successivi.
Vincoli: min: 1		 No
encoding_format enum Formato in cui restituire gli incorporamenti. Può essere float o base64.
Valori possibili: float, base64		 No float
input stringa o matrice di stringhe o matrice di numeri interi o matrice di matrice 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. L'ingresso non deve superare i token di ingresso massimi per il modello (8192 token per tutti i modelli di embedding), non può essere una stringa vuota e qualsiasi array deve avere 2048 dimensioni o meno. Codice Python di esempio per il conteggio dei token. Oltre al limite di token per input, tutti i modelli di incorporamento applicano un massimo di 300.000 token sommati in tutti gli input in una singola richiesta. Sì
model string ID del modello da usare. Puoi utilizzare l'API List Models per vedere tutti i modelli disponibili, oppure consultare la nostra panoramica dei modelli per descriverli. Sì
user string Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. No

OpenAI.CreateEmbeddingResponse

Name Type Description Obbligatorio Predefinito
data matrice di OpenAI.Embedding Elenco di incorporamenti generati dal modello. Sì
model string Nome del modello utilizzato per generare l'incorporamento. Sì
object enum Tipo di oggetto, che è sempre "list".
Valori possibili: list		 Sì
uso OpenAI.CreateEmbeddingResponseUsage Sì
└prompt_tokens integer Sì
└total_tokens integer Sì

OpenAI.CreateEmbeddingResponseUsage

Name Type Description Obbligatorio Predefinito
prompt_tokens integer Sì
total_tokens integer Sì

OpenAI.Embedding

Rappresenta un vettore di incorporamento restituito dall'endpoint di incorporamento.

Name Type Description Obbligatorio Predefinito
embedding matrice di numeri Vettore di incorporamento, che è un elenco di float. La lunghezza del vettore dipende dal modello come indicato nella guida di embedding. Sì
index integer Indice dell'incorporamento nell'elenco di incorporamenti. Sì
object enum Tipo di oggetto, che è sempre "incorporamento".
Valori possibili: embedding		 Sì
  • Last updated on