Referenční informace: Vkládání obrázků | Azure Machine Learning

Článek
09/02/2024

Vytvoří vektor vložení představující vstupní obrázek a dvojici textu.

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

Parametry identifikátoru URI

Název	V	Požaduje se	Type	Popis
verze-api	query	True	string	Verze rozhraní API ve formátu "RRRR-MM-DD" nebo "RRRR-MM-DD-preview".

Hlavička požadavku

Název	Požadováno	Type	Popis
parametry navíc		string	Chování rozhraní API v případech, kdy jsou v datové části uvedeny další parametry. Díky použití `pass-through` rozhraní API předáte parametr podkladovému modelu. Tuto hodnotu použijte, pokud chcete předat parametry, které znáte, že základní model může podporovat. Pomocí `ignore` rozhraní API zahodíte nepodporovaný parametr. Tuto hodnotu použijte, pokud potřebujete použít stejnou datovou část v různých modelech, ale jeden z dalších parametrů může model v případě, že není podporován, chybovat. Použití `error` rozhraní API zamítá všechny další parametry v datové části. Dají se určit pouze parametry zadané v tomto rozhraní API nebo se vrátí chyba 400.
azureml-model-deployment		string	Název nasazení, na které chcete požadavek směrovat. Podporováno pro koncové body, které podporují více nasazení.

Text požadavku

Název	Požadováno	Type	Popis
model		string	Název modelu. Tento parametr se ignoruje, pokud koncový bod obsluhuje pouze jeden model.
input	True	EmbeddingInput[]	Vstupní obrázek pro vložení Pokud chcete vložit více vstupů do jednoho požadavku, předejte pole. Vstup nesmí překročit maximální vstupní tokeny modelu.
dimensions		integer	Početdimenzích Předání hodnoty null způsobí, že model použije výchozí hodnotu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
encoding_format		EmbeddingEncodingFormat	Formát pro vrácení vložených objektů. Buď base64, float, int8, uint8, binary nebo ubinary. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.

Odpovědi

Name	Typ	Popis
200 OK	CreateEmbeddingResponse	OK
401 – Neautorizováno	Neautorizovaná chyba	Přístupový token chybí nebo je neplatný. Hlavičky x-ms-error-code: string
404 – Nenalezeno	NotFoundError	Způsob, který model nepodporuje. V dokumentaci k modelu zjistíte, které trasy jsou k dispozici. Hlavičky x-ms-error-code: string
422 Nezpracovaná entita	UnprocessableContentError	Požadavek obsahuje nezpracovaný obsah. Chyba se vrátí, když je datová část uvedená v souladu s touto specifikací platná. Základní model ale nepodporuje některé pokyny uvedené v datové části. V této `details` části se seznamte s parametrem pro odsunutí. Hlavičky x-ms-error-code: string
429 – Příliš mnoho požadavků	TooManyRequestsError	Dosáhli jste svého přiřazeného limitu rychlosti a vaše žádost se musí postupovat podle tempa. Hlavičky x-ms-error-code: string
Další stavové kódy	ContentFilterError	Chybný požadavek Hlavičky x-ms-error-code: string

Zabezpečení

Autorizace

Token s předponou Bearer: , např. Bearer abcde12345

Typ: apiKey
V: hlavička

AADToken

Ověřování Azure Active Directory OAuth2

Typ: oauth2
Flow: aplikace
Adresa URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token

Příklady

Vytvoří vektor vložení představující vstupní text a obrázek.

Ukázkový požadavek

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
}

Ukázková odezva

Stavový kód: 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
  }
}

Definice

Název	Popis
ContentFilterError	Volání rozhraní API selže, když výzva aktivuje filtr obsahu podle konfigurace. Upravte výzvu a zkuste to znovu.
CreateEmbeddingResponse
CreateImageEmbeddingRequest
Podrobnosti
Vkládání	Představuje vygenerovaný obrázek.
EmbeddingEncodingFormat	Formát pro vrácení vložených objektů. Buď base64, float, int8, uint8, binary nebo ubinary. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
EmbeddingObject	Typ objektu, který je vždy vložen.
EmbeddingInput	Představuje obrázek s volitelným textem.
ListObject	Typ objektu, který je vždy "list".
NotFoundError
TooManyRequestsError
Neautorizovaná chyba
UnprocessableContentError	Požadavek obsahuje nezpracovaný obsah. Chyba se vrátí, když je datová část uvedená v souladu s touto specifikací platná. Základní model ale nepodporuje některé pokyny uvedené v datové části. V této `details` části se seznamte s parametrem pro odsunutí.
Využití	Informace o využití žádosti.

ContentFilterError

Volání rozhraní API selže, když výzva aktivuje filtr obsahu podle konfigurace. Upravte výzvu a zkuste to znovu.

Name	Typ	Popis
code	string	Kód chyby.
chyba	string	Popis chyby.
zpráva	string	Chybová zpráva
Param	string	Parametr, který aktivoval filtr obsahu.
stav	integer	Stavový kód HTTP

CreateEmbeddingResponse

Name	Typ	Popis
data	Vkládání[]	Seznam vložených objektů vygenerovaných modelem
model	string	Název modelu použitého k vygenerování vkládání.
objekt	ListObject	Typ objektu, který je vždy "list".
využití	Využití	Informace o využití žádosti.

CreateImageEmbeddingRequest

Name	Type	Výchozí hodnota	Popis
dimensions	integer		Početdimenzích Předání hodnoty null způsobí, že model použije výchozí hodnotu. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
encoding_format	EmbeddingEncodingFormat	float (číslo s plovoucí řádovou čárkou)	Formát pro vrácení vložených objektů. Buď base64, float, int8, uint8, binary nebo ubinary. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.
input	EmbeddingInput[]		Vstupní obrázek pro vložení Pokud chcete vložit více vstupů do jednoho požadavku, předejte pole. Vstup nesmí překročit maximální vstupní tokeny modelu.

Podrobnosti

Name	Typ	Popis
Loc	string[]	Parametr způsobující problém
hodnota	string	Hodnota předaná parametru způsobuje problémy.

Vkládání

Představuje vygenerovaný obrázek.

Name	Typ	Popis
ukotvení	number[]	Vložený vektor, což je seznam plovoucích hodnot. Délka vektoru závisí na použitém modelu.
index	integer	Index vkládání v seznamu vložených objektů.
objekt	EmbeddingObject	Typ objektu, který je vždy vložen.

EmbeddingEncodingFormat

Formát pro vrácení vložených objektů. Buď base64, float, int8, uint8, binary nebo ubinary. Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.

Name	Typ	Popis
base64	string
binární	string
float (číslo s plovoucí řádovou čárkou)	string
int8	string
ubinary	string
uint8	string

EmbeddingObject

Typ objektu, který je vždy vložen.

Name	Typ	Popis
ukotvení	string

EmbeddingInput

Představuje obrázek s volitelným textem.

Name	Typ	Popis
image	string	Vstupní obrázek kódovaný v `base64` řetězci jako adresa URL dat. Příklad: `data:image/{format};base64,{data}`.
text	string	Nepovinné. Textový vstup, který se má vložit do modelu (například DINO, CLIP). Vrátí chybu 422, pokud model nepodporuje hodnotu nebo parametr.

ListObject

Typ objektu, který je vždy "list".

Name	Typ	Description
list	string

NotFoundError

Name	Typ	Popis
chyba	string	Popis chyby.
zpráva	string	Chybová zpráva
stav	integer	Stavový kód HTTP

TooManyRequestsError

Name	Typ	Popis
chyba	string	Popis chyby.
zpráva	string	Chybová zpráva
stav	integer	Stavový kód HTTP

Neautorizovaná chyba

Name	Typ	Popis
chyba	string	Popis chyby.
zpráva	string	Chybová zpráva
stav	integer	Stavový kód HTTP

UnprocessableContentError

Požadavek obsahuje nezpracovaný obsah. Chyba se vrátí, když je datová část uvedená v souladu s touto specifikací platná. Základní model ale nepodporuje některé pokyny uvedené v datové části. V této details části se seznamte s parametrem pro odsunutí.

Name	Typ	Popis
code	string	Kód chyby.
detail	Podrobnosti
chyba	string	Popis chyby.
zpráva	string	Chybová zpráva
stav	integer	Stavový kód HTTP

Využití

Informace o využití žádosti.

Name	Typ	Popis
prompt_patches	integer	Počet oprav obrázků používaných výzvou k zobrazení obrázku.
prompt_tokens	integer	Počet tokenů používaných výzvou
total_patches	integer	Celkový počet oprav používaných požadavkem.
total_tokens	integer	Celkový počet tokenů používaných požadavkem.

Sdílet prostřednictvím