Get Embeddings - Get Embeddings

Referens

Tjänst:: AI Foundry

API-version:: 2024-05-01-preview

Returnera inbäddningsvektorerna för angivna textprompter. Metoden gör ett REST API-anrop till den /embeddings vägen på den angivna slutpunkten.

POST https:///embeddings?api-version=2024-05-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
extra-parameters		ExtraParameters	Styr vad som händer om extra parametrar, odefinierade av REST-API:et, skickas i JSON-begärandenyttolasten. Detta anger HTTP-begärandehuvudet `extra-parameters`.

Begärandetext

Name	Obligatorisk	Typ	Description
input	True	string[]	Indatatext som ska bäddas in, kodas som en sträng eller matris med token. Om du vill bädda in flera indata i en enda begäran skickar du en matris med strängar eller matriser med tokenmatriser.
dimensions		integer (int32)	Valfri. 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	Valfri. Önskat format för de returnerade inbäddningarna.
input_type		EmbeddingInputType	Valfri. Typ av indata. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern.
model		string	ID för den specifika AI-modell som ska användas, om mer än en modell är tillgänglig på slutpunkten.

Svar

Name	Typ	Description
200 OK	EmbeddingsResult	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

EmbeddingsResult

Begäran har slutförts.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://ml.azure.com/.default

Exempel

maximum set embeddings

minimum set embeddings

maximum set embeddings

Exempelbegäran

HTTP

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"
}

Exempelsvar

Statuskod:: 200

{
  "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

Exempelbegäran

HTTP

POST https:///embeddings?api-version=2024-05-01-preview

{
  "input": [
    "This is a very good text"
  ]
}

Exempelsvar

Statuskod:: 200

{
  "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
  }
}

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat	Anger vilka typer av inbäddningar som ska genereras. Komprimerade inbäddningstyper som `uint8`, `int8`, `ubinary` och `binary`, kan minska lagringskostnaderna utan att offra dataintegriteten. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. Läs modellens dokumentation om du vill veta vilka värden som stöds av modellen.
EmbeddingInputType	Representerar de indatatyper som används för inbäddningssökning.
EmbeddingItem	Representation av en enda jämförelse av inbäddningsrelaterade inbäddningar.
EmbeddingsOptions	Konfigurationsinformationen för en inbäddningsbegäran.
EmbeddingsResult	Representation av svarsdata från en inbäddningsbegäran. Inbäddningar mäter relaterade textsträngar och används ofta för sökning, klustring, rekommendationer och andra liknande scenarier.
EmbeddingsUsage	Mätning av mängden token som används i den här begäran och svaret.
ExtraParameters	Styr vad som händer om extra parametrar, odefinierade av REST-API:et, skickas i JSON-begärandenyttolasten.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

EmbeddingEncodingFormat

Uppräkning

Anger vilka typer av inbäddningar som ska genereras. Komprimerade inbäddningstyper som uint8, int8, ubinary och binary, kan minska lagringskostnaderna utan att offra dataintegriteten. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern. Läs modellens dokumentation om du vill veta vilka värden som stöds av modellen.

Värde	Description
base64	Hämta tillbaka binär representation av inbäddningarna som kodas som Base64-sträng. OpenAI Python-biblioteket hämtar inbäddningar från API:et som kodade binära data i stället för att använda mellanliggande decimalrepresentationer som vanligt.
binary	Hämta signerade binära inbäddningar
float	Få tillbaka fullständiga precisions-inbäddningar
int8	Hämta signerade int8-inbäddningar
ubinary	Hämta osignerade binära inbäddningar
uint8	Hämta osignerade inbäddningar i int8

EmbeddingInputType

Uppräkning

Representerar de indatatyper som används för inbäddningssökning.

Värde	Description
document	Anger att indata representerar ett dokument som lagras i en vektordatabas.
query	Anger att indata representerar en sökfråga för att hitta de mest relevanta dokumenten i vektordatabasen.
text	Anger att indata är en allmän textinmatning.

EmbeddingItem

Objekt

Representation av en enda jämförelse av inbäddningsrelaterade inbäddningar.

Name	Typ	Description
embedding	number[] (float)	Lista över inbäddningsvärden för indataprompten. Dessa representerar ett mått på den vektorbaserade relatednessen för de angivna indata. Eller en base64-kodad sträng av inbäddningsvektorn.
index	integer (int32)	Index för uppmaningen som EmbeddingItem motsvarar.
object	enum: embedding	Objekttypen för det här inbäddningsobjektet. Kommer alltid att vara `embedding`.

EmbeddingsOptions

Objekt

Konfigurationsinformationen för en inbäddningsbegäran.

Name	Typ	Description
dimensions	integer (int32)	Valfri. 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	Valfri. Önskat format för de returnerade inbäddningarna.
input	string[]	Indatatext som ska bäddas in, kodas som en sträng eller matris med token. Om du vill bädda in flera indata i en enda begäran skickar du en matris med strängar eller matriser med tokenmatriser.
input_type	EmbeddingInputType	Valfri. Typ av indata. Returnerar ett 422-fel om modellen inte stöder värdet eller parametern.
model	string	ID för den specifika AI-modell som ska användas, om mer än en modell är tillgänglig på slutpunkten.

EmbeddingsResult

Objekt

Representation av svarsdata från en inbäddningsbegäran. Inbäddningar mäter relaterade textsträngar och används ofta för sökning, klustring, rekommendationer och andra liknande scenarier.

Name	Typ	Description
data	EmbeddingItem[]	Inbäddningsvärden för de frågor som skickas i begäran.
id	string	Unik identifierare för resultatet för inbäddning.
model	string	Modell-ID:t som användes för att generera det här resultatet.
object	enum: list	Objekttypen för inbäddningsresultatet. Kommer alltid att vara `list`.
usage	EmbeddingsUsage	Användningsantal för tokenindata med api:et för inbäddning.

EmbeddingsUsage

Objekt

Mätning av mängden token som används i den här begäran och svaret.

Name	Typ	Description
prompt_tokens	integer (int32)	Antal token i begäran.
total_tokens	integer (int32)	Totalt antal token som har överförts i den här begäran/det här svaret. Ska vara lika med antalet token i begäran.

ExtraParameters

Uppräkning

Styr vad som händer om extra parametrar, odefinierade av REST-API:et, skickas i JSON-begärandenyttolasten.

Värde	Description
drop	Tjänsten ignorerar (släpper) extra parametrar i begärandenyttolasten. Den skickar bara de kända parametrarna till backend-AI-modellen.
error	Tjänsten får ett fel om den har identifierat extra parametrar i begärandenyttolasten. Det här är standardinställningen för tjänsten.
pass-through	Tjänsten skickar extra parametrar till backend-AI-modellen.

Dela via

Get Embeddings - Get Embeddings

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

api-key

OAuth2Auth

Omfattningar

Exempel

maximum set embeddings

Exempelbegäran

Exempelsvar

minimum set embeddings

Exempelbegäran

Exempelsvar

Definitioner

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

Ytterligare resurser