Hivatkozás: Beágyazások | Azure Machine Learning

Cikk
10/16/2024

Létrehoz egy beágyazási vektort, amely a bemeneti szöveget jelöli.

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

URI-paraméterek

Név	In	Kötelező	Típus	Leírás
`api-version`	Lekérdezés	Igaz	húr	Az API verziója "YYYY-MM-DD" vagy "YYYY-MM-DD-preview" formátumban.

Kérelem fejléce

Név	Kötelező	Típus	Leírás
extra paraméterek		húr	Az API viselkedése, amikor a hasznos adatok további paramétereket jeleznek. A használatával `pass-through` az API átadja a paramétert a mögöttes modellnek. Ezt az értéket akkor használja, ha olyan paramétereket szeretne átadni, amelyeket az alapul szolgáló modell támogat. Az API használatával `ignore` elveti a nem támogatott paramétereket. Ezt az értéket akkor használja, ha ugyanazokat a hasznos adatokat kell használnia a különböző modelleken, de az egyik extra paraméter miatt előfordulhat, hogy a modell hibát jelez, ha nem támogatott. A használatával `error` az API elutasítja a hasznos adatokban lévő további paramétereket. Csak az API-ban megadott paraméterek jelezhetők, vagy 400-es hiba jelenik meg.
azureml-model-deployment		húr	Annak az üzemelő példánynak a neve, amelyhez a kérést irányítani szeretné. Több üzembe helyezést támogató végpontok esetén támogatott.

Kérelem törzse

Név	Kötelező	Típus	Leírás
bemenet	Igaz	sztring[]	Bemeneti szöveg beágyazásához, sztringként vagy tokentömbként kódolva. Ha több bemenetet szeretne beágyazni egyetlen kérelembe, adjon át sztringek vagy tokentömbök tömbjének tömböt.
Méretek		egész szám	Az eredményként kapott kimeneti beágyazások dimenzióinak száma. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.
encoding_format		EmbeddingEncodingFormat	A beágyazások visszaadásának formátuma. Vagy base64, float, int8, uint8, bináris vagy ubinary. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.
input_type		EmbeddingInputType	A bemenet típusa. Vagy `text`, `query`vagy `document`. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.

Válaszok

Név	Típus	Leírás
200 OK	CreateEmbeddingResponse	OK
401 Nem engedélyezett	UnauthorizedError	A hozzáférési jogkivonat hiányzik vagy érvénytelen Fejlécek x-ms-error-code: sztring
404 Nem található	NotFoundError	A modell nem támogatja a modalitást. Ellenőrizze a modell dokumentációját, hogy mely útvonalak érhetők el. Fejlécek x-ms-error-code: sztring
422 Feldolgozhatatlan entitás	UnprocessableContentError	A kérelem feldolgozhatatlan tartalmat tartalmaz Fejlécek x-ms-error-code: sztring
429 – Túl sok kérelem	TooManyRequestsError	Elérte a hozzárendelt sebességkorlátot, és a kérést tempóba kell helyeznie. Fejlécek x-ms-error-code: sztring
Egyéb állapotkódok	ContentFilterError	Hibás kérés Fejlécek x-ms-error-code: sztring

Biztonság

Engedélyezés

A jogkivonat a Bearer: prefixkövetkezővel: Bearer abcde12345

Típus: apiKey In: fejléc

AADToken

Azure Active Directory OAuth2-hitelesítés

Típus: oauth2 Flow: alkalmazásjogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/v2.0/token

Példák

Létrehoz egy beágyazási vektort, amely a bemeneti szöveget jelöli

Kérésminta

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

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

Mintaválasz

Állapotkód: 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
  }
}

Definíciók

Név	Leírás
ContentFilterError	Az API-hívás meghiúsul, ha a parancssor a konfigurált tartalomszűrőt aktiválja. Módosítsa a kérést, és próbálkozzon újra.
CreateEmbeddingRequest	Beágyazások létrehozásának kérése.
CreateEmbeddingResponse	A beágyazási kérés válasza.
Részlet	A hibák részletei.
Beágyazás	A létrehozott beágyazási objektumot jelöli.
EmbeddingEncodingFormat	A beágyazások visszaadásának formátuma. Vagy base64, float, int8, uint8, bináris vagy ubinary. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.
EmbeddingInputType	A bemenet típusa. Vagy `text`, `query`vagy `document`. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.
EmbeddingObject	Az objektum típusa, amely mindig "beágyazás".
ListObject	Az objektum típusa, amely mindig "lista".
NotFoundError	Az útvonal nem érvényes az üzembe helyezett modellre.
TooManyRequestsError	Elérte a hozzárendelt sebességkorlátot, és a kéréseket tempóba kell helyeznie.
UnauthorizedError	A hitelesítés hiányzik vagy érvénytelen.
UnprocessableContentError	A kérelem feldolgozhatatlan tartalmat tartalmaz. A hiba akkor jelenik meg, ha a megadott hasznos adat érvényes a specifikációnak megfelelően. A hasznos adatokban jelzett utasítások némelyikét azonban az alapul szolgáló modell nem támogatja. A szakasz segítségével `details` megismerheti a jogsértő paramétert.
Használat	A kérelem használati adatai.

ContentFilterError

Az API-hívás meghiúsul, ha a parancssor a konfigurált tartalomszűrőt aktiválja. Módosítsa a kérést, és próbálkozzon újra.

Név	Típus	Leírás
code	húr	A hibakód.
hiba	húr	A hiba leírása.
üzenet	húr	A hibaüzenet.
Param	húr	A tartalomszűrőt aktiváló paraméter.
status	egész szám	A HTTP-állapotkód.

CreateEmbeddingRequest

Beágyazások létrehozásának kérése.

Név	Kötelező	Típus	Leírás
bemenet	Igaz	sztring[]	Bemeneti szöveg beágyazásához, sztringként vagy tokentömbként kódolva. Ha több bemenetet szeretne beágyazni egyetlen kérelembe, adjon át sztringek vagy tokentömbök tömbjének tömböt.
Méretek		egész szám	Az eredményként kapott kimeneti beágyazások dimenzióinak száma. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.
encoding_format		EmbeddingEncodingFormat	A beágyazások visszaadásának formátuma. Vagy base64, float, int8, uint8, bináris vagy ubinary. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.
input_type		EmbeddingInputType	A bemenet típusa. Vagy `text`, `query`vagy `document`. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.

CreateEmbeddingResponse

A beágyazási kérés válasza.

Név	Típus	Leírás
adatok	Beágyazás[]	A modell által létrehozott beágyazások listája.
modell	húr	A beágyazás létrehozásához használt modell neve.
object	ListObject	Az objektum típusa, amely mindig "lista".
használat	Használat	A kérelem használati adatai.

Részlet

A UnprocessableContentError hiba részletei.

Név	Típus	Leírás
Loc	sztring[]	A problémát okozó paraméter
Érték	húr	A problémát okozó paraméternek átadott érték.

Beágyazás

A létrehozott beágyazást jelöli.

Név	Típus	Leírás
Beágyazás	[]	A beágyazási vektor. A vektor hossza a használt modelltől és a típustól függ `encoding_format` .
index	egész szám	A beágyazás indexe a beágyazások listájában.
object	EmbeddingObject	Az objektum típusa, amely mindig "beágyazás".

EmbeddingEncodingFormat

A beágyazások visszaadásának formátuma. Vagy base64, float, int8, uint8, bináris vagy ubinary. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.

Név	Típus	Leírás
base64	húr
bináris	húr
float	húr
int8	húr
ubinary	húr
uint8	húr

EmbeddingInputType

A bemenet típusa. Vagy text, queryvagy document. 422-s hibát ad vissza, ha a modell nem támogatja az értéket vagy paramétert.

Név	Típus	Leírás
dokumentum	húr	Azt jelzi, hogy a bemenet egy vektoradatbázisban tárolt dokumentumot jelöl.
Lekérdezés	húr	Azt jelzi, hogy a bemenet keresési lekérdezéseket jelöl a vektoradatbázis legrelevánsabb dokumentumainak megkereséséhez.
text	húr	Azt jelzi, hogy a bemenet egy általános szöveges bemenet.

EmbeddingObject

Név	Típus	Leírás
Beágyazás	húr

ListObject

Az objektum típusa, amely mindig "lista".

Név	Típus	Leírás
list	húr

NotFoundError

Név	Típus	Leírás
hiba	húr	A hiba leírása.
üzenet	húr	A hibaüzenet.
status	egész szám	A HTTP-állapotkód.

TooManyRequestsError

Név	Típus	Leírás
hiba	húr	A hiba leírása.
üzenet	húr	A hibaüzenet.
status	egész szám	A HTTP-állapotkód.

UnauthorizedError

Név	Típus	Leírás
hiba	húr	A hiba leírása.
üzenet	húr	A hibaüzenet.
status	egész szám	A HTTP-állapotkód.

UnprocessableContentError

A kérelem feldolgozhatatlan tartalmat tartalmaz. A hiba akkor jelenik meg, ha a megadott hasznos adat érvényes a specifikációnak megfelelően. A hasznos adatokban jelzett utasítások némelyikét azonban az alapul szolgáló modell nem támogatja. A szakasz segítségével details megismerheti a jogsértő paramétert.

Név	Típus	Leírás
code	húr	A hibakód.
részlet	Részlet
hiba	húr	A hiba leírása.
üzenet	húr	A hibaüzenet.
status	egész szám	A HTTP-állapotkód.

Használat

A kérelem használati adatai.

Név	Típus	Leírás
prompt_tokens	egész szám	A parancssor által használt jogkivonatok száma.
total_tokens	egész szám	A kérelem által használt jogkivonatok teljes száma.

Megosztás a következőn keresztül: