Get Embeddings - Get Embeddings

Dienst:: AI Foundry

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

Gibt die Einbettungsvektoren für bestimmte Textaufforderungen zurück. Die Methode führt einen REST-API-Aufruf an die /embeddings Route auf dem angegebenen Endpunkt aus.

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resource	path	True	string	Der Azure AI Services-Ressourcenname, z. B. "my-resource"
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
extra-parameters		ExtraParameters	Steuert, was geschieht, wenn zusätzliche Parameter, die von der REST-API nicht definiert sind, in der JSON-Anforderungsnutzlast übergeben werden. Dadurch wird der HTTP-Anforderungsheader `extra-parameters`festgelegt.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
input	True	string[]	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.
dimensions		integer (int32)	Wahlfrei. Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Wenn Null übergeben wird, verwendet das Modell seinen Standardwert. Gibt einen 422-Fehler zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
encoding_format		EmbeddingEncodingFormat	Wahlfrei. Das gewünschte Format für die zurückgegebenen Einbettungen.
input_type		EmbeddingInputType	Wahlfrei. Der Typ der Eingabe. Gibt einen 422-Fehler zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
model		string	ID des zu verwendenden spezifischen KI-Modells, wenn mehrere Modelle auf dem Endpunkt verfügbar sind.

Antworten

Name	Typ	Beschreibung
200 OK	EmbeddingsResult	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

EmbeddingsResult

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

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

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

maximum set embeddings

minimum set embeddings

maximum set embeddings

Beispielanforderung

HTTP

POST https://{resource}.services.ai.azure.com/models/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"
}

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

HTTP

POST https://{resource}.services.ai.azure.com/models/embeddings?api-version=2024-05-01-preview

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

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
EmbeddingEncodingFormat	Gibt die Typen der zu generierenden Einbettungen an. Komprimierte Einbettungstypen wie `uint8`, `int8`, `ubinary` und `binary`können Speicherkosten reduzieren, ohne die Integrität der Daten zu beeinträchtigen. Gibt einen 422-Fehler zurück, wenn das Modell den Wert oder Parameter nicht unterstützt. Lesen Sie die Dokumentation des Modells, um die vom Modell unterstützten Werte zu kennen.
EmbeddingInputType	Stellt die Eingabetypen dar, die für die Einbettungssuche verwendet werden.
EmbeddingItem	Darstellung eines einzelnen Einbettungsvergleichs.
EmbeddingsOptions	Die Konfigurationsinformationen für eine Einbettungsanforderung.
EmbeddingsResult	Darstellung der Antwortdaten aus einer Einbettungsanforderung. Einbettungen messen die Beziehung von Textzeichenfolgen und werden häufig für Such-, Clustering-, Empfehlungen und andere ähnliche Szenarien verwendet.
EmbeddingsUsage	Messung der Anzahl der token, die in dieser Anforderung und Antwort verwendet werden.
ExtraParameters	Steuert, was geschieht, wenn zusätzliche Parameter, die von der REST-API nicht definiert sind, in der JSON-Anforderungsnutzlast übergeben werden.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

EmbeddingEncodingFormat

Enumeration

Gibt die Typen der zu generierenden Einbettungen an. Komprimierte Einbettungstypen wie uint8, int8, ubinary und binarykönnen Speicherkosten reduzieren, ohne die Integrität der Daten zu beeinträchtigen. Gibt einen 422-Fehler zurück, wenn das Modell den Wert oder Parameter nicht unterstützt. Lesen Sie die Dokumentation des Modells, um die vom Modell unterstützten Werte zu kennen.

Wert	Beschreibung
base64	Abrufen der binären Darstellung der als Base64-Zeichenfolge codierten Einbettungen. Die OpenAI Python-Bibliothek ruft Einbettungen aus der API als codierte Binärdaten ab, anstatt zwischendezimale Darstellungen wie üblich zu verwenden.
binary	Zurückerhalten signierter binärer Einbettungen
float	Vollständige Genauigkeitseinbettungen erhalten
int8	Zurückerhalten von angemeldeten Int8-Einbettungen
ubinary	Zurückerhalten nicht signierter binärer Einbettungen
uint8	Zurückerhalten nicht signierter Int8-Einbettungen

EmbeddingInputType

Enumeration

Stellt die Eingabetypen dar, die für die Einbettungssuche verwendet werden.

Wert	Beschreibung
text	Gibt an, dass die Eingabe eine allgemeine Texteingabe ist.
query	Gibt an, dass die Eingabe eine Suchabfrage darstellt, um die relevantesten Dokumente in Ihrer Vektordatenbank zu finden.
document	Gibt an, dass die Eingabe ein Dokument darstellt, das in einer Vektordatenbank gespeichert ist.

EmbeddingItem

Objekt

Darstellung eines einzelnen Einbettungsvergleichs.

Name	Typ	Beschreibung
embedding	number[] (float)	Liste der Einbettungswerte für die Eingabeaufforderung. Diese stellen eine Messung der vektorbasierten Beziehung der bereitgestellten Eingabe dar. Oder eine base64-codierte Zeichenfolge des Einbettungsvektors.
index	integer (int32)	Index der Eingabeaufforderung, der das EmbeddingItem entspricht.
object	enum: embedding	Der Objekttyp dieses Einbettungselements. Wird immer `embedding`.

EmbeddingsOptions

Objekt

Die Konfigurationsinformationen für eine Einbettungsanforderung.

Name	Typ	Beschreibung
dimensions	integer (int32)	Wahlfrei. Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Wenn Null übergeben wird, verwendet das Modell seinen Standardwert. Gibt einen 422-Fehler zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
encoding_format	EmbeddingEncodingFormat	Wahlfrei. Das gewünschte Format für die zurückgegebenen Einbettungen.
input	string[]	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.
input_type	EmbeddingInputType	Wahlfrei. Der Typ der Eingabe. Gibt einen 422-Fehler zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
model	string	ID des zu verwendenden spezifischen KI-Modells, wenn mehrere Modelle auf dem Endpunkt verfügbar sind.

EmbeddingsResult

Objekt

Darstellung der Antwortdaten aus einer Einbettungsanforderung. Einbettungen messen die Beziehung von Textzeichenfolgen und werden häufig für Such-, Clustering-, Empfehlungen und andere ähnliche Szenarien verwendet.

Name	Typ	Beschreibung
data	EmbeddingItem[]	Einbetten von Werten für die in der Anforderung übermittelten Eingabeaufforderungen.
id	string	Eindeutiger Bezeichner für das Einbettungsergebnis.
model	string	Die Modell-ID, die zum Generieren dieses Ergebnisses verwendet wird.
object	enum: list	Der Objekttyp des Einbettungsergebnisses. Wird immer `list`.
usage	EmbeddingsUsage	Die Verwendungsanzahl für Tokeneingaben mithilfe der Einbettungs-API.

EmbeddingsUsage

Objekt

Messung der Anzahl der token, die in dieser Anforderung und Antwort verwendet werden.

Name	Typ	Beschreibung
prompt_tokens	integer (int32)	Anzahl der Token in der Anforderung.
total_tokens	integer (int32)	Die Gesamtzahl der Token, die in dieser Anforderung/Antwort durchgeführt wurden. Sollte der Anzahl der Token in der Anforderung entsprechen.

ExtraParameters

Enumeration

Steuert, was geschieht, wenn zusätzliche Parameter, die von der REST-API nicht definiert sind, in der JSON-Anforderungsnutzlast übergeben werden.

Wert	Beschreibung
error	Der Dienst tritt auf, wenn zusätzliche Parameter in der Anforderungsnutzlast erkannt wurden. Dies ist der Standarddienst.
drop	Der Dienst ignoriert (Drop) zusätzliche Parameter in der Anforderungsnutzlast. Er übergibt nur die bekannten Parameter an das Back-End-KI-Modell.
pass-through	Der Dienst übergibt zusätzliche Parameter an das Back-End-KI-Modell.

Freigeben über

Get Embeddings - Get Embeddings

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

api-key

OAuth2Auth

Bereiche

Beispiele

maximum set embeddings

Beispielanforderung

Beispiel für eine Antwort

minimum set embeddings

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters