Dokumentacja: Osadzanie obrazów | Azure AI Foundry
Ważne
Elementy oznaczone (wersja zapoznawcza) w tym artykule są obecnie dostępne w publicznej wersji zapoznawczej. Ta wersja zapoznawcza jest udostępniana bez umowy dotyczącej poziomu usług i nie zalecamy korzystania z niej w przypadku obciążeń produkcyjnych. Niektóre funkcje mogą być nieobsługiwane lub ograniczone. Aby uzyskać więcej informacji, zobacz Uzupełniające warunki korzystania z wersji zapoznawczych platformy Microsoft Azure.
Tworzy wektor osadzania reprezentujący wejściowy obraz i parę tekstową.
POST /images/embeddings?api-version=2024-04-01-preview
Parametry identyfikatora URI
| Nazwisko | W | Wymagania | Type | Opis |
|---|---|---|---|---|
| api-version | zapytanie | Prawda | string | Wersja interfejsu API w formacie "RRRR-MM-DD" lub "RRRR-MM-DD-preview". |
Nagłówek żądania
| Nazwisko | Wymagania | Type | Opis |
|---|---|---|---|
| dodatkowe parametry | string | Zachowanie interfejsu API w przypadku wskazania dodatkowych parametrów w ładunku. Użycie pass-through polecenia sprawia, że interfejs API przekazuje parametr do bazowego modelu. Użyj tej wartości, jeśli chcesz przekazać parametry, które wiesz, że bazowy model może obsługiwać. Użycie ignore polecenia sprawia, że interfejs API usuwa dowolny nieobsługiwany parametr. Użyj tej wartości, jeśli musisz użyć tego samego ładunku w różnych modelach, ale jeden z dodatkowych parametrów może spowodować błąd modelu, jeśli nie jest obsługiwany. Użycie error polecenia sprawia, że interfejs API odrzuca dowolny dodatkowy parametr w ładunku. Można wskazać tylko parametry określone w tym interfejsie API lub zwracany jest błąd 400. |
|
| azureml-model-deployment | string | Nazwa wdrożenia, do którego chcesz skierować żądanie. Obsługiwane w przypadku punktów końcowych obsługujących wiele wdrożeń. |
Treść żądania
| Nazwisko | Wymagania | Type | Opis |
|---|---|---|---|
| input | Prawda | OsadzanieInput[] | Obraz wejściowy do osadzenia. Aby osadzić wiele danych wejściowych w jednym żądaniu, przekaż tablicę. Dane wejściowe nie mogą przekraczać maksymalnych tokenów wejściowych dla modelu. |
| wymiary | integer | 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 | Format umożliwiający zwrócenie osadzania. Base64, float, int8, uint8, binary lub ubinary. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru. |
Odpowiedzi
| Nazwisko | Pisz | Opis |
|---|---|---|
| 200 OK | CreateEmbeddingResponse | OK |
| 401 Brak autoryzacji | Brak autoryzacji | Brak tokenu dostępu lub jest on nieprawidłowy Nagłówki x-ms-error-code: ciąg |
| 404 Nie znaleziono | NotFoundError | Modalność nie jest obsługiwana przez model. Zapoznaj się z dokumentacją modelu, aby sprawdzić, które trasy są dostępne. Nagłówki x-ms-error-code: ciąg |
| 422 Jednostka nieprzetworzona | UnprocessableContentError | Żądanie zawiera nieprzetworzoną zawartość. Błąd jest zwracany, gdy wskazany ładunek jest prawidłowy zgodnie z tą specyfikacją. Jednak niektóre instrukcje wskazane w ładunku nie są obsługiwane przez bazowy model. Skorzystaj z details sekcji , aby zrozumieć parametr obraźliwy.Nagłówki x-ms-error-code: ciąg |
| 429 Zbyt wiele żądań | TooManyRequestsError | Przekroczono przypisany limit szybkości, a żądanie musi zostać przekroczone. Nagłówki x-ms-error-code: ciąg |
| Inne kody stanu | ContentFilterError | Nieprawidłowe żądanie Nagłówki x-ms-error-code: ciąg |
Zabezpieczenia
Autoryzacja
Token z prefiksem Bearer: , np. Bearer abcde12345
Typ: apiKey
W: nagłówek
AADToken
Uwierzytelnianie OAuth2 w usłudze Azure Active Directory
Typ: oauth2
Przepływ: aplikacja
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/v2.0/token
Przykłady
Tworzy wektor osadzania reprezentujący tekst wejściowy i obraz
Przykładowe żądanie
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
}
Przykładowa odpowiedź
Kod stanu: 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
}
}
Definicje
| Nazwa/nazwisko | opis |
|---|---|
| ContentFilterError | Wywołanie interfejsu API kończy się niepowodzeniem, gdy monit wyzwoli filtr zawartości zgodnie z konfiguracją. Zmodyfikuj monit i spróbuj ponownie. |
| CreateEmbeddingResponse | |
| CreateImageEmbeddingRequest | |
| Szczegół | |
| Osadzanie | Reprezentuje wygenerowany obraz. |
| EmbeddingEncodingFormat | Format umożliwiający zwrócenie osadzania. Base64, float, int8, uint8, binary lub ubinary. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru. |
| Osadzanie obiektuObject | Typ obiektu, który jest zawsze "osadzaniem". |
| OsadzanieInput | Reprezentuje obraz z opcjonalnym tekstem. |
| ListObject | Typ obiektu, który jest zawsze "list". |
| NotFoundError | |
| TooManyRequestsError | |
| Brak autoryzacji | |
| UnprocessableContentError | Żądanie zawiera nieprzetworzoną zawartość. Błąd jest zwracany, gdy wskazany ładunek jest prawidłowy zgodnie z tą specyfikacją. Jednak niektóre instrukcje wskazane w ładunku nie są obsługiwane przez bazowy model. Skorzystaj z details sekcji , aby zrozumieć parametr obraźliwy. |
| Użycie | Informacje o użyciu żądania. |
ContentFilterError
Wywołanie interfejsu API kończy się niepowodzeniem, gdy monit wyzwoli filtr zawartości zgodnie z konfiguracją. Zmodyfikuj monit i spróbuj ponownie.
| Nazwisko | Pisz | Opis |
|---|---|---|
| code | string | Kod błędu. |
| error | string | Opis błędu. |
| wiadomość | string | Komunikat o błędzie. |
| Param | string | Parametr, który wyzwolił filtr zawartości. |
| status | integer | Kod stanu HTTP. |
CreateEmbeddingResponse
| Nazwisko | Pisz | Opis |
|---|---|---|
| dane | Osadzanie[] | Lista osadzonych elementów wygenerowanych przez model. |
| model | string | Nazwa modelu używanego do generowania osadzania. |
| obiekt | ListObject | Typ obiektu, który jest zawsze "list". |
| użycie | Użycie | Informacje o użyciu żądania. |
CreateImageEmbeddingRequest
| Nazwisko | Type | Wartość domyślna | opis |
|---|---|---|---|
| wymiary | integer | 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 | liczba zmiennoprzecinkowa | Format umożliwiający zwrócenie osadzania. Base64, float, int8, uint8, binary lub ubinary. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru. |
| input | OsadzanieInput[] | Obraz wejściowy do osadzenia. Aby osadzić wiele danych wejściowych w jednym żądaniu, przekaż tablicę. Dane wejściowe nie mogą przekraczać maksymalnych tokenów wejściowych dla modelu. |
Szczegół
| Nazwisko | Pisz | Opis |
|---|---|---|
| Loc | string[] | Parametr powodujący problem |
| wartość | string | Wartość przekazana do parametru powoduje problemy. |
Osadzanie
Reprezentuje wygenerowany obraz.
| Nazwisko | Pisz | Opis |
|---|---|---|
| Osadzanie | number[] | Wektor osadzania, który jest listą zmiennoprzecinkowych. Długość wektora zależy od używanego modelu. |
| index | integer | Indeks osadzania na liście osadzonych. |
| obiekt | Osadzanie obiektuObject | Typ obiektu, który jest zawsze "osadzaniem". |
EmbeddingEncodingFormat
Format umożliwiający zwrócenie osadzania. Base64, float, int8, uint8, binary lub ubinary. Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru.
| Nazwisko | Pisz | Opis |
|---|---|---|
| base64 | string | |
| dane binarne | string | |
| liczba zmiennoprzecinkowa | string | |
| int8 | string | |
| ubinary | string | |
| uint8 | string |
Osadzanie obiektuObject
Typ obiektu, który jest zawsze "osadzaniem".
| Nazwisko | Pisz | Opis |
|---|---|---|
| Osadzanie | string |
OsadzanieInput
Reprezentuje obraz z opcjonalnym tekstem.
| Nazwisko | Pisz | Opis |
|---|---|---|
| obraz | string | Obraz wejściowy zakodowany w base64 ciągu jako adres URL danych. Przykład: data:image/{format};base64,{data}. |
| text | string | Opcjonalny. Wprowadzanie tekstu do modelu (na przykład DINO, CLIP). Zwraca błąd 422, jeśli model nie obsługuje wartości lub parametru. |
ListObject
Typ obiektu, który jest zawsze "list".
| Nazwisko | Pisz | opis |
|---|---|---|
| lista | string |
NotFoundError
| Nazwisko | Pisz | Opis |
|---|---|---|
| error | string | Opis błędu. |
| wiadomość | string | Komunikat o błędzie. |
| status | integer | Kod stanu HTTP. |
TooManyRequestsError
| Nazwisko | Pisz | Opis |
|---|---|---|
| error | string | Opis błędu. |
| wiadomość | string | Komunikat o błędzie. |
| status | integer | Kod stanu HTTP. |
Brak autoryzacji
| Nazwisko | Pisz | Opis |
|---|---|---|
| error | string | Opis błędu. |
| wiadomość | string | Komunikat o błędzie. |
| status | integer | Kod stanu HTTP. |
UnprocessableContentError
Żądanie zawiera nieprzetworzoną zawartość. Błąd jest zwracany, gdy wskazany ładunek jest prawidłowy zgodnie z tą specyfikacją. Jednak niektóre instrukcje wskazane w ładunku nie są obsługiwane przez bazowy model. Skorzystaj z details sekcji , aby zrozumieć parametr obraźliwy.
| Nazwisko | Pisz | Opis |
|---|---|---|
| code | string | Kod błędu. |
| szczegóły | Szczegół | |
| error | string | Opis błędu. |
| wiadomość | string | Komunikat o błędzie. |
| status | integer | Kod stanu HTTP. |
Użycie
Informacje o użyciu żądania.
| Nazwisko | Pisz | Opis |
|---|---|---|
| prompt_patches | integer | Liczba poprawek obrazów używanych przez monit o obraz. |
| prompt_tokens | integer | Liczba tokenów używanych przez monit. |
| total_patches | integer | Całkowita liczba poprawek używanych przez żądanie. |
| total_tokens | integer | Całkowita liczba tokenów używanych przez żądanie. |