Referenz: Image 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 das Eingabebild und das Textpaar darstellt.
POST /images/embeddings?api-version=2024-04-01-preview
URI-Parameter
| Name | Geben Sie in | Erforderlich | Type | BESCHREIBUNG |
|---|---|---|---|---|
| api-version | Abfrage | 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 |
|---|---|---|---|
| input | True | EmbeddingInput[] | Eingabebild zum Einbetten. Übergeben Sie ein Array, um mehrere Eingaben in einer einzelnen Anforderung einzubetten. Die Eingabe darf die maximalen Eingabetoken für das Modell nicht überschreiten. |
| Dimensionen | integer | Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Wenn Null übergeben wird, verwendet das Modell seinen Standardwert. 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. |
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. 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.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:-Präfix, 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 und ein Bild darstellt
Beispiel-Anfrage
POST /images/embeddings?api-version=2024-04-01-preview
{
"input": [
{
"text": "A nice picture of a cat",
"image": "data:image/jpeg;base64,iVBORw0KG..."
}
],
"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": "DINO",
"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. |
| CreateEmbeddingResponse | |
| CreateImageEmbeddingRequest | |
| Detail | |
| Einbettung | Stellt ein generiertes Bild 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. |
| EmbeddingObject | Der Objekttyp, der immer „embedding“ ist. |
| EmbeddingInput | Stellt ein Bild mit optionalem Text dar. |
| ListObject | Der Objekttyp, der immer „list“ lautet. |
| NotFoundError | |
| TooManyRequestsError | |
| UnauthorizedError | |
| 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. |
CreateEmbeddingResponse
| 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. |
CreateImageEmbeddingRequest
| Name | Type | Standardwert | Beschreibung |
|---|---|---|---|
| Dimensionen | integer | Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Wenn Null übergeben wird, verwendet das Modell seinen Standardwert. Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt. | |
| encoding_format | EmbeddingEncodingFormat | float | 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 | EmbeddingInput[] | Eingabebild zum Einbetten. Übergeben Sie ein Array, um mehrere Eingaben in einer einzelnen Anforderung einzubetten. Die Eingabe darf die maximalen Eingabetoken für das Modell nicht überschreiten. |
Detail
| Name | Typ | Beschreibung |
|---|---|---|
| loc | string[] | Der Parameter, der das Problem verursacht |
| value | Zeichenfolge | Der an den Parameter übergebene Wert, der Probleme verursacht |
Einbettung
Stellt ein generiertes Bild dar.
| Name | Typ | Beschreibung |
|---|---|---|
| Einbetten | number[] | Der Einbettungsvektor, bei dem es sich um eine Liste von Floats handelt. Die Länge des Vektors hängt vom verwendeten Modell 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 |
EmbeddingObject
Der Objekttyp, der immer „embedding“ ist.
| Name | Typ | Beschreibung |
|---|---|---|
| Einbetten | Zeichenfolge |
EmbeddingInput
Stellt ein Bild mit optionalem Text dar.
| Name | Typ | Beschreibung |
|---|---|---|
| image | Zeichenfolge | Das in einer base64-Zeichenfolge codierte Eingabebild als Daten-URL. Beispiel: data:image/{format};base64,{data}. |
| Text | Zeichenfolge | Optional. Die Texteingabe, die in das Modell eingespeist werden soll (z. B. DINO, CLIP). Gibt den Fehler 422 zurück, wenn das Modell den Wert oder Parameter nicht unterstützt. |
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_patches | integer | Die Anzahl der von der Bildaufforderung verwendeten Bildpatches. |
| prompt_tokens | integer | Die Anzahl der von der Eingabeaufforderung verwendeten Token. |
| total_patches | integer | Die Gesamtzahl der von der Anforderung verwendeten Patches. |
| total_tokens | integer | Die Gesamtzahl der von der Anforderung verwendeten Token. |