Dokumentacja interfejsu API REST usługi Azure OpenAI w usłudze Microsoft Foundry Models

Ten artykuł zawiera szczegóły dotyczące endpointów REST API inferencyjnego dla Azure OpenAI.

Specyfikacje interfejsu API

Zarządzanie i interakcja z modelami i zasobami Azure OpenAI podzielone są na trzy główne powierzchnie API:

Płaszczyzna sterowania
Płaszczyzna danych – autorowanie
Płaszczyzna danych – wnioskowanie

Każda powierzchnia/specyfikacja API zawiera inny zestaw możliwości Azure OpenAI. Każde API ma własny, unikalny zestaw wersji podglądowych oraz stabilnych/ogólnie dostępnych (GA) wersji API. Obecnie premierowe premiery mają tendencję do miesięcznego rytmu.

Ważna

Obecnie pojawiło się nowe API do podglądu wnioskowania. Dowiedz się więcej w naszym przewodniku po cyklu życia API.

API	Najnowsza wersja zapowiedziowa	Najnowsza wersja GA	Specifications	Opis
Płaszczyzna sterowania	`2025-07-01-preview`	`2025-06-01`	Pliki specyfikacji	API płaszczyzny sterowania jest wykorzystywane do operacji takich jak tworzenie zasobów, wdrażanie modeli oraz inne zadania zarządzania zasobami na wyższym poziomie. Płaszczyzna sterowania reguluje również możliwości takie jak Azure Resource Manager, Bicep, Terraform i Azure CLI.
Płaszczyzna danych	`v1 preview`	`v1`	Pliki specyfikacji	API płaszczyzny danych kontroluje operacje wnioskowania i autorstwa.

Authentication

Azure OpenAI oferuje dwie metody uwierzytelniania. Możesz użyć kluczy API lub Microsoft Entra ID.

Uwierzytelnianie klucza API: W przypadku tego typu uwierzytelniania wszystkie żądania API muszą zawierać klucz API w nagłówku api-key HTTP. Quickstart zawiera wskazówki, jak wykonywać połączenia z tego typu uwierzytelnianiem.
Microsoft Entra ID uwierzytelnianie: Możesz uwierzytelnić wywołanie API za pomocą tokena Microsoft Entra. Tokeny uwierzytelniające są zawarte w żądaniu jako nagłówek Authorization . Dostarczony token musi być poprzedzony Bearerprzez , na przykład Bearer YOUR_AUTH_TOKEN. Możesz przeczytać nasz przewodnik instrukcyjny dotyczący uwierzytelniania za pomocą Microsoft Entra ID.

Wersjonowanie REST API

API usług są wersjonowane za pomocą parametru api-version zapytania. Wszystkie wersje mają strukturę dat YYYY-MM-DD. Przykład:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Wnioskowanie na płaszczyźnie danych

Reszta artykułu dotyczy wydania GA specyfikacji wnioskowania płaszczyzny danych Azure OpenAI, 2024-10-21.

Jeśli szukasz dokumentacji najnowszej wersji zapoznawczej interfejsu API, zapoznaj się z najnowszym interfejsem API wnioskowania płaszczyzny danych w wersji zapoznawczej.

Uzupełnienia

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

Tworzy uzupełnienie dla podanego promptu, parametrów i wybranego modelu.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres url	Obsługiwane Azure endpointów OpenAI (protokół i nazwa hosta, na przykład: `https://aoairesource.openai.azure.com`. Zastąp "aoairesource" nazwą swojego zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg	ID wdrożenia modelu, który został wdrożony.
wersja API	kwerenda	Tak	ciąg	wersja API

Nagłówek żądania

Name	Obowiązkowy	Typ	Opis
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
monit	ciąg lub tablica	Prompt(y) do generowania uzupełnień kodowane jako ciąg znaków, tablica łańcuchów, tablica tokenów lub tablica tokenów. Należy zauważyć, że <\|endoftext\|> to separator dokumentów, który model widzi podczas treningu, więc jeśli prompt nie jest określony, model wygeneruje się tak, jakby od początku nowego dokumentu.	Tak
najlepsze z	liczba całkowita	Generuje `best_of` ukończenia po stronie serwera i zwraca "najlepsze" (to o najwyższym prawdopodobieństwie logu na token). Wyników nie można transmitować w streamingu. Gdy używamy z , `nbest_of`kontroluje liczbę kandydatów na uzupełnienia i określa, `n` ile z nich należy zwrócić – " `best_of` musi być większe niż `n`. Uwaga: Ponieważ ten parametr generuje wiele ukończeń, może szybko pochłonąć Twój limit tokenów. Używaj ostrożnie i upewnij się, że masz rozsądne ustawienia dla `max_tokens` i `stop`.	No	1
echo	boolean	Powtórz prompt oprócz zakończenia	No	Nieprawda
frequency_penalty	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny na podstawie ich dotychczasowej częstotliwości w tekście, zmniejszając prawdopodobieństwo powtórzenia tej samej linii dosłownie.	No	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo pojawienia się określonych żetonów w finale. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokena w tokenizatorze GPT) na powiązaną wartość bias od -100 do 100. Matematycznie uprzedzenie jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnił w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszać lub zwiększać prawdopodobieństwo selekcji; wartości takie jak -100 czy 100 powinny skutkować banem lub wyłącznym wyborem odpowiedniego tokena. Na przykład możesz przepuścić `{"50256": -100}` , aby zapobiec generowaniu tokena <\|endoftext\|> .	No	Żadne
logprobs	liczba całkowita	Uwzględnij prawdopodobieństwa logiczne dla najbardziej `logprobs` prawdopodobnych tokenów wyjściowych, a także wybranych tokenów. Na przykład, jeśli `logprobs` wynosi 5, API zwróci listę pięciu najbardziej prawdopodobnych tokenów. API zawsze zwraca the `logprob` z próbkowanego tokena, więc w odpowiedzi może być więcej `logprobs+1` elementów. Maksymalna wartość dla `logprobs` to 5.	No	Żadne
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować podczas zakończenia. Liczba tokenów w twoim promptie plus `max_tokens` nie może przekroczyć długości kontekstu modelu.	No	16
n	liczba całkowita	Ile ukończeń wygenerować dla każdego promptu. Uwaga: Ponieważ ten parametr generuje wiele ukończeń, może szybko pochłonąć Twój limit tokenów. Używaj ostrożnie i upewnij się, że masz rozsądne ustawienia dla `max_tokens` i `stop`.	No	1
kara za obecność	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny w zależności od tego, czy pojawiają się w tekście, zwiększając prawdopodobieństwo modelu do poruszania nowych tematów.	No	0
seed	liczba całkowita	Jeśli zostanie to określone, nasz system dołoży wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi `seed` parametrami i parametry zwracały ten sam wynik. Determinizm nie jest gwarantowany i powinieneś odwołać się do parametru `system_fingerprint` odpowiedzi, aby monitorować zmiany w backendzie.	No
stop	ciąg lub tablica	Do czterech sekwencji, w których API przestaje generować kolejne tokeny. Zwrócony tekst nie zawiera sekwencji stop.	No
odtwarzać strumieniowo	boolean	Czy odtworzyć częściowy postęp. Jeśli są ustawione, tokeny będą wysyłane jako zdarzenia wysyłane wyłącznie przez serwer danych, gdy tylko staną się dostępne, a strumień kończy się wiadomością `data: [DONE]` .	No	Nieprawda
Sufiks	ciąg	Przyrostek pojawiający się po uzupełnieniu wstawionego tekstu. Ten parametr jest obsługiwany tylko dla `gpt-3.5-turbo-instruct`.	No	Żadne
temperatura	number	Jakiej temperatury próbkowania użyć, między 0 a 2. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Zazwyczaj zalecamy modyfikację tego lub `top_p` nie obu tych rzeczy.	No	1
top_p	number	Alternatywą dla próbkowania za pomocą temperatury, zwaną próbkowaniem jądrowym, gdzie model uwzględnia wyniki tokenów o top_p masie prawdopodobieństwa. Zatem 0,1 oznacza, że rozważane są tylko tokeny tworzące 10 najwyższych% masy prawdopodobieństwa. Zazwyczaj zalecamy modyfikację tego lub `temperature` nie obu tych rzeczy.	No	1
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	createCompletionResponse	Reprezentuje odpowiedź na zakończenie z API. Uwaga: zarówno obiekty odpowiedzi przesyłane, jak i niestrumieniowane mają ten sam kształt (w przeciwieństwie do endpointu czatu).

Kod statusu: domyślny

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
application/json	errorResponse

Examples

Przykład

Tworzy uzupełnienie dla podanego promptu, parametrów i wybranego modelu.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Osadzanie

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

Uzyskaj reprezentację wektorową danego wejścia, którą łatwo wykorzystają modele i algorytmy uczenia maszynowego.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres url	Obsługiwane Azure endpointów OpenAI (protokół i nazwa hosta, na przykład: `https://aoairesource.openai.azure.com`. Zastąp "aoairesource" nazwą swojego zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg
wersja API	kwerenda	Tak	ciąg	wersja API

Nagłówek żądania

Name	Obowiązkowy	Typ	Opis
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy
dane wejściowe	ciąg lub tablica	Wprowadzanie tekstu do osadzenia, kodowane jako ciąg lub tablica tokenów. Aby osadzić wiele wejść w jednym żądaniu, należy przekazać tablicę łańcuchów lub tablicę tablic tokenów. Dane wejściowe nie mogą przekraczać maksymalnej liczby tokenów wejściowych dla modelu (8 192 tokenów dla `text-embedding-ada-002`), nie może być pustym ciągiem tekstowym, a każda tablica musi mieć co najmniej 2 048 wymiarów. Oprócz limitu tokenu dla danych wejściowych wszystkie modele osadzania wymuszają maksymalnie 300 000 tokenów sumowanych we wszystkich danych wejściowych w jednym żądaniu.	Tak
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który może pomóc w monitorowaniu i wykrywaniu nadużyć.	No
typ_wprowadzenia	ciąg	Typ wyszukiwania osadzonego wejściowego do wykorzystania	No
encoding_format	ciąg	Format, w którym zwraca się osadzenia. Może być albo albo `floatbase64`. Domyślnie przyjmuje .`float`	No
wymiary	liczba całkowita	Liczba wymiarów, jakie powinny mieć powstałe osadzenia wyjściowe. Obsługiwane tylko w `text-embedding-3` modelach i późniejszych.	No

Responses

Name	Typ	Obowiązkowy
obiekt	ciąg	Tak
model	ciąg	Tak
dane	macierz	Tak
użycie	obiekt	Tak

Właściwości do zastosowania

prompt_tokens

Name	Typ	Opis	Wartość domyślna
prompt_tokens	liczba całkowita

total_tokens

Name	Typ	Opis	Wartość domyślna
total_tokens	liczba całkowita

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	obiekt

Examples

Przykład

Zwróć osadzenia dla danego promptu.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Ukończenie czatu

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

Tworzy zakończenie wiadomości czatu

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres url	Obsługiwane Azure endpointów OpenAI (protokół i nazwa hosta, na przykład: `https://aoairesource.openai.azure.com`. Zastąp "aoairesource" nazwą swojego zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg	ID wdrożenia modelu, który został wdrożony.
wersja API	kwerenda	Tak	ciąg	wersja API

Nagłówek żądania

Name	Obowiązkowy	Typ	Opis
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
temperatura	number	Jakiej temperatury próbkowania użyć, między 0 a 2. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Zazwyczaj zalecamy modyfikację tego lub `top_p` nie obu tych rzeczy.	No	1
top_p	number	Alternatywą dla próbkowania za pomocą temperatury, zwaną próbkowaniem jądrowym, gdzie model uwzględnia wyniki tokenów o top_p masie prawdopodobieństwa. Zatem 0,1 oznacza, że rozważane są tylko tokeny tworzące 10 najwyższych% masy prawdopodobieństwa. Zazwyczaj zalecamy modyfikację tego lub `temperature` nie obu tych rzeczy.	No	1
odtwarzać strumieniowo	boolean	Jeśli jest ustawiony, zostaną wysłane częściowe delta wiadomości, jak w ChatGPT. Tokeny będą wysyłane jako zdarzenia wysyłane wyłącznie przez serwer z danymi, gdy tylko staną się dostępne, a strumień kończy się wiadomością `data: [DONE]` .	No	Nieprawda
stop	ciąg lub tablica	Do czterech sekwencji, w których API przestaje generować kolejne tokeny.	No
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować podczas zakończenia czatu. Całkowita długość tokenów wejściowych i wygenerowanych jest ograniczona przez długość kontekstu modelu.	No
max_completion_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla zakończenia, w tym widocznych tokenów wyjściowych i tokenów rozumowania.	No
kara za obecność	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny w zależności od tego, czy pojawiają się w tekście, zwiększając prawdopodobieństwo modelu do poruszania nowych tematów.	No	0
frequency_penalty	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny na podstawie ich dotychczasowej częstotliwości w tekście, zmniejszając prawdopodobieństwo powtórzenia tej samej linii dosłownie.	No	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo pojawienia się określonych żetonów w finale. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokena w tokenizerze) na przypisaną wartość bias od -100 do 100. Matematycznie uprzedzenie jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnił w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszać lub zwiększać prawdopodobieństwo selekcji; wartości takie jak -100 czy 100 powinny skutkować banem lub wyłącznym wyborem odpowiedniego tokena.	No	Żadne
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No
messages	macierz	Lista wiadomości składających się na dotychczasową rozmowę.	Tak
data_sources	macierz	Wpisy konfiguracyjne dla rozszerzeń czatu Azure OpenAI, które je używają. Ta dodatkowa specyfikacja jest kompatybilna tylko z Azure OpenAI.	No
logprobs	boolean	Czy zwracać logarytmiczne prawdopodobieństwa tokenów wyjściowych, czy nie. Jeśli jest prawdziwa, zwraca logarytmiczne prawdopodobieństwa każdego tokena wyjściowego zwróconego w .`contentmessage`	No	Nieprawda
top_logprobs	liczba całkowita	Liczba całkowita od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokena, z przypisanym logarytmem prawdopodobieństwa. `logprobs` musi być ustawione na , `true` jeśli ten parametr jest używany.	No
n	liczba całkowita	Ile opcji uzupełniania czatu wygenerować dla każdej wiadomości wejściowej. Pamiętaj, że opłata będzie zależała od liczby wygenerowanych żetonów we wszystkich opcjach. Dbaj `n` o `1` minimalizację kosztów.	No	1
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas użycia narzędzia.	No	True
format_odpowiedzi	ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema	Obiekt określający format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4o mini, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo nowszymi od `gpt-3.5-turbo-1106`. Ustawienie na `{ "type": "json_schema", "json_schema": {...} }` Structured Outputs, które gwarantują, że model będzie odpowiadał Twojemu dostarczonemu schematowi JSON. Ustawienie trybu `{ "type": "json_object" }` JSON, który gwarantuje, że generowany przez model komunikat jest poprawny w JSON. Ważne: podczas korzystania z trybu JSON musisz również polecić modelowi samodzielne wygenerowanie JSON za pomocą komunikatu systemowego lub użytkownika. Bez tego model może generować niekończący się strumień białych przestrzeni, aż generowanie osiągnie limit tokenów, co skutkuje długotrwałym i pozornie "zablokowanym" żądaniem. Należy też zauważyć, że treść wiadomości może być częściowo odcięta, jeśli `finish_reason="length"`, co oznacza, że generowanie przekroczyło `max_tokens` lub rozmowa przekroczyła maksymalną długość kontekstu.	No
seed	liczba całkowita	Ta funkcja jest w fazie beta. Jeśli zostanie to określone, nasz system dołoży wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi `seed` parametrami i parametry zwracały ten sam wynik. Determinizm nie jest gwarantowany i powinieneś odwołać się do parametru `system_fingerprint` odpowiedzi, aby monitorować zmiany w backendzie.	No
Narzędzia	macierz	Lista narzędzi, które model może wywołać. Obecnie obsługiwane są tylko funkcje jako narzędzie. Użyj tego, aby uzyskać listę funkcji, dla których model może generować wejścia JSON. Obsługiwanych jest maksymalnie 128 funkcji.	No
tool_choice	chatCompletionToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. `none` Oznacza to, że model nie wywołuje żadnego narzędzia, lecz generuje komunikat. `auto` oznacza to, że model może wybrać między generowaniem wiadomości a wywołaniem jednego lub więcej narzędzi. `required` oznacza, że model musi wywołać jedno lub więcej narzędzi. Określenie konkretnego narzędzia via `{"type": "function", "function": {"name": "my_function"}}` wymusza wywołanie tego narzędzia przez model. `none` jest domyślne, gdy nie ma narzędzi. `auto` jest domyślne, jeśli narzędzia są obecne.	No
function_call	string lub chatCompletionFunctionCallOption	Wycofane na rzecz `tool_choice`. Kontroluje, która (jeśli w ogóle) funkcja jest wywoływana przez model. `none` oznacza to, że model nie wywołuje funkcji, lecz generuje wiadomość. `auto` oznacza to, że model może wybrać między generowaniem wiadomości a wywołaniem funkcji. Określenie konkretnej funkcji przez `{"name": "my_function"}` wymusza wywołanie tej funkcji przez model. `none` jest domyślnym, gdy nie ma żadnych funkcji. `auto` jest domyślnym, jeśli funkcje są obecne.	No
functions	macierz	Wycofane na rzecz `tools`. Lista funkcji, dla których model może generować wejścia JSON.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	createChatCompletionResponse lub createChatCompletionStreamResponse

Kod statusu: domyślny

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
application/json	errorResponse

Examples

Przykład

Tworzy uzupełnienie dla podanego promptu, parametrów i wybranego modelu.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Przykład

Tworzy kompletację na podstawie danych Azure Search oraz przypisanej przez system tożsamości zarządzanej.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Przykład

Tworzy uzupełnienie na podstawie danych wektorowych Azure Search, poprzedniej wiadomości asystenta oraz przypisanej przez użytkownika tożsamości zarządzanej.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Przykład

Tworzy kompletację dla dostarczonej bazy Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transkrypcje - Stwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Transkrybuje dźwięk do języka wejściowego.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres url	Obsługiwane Azure endpointów OpenAI (protokół i nazwa hosta, na przykład: `https://aoairesource.openai.azure.com`. Zastąp "aoairesource" nazwą swojego zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg	ID wdrożenia modelu mowy na tekst. Informacje o obsługiwanych modelach można znaleźć pod [/azure/ai-foundry/openai/concepts/models#audio-models].
wersja API	kwerenda	Tak	ciąg	wersja API

Nagłówek żądania

Name	Obowiązkowy	Typ	Opis
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Treść żądania

Typ zawartości: dane wielu części/formularzu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
plik	ciąg	Plik audio wymaga transkrypcji.	Tak
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Prompt powinien odpowiadać językowi dźwięku.	No
format_odpowiedzi	audioResponseFormat	Definiuje format wyjścia.	No
temperatura	number	Temperatura próbkowania, między 0 a 1. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Jeśli ustawimy na 0, model będzie używał logarytmicznego prawdopodobieństwa do automatycznego podnoszenia temperatury aż do osiągnięcia określonych progów.	No	0
język	ciąg	Język wejściowego dźwięku. Dostarczenie języka wejściowego w formacie ISO-639-1 poprawi dokładność i opóźnienia.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	audioResponse lub audioVerboseResponse
text/plain	ciąg	Transkrybowany tekst w formacie wyjściowym (gdy response_format był tekstowy, VTT lub SRT).

Examples

Przykład

Pobiera przepisany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Przykład

Pobiera przepisany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpowiedzi: Kod statusu: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Tłumaczenia - Stwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Transkrybuje i tłumaczy wejście audio na tekst angielski.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres url	Obsługiwane Azure endpointów OpenAI (protokół i nazwa hosta, na przykład: `https://aoairesource.openai.azure.com`. Zastąp "aoairesource" nazwą swojego zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg	ID wdrożenia modelu whisper, który został wdrożony. Informacje o obsługiwanych modelach można znaleźć pod [/azure/ai-foundry/openai/concepts/models#audio-models].
wersja API	kwerenda	Tak	ciąg	wersja API

Nagłówek żądania

Name	Obowiązkowy	Typ	Opis
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Treść żądania

Typ zawartości: dane wielu części/formularzu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
plik	ciąg	Plik audio do tłumaczenia.	Tak
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Zadanie powinno być po angielsku.	No
format_odpowiedzi	audioResponseFormat	Definiuje format wyjścia.	No
temperatura	number	Temperatura próbkowania, między 0 a 1. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Jeśli ustawimy na 0, model będzie używał logarytmicznego prawdopodobieństwa do automatycznego podnoszenia temperatury aż do osiągnięcia określonych progów.	No	0

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	audioResponse lub audioVerboseResponse
text/plain	ciąg	Transkrybowany tekst w formacie wyjściowym (gdy response_format był tekstowy, VTT lub SRT).

Examples

Przykład

Otrzymuje transkrybowany tekst w języku angielskim oraz powiązane metadane z udostępnionych danych audio mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Przykład

Otrzymuje transkrybowany tekst w języku angielskim oraz powiązane metadane z udostępnionych danych audio mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpowiedzi: Kod statusu: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Generowanie obrazu

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Generuje partię obrazów z podpisu tekstowego przy danym wdrożeniu modelu dall-e

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres url	Obsługiwane Azure endpointów OpenAI (protokół i nazwa hosta, na przykład: `https://aoairesource.openai.azure.com`. Zastąp "aoairesource" nazwą swojego zasobu Azure OpenAI). https://{nazwa_zasobu}.openai.azure.com
identyfikator wdrożenia	ścieżka	Tak	ciąg	ID wdrożenia modelu dall-e, który został wdrożony.
wersja API	kwerenda	Tak	ciąg	wersja API

Nagłówek żądania

Name	Obowiązkowy	Typ	Opis
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
monit	ciąg	Tekstowy opis pożądanego obrazu(ów). Maksymalna długość to 4 000 znaków.	Tak
n	liczba całkowita	Liczba obrazów do wygenerowania.	No	1
size	imageSize	Rozmiar wygenerowanych obrazów.	No	1024x1024
format_odpowiedzi	imagesResponseFormat	Format, w którym zwracane są wygenerowane obrazy.	No	Adres url
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No
jakość	imageQuality	Jakość wygenerowanego obrazu.	No	standard
styl	imageStyle	Styl generowanych obrazów.	No	żywy

Responses

Kod statusu: 200

Opis: Ok

Typ zawartości	Typ	Opis
application/json	generateImagesResponse

Kod statusu: domyślny

Opis: Wystąpił błąd.

Typ zawartości	Typ	Opis
application/json	dalleErrorResponse

Examples

Przykład

Tworzy obrazy na podstawie promptu.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Odpowiedzi: Kod statusu: 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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Components

errorResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
błąd	error		No

errorBase

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	ciąg		No
komunikat	ciąg		No

błąd

Name	Typ	Opis	Obowiązkowy
param	ciąg		No
typ	ciąg		No
inner_error	innerError	Błąd wewnętrzny z dodatkowymi szczegółami.	No

innerError

Błąd wewnętrzny z dodatkowymi szczegółami.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	innerErrorCode	Kody błędów dla wewnętrznego obiektu błędu.	No
content_filter_results	contentFilterPromptResults	Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o treściach jailbreakowych i przekleństwach, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.	No

innerErrorCode

Kody błędów dla wewnętrznego obiektu błędu.

Opis: Kody błędów dla wewnętrznego obiektu błędu.

Typ: ciąg

Domyślnie:

Nazwa enum: InnerErrorCode

Wartości enuma

Wartość	Opis
Naruszenie Polityki Odpowiedzialnego SI	Prompt naruszył jedną z zasad filtrowania treści.

dalleErrorResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
błąd	dalleError		No

dalleError

Name	Typ	Opis	Obowiązkowy
param	ciąg		No
typ	ciąg		No
inner_error	dalleInnerError	Błąd wewnętrzny z dodatkowymi szczegółami.	No

dalleInnerError

Błąd wewnętrzny z dodatkowymi szczegółami.

Name	Typ	Opis	Obowiązkowy
kod	innerErrorCode	Kody błędów dla wewnętrznego obiektu błędu.	No
content_filter_results	dalleFilterResults	Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o treściach jailbreakowych i przekleństwach, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.	No
(revised_prompt remains unchanged, assuming it is a placeholder requiring no translation or adaptation)	ciąg	Prompt, który został użyty do wygenerowania obrazu, jeśli nastąpiła jakaś poprawka w poleceniu.	No

podstawaWynikuFiltraZawartości

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
filtered	boolean		Tak

WynikPoziomuSurowościFiltraTreści

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
filtered	boolean		Tak
severity	ciąg		No

WykrytoWynikFiltruTreści

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
filtered	boolean		Tak
detected	boolean		No

Filtr treści wykryty z wynikiem cytowania

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
cytat	obiekt		No

Właściwości cytowania

adres URL

Name	Typ	Opis	Wartość domyślna
adres URL	ciąg

licencja

Name	Typ	Opis	Wartość domyślna
licencja	ciąg

PodstawaWynikówFiltraZawartości

Informacje o wynikach filtrowania treści.

Name	Typ	Obowiązkowy
sexual	WynikFiltrowaniaZawartościWedługNasilenia	No
violence	WynikFiltrowaniaZawartościWedługNasilenia	No
hate	WynikFiltrowaniaZawartościWedługNasilenia	No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia	No
profanity	wynikWykrywaniaFiltruZawartości	No
błąd	errorBase	No

contentFilterPromptResults

Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o treściach jailbreakowych i przekleństwach, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.

Name	Typ	Obowiązkowy
sexual	WynikFiltrowaniaZawartościWedługNasilenia	No
violence	WynikFiltrowaniaZawartościWedługNasilenia	No
hate	WynikFiltrowaniaZawartościWedługNasilenia	No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia	No
profanity	wynikWykrywaniaFiltruZawartości	No
błąd	errorBase	No
jailbreak	wynikWykrywaniaFiltruZawartości	No

wynikiWyboruFiltruZawartości

Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o tekście i przekleństwach stron trzecich, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.

Name	Typ	Obowiązkowy
sexual	WynikFiltrowaniaZawartościWedługNasilenia	No
violence	WynikFiltrowaniaZawartościWedługNasilenia	No
hate	WynikFiltrowaniaZawartościWedługNasilenia	No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia	No
profanity	wynikWykrywaniaFiltruZawartości	No
błąd	errorBase	No
protected_material_text	wynikWykrywaniaFiltruZawartości	No
protected_material_code	wykryto filtr treści z wynikiem cytowania	No

WynikFiltrowaniaPromptu

Filtrowanie treści wychodzi dla pojedynczego promptu w żądaniu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
prompt_index	liczba całkowita		No
content_filter_results	contentFilterPromptResults	Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o treściach jailbreakowych i przekleństwach, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.	No

pokażWynikiFiltru

Filtrowanie treści daje zero lub więcej podpowiedzi w żądaniu. W przypadku zapytania streamingowego wyniki dla różnych promptów mogą pojawić się w różnych godzinach lub w różnej kolejności.

Nie ma zdefiniowanych właściwości dla tego komponentu.

Wyniki Filtra Treści DALL-E

Informacje o wynikach filtrowania treści.

Name	Typ	Obowiązkowy
sexual	WynikFiltrowaniaZawartościWedługNasilenia	No
violence	WynikFiltrowaniaZawartościWedługNasilenia	No
hate	WynikFiltrowaniaZawartościWedługNasilenia	No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia	No

dalleFilterResults

Name	Typ	Obowiązkowy
sexual	WynikFiltrowaniaZawartościWedługNasilenia	No
violence	WynikFiltrowaniaZawartościWedługNasilenia	No
hate	WynikFiltrowaniaZawartościWedługNasilenia	No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia	No
profanity	wynikWykrywaniaFiltruZawartości	No
jailbreak	wynikWykrywaniaFiltruZawartości	No

ŻądanieKończeniaCzatuWspólne

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
temperatura	number	Jakiej temperatury próbkowania użyć, między 0 a 2. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Zazwyczaj zalecamy modyfikację tego lub `top_p` nie obu tych rzeczy.	No	1
top_p	number	Alternatywą dla próbkowania za pomocą temperatury, zwaną próbkowaniem jądrowym, gdzie model uwzględnia wyniki tokenów o top_p masie prawdopodobieństwa. Zatem 0,1 oznacza, że rozważane są tylko tokeny tworzące 10 najwyższych% masy prawdopodobieństwa. Zazwyczaj zalecamy modyfikację tego lub `temperature` nie obu tych rzeczy.	No	1
odtwarzać strumieniowo	boolean	Jeśli jest ustawiony, zostaną wysłane częściowe delta wiadomości, jak w ChatGPT. Tokeny będą wysyłane jako zdarzenia wysyłane wyłącznie przez serwer z danymi, gdy tylko staną się dostępne, a strumień kończy się wiadomością `data: [DONE]` .	No	Nieprawda
stop	ciąg lub tablica	Do czterech sekwencji, w których API przestaje generować kolejne tokeny.	No
max_tokens	liczba całkowita	Maksymalna liczba żetonów dozwolona dla wygenerowanej odpowiedzi. Domyślnie liczba tokenów, które model może zwrócić, wynosi (4096 – tokeny promptu). Ta wartość została obecnie wycofana na rzecz `max_completion_tokens`, i nie jest kompatybilna z modelami serii O1.	No	4096
max_completion_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla zakończenia, w tym widocznych tokenów wyjściowych i tokenów rozumowania.	No
kara za obecność	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny w zależności od tego, czy pojawiają się w tekście, zwiększając prawdopodobieństwo modelu do poruszania nowych tematów.	No	0
frequency_penalty	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny na podstawie ich dotychczasowej częstotliwości w tekście, zmniejszając prawdopodobieństwo powtórzenia tej samej linii dosłownie.	No	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo pojawienia się określonych żetonów w finale. Akceptuje obiekt json, który mapuje tokeny (określone przez ich identyfikator tokena w tokenizatorze) na przypisaną wartość bias od -100 do 100. Matematycznie uprzedzenie jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnił w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszać lub zwiększać prawdopodobieństwo selekcji; wartości takie jak -100 czy 100 powinny skutkować banem lub wyłącznym wyborem odpowiedniego tokena.	No
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który może pomóc Azure OpenAI monitorować i wykrywać nadużycia.	No

utwórzŻądanieZakończenia

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
monit	ciąg lub tablica	Prompt(y) do generowania uzupełnień kodowane jako ciąg znaków, tablica łańcuchów, tablica tokenów lub tablica tokenów. Należy zauważyć, że <\|endoftext\|> to separator dokumentów, który model widzi podczas treningu, więc jeśli prompt nie jest określony, model wygeneruje się tak, jakby od początku nowego dokumentu.	Tak
najlepsze z	liczba całkowita	Generuje `best_of` ukończenia po stronie serwera i zwraca "najlepsze" (to o najwyższym prawdopodobieństwie logu na token). Wyników nie można transmitować w streamingu. Gdy używamy z , `nbest_of`kontroluje liczbę kandydatów na uzupełnienia i określa, `n` ile z nich należy zwrócić – " `best_of` musi być większe niż `n`. Uwaga: Ponieważ ten parametr generuje wiele ukończeń, może szybko pochłonąć Twój limit tokenów. Używaj ostrożnie i upewnij się, że masz rozsądne ustawienia dla `max_tokens` i `stop`.	No	1
echo	boolean	Powtórz prompt oprócz zakończenia	No	Nieprawda
frequency_penalty	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny na podstawie ich dotychczasowej częstotliwości w tekście, zmniejszając prawdopodobieństwo powtórzenia tej samej linii dosłownie.	No	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo pojawienia się określonych żetonów w finale. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokena w tokenizatorze GPT) na powiązaną wartość bias od -100 do 100. Matematycznie uprzedzenie jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnił w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszać lub zwiększać prawdopodobieństwo selekcji; wartości takie jak -100 czy 100 powinny skutkować banem lub wyłącznym wyborem odpowiedniego tokena. Na przykład możesz przepuścić `{"50256": -100}` , aby zapobiec generowaniu tokena <\|endoftext\|> .	No	Żadne
logprobs	liczba całkowita	Uwzględnij prawdopodobieństwa logiczne dla najbardziej `logprobs` prawdopodobnych tokenów wyjściowych, a także wybranych tokenów. Na przykład, jeśli `logprobs` wynosi 5, API zwróci listę pięciu najbardziej prawdopodobnych tokenów. API zawsze zwraca the `logprob` z próbkowanego tokena, więc w odpowiedzi może być więcej `logprobs+1` elementów. Maksymalna wartość dla `logprobs` to 5.	No	Żadne
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować podczas zakończenia. Liczba tokenów w twoim promptie plus `max_tokens` nie może przekroczyć długości kontekstu modelu.	No	16
n	liczba całkowita	Ile ukończeń wygenerować dla każdego promptu. Uwaga: Ponieważ ten parametr generuje wiele ukończeń, może szybko pochłonąć Twój limit tokenów. Używaj ostrożnie i upewnij się, że masz rozsądne ustawienia dla `max_tokens` i `stop`.	No	1
kara za obecność	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny w zależności od tego, czy pojawiają się w tekście, zwiększając prawdopodobieństwo modelu do poruszania nowych tematów.	No	0
seed	liczba całkowita	Jeśli zostanie to określone, nasz system dołoży wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi `seed` parametrami i parametry zwracały ten sam wynik. Determinizm nie jest gwarantowany i powinieneś odwołać się do parametru `system_fingerprint` odpowiedzi, aby monitorować zmiany w backendzie.	No
stop	ciąg lub tablica	Do czterech sekwencji, w których API przestaje generować kolejne tokeny. Zwrócony tekst nie zawiera sekwencji stop.	No
odtwarzać strumieniowo	boolean	Czy odtworzyć częściowy postęp. Jeśli są ustawione, tokeny będą wysyłane jako zdarzenia wysyłane wyłącznie przez serwer danych, gdy tylko staną się dostępne, a strumień kończy się wiadomością `data: [DONE]` .	No	Nieprawda
Sufiks	ciąg	Przyrostek pojawiający się po uzupełnieniu wstawionego tekstu. Ten parametr jest obsługiwany tylko dla `gpt-3.5-turbo-instruct`.	No	Żadne
temperatura	number	Jakiej temperatury próbkowania użyć, między 0 a 2. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Zazwyczaj zalecamy modyfikację tego lub `top_p` nie obu tych rzeczy.	No	1
top_p	number	Alternatywą dla próbkowania za pomocą temperatury, zwaną próbkowaniem jądrowym, gdzie model uwzględnia wyniki tokenów o top_p masie prawdopodobieństwa. Zatem 0,1 oznacza, że rozważane są tylko tokeny tworzące 10 najwyższych% masy prawdopodobieństwa. Zazwyczaj zalecamy modyfikację tego lub `temperature` nie obu tych rzeczy.	No	1
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No

createCompletionResponse

Reprezentuje odpowiedź na zakończenie z API. Uwaga: zarówno obiekty odpowiedzi przesyłane, jak i niestrumieniowane mają ten sam kształt (w przeciwieństwie do endpointu czatu).

Name	Typ	Opis	Obowiązkowy
id	ciąg	Unikalny identyfikator zakończenia.	Tak
choices	macierz	Lista opcji uzupełnienia wygenerowana przez model na prompt wejścia.	Tak
utworzone	liczba całkowita	Znacznik czasu Unixa (w sekundach) momentu utworzenia zakończenia.	Tak
model	ciąg	Model używany do ukończenia.	Tak
prompt_filter_results	promptFilterResults	Filtrowanie treści daje zero lub więcej podpowiedzi w żądaniu. W przypadku zapytania streamingowego wyniki dla różnych promptów mogą pojawić się w różnych godzinach lub w różnej kolejności.	No
system_fingerprint	ciąg	Ten odcisk palca reprezentuje konfigurację backend, z którą działa model. Może być używany razem z parametrem żądania, `seed` aby zrozumieć, kiedy wprowadzono zmiany w backendzie, które mogą wpłynąć na determinizm.	No
obiekt	wyliczenie	Typ obiektu, który zawsze jest "text_completion" Możliwe wartości: text_completion	Tak
użycie	completionUsage	Statystyki wykorzystania wniosku o zakończenie.	No

UtwórzŻądanieZakończeniaCzatu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
temperatura	number	Jakiej temperatury próbkowania użyć, między 0 a 2. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Zazwyczaj zalecamy modyfikację tego lub `top_p` nie obu tych rzeczy.	No	1
top_p	number	Alternatywą dla próbkowania za pomocą temperatury, zwaną próbkowaniem jądrowym, gdzie model uwzględnia wyniki tokenów o top_p masie prawdopodobieństwa. Zatem 0,1 oznacza, że rozważane są tylko tokeny tworzące 10 najwyższych% masy prawdopodobieństwa. Zazwyczaj zalecamy modyfikację tego lub `temperature` nie obu tych rzeczy.	No	1
odtwarzać strumieniowo	boolean	Jeśli jest ustawiony, zostaną wysłane częściowe delta wiadomości, jak w ChatGPT. Tokeny będą wysyłane jako zdarzenia wysyłane wyłącznie przez serwer z danymi, gdy tylko staną się dostępne, a strumień kończy się wiadomością `data: [DONE]` .	No	Nieprawda
stop	ciąg lub tablica	Do czterech sekwencji, w których API przestaje generować kolejne tokeny.	No
max_tokens	liczba całkowita	Maksymalna liczba tokenów, które można wygenerować podczas zakończenia czatu. Całkowita długość tokenów wejściowych i wygenerowanych jest ograniczona przez długość kontekstu modelu.	No
max_completion_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla zakończenia, w tym widocznych tokenów wyjściowych i tokenów rozumowania.	No
kara za obecność	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny w zależności od tego, czy pojawiają się w tekście, zwiększając prawdopodobieństwo modelu do poruszania nowych tematów.	No	0
frequency_penalty	number	Liczba między -2,0 a 2,0. Wartości dodatnie karzą nowe tokeny na podstawie ich dotychczasowej częstotliwości w tekście, zmniejszając prawdopodobieństwo powtórzenia tej samej linii dosłownie.	No	0
logit_bias	obiekt	Zmodyfikuj prawdopodobieństwo pojawienia się określonych żetonów w finale. Akceptuje obiekt JSON, który mapuje tokeny (określone przez ich identyfikator tokena w tokenizerze) na przypisaną wartość bias od -100 do 100. Matematycznie uprzedzenie jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt będzie się różnił w zależności od modelu, ale wartości między -1 a 1 powinny zmniejszać lub zwiększać prawdopodobieństwo selekcji; wartości takie jak -100 czy 100 powinny skutkować banem lub wyłącznym wyborem odpowiedniego tokena.	No	Żadne
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No
messages	macierz	Lista wiadomości składających się na dotychczasową rozmowę.	Tak
data_sources	macierz	Wpisy konfiguracyjne dla rozszerzeń czatu Azure OpenAI, które je używają. Ta dodatkowa specyfikacja jest kompatybilna tylko z Azure OpenAI.	No
logprobs	boolean	Czy zwracać logarytmiczne prawdopodobieństwa tokenów wyjściowych, czy nie. Jeśli jest prawdziwa, zwraca logarytmiczne prawdopodobieństwa każdego tokena wyjściowego zwróconego w .`contentmessage`	No	Nieprawda
top_logprobs	liczba całkowita	Liczba całkowita od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji tokena, z przypisanym logarytmem prawdopodobieństwa. `logprobs` musi być ustawione na , `true` jeśli ten parametr jest używany.	No
n	liczba całkowita	Ile opcji uzupełniania czatu wygenerować dla każdej wiadomości wejściowej. Pamiętaj, że opłata będzie zależała od liczby wygenerowanych żetonów we wszystkich opcjach. Dbaj `n` o `1` minimalizację kosztów.	No	1
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas użycia narzędzia.	No	True
format_odpowiedzi	ResponseFormatText lub ResponseFormatJsonObject lub ResponseFormatJsonSchema	Obiekt określający format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4o mini, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo nowszymi od `gpt-3.5-turbo-1106`. Ustawienie na `{ "type": "json_schema", "json_schema": {...} }` Structured Outputs, które gwarantują, że model będzie odpowiadał Twojemu dostarczonemu schematowi JSON. Ustawienie trybu `{ "type": "json_object" }` JSON, który gwarantuje, że generowany przez model komunikat jest poprawny w JSON. Ważne: podczas korzystania z trybu JSON musisz również polecić modelowi samodzielne wygenerowanie JSON za pomocą komunikatu systemowego lub użytkownika. Bez tego model może generować niekończący się strumień białych przestrzeni, aż generowanie osiągnie limit tokenów, co skutkuje długotrwałym i pozornie "zablokowanym" żądaniem. Należy też zauważyć, że treść wiadomości może być częściowo odcięta, jeśli `finish_reason="length"`, co oznacza, że generowanie przekroczyło `max_tokens` lub rozmowa przekroczyła maksymalną długość kontekstu.	No
seed	liczba całkowita	Ta funkcja jest w fazie beta. Jeśli zostanie to określone, nasz system dołoży wszelkich starań, aby próbkować deterministycznie, tak aby powtarzające się żądania z tymi samymi `seed` parametrami i parametry zwracały ten sam wynik. Determinizm nie jest gwarantowany i powinieneś odwołać się do parametru `system_fingerprint` odpowiedzi, aby monitorować zmiany w backendzie.	No
Narzędzia	macierz	Lista narzędzi, które model może wywołać. Obecnie obsługiwane są tylko funkcje jako narzędzie. Użyj tego, aby uzyskać listę funkcji, dla których model może generować wejścia JSON. Obsługiwanych jest maksymalnie 128 funkcji.	No
tool_choice	chatCompletionToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. `none` Oznacza to, że model nie wywołuje żadnego narzędzia, lecz generuje komunikat. `auto` oznacza to, że model może wybrać między generowaniem wiadomości a wywołaniem jednego lub więcej narzędzi. `required` oznacza, że model musi wywołać jedno lub więcej narzędzi. Określenie konkretnego narzędzia via `{"type": "function", "function": {"name": "my_function"}}` wymusza wywołanie tego narzędzia przez model. `none` jest domyślne, gdy nie ma narzędzi. `auto` jest domyślne, jeśli narzędzia są obecne.	No
function_call	string lub chatCompletionFunctionCallOption	Wycofane na rzecz `tool_choice`. Kontroluje, która (jeśli w ogóle) funkcja jest wywoływana przez model. `none` oznacza to, że model nie wywołuje funkcji, lecz generuje wiadomość. `auto` oznacza to, że model może wybrać między generowaniem wiadomości a wywołaniem funkcji. Określenie konkretnej funkcji przez `{"name": "my_function"}` wymusza wywołanie tej funkcji przez model. `none` jest domyślnym, gdy nie ma żadnych funkcji. `auto` jest domyślnym, jeśli funkcje są obecne.	No
functions	macierz	Wycofane na rzecz `tools`. Lista funkcji, dla których model może generować wejścia JSON.	No

funkcjeUkończeniaChatu

Name	Typ	Opis	Obowiązkowy
opis	ciąg	Opis tego, co funkcja robi, używany przez model do wyboru, kiedy i jak wywołać funkcję.	No
nazwa	ciąg	Nazwa funkcji, którą ma się wywołać. Musi być od A do Z, A-Z, 0-9 lub zawierać podkreślenia i kreski, a maksymalna długość to 64.	Tak
parameters	Parametry funkcji	Parametry, które funkcje akceptują, są opisane jako obiekt schematu JSON. Zobacz przewodnik dla przykładów oraz odniesienie do schematu JSON dla dokumentacji formatu. Pomijanie `parameters` definiuje funkcję z pustą listą parametrów.	No

Opcja wywołania funkcji czatu zakończeniowego

Określenie konkretnej funkcji przez {"name": "my_function"} wymusza wywołanie tej funkcji przez model.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	Tak

chatCompletionRequestMessage

Ten składnik może być jednym z następujących elementów:

chatCompletionRequestSystemMessage

Name	Typ	Opis	Obowiązkowy
zawartość	ciąg lub tablica	Treść wiadomości systemowej.	Tak
rola	wyliczenie	Rola autora wiadomości, w tym przypadku `system`. Możliwe wartości: system	Tak
nazwa	ciąg	Opcjonalne imię uczestnika. Dostarcza informacji modelowych pozwalających rozróżnić uczestników tej samej roli.	No

chatCompletionRequestUserMessage

Name	Typ	Opis	Obowiązkowy
zawartość	ciąg lub tablica	Treść wiadomości użytkownika.	Tak
rola	wyliczenie	Rola autora wiadomości, w tym przypadku `user`. Możliwe wartości: użytkownik	Tak
nazwa	ciąg	Opcjonalne imię uczestnika. Dostarcza informacji modelowych pozwalających rozróżnić uczestników tej samej roli.	No

wiadomośćAsystentaZwiązanaZProśbąOukończenieCzatu

Name	Typ	Opis	Obowiązkowy
zawartość	ciąg lub tablica	Treść wiadomości od asystenta. Wymagane, chyba że `tool_calls` jest to określone lub `function_call` zakreślone.	No
refusal	ciąg	Wiadomość odmowy od asystenta.	No
rola	wyliczenie	Rola autora wiadomości, w tym przypadku `assistant`. Możliwe wartości: asystent	Tak
nazwa	ciąg	Opcjonalne imię uczestnika. Dostarcza informacji modelowych pozwalających rozróżnić uczestników tej samej roli.	No
tool_calls	chatCompletionMessageToolCalls	Wywołania narzędzi generowane przez model, takie jak wywołania funkcji.	No
function_call	obiekt	Wycofane i zastąpione przez `tool_calls`. Nazwa i argumenty funkcji, którą należy wywołać, wygenerowane przez model.	No

Właściwości function_call

arguments

Name	Typ	Opis	Wartość domyślna
arguments	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje poprawny JSON i może generować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.

nazwa

Name	Typ	Opis	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.

chatCompletionRequestToolMessage

Name	Typ	Opis	Obowiązkowy
rola	wyliczenie	Rola autora wiadomości, w tym przypadku `tool`. Możliwe wartości: narzędzie	Tak
zawartość	ciąg lub tablica	Treść wiadomości narzędziowej.	Tak
tool_call_id	ciąg	Wezwanie narzędzi, na które odpowiada ta wiadomość.	Tak

chatCompletionRequestFunctionMessage

Name	Typ	Opis	Obowiązkowy
rola	wyliczenie	Rola autora wiadomości, w tym przypadku `function`. Możliwe wartości: funkcja	Tak
zawartość	ciąg	Zawartość komunikatu funkcji.	Tak
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	Tak

Żądanie czatuUzupełnienieSystemKomunikatTreśćCzęść

Ten składnik może być jednym z następujących elementów:

częśćZawartościWiadomościUżytkownikaChatCompletionRequest

Ten składnik może być jednym z następujących elementów:

CzęśćTreściWiadomościAsystentaŻądaniaUkończeniaCzatu

Ten składnik może być jednym z następujących elementów:

TreśćWiadomościNarzędziaŻądaniaUkończeniaCzatu

Ten składnik może być jednym z następujących elementów:

chatCompletionRequestMessageContentPartText

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj treści. Możliwe wartości: tekst	Tak
SMS	ciąg	Treść tekstu.	Tak

chatCompletionRequestMessageContentPartImage

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj treści. Możliwe wartości: image_url	Tak
image_url	obiekt		Tak

Właściwości image_url

Adres url

Name	Typ	Opis	Wartość domyślna
Adres url	ciąg	Można to być albo adresem URL obrazu, albo danymi obrazowymi zakodowanymi w base64.

detail

Name	Typ	Opis	Wartość domyślna
detail	ciąg	Określa poziom szczegółowości obrazu. Dowiedz się więcej w przewodniku Vision.	samochód

chatCompletionRequestMessageContentPartRefusal

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj treści. Możliwe wartości: odmowa	Tak
refusal	ciąg	Komunikat odmowy generowany przez model.	Tak

KonfiguracjaAzureChatExtension

Reprezentacja danych konfiguracyjnych dla pojedynczego rozszerzenia czatu Azure OpenAI. Będzie to wykorzystywane przez żądanie zakończenia czatu, które powinno wykorzystywać rozszerzenia czatu Azure OpenAI, aby wzmocnić zachowanie odpowiedzi. Użycie tej konfiguracji jest kompatybilne wyłącznie z Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	azureChatExtensionType	Reprezentacja danych konfiguracyjnych dla pojedynczego rozszerzenia czatu Azure OpenAI. Będzie to wykorzystywane przez czat żądania ukończenia, które powinny wykorzystywać rozszerzenia czatu Azure OpenAI, aby wzmocnić zachowanie odpowiedzi. Użycie tej konfiguracji jest kompatybilne wyłącznie z Azure OpenAI.	Tak

Typ rozszerzenia czatu Azure

Description: Reprezentacja danych konfiguracyjnych dla jednego rozszerzenia czatu OpenAI Azure. Będzie to wykorzystywane przez żądanie zakończenia czatu, które powinno wykorzystywać rozszerzenia czatu Azure OpenAI, aby wzmocnić zachowanie odpowiedzi. Użycie tej konfiguracji jest kompatybilne wyłącznie z Azure OpenAI.

Typ: ciąg

Domyślnie:

Nazwa wyliczenia: AzureChatExtensionType

Wartości enuma

Wartość	Opis
wyszukiwanie w Azure	Oznacza użycie Azure Search jako rozszerzenia czatu Azure OpenAI.
azure_cosmos_db	Oznacza użycie Azure Cosmos DB jako rozszerzenia czatu Azure OpenAI.

Konfiguracja rozszerzenia czatu AzureSearch (azureSearchChatExtensionConfiguration)

Specyficzna reprezentacja konfigurowalnych opcji dla wyszukiwania Azure podczas używania go jako rozszerzenia czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	azureChatExtensionType	Reprezentacja danych konfiguracyjnych dla pojedynczego rozszerzenia czatu Azure OpenAI. Będzie to wykorzystywane przez czat żądania ukończenia, które powinny wykorzystywać rozszerzenia czatu Azure OpenAI, aby wzmocnić zachowanie odpowiedzi. Użycie tej konfiguracji jest kompatybilne wyłącznie z Azure OpenAI.	Tak
parameters	azureSearchChatExtensionParameters	Parametry dla Azure Search gdy jest używany jako rozszerzenie czatu Azure OpenAI.	No

azureSearchChatExtensionParameters

Parametry dla Azure Search gdy jest używany jako rozszerzenie czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions lub onYourDataSystemAssignedManagedIdentityAuthenticationOptions albo onYourDataUserAssignedManagedIdentityAuthenticationOptions		Tak
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	No
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
ścisłość	liczba całkowita	Konfigurowana rygorystyka filtrowania trafności wyszukiwania. Im bardziej rygorystyczna, tym większa precyzja, ale mniej pamiętana odpowiedź.	No
informacje_o_roli	ciąg	Daj modelowi instrukcje, jak powinien się zachowywać i jaki kontekst powinien odnosić się podczas generowania odpowiedzi. Możesz opisać osobowość asystenta i powiedzieć mu, jak ma formatować odpowiedzi. Jest limit 100 tokenów, który liczy się do całkowitego limitu tokenów.	No
punkt końcowy	ciąg	Absolutna ścieżka końcowa dla zasobu Azure Search do wykorzystania.	Tak
nazwa_indeksu	ciąg	Nazwa indeksu, którą można użyć w zasobach Azure Search, do którego się odwołuje.	Tak
mapowanie pól	Opcje Mapowania Pola Indeksu Wyszukiwania Azure	Opcjonalne ustawienia do kontrolowania przetwarzania pól podczas korzystania z skonfigurowanego zasobu Azure Search.	No
typ zapytania	azureSearchQueryType	Typ zapytania wyszukiwania Azure Search, który powinien być wykonywany podczas używania go jako rozszerzenia czatu Azure OpenAI.	No
konfiguracja semantyczna	ciąg	Dodatkowa konfiguracja semantyczna zapytania.	No
filtr	ciąg	Filtr wyszukiwania.	No
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		No

Opcje Mapowania Pola Indeksu Wyszukiwania Azure

Opcjonalne ustawienia do kontrolowania przetwarzania pól podczas korzystania z skonfigurowanego zasobu Azure Search.

Name	Typ	Opis	Obowiązkowy
pole_tytułu	ciąg	Nazwa pola indeksu, której można użyć jako tytułu.	No
url_field	ciąg	Nazwa pola indeksu, którą można użyć jako adres URL.	No
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako treść.	No
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola treści.	No
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	No

azureSearchQueryType

Typ zapytania wyszukiwania Azure Search, który powinien być wykonywany podczas używania go jako rozszerzenia czatu Azure OpenAI.

Description: Typ zapytania wyszukiwania Azure Search, który powinien być wykonywany podczas używania go jako rozszerzenia czatu OpenAI Azure.

Typ: ciąg

Domyślnie:

Nazwa typu wyliczenia: AzureSearchQueryType

Wartości enuma

Wartość	Opis
simple	Reprezentuje domyślny, prosty parser zapytań.
semantyczny	Reprezentuje semantyczny parser zapytań dla zaawansowanego modelowania semantycznego.
wektor	Reprezentuje wyszukiwanie wektorowe na danych obliczeniowych.
vector_prosty_hybrydowy	Reprezentuje połączenie strategii prostego zapytania z danymi wektorowymi.
wektor_semantyczny_hybryda	Reprezentuje połączenie wyszukiwania semantycznego i zapytań wektorowych.

azureCosmosDBChatExtensionConfiguration

Specyficzna reprezentacja konfigurowalnych opcji dla Azure Cosmos DB przy użyciu go jako rozszerzenia czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	azureChatExtensionType	Reprezentacja danych konfiguracyjnych dla pojedynczego rozszerzenia czatu Azure OpenAI. Będzie to wykorzystywane przez czat żądania ukończenia, które powinny wykorzystywać rozszerzenia czatu Azure OpenAI, aby wzmocnić zachowanie odpowiedzi. Użycie tej konfiguracji jest kompatybilne wyłącznie z Azure OpenAI.	Tak
parameters	azureCosmosDBChatExtensionParameters	Parametry, których należy używać przy konfigurowaniu rozszerzeń czatu Azure OpenAI On Your Data przy użyciu Azure Cosmos DB dla vCore MongoDB.	No

azureCosmosDBChatExtensionParameters

Parametry, których należy używać przy konfigurowaniu rozszerzeń czatu Azure OpenAI On Your Data przy użyciu Azure Cosmos DB dla MongoDB vCore.

Name	Typ	Opis	Obowiązkowy
uwierzytelnianie	onYourDataConnectionStringOpcjeUwierzytelniania	Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu parametry połączenia.	Tak
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	No
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
ścisłość	liczba całkowita	Konfigurowana rygorystyka filtrowania trafności wyszukiwania. Im bardziej rygorystyczna, tym większa precyzja, ale mniej pamiętana odpowiedź.	No
informacje_o_roli	ciąg	Daj modelowi instrukcje, jak powinien się zachowywać i jaki kontekst powinien odnosić się podczas generowania odpowiedzi. Możesz opisać osobowość asystenta i powiedzieć mu, jak ma formatować odpowiedzi. Jest limit 100 tokenów, który liczy się do całkowitego limitu tokenów.	No
nazwa_bazy_danych	ciąg	Nazwa bazy MongoDB vCore do użycia z Azure Cosmos DB.	Tak
nazwa_kontenera	ciąg	Nazwa kontenera zasobów Azure Cosmos DB.	Tak
nazwa_indeksu	ciąg	Nazwa indeksu MongoDB vCore do użycia z Azure Cosmos DB.	Tak
mapowanie pól	azureCosmosDBFieldMappingOptions	Opcjonalne ustawienia do kontroli przetwarzania pól podczas korzystania z skonfigurowanego zasobu bazy Azure Cosmos DB.	Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak

azureCosmosDBFieldMappingOptions

Opcjonalne ustawienia do kontroli przetwarzania pól podczas korzystania z skonfigurowanego zasobu bazy Azure Cosmos DB.

Name	Typ	Opis	Obowiązkowy
pole_tytułu	ciąg	Nazwa pola indeksu, której można użyć jako tytułu.	No
url_field	ciąg	Nazwa pola indeksu, którą można użyć jako adres URL.	No
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
pola_treści	macierz	Nazwy pól indeksu, które powinny być traktowane jako treść.	Tak
separator_pól_treści	ciąg	Wzorzec separatora, którego powinny używać pola treści.	No
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

OpcjeUwierzytelnianiaTwoichDanych

Opcje uwierzytelniania dla Azure OpenAI na Twoich danych.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak

typUwierzytelnieniaTwoichDanych

Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.

Description: Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.

Typ: ciąg

Domyślnie:

Nazwa enum: OnYourDataAuthenticationType

Wartości enuma

Wartość	Opis
klucz_api	Uwierzytelnianie za pomocą klucza API.
connection_string	Uwierzytelnianie za pomocą parametry połączenia.
tożsamość zarządzana przypisana przez system	Uwierzytelnianie za pomocą systemowej tożsamości zarządzanej.
tożsamość zarządzana przypisana przez użytkownika	Uwierzytelnianie za pomocą przypisanej przez użytkownika tożsamości zarządzanej.

Opcje uwierzytelniania klucza API Twoje Dane

Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu klucza API.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak
klucz	ciąg	Klucz API do uwierzytelniania.	No

onYourDataConnectionStringOpcjeUwierzytelniania

Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu parametry połączenia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak
connection_string	ciąg	parametry połączenia do uwierzytelniania.	No

opcjeUwierzytelnianiaTożsamościZarządzanejPrzydzielonejPrzezTwójSystemDanych

Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu systemowej tożsamości zarządzanej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak

Opcje uwierzytelniania przy użyciu przypisanej tożsamości zarządzanej dla użytkownika na platformie YourData

Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu przypisanej przez użytkownika tożsamości zarządzanej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak
managed_identity_resource_id	ciąg	Identyfikator zasobu przypisanej przez użytkownika tożsamości zarządzanej do uwierzytelniania.	No

ŹródłoWeWektorzeDanych

Abstrakcyjna reprezentacja źródła wektoryzacji dla Azure OpenAI On Your Data z wyszukiwaniem wektorowym.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które Azure OpenAI On Your Data może wykorzystać do konfiguracji wektoryzacji danych do użycia z wyszukiwanie wektorów.	Tak

naTwójTypŹródłaWeektoryzacjiDanych

Reprezentuje dostępne źródła, które Azure OpenAI On Your Data może wykorzystać do konfiguracji wektoryzacji danych do wyszukiwania wektorowego.

Description: Reprezentuje dostępne źródła Azure OpenAI On Your Data może wykorzystać do konfiguracji wektoryzacji danych do użycia z
wyszukiwanie wektorów.

Typ: ciąg

Domyślnie:

Nazwa enum: OnYourDataVectorizationSourceType

Wartości enuma

Wartość	Opis
punkt końcowy	Reprezentuje wektoryzację wykonywaną przez wywołania usług publicznych do modelu osadzania Azure OpenAI.
nazwa_wdrożenia	Reprezentuje nazwę wdrożenia modelu Ada. Wdrożenie tego modelu musi być w tym samym zasobie Azure OpenAI, ale On Your Data będzie korzystać z tego modelu poprzez wewnętrzne wywołanie, a nie publiczne, co umożliwia wektorowanie Szukaj nawet w prywatnych sieciach.

onYourDataDeploymentNameWektoryzacjaŹródło

Szczegóły źródła wektoryzacji, używanego przez Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego, opartego na wewnętrznej nazwie modelu wdrożenia embeddingów w tym samym zasobu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które Azure OpenAI On Your Data może wykorzystać do konfiguracji wektoryzacji danych do użycia z wyszukiwanie wektorów.	Tak
nazwa_wdrożenia	ciąg	Określa nazwę wdrożenia modelu do wektoryzacji. To wdrożenie modelu musi być w tym samym zasobu Azure OpenAI, ale On Your Data będzie korzystać z tego modelu poprzez wewnętrzne wywołanie, a nie publiczne, co umożliwia wyszukiwanie wektorowe nawet w sieciach prywatnych.	No

onYourDataEndpointVectorizationSource

Szczegóły źródła wektoryzacji, używanego przez Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego, opartego na publicznym wywołaniu punktu końcowego Azure OpenAI dla osadzeń.

Name	Typ	Opis	Obowiązkowy
typ	naTwójTypŹródłaWeektoryzacjiDanych	Reprezentuje dostępne źródła, które Azure OpenAI On Your Data może wykorzystać do konfiguracji wektoryzacji danych do użycia z wyszukiwanie wektorów.	Tak
uwierzytelnianie	Opcje uwierzytelniania klucza API Twoje Dane	Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu klucza API.	No
punkt końcowy	ciąg	Określa punkt końcowy do wektoryzacji. Ten punkt końcowy musi znajdować się w tym samym zasobie Azure OpenAI, ale On Your Data będzie korzystać z tego punktu przez wewnętrzne wywołanie, a nie publiczne, co umożliwia wyszukiwanie wektorowe nawet w sieciach prywatnych.	No

kontekstWiadomościRozszerzeńAzureChat

Przedstawienie dodatkowych informacji kontekstowych dostępnych przy generowaniu odpowiadającej odpowiedzi na zakończenie czatu Azure OpenAI. Te informacje kontekstowe są wypełniane tylko wtedy, gdy używamy żądania Azure OpenAI skonfigurowanego do używania odpowiadającego rozszerzenia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
citations	macierz	Wynik pobierania źródła danych, używany do generowania wiadomości asystenckiej w odpowiedzi.	No
intencja	ciąg	Wykryty intencji z historii czatu wykorzystywany do przekazywania do następnej tury, by przenieść kontekst.	No

cytat

Informacje o cytowaniu w wiadomości odpowiedzi na zakończenie czatu.

Name	Typ	Opis	Obowiązkowy
zawartość	ciąg	Treść uzasadnienia.	Tak
tytuł	ciąg	Tytuł uzasadnienia.	No
Adres url	ciąg	URL cytowania.	No
ścieżka pliku	ciąg	Ścieżka pliku do cytatu.	No
identyfikator_kawałka	ciąg	Numer numeru cytowania.	No

KomunikatZakończeniaRozmowyNarzędziaCall

Name	Typ	Opis	Obowiązkowy
id	ciąg	ID wywołania narzędzia.	Tak
typ	toolCallType	Typ wywołania narzędzia, w tym przypadku `function`.	Tak
funkcja	obiekt	Funkcja, którą model wywoływał.	Tak

Właściwości funkcji

nazwa

Name	Typ	Opis	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.

arguments

Name	Typ	Opis	Wartość domyślna
arguments	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje poprawny JSON i może generować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.

typWywołaniaNarzędzia

Typ wywołania narzędzia, w tym przypadku function.

Opis: Typ wywołania narzędzia, w tym przypadku function.

Typ: ciąg

Domyślnie:

Nazwa enum: ToolCallType

Wartości enuma

Wartość	Opis
funkcja	Typ wywołania narzędzia to funkcja.

Narzędzie do wysyłania wiadomości z prośbą o zakończenie czatu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
tool_call_id	ciąg	Wezwanie narzędzi, na które odpowiada ta wiadomość.	No
zawartość	ciąg	Treść wiadomości.	No

chatCompletionRequestMessageFunction

Name	Typ	Opis	Obowiązkowy
rola	wyliczenie	Rola autora wiadomości, w tym przypadku `function`. Możliwe wartości: funkcja	No
nazwa	ciąg	Treść wiadomości.	No
zawartość	ciąg	Treść wiadomości.	No

utwórzOdpowiedźNaZakończenieCzatu

Reprezentuje odpowiedź zakończenia czatu zwracaną przez model, na podstawie dostarczonego wejścia.

Name	Typ	Opis	Obowiązkowy
id	ciąg	Unikalny identyfikator zakończenia czatu.	Tak
prompt_filter_results	promptFilterResults	Filtrowanie treści daje zero lub więcej podpowiedzi w żądaniu. W przypadku zapytania streamingowego wyniki dla różnych promptów mogą pojawić się w różnych godzinach lub w różnej kolejności.	No
choices	macierz	Lista opcji do ukończenia czatu. Może być więcej niż jeden, jeśli `n` jest większe niż 1.	Tak
utworzone	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) momentu ukończenia czatu.	Tak
model	ciąg	Model użyty do zakończenia czatu.	Tak
system_fingerprint	ciąg	Ten odcisk palca reprezentuje konfigurację backend, z którą działa model. Może być używany razem z parametrem żądania, `seed` aby zrozumieć, kiedy wprowadzono zmiany w backendzie, które mogą wpłynąć na determinizm.	No
obiekt	wyliczenie	Typ obiektu, który zawsze `chat.completion`jest . Możliwe wartości: chat.completion	Tak
użycie	completionUsage	Statystyki wykorzystania wniosku o zakończenie.	No

utwórzOdpowiedźNaKompletacjęStrumieniaCzatu

Reprezentuje strumieniowy fragment odpowiedzi zakończenia czatu zwracany przez model, na podstawie dostarczonego wejścia.

Name	Typ	Opis	Obowiązkowy
id	ciąg	Unikalny identyfikator zakończenia czatu. Każdy chunk ma ten sam identyfikator.	Tak
choices	macierz	Lista opcji do ukończenia czatu. Może zawierać więcej niż jeden element, jeśli `n` jest większy niż 1.	Tak
utworzone	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) momentu ukończenia czatu. Każdy chunk ma ten sam znacznik czasu.	Tak
model	ciąg	Model do wygenerowania zakończenia.	Tak
system_fingerprint	ciąg	Ten odcisk palca reprezentuje konfigurację backend, z którą działa model. Może być używany razem z parametrem żądania, `seed` aby zrozumieć, kiedy wprowadzono zmiany w backendzie, które mogą wpłynąć na determinizm.	No
obiekt	wyliczenie	Typ obiektu, który zawsze `chat.completion.chunk`jest . Możliwe wartości: chat.completion.chunk	Tak

chatCompletionStreamResponseDelta

Delta zakończenia czatu generowana przez odpowiedzi streamowanych modeli.

Name	Typ	Opis	Obowiązkowy
zawartość	ciąg	Treść wiadomości chunk.	No
function_call	obiekt	Wycofane i zastąpione przez `tool_calls`. Nazwa i argumenty funkcji, którą należy wywołać, wygenerowane przez model.	No
tool_calls	macierz		No
rola	wyliczenie	Rola autora tego przesłania. Możliwe wartości: system, użytkownik, asystent, narzędzie	No
refusal	ciąg	Komunikat odmowy generowany przez model.	No

Właściwości function_call

arguments

Name	Typ	Opis	Wartość domyślna
arguments	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje poprawny JSON i może generować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.

nazwa

Name	Typ	Opis	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.

Segment wywołania narzędzia wiadomości chatCompletion

Name	Typ	Opis	Obowiązkowy
indeks	liczba całkowita		Tak
id	ciąg	ID wywołania narzędzia.	No
typ	wyliczenie	Rodzaj narzędzia. Obecnie obsługiwany jest tylko `function` on. Możliwe wartości: funkcja	No
funkcja	obiekt		No

Właściwości funkcji

nazwa

Name	Typ	Opis	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.

arguments

Name	Typ	Opis	Wartość domyślna
arguments	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje poprawny JSON i może generować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.

chatCompletionStreamOptions

Opcje odpowiedzi na streaming. Ustawiam to tylko wtedy, gdy ustawiasz stream: true.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
include_usage	boolean	Jeśli jest ustawiony, przed wiadomością `data: [DONE]` zostanie wystrzelony dodatkowy fragment. Pole `usage` w tym bloku pokazuje statystyki użycia tokenów dla całego żądania, a pole `choices` zawsze będzie pustą tablicą. Wszystkie pozostałe bloki również będą zawierać `usage` pole, ale z wartością zerową.	No

chatCompletionChoiceLogPrawdopodobieństwa

Loguj informacje o prawdopodobieństwie wyboru.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	macierz	Lista tokenów treści wiadomości z logami informacji o prawdopodobieństwie.	Tak
refusal	macierz	Lista tokenów odmowy wiadomości z logicznymi informacjami o prawdopodobieństwie.	No

chatCompletionTokenLogprob

Name	Typ	Opis	Obowiązkowy
kod przedpłaty	ciąg	Znacznik.	Tak
logprob	number	Log probability tego tokena.	Tak
bytes	macierz	Lista liczb całkowitych reprezentujących bajtową reprezentację tokena w UTF-8. Przydatne w przypadkach, gdy znaki są reprezentowane przez wiele tokenów, a ich reprezentacje bajtów muszą być łączone, aby uzyskać poprawną reprezentację tekstową. Może być `null` , jeśli token nie ma reprezentacji bajtów.	Tak
top_logprobs	macierz	Lista najbardziej prawdopodobnych tokenów i ich log prawdopodobieństwa na tej pozycji tokena. W rzadkich przypadkach może być mniej niż wymagana liczba zwróconych `top_logprobs` .	Tak

WiadomośćOdpowiedziNaZakończenieCzatu

Wiadomość zakończenia czatu wygenerowana przez model.

Name	Typ	Opis	Obowiązkowy
rola	chatCompletionResponseMessageRole	Rola autora wiadomości odpowiedzi.	Tak
refusal	ciąg	Komunikat odmowy generowany przez model.	Tak
zawartość	ciąg	Treść wiadomości.	Tak
tool_calls	macierz	Wywołania narzędzi generowane przez model, takie jak wywołania funkcji.	No
function_call	chatCompletionFunctionCall	Wycofane i zastąpione przez `tool_calls`. Nazwa i argumenty funkcji, którą należy wywołać, wygenerowane przez model.	No
kontekst	azureChatExtensionsMessageContext	Przedstawienie dodatkowych informacji kontekstowych dostępnych przy użyciu rozszerzeń czatu Azure OpenAI w generowaniu odpowiadającej odpowiedzi na zakończenie czatu. Te informacje kontekstowe są wypełniane tylko wtedy, gdy używając żądania Azure OpenAI skonfigurowanego do używania pasującego rozszerzenia.	No

chatCompletionResponseMessageRole

Rola autora wiadomości odpowiedzi.

Opis: Rola autora wiadomości odpowiedzi.

Typ: ciąg

Domyślnie:

Wartości enuma

asystent

chatCompletionToolChoiceOption

Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none Oznacza to, że model nie wywołuje żadnego narzędzia, lecz generuje komunikat. auto oznacza to, że model może wybrać między generowaniem wiadomości a wywołaniem jednego lub więcej narzędzi. required oznacza, że model musi wywołać jedno lub więcej narzędzi. Określenie konkretnego narzędzia via {"type": "function", "function": {"name": "my_function"}} wymusza wywołanie tego narzędzia przez model. none jest domyślne, gdy nie ma narzędzi. auto jest domyślne, jeśli narzędzia są obecne.

Ten składnik może być jednym z następujących elementów:

chatCompletionNamedToolChoice

Określa narzędzie, którego model powinien używać. Używa się do wymuszenia wywołania konkretnej funkcji.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj narzędzia. Obecnie obsługiwany jest tylko `function` on. Możliwe wartości: funkcja	Tak
funkcja	obiekt		Tak

Właściwości funkcji

nazwa

Name	Typ	Opis	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.

ParallelToolCalls

Czy włączyć równoległe wywoływanie funkcji podczas użycia narzędzia.

Nie ma zdefiniowanych właściwości dla tego komponentu.

chatCompletionMessageToolCalls

Wywołania narzędzi generowane przez model, takie jak wywołania funkcji.

Nie ma zdefiniowanych właściwości dla tego komponentu.

chatCompletionFunctionCall

Wycofane i zastąpione przez tool_calls. Nazwa i argumenty funkcji, którą należy wywołać, wygenerowane przez model.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	Tak
arguments	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje poprawny JSON i może generować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.	Tak

completionUsage

Statystyki wykorzystania wniosku o zakończenie.

Name	Typ	Opis	Obowiązkowy
prompt_tokens	liczba całkowita	Liczba żetonów w promptie.	Tak
completion_tokens	liczba całkowita	Liczba tokenów w wygenerowanym ukończeniu.	Tak
total_tokens	liczba całkowita	Całkowita liczba tokenów użytych w żądaniu (prompt + zakończenie).	Tak
completion_tokens_details	obiekt	Podział tokenów używanych w zakończeniu transakcji.	No

Właściwości dla completion_tokens_details

tokeny_rozumowania

Name	Typ	Opis	Wartość domyślna
tokeny_rozumowania	liczba całkowita	Tokeny generowane przez model do rozumowania.

narzędzie do zakończenia czatu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj narzędzia. Obecnie obsługiwany jest tylko `function` on. Możliwe wartości: funkcja	Tak
funkcja	FunctionObject		Tak

Parametry funkcji

Parametry, które funkcje akceptują, są opisane jako obiekt schematu JSON. Zobacz przewodnik dla przykładów oraz odniesienie do schematu JSON dla dokumentacji formatu.

Pomijanie parameters definiuje funkcję z pustą listą parametrów.

Nie ma zdefiniowanych właściwości dla tego komponentu.

FunctionObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis tego, co funkcja robi, używany przez model do wyboru, kiedy i jak wywołać funkcję.	No
nazwa	ciąg	Nazwa funkcji, którą ma się wywołać. Musi być od A do Z, A-Z, 0-9 lub zawierać podkreślenia i kreski, a maksymalna długość to 64.	Tak
parameters	Parametry funkcji	Parametry, które funkcje akceptują, są opisane jako obiekt schematu JSON. Zobacz przewodnik dla przykładów oraz odniesienie do schematu JSON dla dokumentacji formatu. Pomijanie `parameters` definiuje funkcję z pustą listą parametrów.	No
surowy	boolean	Czy należy umożliwić ścisłe przestrzeganie schematu podczas generowania wywołania funkcji. Jeśli ustawiono na prawdę, model będzie podążał za dokładnym schematem zdefiniowanym w `parameters` polu. Obsługiwany jest tylko podzbiór schematu JSON, gdy `strict` jest .`true`	No	Nieprawda

FormatTekstuOdpowiedzi

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ definiowanego formatu odpowiedzi: `text` Możliwe wartości: tekst	Tak

FormatOdpowiedziJsonObiekt

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ definiowanego formatu odpowiedzi: `json_object` Możliwe wartości: json_object	Tak

ResponseFormatJsonSchemaSchema

Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.

Nie ma zdefiniowanych właściwości dla tego komponentu.

FormatOdpowiedziJsonSchema

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ definiowanego formatu odpowiedzi: `json_schema` Możliwe wartości: json_schema	Tak
json_schema	obiekt		Tak

Właściwości dla json_schema

opis

Name	Typ	Opis	Wartość domyślna
opis	ciąg	Opis formatu odpowiedzi, używany przez model do określenia, jak odpowiedzieć w formacie.

nazwa

Name	Typ	Opis	Wartość domyślna
nazwa	ciąg	Nazwa formatu odpowiedzi. Musi być od A do Z, A-Z, 0-9 lub zawierać podkreślenia i kreski, a maksymalna długość to 64.

schemat

Name	Typ	Opis	Wartość domyślna
schemat	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.

surowy

Name	Typ	Opis	Wartość domyślna
surowy	boolean	Czy należy umożliwić ścisłe przestrzeganie schematu podczas generowania wyniku. Jeśli ustawimy na true, model zawsze będzie podążał za dokładnym schematem zdefiniowanym `schema` w polu. Obsługiwany jest tylko podzbiór schematu JSON, gdy `strict` jest .`true`	Nieprawda

Opcja ukończenia rozmowy wspólna

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
indeks	liczba całkowita		No
powód zakończenia	ciąg		No

utwórzŻądanieTłumaczenia

Żądanie tłumaczenia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
plik	ciąg	Plik audio do tłumaczenia.	Tak
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Zadanie powinno być po angielsku.	No
format_odpowiedzi	audioResponseFormat	Definiuje format wyjścia.	No
temperatura	number	Temperatura próbkowania, między 0 a 1. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Jeśli ustawimy na 0, model będzie używał logarytmicznego prawdopodobieństwa do automatycznego podnoszenia temperatury aż do osiągnięcia określonych progów.	No	0

odpowiedź dźwiękowa

Odpowiedź na tłumaczenie lub transkrypcję, gdy response_format był json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst przetłumaczony lub przepisany.	Tak

audioVerboseResponse

Odpowiedź tłumaczeniowa lub transkrypcja, gdy response_format była verbose_json

Name	Typ	Opis	Obowiązkowy
SMS	ciąg	Tekst przetłumaczony lub przepisany.	Tak
zadanie	ciąg	Rodzaj zadania audio.	No
język	ciąg	Language.	No
duration	number	Czas trwania.	No
segments	macierz		No

audioResponseFormat

Definiuje format wyjścia.

Opis: Definiuje format wyjścia.

Typ: ciąg

Domyślnie:

Wartości enuma

JSON
SMS
srt
verbose_json
vtt

utwórzŻądanieTranskrypcji

Żądanie transkrypcji.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
plik	ciąg	Plik audio wymaga transkrypcji.	Tak
monit	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Prompt powinien odpowiadać językowi dźwięku.	No
format_odpowiedzi	audioResponseFormat	Definiuje format wyjścia.	No
temperatura	number	Temperatura próbkowania, między 0 a 1. Wyższe wartości, takie jak 0,8, sprawią, że wynik będzie bardziej losowy, podczas gdy niższe, jak 0,2, sprawią, że będzie bardziej skupiony i deterministyczny. Jeśli ustawimy na 0, model będzie używał logarytmicznego prawdopodobieństwa do automatycznego podnoszenia temperatury aż do osiągnięcia określonych progów.	No	0
język	ciąg	Język wejściowego dźwięku. Dostarczenie języka wejściowego w formacie ISO-639-1 poprawi dokładność i opóźnienia.	No

Fragment dźwiękowy

Segment transkrypcji lub tłumaczenia.

Name	Typ	Opis	Obowiązkowy
id	liczba całkowita	Identyfikator segmentu.	No
seek	number	Przesunięcie segmentu.	No
początek	number	Początek segmentu jest przesunuty.	No
end	number	Przesunięcie końca segmentu.	No
SMS	ciąg	Tekst segmentu.	No
tokens	macierz	Znaki tekstu.	No
temperatura	number	Temperatura.	No
avg_logprob	number	Średnie prawdopodobieństwo logu.	No
compression_ratio	number	Współczynnik sprężania.	No
no_speech_prob	number	Prawdopodobieństwo `no speech`.	No

imageQuality

Jakość wygenerowanego obrazu.

Opis: Jakość wygenerowanego obrazu.

Typ: ciąg

Wartość domyślna: standardowa

Nazwa enum: Quality

Wartości enuma

Wartość	Opis
standard	Standardowa jakość tworzy obrazy o standardowej jakości.
HD	Jakość HD tworzy obrazy z drobniejszymi detalami i większą spójnością na całym obrazie.

imagesResponseFormat

Format, w którym zwracane są wygenerowane obrazy.

Opis: Format, w którym zwracane są wygenerowane obrazy.

Typ: ciąg

Ustawienie domyślne: adres URL

Nazwa enum: ImagesResponseFormat

Wartości enuma

Wartość	Opis
Adres url	URL umożliwiający tymczasowy dostęp do pobrania wygenerowanych obrazów.
b64_json	Wygenerowane obrazy są zwracane jako łańcuch zakodowany w base64.

imageSize

Rozmiar wygenerowanych obrazów.

Opis: Rozmiar wygenerowanych obrazów.

Typ: ciąg

Ustawienie domyślne: 1024x1024

Nazwa enum: Rozmiar

Wartości enuma

Wartość	Opis
1792x1024	Pożądany rozmiar wygenerowanego obrazu to 1792x1024 pikseli.
1024x1792	Pożądany rozmiar wygenerowanego obrazu to 1024x1792 pikseli.
1024x1024	Pożądany rozmiar wygenerowanego obrazu to 1024x1024 pikseli.

imageStyle

Styl generowanych obrazów.

Opis: Styl generowanych obrazów.

Typ: ciąg

Ustawienie domyślne: żywe

Nazwa enum: Styl

Wartości enuma

Wartość	Opis
żywy	Vivid tworzy obrazy hiperrealistyczne i dramatyczne.
naturalny	Naturalność tworzy obrazy bardziej naturalne i mniej hiperrealistyczne.

żądanieGeneracjiObrazów

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
monit	ciąg	Tekstowy opis pożądanego obrazu(ów). Maksymalna długość to 4 000 znaków.	Tak
n	liczba całkowita	Liczba obrazów do wygenerowania.	No	1
size	imageSize	Rozmiar wygenerowanych obrazów.	No	1024x1024
format_odpowiedzi	imagesResponseFormat	Format, w którym zwracane są wygenerowane obrazy.	No	Adres url
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No
jakość	imageQuality	Jakość wygenerowanego obrazu.	No	standard
styl	imageStyle	Styl generowanych obrazów.	No	żywy

generateImagesResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
utworzone	liczba całkowita	Znacznik czasu uniksa w momencie utworzenia operacji.	Tak
dane	macierz	Dane wynikowe operacji, jeśli się powiedzą	Tak

wynikObrazu

URL obrazu lub zakodowany obraz, jeśli się powiedzie, a w przeciwnym razie pojawia się błąd.

Name	Typ	Opis	Obowiązkowy
Adres url	ciąg	URL obrazu.	No
b64_json	ciąg	Obraz zakodowany w base64	No
content_filter_results	Wyniki filtru treści DALL-E	Informacje o wynikach filtrowania treści.	No
(revised_prompt remains unchanged, assuming it is a placeholder requiring no translation or adaptation)	ciąg	Prompt, który został użyty do wygenerowania obrazu, jeśli nastąpiła jakaś poprawka w poleceniu.	No
prompt_filter_results	dalleFilterResults	Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o treściach jailbreakowych i przekleństwach, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.	No

Rozszerzenia uzupełniania

Rozszerzenia dopełnień nie są częścią najnowszej wersji GA specyfikacji inferencji Azure OpenAI data plane.

Wiadomość czatu

Obiekt wiadomości Chat nie jest częścią najnowszej wersji GA specyfikacji inferencji Azure OpenAI data plane.

Zamiana tekstu na mowę (Zapowiedź)

Obecnie nie jest częścią najnowszej wersji Azure OpenAI GA specyfikacji wnioskowania Azure płaszczyzny danych OpenAI. Dla tej możliwości można odnieść się do najnowszej wersji preview tej możliwości.

Następne kroki

Dowiedz się o modelach i dopracowywaniu z API REST. Dowiedz się więcej na temat modeli underlying, które zasilają Azure OpenAI.

Opinia

Czy ta strona była pomocna?

Last updated on 2026-05-20