Azure OpenAI Embeddings

API-Version: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models APIs

Servervariablen:

Variable Vorgabe Description
endpoint Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname.
Beispiel:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentifizierung

ApiKeyAuth (API-Schlüssel)

Gib deinen API-Schlüssel in den Header api-key .

ApiKeyAuth_ (API-Schlüssel)

Gib deinen API-Schlüssel in den Header authorization .

OAuth2Auth (OAuth 2.0)

Fluss: implizit

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

Bereiche:

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

Sicherheitsanforderungen

Endpunkte akzeptieren eine der folgenden Authentifizierungsmethoden:

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

Einbettung erstellen

POST {endpoint}/openai/v1/embeddings

Erstellt einen Einbettungsvektor, der den Eingabetext darstellt.

URI-Parameter

Name In Required Typ Description
endpoint server Ja Schnur Ein unterstütztes Azure AI Foundry Models APIs-Endpunkt, einschließlich Protokoll und Hostname.
Beispiel:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
API-Version query No Schnur
Mögliche Werte: v1, preview		 Die explizite API-Version der Azure AI Foundry Models-API, die für diese Anforderung verwendet werden soll.
v1 wenn nicht anders angegeben.

Anforderungstext

Content-Type: application/json

Name Typ Description Required Vorgabe
dimensions integer Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Nur in text-embedding-3 und späteren Modellen unterstützt.
Einschränkungen: min: 1		 No
encoding_format enum Das Format, in das die Einbettungen zurückgegeben werden sollen. Kann entweder float oder base64 sein.
Mögliche Werte: float, base64		 No float
input Zeichenfolge oder Array von Zeichenfolge oder Array von ganzzahligem Array oder Array von Arrays Eingabetext zum Einbetten, codiert als Zeichenfolge oder Array von Token. Um mehrere Eingaben in eine einzelne Anforderung einzubetten, übergeben Sie ein Array von Zeichenfolgen oder ein Array von Tokenarrays. Die Eingabe darf die maximalen Eingabetoken des Modells (8192 Token für alle Einbettungsmodelle) nicht überschreiten, darf keine leere Zeichenkette sein, und jedes Array muss 2048 Dimensionen oder weniger haben. Example Python Code zum Zählen von Token. Zusätzlich zum Grenzwert pro Eingabetoken erzwingen alle Einbettungsmodelle maximal 300.000 Token, die über alle Eingaben in einer einzigen Anforderung summiert wurden. Ja
model Schnur ID des zu verwendenden Modells. Sie können die List Models API nutzen, um alle verfügbaren Modelle zu sehen, oder unsere Modellübersicht für Beschreibungen einsehen. Ja
user Schnur Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. No

Responses

Statuscode: 200

Beschreibung: Die Anforderung ist erfolgreich.

Inhaltstyp Typ Beschreibung
Anwendung/json OpenAI.CreateEmbeddingResponse

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Statuscode: Standard

Beschreibung: Eine unerwartete Fehlerantwort.

Inhaltstyp Typ Beschreibung
Anwendung/json Objekt
Name Typ Description Required Vorgabe
Programmcode Zeichenfolge oder null Ja
innerer Fehler No
message Schnur Ja
param Zeichenfolge oder null No
type Schnur No

Antwortheader:

Header Typ Description
apim-request-id Schnur Eine Anforderungs-ID, die für Problembehandlungszwecke verwendet wird.

Examples

Example

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

Components

AzureAIFoundryModelsApiVersion

Property Wert
Typ Schnur
Werte v1
preview

OpenAI.CreateEmbeddingRequest

Name Typ Description Required Vorgabe
dimensions integer Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Nur in text-embedding-3 und späteren Modellen unterstützt.
Einschränkungen: min: 1		 No
encoding_format enum Das Format, in das die Einbettungen zurückgegeben werden sollen. Kann entweder float oder base64 sein.
Mögliche Werte: float, base64		 No float
input Zeichenfolge oder Array von Zeichenfolge oder Array von ganzzahligem Array oder Array von Arrays Eingabetext zum Einbetten, codiert als Zeichenfolge oder Array von Token. Um mehrere Eingaben in eine einzelne Anforderung einzubetten, übergeben Sie ein Array von Zeichenfolgen oder ein Array von Tokenarrays. Die Eingabe darf die maximalen Eingabetoken des Modells (8192 Token für alle Einbettungsmodelle) nicht überschreiten, darf keine leere Zeichenkette sein, und jedes Array muss 2048 Dimensionen oder weniger haben. Example Python Code zum Zählen von Token. Zusätzlich zum Grenzwert pro Eingabetoken erzwingen alle Einbettungsmodelle maximal 300.000 Token, die über alle Eingaben in einer einzigen Anforderung summiert wurden. Ja
model Schnur ID des zu verwendenden Modells. Sie können die List Models API nutzen, um alle verfügbaren Modelle zu sehen, oder unsere Modellübersicht für Beschreibungen einsehen. Ja
user Schnur Ein eindeutiger Bezeichner, der Ihren Endbenutzer darstellt, der OpenAI dabei helfen kann, Missbrauch zu überwachen und zu erkennen. No

OpenAI.CreateEmbeddingResponse

Name Typ Description Required Vorgabe
data Array von OpenAI.Embedding Die Liste der vom Modell generierten Einbettungen. Ja
model Schnur Der Name des Modells, das zum Generieren der Einbettung verwendet wird. Ja
Objekt enum Der Objekttyp, der immer "liste" ist.
Mögliche Werte: list		 Ja
usage OpenAI.CreateEmbeddingResponseUsage Ja
└– prompt_tokens integer Ja
└– total_tokens integer Ja

OpenAI.CreateEmbeddingResponseUsage

Name Typ Description Required Vorgabe
prompt_tokens integer Ja
Gesamtanzahl Tokens integer Ja

OpenAI.Embedding

Stellt einen einbettenden Vektor dar, der vom Einbettungsendpunkt zurückgegeben wird.

Name Typ Description Required Vorgabe
Einbetten Array der Zahl Der Einbettungsvektor, bei dem es sich um eine Liste von Floats handelt. Die Länge des Vektors hängt vom Modell ab, wie es im Einbettungsleitfaden aufgeführt ist. Ja
index integer Der Index der Einbettung in der Liste der Einbettungen. Ja
Objekt enum Der Objekttyp, der immer "einbetten" ist.
Mögliche Werte: embedding		 Ja
  • Last updated on