Get Embeddings - Get Embeddings

Odwołanie

Usługa:: AI Foundry

Wersja interfejsu API:: 2024-05-01-preview

Zwróć wektory osadzania dla podanych monitów tekstowych. Metoda wykonuje wywołanie interfejsu API REST do trasy /embeddings w danym punkcie końcowym.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
extra-parameters		ExtraParameters	Określa, co się stanie, jeśli dodatkowe parametry, niezdefiniowane przez interfejs API REST, są przekazywane w ładunku żądania JSON. Spowoduje to ustawienie nagłówka żądania HTTP `extra-parameters`.

Treść żądania

Nazwa	Wymagane	Typ	Opis
input	True	string[]	Tekst wejściowy do osadzenia, zakodowany jako ciąg lub tablica tokenów. Aby osadzić wiele danych wejściowych w jednym żądaniu, przekaż tablicę ciągów lub tablicę tablic tokenów.
dimensions		integer (int32)	Fakultatywny. Liczba wymiarów, które powinny mieć wynikowe osadzanie danych wyjściowych. Przekazywanie wartości null powoduje, że model używa wartości domyślnej. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru.
encoding_format		EmbeddingEncodingFormat	Fakultatywny. Żądany format zwróconych osadzeń.
input_type		EmbeddingInputType	Fakultatywny. Typ danych wejściowych. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru.
model		string	Identyfikator określonego modelu sztucznej inteligencji do użycia, jeśli w punkcie końcowym jest dostępny więcej niż jeden model.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EmbeddingsResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

EmbeddingsResult

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://ml.azure.com/.default

Przykłady

maximum set embeddings

minimum set embeddings

maximum set embeddings

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat	Określa typy osadzania do wygenerowania. Skompresowane typy osadzania, takie jak `uint8`, `int8`, `ubinary` i `binary`, mogą zmniejszyć koszty magazynowania bez poświęcania integralności danych. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru. Przeczytaj dokumentację modelu, aby poznać wartości obsługiwane przez model.
EmbeddingInputType	Reprezentuje typy danych wejściowych używane do osadzania wyszukiwania.
EmbeddingItem	Reprezentacja pojedynczego porównania powiązanych elementów osadzania.
EmbeddingsOptions	Informacje o konfiguracji żądania osadzania.
EmbeddingsResult	Reprezentacja danych odpowiedzi z żądania osadzania. Osadzanie mierzy pokrewność ciągów tekstowych i są często używane do wyszukiwania, klastrowania, rekomendacji i innych podobnych scenariuszy.
EmbeddingsUsage	Pomiar ilości tokenów używanych w tym żądaniu i odpowiedzi.
ExtraParameters	Określa, co się stanie, jeśli dodatkowe parametry, niezdefiniowane przez interfejs API REST, są przekazywane w ładunku żądania JSON.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

EmbeddingEncodingFormat

Wyliczanie

Określa typy osadzania do wygenerowania. Skompresowane typy osadzania, takie jak uint8, int8, ubinary i binary, mogą zmniejszyć koszty magazynowania bez poświęcania integralności danych. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru. Przeczytaj dokumentację modelu, aby poznać wartości obsługiwane przez model.

Wartość	Opis
base64	Pobierz reprezentację binarną osadzania zakodowaną jako ciąg Base64. Biblioteka openAI języka Python pobiera osadzanie z interfejsu API jako zakodowane dane binarne, zamiast używać pośrednich reprezentacji dziesiętnych, tak jak zwykle.
binary	Pobieranie z powrotem podpisanych plików binarnych osadzania
float	Uzyskiwanie pełnej precyzji osadzania
int8	Pobieranie z powrotem logowanych int8 osadzania
ubinary	Pobieranie niepodpisanych osadzania binarnego
uint8	Pobieranie niepodpisanych int8 osadzania

EmbeddingInputType

Wyliczanie

Reprezentuje typy danych wejściowych używane do osadzania wyszukiwania.

Wartość	Opis
document	Wskazuje dane wejściowe reprezentuje dokument przechowywany w bazie danych wektorów.
query	Wskazuje dane wejściowe reprezentuje zapytanie wyszukiwania w celu znalezienia najbardziej odpowiednich dokumentów w bazie danych wektorów.
text	Wskazuje, że dane wejściowe są ogólnym tekstem wejściowym.

EmbeddingItem

Objekt

Reprezentacja pojedynczego porównania powiązanych elementów osadzania.

Nazwa	Typ	Opis
embedding	number[] (float)	Lista wartości osadzania dla monitu wejściowego. Reprezentują one pomiar zależności wektorowej dostarczonej danych wejściowych. Lub ciąg zakodowany w formacie base64 wektora osadzania.
index	integer (int32)	Indeks monitu, do którego odpowiada element EmbeddingItem.
object	enum: embedding	Typ obiektu tego elementu osadzania. Zawsze będzie `embedding`.

EmbeddingsOptions

Objekt

Informacje o konfiguracji żądania osadzania.

Nazwa	Typ	Opis
dimensions	integer (int32)	Fakultatywny. Liczba wymiarów, które powinny mieć wynikowe osadzanie danych wyjściowych. Przekazywanie wartości null powoduje, że model używa wartości domyślnej. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru.
encoding_format	EmbeddingEncodingFormat	Fakultatywny. Żądany format zwróconych osadzeń.
input	string[]	Tekst wejściowy do osadzenia, zakodowany jako ciąg lub tablica tokenów. Aby osadzić wiele danych wejściowych w jednym żądaniu, przekaż tablicę ciągów lub tablicę tablic tokenów.
input_type	EmbeddingInputType	Fakultatywny. Typ danych wejściowych. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru.
model	string	Identyfikator określonego modelu sztucznej inteligencji do użycia, jeśli w punkcie końcowym jest dostępny więcej niż jeden model.

EmbeddingsResult

Objekt

Reprezentacja danych odpowiedzi z żądania osadzania. Osadzanie mierzy pokrewność ciągów tekstowych i są często używane do wyszukiwania, klastrowania, rekomendacji i innych podobnych scenariuszy.

Nazwa	Typ	Opis
data	EmbeddingItem[]	Osadzanie wartości dla monitów przesłanych w żądaniu.
id	string	Unikatowy identyfikator wyniku osadzania.
model	string	Identyfikator modelu użyty do wygenerowania tego wyniku.
object	enum: list	Typ obiektu wyniku osadzania. Zawsze będzie `list`.
usage	EmbeddingsUsage	Liczniki użycia dla tokenów wejściowych przy użyciu interfejsu API osadzania.

EmbeddingsUsage

Objekt

Pomiar ilości tokenów używanych w tym żądaniu i odpowiedzi.

Nazwa	Typ	Opis
prompt_tokens	integer (int32)	Liczba tokenów w żądaniu.
total_tokens	integer (int32)	Łączna liczba tokenów transakcji w tym żądaniu/odpowiedzi. Powinna być równa liczbie tokenów w żądaniu.

ExtraParameters

Wyliczanie

Określa, co się stanie, jeśli dodatkowe parametry, niezdefiniowane przez interfejs API REST, są przekazywane w ładunku żądania JSON.

Wartość	Opis
drop	Usługa zignoruje (upuść) dodatkowe parametry w ładunku żądania. Przekaże on tylko znane parametry do modelu AI zaplecza.
error	Jeśli usługa wykryje dodatkowe parametry w ładunku żądania, wystąpi błąd. Jest to domyślna usługa.
pass-through	Usługa przekaże dodatkowe parametry do modelu AI zaplecza.

Udostępnij za pośrednictwem

Get Embeddings - Get Embeddings

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

api-key

OAuth2Auth

Zakresy

Przykłady

maximum set embeddings

Przykładowe żądanie

Przykładowa odpowiedź

minimum set embeddings

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

Dodatkowe zasoby