Referens: Bildinbäddningar | Azure AI Foundry
Viktigt!
Objekt markerade (förhandsversion) i den här artikeln är för närvarande i offentlig förhandsversion. Den här förhandsversionen tillhandahålls utan ett serviceavtal och vi rekommenderar det inte för produktionsarbetsbelastningar. Vissa funktioner kanske inte stöds eller kan vara begränsade. Mer information finns i Kompletterande villkor för användning av Microsoft Azure-förhandsversioner.
Skapar en inbäddningsvektor som representerar indatabilden och textparet.
POST /images/embeddings?api-version=2024-05-01-preview
URI-parametrar
| Name | I | Obligatoriskt | Type | Beskrivning |
|---|---|---|---|---|
| api-version | query | Sant | sträng | Versionen av API:et i formatet "ÅÅÅÅ-MM-DD" eller "ÅÅÅÅ-MM-DD-preview". |
Begärandehuvud
| Namn | Obligatoriskt | Type | Beskrivning |
|---|---|---|---|
| extraparametrar | sträng | Beteendet för API:et när extra parametrar anges i nyttolasten. Med gör pass-through api:et att skicka parametern till den underliggande modellen. Använd det här värdet när du vill skicka parametrar som du vet att den underliggande modellen kan stödja. Med hjälp av drop får API:et att släppa valfri parameter som inte stöds. Använd det här värdet när du behöver använda samma nyttolast i olika modeller, men en av de extra parametrarna kan göra att en modell felar ut om den inte stöds. Api error :et används för att avvisa eventuella extra parametrar i nyttolasten. Endast parametrar som anges i det här API:et kan anges eller så returneras ett 400-fel. |
|
| azureml-model-deployment | sträng | Namnet på den distribution som du vill dirigera begäran till. Stöds för slutpunkter som stöder flera distributioner. |
Begärandetext
| Namn | Obligatoriskt | Type | Beskrivning |
|---|---|---|---|
| indata | Sant | EmbeddingInput[] | Indatabild som ska bäddas in. Om du vill bädda in flera indata i en enda begäran skickar du en matris. Indata får inte överskrida de maximala indatatoken för modellen. |
| dimensioner | integer | Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Om du skickar null används standardvärdet för modellen. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. | |
| encoding_format | EmbeddingEncodingFormat | Formatet för att returnera inbäddningarna i. Antingen base64, float, int8, uint8, binary eller ubinary. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. |
Svar
| Namn | Type | Beskrivning |
|---|---|---|
| 200 OK | CreateEmbeddingResponse | OK |
| 401 – Ej behörig | UnauthorizedError | Åtkomsttoken saknas eller är ogiltig Sidhuvuden x-ms-error-code: string |
| 404 – Hittades inte | NotFoundError | Modalitet stöds inte av modellen. Kontrollera dokumentationen för modellen för att se vilka vägar som är tillgängliga. Sidhuvuden x-ms-error-code: string |
| 422 Entitet som inte kan bearbetas | UnprocessableContentError | Begäran innehåller oförbearbetat innehåll. Felet returneras när nyttolasten som anges är giltig enligt den här specifikationen. Vissa av instruktionerna som anges i nyttolasten stöds dock inte av den underliggande modellen. Använd avsnittet details för att förstå den felande parametern.Sidhuvuden x-ms-error-code: string |
| 429 För många förfrågningar | TooManyRequestsError | Du har nått den tilldelade hastighetsgränsen och din begäran måste ökas i takt. Sidhuvuden x-ms-error-code: string |
| Andra statuskoder | ContentFilterError | Felaktig begäran Sidhuvuden x-ms-error-code: string |
Säkerhet
Auktorisering
Token med prefixet Bearer: , t.ex. Bearer abcde12345
Typ: apiKey
I: rubrik
AADToken
Azure Active Directory OAuth2-autentisering
Typ: oauth2
Flöde: program
Token-URL: https://login.microsoftonline.com/common/oauth2/v2.0/token
Exempel
Skapar en inbäddningsvektor som representerar indatatexten och bilden
Exempelförfrågan
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
}
Exempelsvar
Statuskod: 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
}
}
Definitioner
| Name | beskrivning |
|---|---|
| ContentFilterError | API-anropet misslyckas när kommandotolken utlöser ett innehållsfilter som konfigurerats. Ändra kommandotolken och försök igen. |
| CreateEmbeddingResponse | |
| CreateImageEmbeddingRequest | |
| Detalj | |
| Inbäddning | Representerar en avbildning som genererats. |
| EmbeddingEncodingFormat | Formatet för att returnera inbäddningarna i. Antingen base64, float, int8, uint8, binary eller ubinary. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. |
| EmbeddingObject | Objekttypen, som alltid är "inbäddning". |
| EmbeddingInput | Representerar en bild med valfri text. |
| ListObject | Objekttypen, som alltid är "lista". |
| NotFoundError | |
| TooManyRequestsError | |
| UnauthorizedError | |
| UnprocessableContentError | Begäran innehåller oförbearbetat innehåll. Felet returneras när nyttolasten som anges är giltig enligt den här specifikationen. Vissa av instruktionerna som anges i nyttolasten stöds dock inte av den underliggande modellen. Använd avsnittet details för att förstå den felande parametern. |
| Användning | Användningsinformationen för begäran. |
ContentFilterError
API-anropet misslyckas när kommandotolken utlöser ett innehållsfilter som konfigurerats. Ändra kommandotolken och försök igen.
| Namn | Type | Beskrivning |
|---|---|---|
| kod | sträng | Felkoden. |
| fel | sträng | Felbeskrivningen. |
| meddelande | sträng | Felmeddelandet. |
| Param | sträng | Parametern som utlöste innehållsfiltret. |
| status | integer | HTTP-statuskoden. |
CreateEmbeddingResponse
| Namn | Type | Beskrivning |
|---|---|---|
| data | Bädda in[] | Listan över inbäddningar som genereras av modellen. |
| modell | sträng | Namnet på den modell som används för att generera inbäddningen. |
| objekt | ListObject | Objekttypen, som alltid är "lista". |
| användning | Användning | Användningsinformationen för begäran. |
CreateImageEmbeddingRequest
| Namn | Type | Standardvärde | beskrivning |
|---|---|---|---|
| dimensioner | integer | Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Om du skickar null används standardvärdet för modellen. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. | |
| encoding_format | EmbeddingEncodingFormat | flyttal | Formatet för att returnera inbäddningarna i. Antingen base64, float, int8, uint8, binary eller ubinary. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. |
| indata | EmbeddingInput[] | Indatabild som ska bäddas in. Om du vill bädda in flera indata i en enda begäran skickar du en matris. Indata får inte överskrida de maximala indatatoken för modellen. |
Detalj
| Namn | Type | Beskrivning |
|---|---|---|
| Loc | string[] | Parametern som orsakar problemet |
| värde | sträng | Värdet som skickas till parametern som orsakar problem. |
Inbäddning
Representerar en avbildning som genererats.
| Namn | Type | Beskrivning |
|---|---|---|
| inbäddning | number[] | Inbäddningsvektorn, som är en lista över flyttal. Längden på vektorn beror på vilken modell som används. |
| index | integer | Indexet för inbäddningen i listan över inbäddningar. |
| objekt | EmbeddingObject | Objekttypen, som alltid är "inbäddning". |
EmbeddingEncodingFormat
Formatet för att returnera inbäddningarna i. Antingen base64, float, int8, uint8, binary eller ubinary. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern.
| Namn | Type | Beskrivning |
|---|---|---|
| base64 | sträng | |
| binary | sträng | |
| flyttal | sträng | |
| int8 | sträng | |
| ubinary | sträng | |
| uint8 | sträng |
EmbeddingObject
Objekttypen, som alltid är "inbäddning".
| Namn | Type | Beskrivning |
|---|---|---|
| inbäddning | sträng |
EmbeddingInput
Representerar en bild med valfri text.
| Namn | Type | Beskrivning |
|---|---|---|
| bild | sträng | Indatabilden som kodas i base64 strängen som en data-URL. Exempel: data:image/{format};base64,{data}. |
| text | sträng | Valfritt. Textinmatningen som ska matas in i modellen (till exempel DINO, CLIP). Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. |
ListObject
Objekttypen, som alltid är "lista".
| Namn | Type | Description |
|---|---|---|
| lista | sträng |
NotFoundError
| Namn | Type | Beskrivning |
|---|---|---|
| fel | sträng | Felbeskrivningen. |
| meddelande | sträng | Felmeddelandet. |
| status | integer | HTTP-statuskoden. |
TooManyRequestsError
| Namn | Type | Beskrivning |
|---|---|---|
| fel | sträng | Felbeskrivningen. |
| meddelande | sträng | Felmeddelandet. |
| status | integer | HTTP-statuskoden. |
UnauthorizedError
| Namn | Type | Beskrivning |
|---|---|---|
| fel | sträng | Felbeskrivningen. |
| meddelande | sträng | Felmeddelandet. |
| status | integer | HTTP-statuskoden. |
UnprocessableContentError
Begäran innehåller oförbearbetat innehåll. Felet returneras när nyttolasten som anges är giltig enligt den här specifikationen. Vissa av instruktionerna som anges i nyttolasten stöds dock inte av den underliggande modellen. Använd avsnittet details för att förstå den felande parametern.
| Namn | Type | Beskrivning |
|---|---|---|
| kod | sträng | Felkoden. |
| detalj | Detalj | |
| fel | sträng | Felbeskrivningen. |
| meddelande | sträng | Felmeddelandet. |
| status | integer | HTTP-statuskoden. |
Förbrukning
Användningsinformationen för begäran.
| Namn | Type | Beskrivning |
|---|---|---|
| prompt_patches | integer | Antalet bildkorrigeringar som används av bildprompten. |
| prompt_tokens | integer | Antalet token som används av prompten. |
| total_patches | integer | Det totala antalet korrigeringar som används av begäran. |
| total_tokens | integer | Det totala antalet token som används av begäran. |