Get Embeddings - Get Embeddings
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:///embeddings?api-version=2024-05-01-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
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 |
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 |
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 |
Wahlfrei. Das gewünschte Format für die zurückgegebenen Einbettungen. |
||
input_type |
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 |
Die Anforderung ist erfolgreich. |
|
Other Status Codes |
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://ml.azure.com/.default |
Beispiele
maximum set embeddings |
minimum set embeddings |
maximum set embeddings
Beispielanforderung
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"
}
Beispiel für eine Antwort
{
"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
POST https:///embeddings?api-version=2024-05-01-preview
{
"input": [
"This is a very good text"
]
}
Beispiel für eine Antwort
{
"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. |
Das Fehlerobjekt. |
Azure. |
Eine Antwort, die Fehlerdetails enthält. |
Azure. |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Embedding |
Gibt die Typen der zu generierenden Einbettungen an. Komprimierte Einbettungstypen wie |
Embedding |
Stellt die Eingabetypen dar, die für die Einbettungssuche verwendet werden. |
Embedding |
Darstellung eines einzelnen Einbettungsvergleichs. |
Embeddings |
Die Konfigurationsinformationen für eine Einbettungsanforderung. |
Embeddings |
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. |
Embeddings |
Messung der Anzahl der token, die in dieser Anforderung und Antwort verwendet werden. |
Extra |
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
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
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
Eine Antwort, die Fehlerdetails enthält.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
Azure.Core.Foundations.InnerError
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
innererror |
Innerer Fehler. |
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.
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
Stellt die Eingabetypen dar, die für die Einbettungssuche verwendet werden.
Wert | Beschreibung |
---|---|
document |
Gibt an, dass die Eingabe ein Dokument darstellt, das in einer Vektordatenbank gespeichert ist. |
query |
Gibt an, dass die Eingabe eine Suchabfrage darstellt, um die relevantesten Dokumente in Ihrer Vektordatenbank zu finden. |
text |
Gibt an, dass die Eingabe eine allgemeine Texteingabe ist. |
EmbeddingItem
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 |
EmbeddingsOptions
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 |
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 |
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
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 |
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 |
usage |
Die Verwendungsanzahl für Tokeneingaben mithilfe der Einbettungs-API. |
EmbeddingsUsage
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
Steuert, was geschieht, wenn zusätzliche Parameter, die von der REST-API nicht definiert sind, in der JSON-Anforderungsnutzlast übergeben werden.
Wert | Beschreibung |
---|---|
drop |
Der Dienst ignoriert (Drop) zusätzliche Parameter in der Anforderungsnutzlast. Er übergibt nur die bekannten Parameter an das Back-End-KI-Modell. |
error |
Der Dienst tritt auf, wenn zusätzliche Parameter in der Anforderungsnutzlast erkannt wurden. Dies ist der Standarddienst. |
pass-through |
Der Dienst übergibt zusätzliche Parameter an das Back-End-KI-Modell. |