Referenz: Einbettungen | Azure KI Studio

Wichtig

Die in diesem Artikel markierten Elemente (Vorschau) sind aktuell als öffentliche Vorschau verfügbar. Diese Vorschauversion wird ohne Vereinbarung zum Servicelevel bereitgestellt und sollte nicht für Produktionsworkloads verwendet werden. Manche Features werden möglicherweise nicht unterstützt oder sind nur eingeschränkt verwendbar. Weitere Informationen finden Sie unter Zusätzliche Nutzungsbestimmungen für Microsoft Azure-Vorschauen.

Erstellt einen Einbettungsvektor, der den Eingabetext darstellt.

POST /embeddings?api-version=2024-04-01-preview

URI-Parameter

Name	Geben Sie in	Erforderlich	Type	BESCHREIBUNG
api-version	query	True	Zeichenfolge	Die Version der API im Format "JJJJ-MM-TT" oder "JJJJ-MM-TT-Vorschau"

Anforderungsheader

Name	Erforderlich	Type	Beschreibung
Zusätzliche Parameter		Zeichenfolge	Das Verhalten der API, wenn zusätzliche Parameter in der Nutzlast angegeben werden. Durch die Verwendung von pass-through wird die API zum Übergeben des Parameters an das zugrunde liegende Modell angeregt. Verwenden Sie diesen Wert, wenn Sie Parameter übergeben möchten, die Ihnen bekannt sind, damit das zugrunde liegende Modell unterstützt werden kann. Die Verwendung von ignore führt dazu, dass die API alle nicht unterstützten Parameter ablegt. Verwenden Sie diesen Wert, wenn Sie dieselbe Nutzlast in verschiedenen Modellen verwenden müssen, aber einer der zusätzlichen Parameter kann dazu führen, dass ein Modell ausfällt, wenn es nicht unterstützt wird. Die Verwendung von error sorgt dafür, dass die API alle zusätzlichen Parameter in der Nutzlast ablehnt. Es können nur Parameter angegeben werden, die in dieser API festgelegt sind, ansonsten wird ein 400-Fehler zurückgegeben.
azureml-model-deployment		Zeichenfolge	Name der Bereitstellung, an die Sie die Anforderung weiterleiten möchten Unterstützt für Endpunkte, die mehrere Bereitstellungen unterstützen

Anforderungstext

Name	Erforderlich	Type	Beschreibung
model		Zeichenfolge	Der Name des Modells. Dieser Parameter wird ignoriert, wenn der Endpunkt nur für ein Modell verwendet wird.
input	True	string[]	Eingabetext zum Einbetten, codiert als Zeichenfolge oder Array von Token. Übergeben Sie ein Array von Zeichenfolgen oder ein Array von Tokenarrays, um mehrere Eingaben in einer einzelnen Anforderung einzubetten.
Dimensionen		integer	Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
encoding_format		EmbeddingEncodingFormat	Das Format, in das die Einbettungen zurückgegeben werden sollen. Entweder base64, float, int8, uint8, binary oder ubinary. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
input_type		EmbeddingInputType	Der Typ der Eingabe. Entweder text, query oder document. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.

Antworten

Name	Typ	BESCHREIBUNG
200 – OK	CreateEmbeddingResponse	OK
401 – Nicht autorisiert	UnauthorizedError	Zugriffstoken fehlt oder ist ungültig Kopfzeile x-ms-error-code: string
404 Nicht gefunden	NotFoundError	Modalität wird vom Modell nicht unterstützt. Sehen Sie in der Dokumentation des Modells nach, welche Routen verfügbar sind. Kopfzeile x-ms-error-code: string
422: Entität kann nicht verarbeitet werden	UnprocessableContentError	Die Anforderung enthält nicht verarbeitbaren Inhalt. Kopfzeile x-ms-error-code: string
429 – Zu viele Anforderungen	TooManyRequestsError	Sie haben das zugewiesene Ratenlimit erreicht, und Ihre Anforderung muss beschleunigt werden. Kopfzeile x-ms-error-code: string
Andere Statuscodes	ContentFilterError	Ungültige Anforderung Kopfzeile x-ms-error-code: string

Sicherheit

Autorisierung

Das Token mit dem Bearer: prefix, z. B. Bearer abcde12345

Typ: apiKey In: Header

AADToken

Azure Active Directory OAuth2-Authentifizierung

Typ: oauth2 Flow: Anwendung Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Beispiele

Erstellt einen Einbettungsvektor, der den Eingabetext darstellt

Beispiel-Anfrage

POST /embeddings?api-version=2024-04-01-preview

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

Beispiel für eine Antwort

Statuscode: 200

{
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "BERT",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Definitionen

Name	Beschreibung
ContentFilterError	Der API-Aufruf schlägt fehl, wenn der Prompt einen Inhaltsfilter wie konfiguriert auslöst. Ändern Sie die Äußerung, und versuchen Sie es erneut.
CreateEmbeddingRequest	Anforderung zum Erstellen von Einbettungen.
CreateEmbeddingResponse	Antwort von einer Einbettungsanforderung.
Detail	Details zu den Fehlern.
Einbettung	Stellt das generierte Einbettungsobjekt dar.
EmbeddingEncodingFormat	Das Format, in das die Einbettungen zurückgegeben werden sollen. Entweder base64, float, int8, uint8, binary oder ubinary. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
EmbeddingInputType	Der Typ der Eingabe. Entweder text, query oder document. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
EmbeddingObject	Der Objekttyp, der immer „embedding“ ist.
ListObject	Der Objekttyp, der immer „list“ lautet.
NotFoundError	Die Route ist für das bereitgestellte Modell ungültig.
TooManyRequestsError	Sie haben das zugewiesene Ratenlimit erreicht, und Ihre Anforderungen müssen beschleunigt werden.
UnauthorizedError	Die Authentifizierung fehlt oder ist ungültig.
UnprocessableContentError	Die Anforderung enthält nicht verarbeitbaren Inhalt. Der Fehler wird zurückgegeben, wenn die angegebene Nutzlast gemäß dieser Spezifikation gültig ist. Einige der in der Nutzlast angegebenen Anweisungen werden jedoch vom zugrunde liegenden Modell nicht unterstützt. Verwenden Sie den details-Abschnitt, um den problematischen Parameter zu verstehen.
Verwendung	Die Nutzungsinformationen für die Anforderung.

ContentFilterError

Der API-Aufruf schlägt fehl, wenn der Prompt einen Inhaltsfilter wie konfiguriert auslöst. Ändern Sie die Äußerung, und versuchen Sie es erneut.

Name	Typ	BESCHREIBUNG
code	Zeichenfolge	Der Fehlercode.
error	Zeichenfolge	Die Fehlerbeschreibung.
message	Zeichenfolge	Die Fehlermeldung.
param	Zeichenfolge	Der Parameter, der den Inhaltsfilter ausgelöst hat.
status	integer	Der HTTP-Statuscode.

CreateEmbeddingRequest

Anforderung zum Erstellen von Einbettungen.

Name	Erforderlich	Type	Beschreibung
input	True	string[]	Eingabetext zum Einbetten, codiert als Zeichenfolge oder Array von Token. Übergeben Sie ein Array von Zeichenfolgen oder ein Array von Tokenarrays, um mehrere Eingaben in einer einzelnen Anforderung einzubetten.
Dimensionen		integer	Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
encoding_format		EmbeddingEncodingFormat	Das Format, in das die Einbettungen zurückgegeben werden sollen. Entweder base64, float, int8, uint8, binary oder ubinary. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.
input_type		EmbeddingInputType	Der Typ der Eingabe. Entweder text, query oder document. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.

CreateEmbeddingResponse

Antwort von einer Einbettungsanforderung.

Name	Typ	Beschreibung
data	Embedding[]	Die Liste der vom Modell generierten Einbettungen.
model	Zeichenfolge	Der Name des Modells, das zum Generieren der Einbettung verwendet wurde.
Objekt	ListObject	Der Objekttyp, der immer „list“ lautet.
Nutzung	Verwendung	Die Nutzungsinformationen für die Anforderung.

Detail

Details zum Fehler UnprocessableContentError.

Name	Typ	Beschreibung
loc	string[]	Der Parameter, der das Problem verursacht
value	Zeichenfolge	Der an den Parameter übergebene Wert, der Probleme verursacht

Einbettung

Stellt die generierte Einbettung dar.

Name	Typ	Beschreibung
Einbetten	[]	Der Einbettungsvektor. Die Länge des Vektors hängt vom verwendeten Modell ab, und der Typ hängt von der verwendeten encoding_format ab.
Index	integer	Der Index der Einbettung in der Liste der Einbettungen
Objekt	EmbeddingObject	Der Objekttyp, der immer „embedding“ ist.

EmbeddingEncodingFormat

Das Format, in das die Einbettungen zurückgegeben werden sollen. Entweder base64, float, int8, uint8, binary oder ubinary. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.

Name	Typ	Beschreibung
base64	Zeichenfolge
binary	Zeichenfolge
float	Zeichenfolge
int8	Zeichenfolge
ubinary	Zeichenfolge
uint8	Zeichenfolge

EmbeddingInputType

Der Typ der Eingabe. Entweder text, query oder document. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt.

Name	Typ	Beschreibung
document	Zeichenfolge	Gibt an, dass die Eingabe ein Dokument darstellt, das in einer Vektordatenbank gespeichert ist.
query	Zeichenfolge	Gibt an, dass die Eingabe eine Suchabfrage nach den relevantesten Dokumenten in Ihrer Vektordatenbank darstellt.
Text	Zeichenfolge	Gibt an, dass die Eingabe eine allgemeine Texteingabe ist.

EmbeddingObject

Name	Typ	Beschreibung
Einbetten	Zeichenfolge

ListObject

Der Objekttyp, der immer „list“ lautet.

Name	Typ	Beschreibung des Dataflows
list	Zeichenfolge

NotFoundError

Name	Typ	Beschreibung des Dataflows
error	Zeichenfolge	Die Fehlerbeschreibung.
message	Zeichenfolge	Die Fehlermeldung.
status	integer	Der HTTP-Statuscode.

TooManyRequestsError

Name	Typ	Beschreibung des Dataflows
error	Zeichenfolge	Die Fehlerbeschreibung.
message	Zeichenfolge	Die Fehlermeldung.
status	integer	Der HTTP-Statuscode.

UnauthorizedError

Name	Typ	Beschreibung des Dataflows
error	Zeichenfolge	Die Fehlerbeschreibung.
message	Zeichenfolge	Die Fehlermeldung.
status	integer	Der HTTP-Statuscode.

UnprocessableContentError

Die Anforderung enthält nicht verarbeitbaren Inhalt. Der Fehler wird zurückgegeben, wenn die angegebene Nutzlast gemäß dieser Spezifikation gültig ist. Einige der in der Nutzlast angegebenen Anweisungen werden jedoch vom zugrunde liegenden Modell nicht unterstützt. Verwenden Sie den details-Abschnitt, um den problematischen Parameter zu verstehen.

Name	Typ	BESCHREIBUNG
code	Zeichenfolge	Der Fehlercode.
Detail	Detail
error	Zeichenfolge	Die Fehlerbeschreibung.
message	Zeichenfolge	Die Fehlermeldung.
status	integer	Der HTTP-Statuscode.

Verbrauch

Die Nutzungsinformationen für die Anforderung.

Name	Typ	Beschreibung
prompt_tokens	integer	Die Anzahl der vom Prompt verwendeten Token.
total_tokens	integer	Die Gesamtzahl der von der Anforderung verwendeten Token.