Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
W tym artykule dokumentacji obraz, dźwięk (mowa) i operacje interfejsu API REST generowania wideo dla Azure interfejsu OpenAI w wersji zapoznawczej w wersji zapoznawczej 1. Aby uzyskać informacje na temat uzupełniania czatów, osadzania, wale, plików, dostrajania, odpowiedzi, magazynów wektorów i wszystkich innych operacji, zobacz oficjalną dokumentację interfejsu API REST platformy OpenAI Azure.
Wnioskowanie płaszczyzny danych
W pozostałej części tego artykułu omówiono operacje obrazów, audio i wideo w nowej wersji zapoznawczej interfejsu API Azure specyfikacji wnioskowania płaszczyzny danych openAI. Aby uzyskać więcej informacji, zobacz przewodnik cyklu życia interfejsu API.
Aby uzyskać pełny interfejs API płaszczyzny danych ogólnie dostępnej wersji 1, zobacz oficjalną dokumentację interfejsu API REST platformy OpenAI Azure.
Tworzenie mowy
POST {endpoint}/openai/v1/audio/speech?api-version=preview
Generuje dźwięk zamiany tekstu na mowę na podstawie tekstu wejściowego.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API Microsoft Foundry Models do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| dane wejściowe | ciąg | Tekst do wygenerowania dźwięku. Maksymalna długość to 4096 znaków. | Tak | |
| instructions | ciąg | Sterowanie głosem wygenerowanego dźwięku za pomocą dodatkowych instrukcji. Nie działa z programem tts-1 lub tts-1-hd. |
No | |
| model | ciąg | Model do użycia dla tego żądania zamiany tekstu na mowę. | Tak | |
| format_odpowiedzi | obiekt | Obsługiwane formaty danych wyjściowych audio dla zamiany tekstu na mowę. | No | |
| Prędkość | number | Szybkość mowy dla wygenerowanego dźwięku. Wartości są prawidłowe w zakresie od 0,25 do 4,0, z wartościami domyślnymi i wyższymi odpowiadającymi szybszej mowy. | No | 1 |
| stream_format | wyliczenie | Format przesyłania strumieniowego dźwięku. Obsługiwane formaty to sse i audio.
sse program nie jest obsługiwany dla tts-1 programu lub tts-1-hd.Możliwe wartości: sse, audio |
No | |
| voice | obiekt | Tak |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/octet-stream | ciąg |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureErrorResponse |
Examples
Przykład
Syntetyzuje dźwięk z dostarczonego tekstu.
POST {endpoint}/openai/v1/audio/speech?api-version=preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3",
"model": "tts-1"
}
Odpowiedzi: Kod stanu: 200
{
"body": "101010101"
}
Tworzenie transkrypcji
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
Transkrybuje dźwięk w języku wejściowym.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| chunking_strategy | obiekt | No | ||
| └─prefix_padding_ms | liczba całkowita | Ilość dźwięku do uwzględnienia przed wykryciem mowy vaD (w milisekundach). | No | 300 |
| └czas_trwania_ciszy_ms | liczba całkowita | Czas trwania ciszy wykrywania zatrzymania mowy (w milisekundach). Dzięki krótszym wartościom model będzie reagować szybciej, ale może wskoczyć na krótkie przerwy od użytkownika. | No | 200 |
| └* próg | number | Próg poufności (od 0,0 do 1,0) na potrzeby wykrywania aktywności głosowej. Wyższy próg będzie wymagać głośniejszego dźwięku do aktywowania modelu, a tym samym może działać lepiej w hałaśliwych środowiskach. | No | 0,5 |
| └typ | wyliczenie | Musi być ustawiona wartość , aby server_vad włączyć ręczne fragmentowanie przy użyciu vaD po stronie serwera.Możliwe wartości: server_vad |
No | |
| plik | ciąg | Tak | ||
| filename | ciąg | Opcjonalna nazwa pliku lub identyfikator opisowy do skojarzenia z danymi audio. | No | |
| include[] | macierz | Dodatkowe informacje do uwzględnienia w odpowiedzi transkrypcji.
logprobs Zwróci prawdopodobieństwo dziennika tokenów w odpowiedzi, aby zrozumieć zaufanie modelu do transkrypcji.
logprobs Działa tylko z response_format ustawioną na json i tylko z modelami gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribei gpt-4o-mini-transcribe-2025-12-15. |
No | |
| język | ciąg | Język wejściowego dźwięku. Podanie języka wejściowego w formacie ISO-639-1 (np. en) poprawi dokładność i opóźnienie. |
No | |
| model | ciąg | Model do użycia dla tego żądania transkrypcji. | No | |
| monit | ciąg | Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być zgodny z językiem dźwięku. | No | |
| format_odpowiedzi | obiekt | No | ||
| odtwarzać strumieniowo | boolean | W przypadku ustawienia wartości true dane odpowiedzi modelu będą przesyłane strumieniowo do klienta, ponieważ są generowane przy użyciu zdarzeń wysyłanych przez serwer. Uwaga: przesyłanie strumieniowe nie jest obsługiwane dla whisper-1 modelu i zostanie zignorowane. |
No | Nieprawda |
| temperatura | number | Temperatura próbkowania z zakresu od 0 do 1. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model użyje prawdopodobieństwa dziennika , aby automatycznie zwiększyć temperaturę do momentu trafienia określonych progów. | No | 0 |
| timestamp_granularities[] | macierz | Stopień szczegółowości sygnatury czasowej do wypełnienia dla tej transkrypcji.
response_format należy ustawić, verbose_json aby używać szczegółowości sygnatury czasowej. Obsługiwane są obie te opcje: word, lub segment. Uwaga: nie ma dodatkowego opóźnienia dla sygnatur czasowych segmentu, ale generowanie znaczników czasu wyrazów powoduje dodatkowe opóźnienie. |
No | ['segment'] |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureAudioTranscriptionResponse | |
| text/plain | ciąg |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureErrorResponse |
Examples
Przykład
Pobiera transkrypcja tekstu i skojarzonych metadanych z dostarczonych danych dźwiękowych mówionych.
POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Odpowiedzi: Kod stanu: 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Tworzenie tłumaczenia
POST {endpoint}/openai/v1/audio/translations?api-version=preview
Pobiera transkrybowany tekst w języku angielskim i skojarzone metadane z dostarczonych danych dźwiękowych mówionych.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| plik | ciąg | Tak | ||
| filename | ciąg | Opcjonalna nazwa pliku lub identyfikator opisowy do skojarzenia z danymi audio | No | |
| model | ciąg | Model do użycia dla tego żądania tłumaczenia. | No | |
| monit | ciąg | Opcjonalny tekst prowadzący do stylu modelu lub kontynuacji poprzedniego segmentu audio. Monit powinien być w języku angielskim. | No | |
| format_odpowiedzi | obiekt | No | ||
| temperatura | number | Temperatura próbkowania z zakresu od 0 do 1. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będzie bardziej skoncentrowany i deterministyczny. Jeśli ustawiono wartość 0, model użyje prawdopodobieństwa dziennika , aby automatycznie zwiększyć temperaturę do momentu trafienia określonych progów. | No | 0 |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureAudioTranslationResponse | |
| text/plain | ciąg |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureErrorResponse |
Examples
Przykład
Pobiera transkrybowany tekst w języku angielskim i skojarzone metadane z dostarczonych danych dźwiękowych mówionych.
POST {endpoint}/openai/v1/audio/translations?api-version=preview
{
"file": "<binary audio data>",
"model": "whisper-1",
"response_format": "text"
}
Odpowiedzi: Kod stanu: 200
{
"body": "plain text when requesting text, srt, or vtt"
}
Tworzenie edycji obrazu
POST {endpoint}/openai/v1/images/edits?api-version=preview
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| tło | wyliczenie | Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku gpt-image-1 modeli. Musi być jedną z transparentwartości lub opaqueauto (wartość domyślna). Gdy auto jest używany, model automatycznie określi najlepsze tło dla obrazu.Jeśli transparentformat danych wyjściowych musi obsługiwać przezroczystość, dlatego powinien być ustawiony na png wartość (wartość domyślna) lub webp.Możliwe wartości: transparent, , opaqueauto |
No | |
| obraz | ciąg lub tablica | Tak | ||
| maska | ciąg | No | ||
| model | ciąg | Wdrożenie modelu do użycia dla operacji edytowania obrazu. | Tak | |
| n | liczba całkowita | Liczba obrazów do wygenerowania. Musi należeć do zakresu od 1 do 10. | No | 1 |
| kompresja wyjściowa | liczba całkowita | Poziom kompresji (0–100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku gpt-image-1modeli serii z formatami webp lub jpeg wyjściowymi, a wartością domyślną jest 100. |
No | 100 |
| format_wyjściowy | wyliczenie | Format, w którym są zwracane wygenerowane obrazy. Ten parametr jest obsługiwany tylko w przypadku gpt-image-1modeli serii . Musi być jednym z pngelementów , jpeglub webp.Wartość domyślna to png.Możliwe wartości: png, , jpegwebp |
No | |
| monit | ciąg | Opis tekstu żądanych obrazów. Maksymalna długość to 1000 znaków dla dall-e-2modeli serii i 32000 znaków gpt-image-1. |
Tak | |
| jakość | wyliczenie | Jakość obrazu, który zostanie wygenerowany.
high
medium i low są obsługiwane tylko w przypadku gpt-image-1modeli serii ..
dall-e-2 obsługuje standard tylko jakość. Wartość domyślna to auto.Możliwe wartości: standard, , lowmedium, , highauto |
No | |
| format_odpowiedzi | wyliczenie | Format, w którym są zwracane wygenerowane obrazy. Musi być jednym z url elementów lub b64_json. Adresy URL są prawidłowe tylko przez 60 minut po wygenerowaniu obrazu. Ten parametr jest obsługiwany tylko w przypadku dall-e-2modeli serii , ponieważ gpt-image-1modele serii zawsze będą zwracać obrazy zakodowane w formacie base64.Możliwe wartości: url, b64_json |
No | |
| size | wyliczenie | Rozmiar wygenerowanych obrazów. Musi być jednym z elementów , (poziomych1024x1024), 1536x1024 (pionowych) lub 1024x1536 (wartością domyślną) dla automodeli serii - oraz jedną z gpt-image-1wartości , 256x256lub 512x512 dla 1024x1024. dall-e-2Możliwe wartości: 256x256, , 512x5121024x1024, 1536x1024, , 1024x1536auto |
No | |
| użytkownik | ciąg | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. | No |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureImagesResponse |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureErrorResponse |
Tworzenie obrazu
POST {endpoint}/openai/v1/images/generations?api-version=preview
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Treść żądania
Typ zawartości: aplikacja/json
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| tło | wyliczenie | Umożliwia ustawienie przezroczystości tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku gpt-image-1 modeli. Musi być jedną z transparentwartości lub opaqueauto (wartość domyślna). Gdy auto jest używany, model automatycznie określi najlepsze tło dla obrazu.Jeśli transparentformat danych wyjściowych musi obsługiwać przezroczystość, dlatego powinien być ustawiony na png wartość (wartość domyślna) lub webp.Możliwe wartości: transparent, , opaqueauto |
No | |
| model | ciąg | Wdrożenie modelu do użycia na potrzeby generowania obrazu. | Tak | |
| Umiarem | wyliczenie | Kontrolowanie poziomu moderowania zawartości dla obrazów generowanych przez gpt-image-1modele serii. Musi być w low przypadku mniej restrykcyjnego filtrowania lub auto (wartość domyślna).Możliwe wartości: low, auto |
No | |
| n | liczba całkowita | Liczba obrazów do wygenerowania. Musi należeć do zakresu od 1 do 10. W przypadku dall-e-3programu obsługiwane są tylko n=1 elementy . |
No | 1 |
| kompresja wyjściowa | liczba całkowita | Poziom kompresji (0–100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko w przypadku gpt-image-1modeli serii z formatami webp lub jpeg wyjściowymi, a wartością domyślną jest 100. |
No | 100 |
| format_wyjściowy | wyliczenie | Format, w którym są zwracane wygenerowane obrazy. Ten parametr jest obsługiwany tylko w przypadku gpt-image-1modeli serii . Musi być jednym z pngelementów , jpeglub webp.Możliwe wartości: png, , jpegwebp |
No | |
| monit | ciąg | Opis tekstu żądanych obrazów. Maksymalna długość to 32000 znaków dla gpt-image-1modeli serii, 1000 znaków dla dall-e-2 i 4000 znaków dla dall-e-3. |
Tak | |
| jakość | wyliczenie | Jakość obrazu, który zostanie wygenerowany. - auto (wartość domyślna) automatycznie wybierze najlepszą jakość dla danego modelu.- high
medium i low są obsługiwane w przypadku gpt-image-1modeli serii .- hd i standard są obsługiwane dla programu dall-e-3.- standard jest jedyną opcją dla elementu dall-e-2.Możliwe wartości: standard, , hdlow, medium, , highauto |
No | |
| format_odpowiedzi | wyliczenie | Format, w którym są zwracane wygenerowane obrazy dall-e-2 i dall-e-3 . Musi być jednym z url elementów lub b64_json. Adresy URL są prawidłowe tylko przez 60 minut po wygenerowaniu obrazu. Ten parametr nie jest obsługiwany w przypadku gpt-image-1modeli serii , które zawsze będą zwracać obrazy zakodowane w formacie base64.Możliwe wartości: url, b64_json |
No | |
| size | wyliczenie | Rozmiar wygenerowanych obrazów. Musi być jednym z elementów , (poziomych1024x1024), 1536x1024 (pionowych) lub 1024x1536 (wartość domyślna) dla automodeli serii -, jednej z gpt-image-1, 256x256lub 512x5121024x1024dla , i jednej z dall-e-2, 1024x1024lub 1792x1024 dla 1024x1792. dall-e-3Możliwe wartości: auto, , 1024x10241536x1024, 1024x1536256x256, , 512x512, , 1792x10241024x1792 |
No | |
| styl | wyliczenie | Styl wygenerowanych obrazów. Ten parametr jest obsługiwany tylko dla programu dall-e-3. Musi być jednym z vivid elementów lub natural. Vivid powoduje, że model opiera się na generowaniu hiper-rzeczywistych i dramatycznych obrazów. Naturalne powoduje, że model tworzy bardziej naturalne, mniej hiper realne obrazy.Możliwe wartości: vivid, natural |
No | |
| użytkownik | ciąg | Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. | No |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureImagesResponse |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureErrorResponse |
Examples
Przykład
Tworzy obrazy z monitem.
POST {endpoint}/openai/v1/images/generations?api-version=preview
{
"model": "dall-e-3",
"prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
"n": 1,
"style": "natural",
"quality": "standard"
}
Odpowiedzi: Kod stanu: 200
{
"body": {
"created": 1698342300,
"data": [
{
"revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
"prompt_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
},
"profanity": {
"detected": false,
"filtered": false
},
"custom_blocklists": {
"filtered": false,
"details": []
}
},
"url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
"content_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
}
}
}
]
}
}
Zadania generowania wideo — tworzenie
POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Tworzy nowe zadanie generowania wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Treść żądania
Typ zawartości: aplikacja/json
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| height | liczba całkowita | Wysokość filmu wideo. Obsługiwane są następujące wymiary: 480x480, 854x480, 720x720, 1280x720, 1080x1080 i 1920x1080 zarówno w orientacji poziomej, jak i pionowej. | Tak | |
| model | ciąg | Nazwa wdrożenia do użycia dla tego żądania. | Tak | |
| n_seconds | liczba całkowita | Czas trwania zadania generowania wideo. Musi należeć do zakresu od 1 do 20 sekund. | No | 5 |
| n_variants | liczba całkowita | Liczba filmów wideo do utworzenia jako wariantów dla tego zadania. Musi należeć do przedziału od 1 do 5. Mniejsze wymiary umożliwiają korzystanie z większej liczby wariantów. | No | 1 |
| monit | ciąg | Monit o zadanie generowania wideo. | Tak | |
| width | liczba całkowita | Szerokość filmu wideo. Obsługiwane są następujące wymiary: 480x480, 854x480, 720x720, 1280x720, 1080x1080 i 1920x1080 zarówno w orientacji poziomej, jak i pionowej. | Tak |
Treść żądania
Typ zawartości: dane wielu części/formularzu
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| Pliki | macierz | Tak | ||
| height | liczba całkowita | Wysokość filmu wideo. Obsługiwane są następujące wymiary: 480x480, 854x480, 720x720, 1280x720, 1080x1080 i 1920x1080 zarówno w orientacji poziomej, jak i pionowej. | Tak | |
| inpaint_items | macierz | Opcjonalne elementy inpainting dla tego zadania generowania wideo. | No | |
| model | ciąg | Nazwa wdrożenia do użycia dla tego żądania. | Tak | |
| n_seconds | liczba całkowita | Czas trwania zadania generowania wideo. Musi należeć do zakresu od 1 do 20 sekund. | No | 5 |
| n_variants | liczba całkowita | Liczba filmów wideo do utworzenia jako wariantów dla tego zadania. Musi należeć do przedziału od 1 do 5. Mniejsze wymiary umożliwiają korzystanie z większej liczby wariantów. | No | 1 |
| monit | ciąg | Monit o zadanie generowania wideo. | Tak | |
| width | liczba całkowita | Szerokość filmu wideo. Obsługiwane są następujące wymiary: 480x480, 854x480, 720x720, 1280x720, 1080x1080 i 1920x1080 zarówno w orientacji poziomej, jak i pionowej. | Tak |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | VideoGenerationJob |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Examples
Nie można odnaleźć przykładowego pliku: ./examples/create_video_generation_job_simple.json
Zadania generowania wideo — lista
GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview
Wyświetla listę zadań generowania wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| przed | kwerenda | No | ciąg | |
| Po | kwerenda | No | ciąg | |
| limit | kwerenda | Tak | liczba całkowita | |
| statuses | kwerenda | No | macierz |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | VideoGenerationJobList |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Examples
Nie można odnaleźć przykładowego pliku: ./examples/get_video_generation_job_list.json
Zadania generowania wideo — pobieranie
GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Pobiera właściwości zadania generowania wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| job-id | ścieżka | Tak | ciąg | Identyfikator zadania generowania wideo do użycia dla żądania Azure OpenAI. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | VideoGenerationJob |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Examples
Nie można odnaleźć przykładowego pliku: ./examples/get_video_generation_job.json
Zadania generowania wideo — usuwanie
DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
Usuwa zadanie generowania wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| job-id | ścieżka | Tak | ciąg | Identyfikator zadania generowania wideo do użycia dla żądania Azure OpenAI. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 204
Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Generacje wideo — pobierz
GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview
Pobiera generowanie wideo według identyfikatora.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| generation-id | ścieżka | Tak | ciąg | Identyfikator generowania wideo do użycia dla żądania Azure OpenAI. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | VideoGeneration |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Examples
Nie można odnaleźć przykładowego pliku: ./examples/get_video_generation.json
Generacje wideo — pobieranie miniatury
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview
Pobiera miniaturę wygenerowanej zawartości wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| generation-id | ścieżka | Tak | ciąg | Identyfikator generowania wideo do użycia dla żądania Azure OpenAI. |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| image/jpg | ciąg |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Generacje wideo — pobieranie zawartości wideo
GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Pobiera wygenerowaną zawartość wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| generation-id | ścieżka | Tak | ciąg | Identyfikator generowania wideo do użycia dla żądania Azure OpenAI. |
| jakość | kwerenda | No |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
| Typ zawartości | Typ | Opis |
|---|---|---|
| wideo/mp4 | ciąg |
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Generacje wideo — pobieranie tylko nagłówków wideocontent
HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview
Pobiera nagłówki wygenerowanej zawartości wideo.
Parametry identyfikatora URI
| Name | W | Obowiązkowy | Typ | Opis |
|---|---|---|---|---|
| punkt końcowy | ścieżka | Tak | ciąg Adres url |
Obsługiwane punkty końcowe Azure OpenAI (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą zasobu openAI Azure). https://{nazwa_zasobu}.openai.azure.com |
| wersja API | kwerenda | No | Jawna wersja interfejsu API modeli foundry do użycia dla tego żądania.v1 jeśli nie określono inaczej. |
|
| generation-id | ścieżka | Tak | ciąg | Identyfikator generowania wideo do użycia dla żądania Azure OpenAI. |
| jakość | kwerenda | No |
Nagłówek żądania
Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.
| Name | Obowiązkowy | Typ | Opis |
|---|---|---|---|
| Autoryzacja | True | ciąg |
Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token}Aby wygenerować token uwierzytelniania przy użyciu Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeZakres: https://ai.azure.com/.default |
| klucz API | True | ciąg | Tutaj podaj klucz interfejsu API openAI Azure |
Responses
Kod stanu: 200
Opis: Żądanie zakończyło się pomyślnie.
Kod stanu: wartość domyślna
Opis: Nieoczekiwana odpowiedź na błąd.
| Typ zawartości | Typ | Opis |
|---|---|---|
| application/json | AzureOpenAIVideoGenerationErrorResponse |
Components
Aby zapoznać się z definicjami schematu używanymi przez czat, uzupełnienia, osadzanie, odpowiedzi i inne operacje tekstowe, zobacz dokumentację interfejsu API REST platformy Azure OpenAI. Poniższe schematy obsługują operacje obrazów, audio i wideo na tej stronie.
AzureAudioTranscriptionResponse
Informacje o wyniku operacji, która transkrybował dźwięk mówiony do tekstu pisanego.
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| duration | number | Łączny czas trwania dźwięku przetworzonego w celu utworzenia towarzyszących informacji transkrypcji. | No | |
| język | ciąg | Język mówiony, który został wykryty w transkrypcji danych audio. Jest to wyrażone jako dwuliterowy kod języka ISO-639-1, taki jak "en" lub "fr". |
No | |
| segments | macierz | Kolekcja informacji o chronometrażu, prawdopodobieństw i innych szczegółach każdego przetworzonego segmentu audio. | No | |
| zadanie | obiekt | Definiuje możliwe deskryptory dla dostępnych odpowiedzi operacji audio. | No | |
| SMS | ciąg | Transkrypcja tekstu dla podanych danych dźwiękowych. | Tak | |
| Słowy | macierz | Kolekcja informacji o chronometrażu każdego przetworzonego słowa. | No |
AzureAudioTranslationResponse
Informacje o wyniku operacji, która przetłumaczyła dźwięk mówiony na tekst pisany.
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| duration | number | Łączny czas trwania przetworzonego dźwięku w celu utworzenia towarzyszących informacji o tłumaczeniu. | No | |
| język | ciąg | Język mówiony, który został wykryty w przetłumaczonych danych audio. Jest to wyrażone jako dwuliterowy kod języka ISO-639-1, taki jak "en" lub "fr". |
No | |
| segments | macierz | Kolekcja informacji o chronometrażu, prawdopodobieństw i innych szczegółach każdego przetworzonego segmentu audio. | No | |
| zadanie | obiekt | Definiuje możliwe deskryptory dla dostępnych odpowiedzi operacji audio. | No | |
| SMS | ciąg | Przetłumaczony tekst dla podanych danych dźwiękowych. | Tak |
AzureErrorResponse
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| błąd | obiekt | Szczegóły błędu. | No | |
| └─ kod | ciąg | Unikatowy identyfikator wygenerowany przez maszynę dla błędu. | No | |
| └inner_error | No | |||
| └─ Komunikat | ciąg | Czytelny dla człowieka komunikat skojarzony z błędem. | No | |
| └* param | ciąg | Jeśli ma to zastosowanie, parametr wejściowy żądania skojarzony z błędem | No | |
| └typ | wyliczenie | Typ obiektu, zawsze "błąd". Możliwe wartości: error |
No |
AzureImagesResponse
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| tło | wyliczenie | Tylko GPT-image-1: parametr tła używany do generowania obrazu. Albo transparent lub opaque.Możliwe wartości: transparent, opaque |
No | |
| utworzone | liczba całkowita | Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia obrazu. | Tak | |
| dane | macierz | No | ||
| format_wyjściowy | wyliczenie | Format wyjściowy generowania obrazu. Albo png, webplub jpeg.Możliwe wartości: png, , webpjpeg |
No | |
| jakość | wyliczenie | Jakość wygenerowanego obrazu. Albo low, mediumlub high.Możliwe wartości: low, , mediumhigh |
No | |
| size | wyliczenie | Rozmiar wygenerowanego obrazu. Albo 1024x1024, 1024x1536lub 1536x1024.Możliwe wartości: 1024x1024, , 1024x15361536x1024 |
No | |
| użycie | obiekt | Tylko w przypadku gpt-image-1modeli serii informacje o użyciu tokenu dla generowania obrazu. |
No | |
| └input_tokens | liczba całkowita | Liczba tokenów (obrazów i tekstu) w wierszu polecenia wejściowego. | No | |
| └input_tokens_details | obiekt | Tokeny wejściowe zawierają szczegółowe informacje dotyczące generowania obrazu. | No | |
| └image_tokens | liczba całkowita | Liczba tokenów obrazu w wierszu polecenia wejściowego. | No | |
| └ text_tokens | liczba całkowita | Liczba tokenów tekstowych w wierszu polecenia wejściowego. | No | |
| └─ tokeny_wyjściowe | liczba całkowita | Liczba tokenów obrazu na obrazie wyjściowym. | No | |
| └total_tokens | liczba całkowita | Całkowita liczba tokenów (obrazów i tekstu) używanych do generowania obrazu. | No |
AzureOpenAIVideoGenerationErrorResponse
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| kod | ciąg | Unikatowy identyfikator wygenerowany przez maszynę dla błędu. | No | |
| inner_error | obiekt | Jeśli ma to zastosowanie, błąd nadrzędny, który pochodzi z tego błędu. | No | |
| └─ kod | wyliczenie | Kod skojarzony z błędem wewnętrznym. Możliwe wartości: ResponsibleAIPolicyViolation |
No | |
| └─ szczegóły_błędu | Szczegóły wyniku filtru zawartości skojarzone z błędem wewnętrznym. | No | ||
| └revised_prompt | ciąg | Jeśli ma to zastosowanie, zmodyfikowany monit używany do generowania. | No | |
| komunikat | ciąg | Czytelny dla człowieka komunikat skojarzony z błędem. | No | |
| param | ciąg | Jeśli ma to zastosowanie, parametr wejściowy żądania skojarzony z błędem | No | |
| typ | ciąg | Jeśli ma to zastosowanie, numer wiersza wejściowego skojarzony z błędem. | No |
VideoGeneration
Wynik generowania wideo.
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Godzina utworzenia generowania wideo. | Tak | |
| height | liczba całkowita | Wysokość filmu wideo. | Tak | |
| id | ciąg | Identyfikator generowania wideo. | Tak | |
| job_id | ciąg | Identyfikator zadania generowania wideo dla tego wideo. | Tak | |
| n_seconds | liczba całkowita | Czas trwania generowania wideo. | Tak | |
| obiekt | wyliczenie | Możliwe wartości: video.generation |
Tak | |
| monit | ciąg | Monit o wygenerowanie tego wideo. | Tak | |
| width | liczba całkowita | Szerokość filmu wideo. | Tak |
VideoGenerationJob
Zadanie generowania wideo.
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| utworzono_o | liczba całkowita | Godzina utworzenia zadania. | Tak | |
| wygasa_o | liczba całkowita | Godzina automatycznego usunięcia zadania z usługi. Zawartość wideo i metadane zadania powinny być przechowywane przed tą datą, aby uniknąć utraty danych. | No | |
| failure_reason | ciąg (zobacz prawidłowe modele poniżej) | No | ||
| zakończono_o | liczba całkowita | Czas zakończenia zadania ze wszystkimi generacjami wideo. | No | |
| Pokoleń | macierz | Wygenerowane filmy wideo dla tego zadania. Liczba zależy od danej n_variants i sukcesu tworzenia pokoleń. | No | |
| height | liczba całkowita | Wysokość filmu wideo. | Tak | |
| id | ciąg | Identyfikator zadania. | Tak | |
| inpaint_items | macierz | Opcjonalne elementy inpainting dla tego zadania generowania wideo. | No | |
| model | ciąg | Nazwa wdrożenia do użycia dla tego zadania generowania wideo. | Tak | |
| n_seconds | liczba całkowita | Czas trwania zadania generowania wideo. | Tak | |
| n_variants | liczba całkowita | Liczba filmów wideo do utworzenia jako wariantów dla tego zadania generowania wideo. | Tak | |
| obiekt | wyliczenie | Możliwe wartości: video.generation.job |
Tak | |
| monit | ciąg | Monit o zadanie generowania wideo. | Tak | |
| stan | obiekt | Stan zadania generowania wideo. | Tak | |
| width | liczba całkowita | Wysokość filmu wideo. | Tak |
VideoGenerationJobList
Lista zadań generowania wideo.
| Name | Typ | Opis | Obowiązkowy | Wartość domyślna |
|---|---|---|---|---|
| dane | macierz | Lista zadań generowania wideo. | Tak | |
| first_id | ciąg | Identyfikator pierwszego zadania na bieżącej stronie, jeśli jest dostępny. | No | |
| zawiera_więcej | boolean | Flaga wskazująca, czy po liście jest dostępnych więcej zadań. | Tak | |
| last_id | ciąg | Identyfikator ostatniego zadania na bieżącej stronie, jeśli jest dostępny. | No | |
| obiekt | wyliczenie | Możliwe wartości: list |
Tak |
Następne kroki
Dowiedz się więcej o modelach i dostrajaniu za pomocą interfejsu API REST. Dowiedz się więcej na temat modeli underlying, które zasilają Azure OpenAI.