Azure OpenAI in Microsoft Foundry Models REST API preview

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 obejmuje wersję podglądową 2025-04-01-preview specyfikacji wnioskowania Azure płaszczyzny danych OpenAI.

Jeśli szukasz dokumentacji najnowszej wersji interfejsu API ga, zapoznaj się z najnowszym interfejsem API wnioskowania płaszczyzny danych ogólnie dostępnego.

Ukończenia - Stwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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 znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
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_ofkontroluje liczbę kandydatów na uzupełnienia i określa, n ile z nich 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 to bias jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt różni się 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 zwraca listę 5 najbardziej prawdopodobnych tokenów. API zawsze zwraca , logprob z tokena próbkowanym, 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
monit	ciąg lub tablica	Prompt do generowania uzupełnień zakodowanych 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 generuje się tak, jakby od początku nowego dokumentu.	Tak
seed	liczba całkowita	Jeśli jest to określone, nasz system podejmuje najlepsze starania, aby próbkować deterministyczne, tak aby powtarzające się żądania z tymi samymi seed parametrami i powinny zwracać 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 są wysyłane jako zdarzenia wysyłane tylko na serwer z danymi, gdy tylko stają się dostępne, a strumień kończy się wiadomością data: [DONE] . Przykład Python kod.	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, jak 0,8, sprawiają, że wynik jest bardziej losowy, podczas gdy niższe, jak 0,2, jest 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

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=2025-04-01-preview

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

Osadzenia - Utwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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 znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
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
encoding_format	ciąg	Format, w którym zwraca się osadzenia. Może być albo albo floatbase64. Domyślnie przyjmuje .float	No
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
typ_wprowadzenia	ciąg	Typ wyszukiwania osadzonego wejściowego do wykorzystania	No
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

Responses

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=2025-04-01-preview

{
 "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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Ukończenie czatu - Stwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Tworzy zakończenie wiadomości czatu

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
audio	obiekt	Parametry wyjścia audio. Wymagane, gdy żądane jest wyjście audio z .modalities: ["audio"]	No
Format └─	wyliczenie	Określa format wyjściowego dźwięku. Musi być jednym z wav, mp3, flac, opus, lub pcm16. Możliwe wartości: wav, mp3, flac, , opuspcm16	No
└─ głos	wyliczenie	Określa typ głosu. Głosy wspierane to alloy, echo, fable, onyx, nova, oraz .shimmer Możliwe wartości: alloy, echo, fable, , onyx, nova, shimmer	No
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
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
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
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 to bias jest dodawane do logitów generowanych przez model przed próbkowaniem. Dokładny efekt różni się 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
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
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
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
messages	macierz	Lista wiadomości składających się na dotychczasową rozmowę. Przykład Python kod.	Tak
metadane	obiekt	Tagi i wartości definiowane przez dewelopera używane do filtrowania zakończeń w pulpicie z przechowywanymi kompletacjami.	No
Sposoby	ChatCompletionModalities	Typy wyników, które model chciałby wygenerować dla tego żądania. Większość modeli potrafi generować tekst, co jest domyślne: ["text"] Model ten gpt-4o-audio-preview może być również używany do generowania dźwięku. Aby poprosić ten model o generowanie zarówno odpowiedzi tekstowych, jak i audio, możesz użyć: ["text", "audio"]	No
n	liczba całkowita	Ile opcji uzupełniania czatu wygenerować dla każdej wiadomości wejściowej. Opłata będzie zależana 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
przewidywanie	PredictionContent	Konfiguracja dla przewidywanego wyjścia, która może znacznie poprawić czas reakcji, gdy duże części odpowiedzi modelu są znane z wyprzedzeniem. Najczęściej dzieje się to przy regeneracji pliku z jedynie drobnymi zmianami w większości treści.	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
wysiłek rozumowania	wyliczenie	Tylko modele O1 Ogranicza wysiłek związany z rozumowaniem dla modeli rozumowania. Obecnie obsługiwane wartości to low, medium, oraz high. Zmniejszenie wysiłku rozumowania może skutkować szybszymi odpowiedziami i mniejszą liczbą tokenów używanych do rozumowania w odpowiedzi. Możliwe wartości: low, medium, high	No
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": {...} } aktywne Structured Outputs, które gwarantują, że model odpowiada 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 jest to określone, nasz system podejmuje najlepsze starania, aby próbkować deterministyczne, tak aby powtarzające się żądania z tymi samymi seed parametrami i powinny zwracać 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 4 sekwencji, w których API przestaje generować kolejne tokeny.	No
przechowywać	boolean	Czy przechowywać wynik tego żądania zakończenia czatu do wykorzystania w naszych produktach do destylacji lub oceny modelu.	No
odtwarzać strumieniowo	boolean	Jeśli jest ustawiona, wysyłane są częściowe delta wiadomości, jak w ChatGPT. Tokeny są wysyłane jako zdarzenia wysyłane wyłącznie przez serwer za pośrednictwem danych, gdy tylko stają się dostępne, a strumień kończy się wiadomością data: [DONE] . Przykład Python kod.	No	Nieprawda
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi na streaming. Ustawiam to tylko wtedy, gdy ustawiasz stream: true.	No	Żadne
temperatura	number	Jakiej temperatury próbkowania użyć, między 0 a 2. Wyższe wartości, jak 0,8, sprawiają, że wynik jest bardziej losowy, podczas gdy niższe, jak 0,2, jest bardziej skupiony i deterministyczny. Zazwyczaj zalecamy modyfikację tego lub top_p nie obu tych rzeczy.	No	1
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
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
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
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
user_security_context	userSecurityContext	Kontekst bezpieczeństwa użytkownika zawiera kilka parametrów opisujących samą aplikację AI oraz użytkownika końcowego, który z nią wchodzi. Te obszary pomagają zespołom operacji bezpieczeństwa badać i ograniczać incydenty bezpieczeństwa, oferując kompleksowe podejście do ochrony aplikacji AI. Dowiedz się więcej o ochronie aplikacji AI za pomocą Microsoft Defender dla Chmury.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	obiekt

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=2025-04-01-preview

{
 "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=2025-04-01-preview

{
 "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 kompletację na podstawie danych wektorowych obrazów z Azure Search.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "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=2025-04-01-preview

{
 "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=2025-04-01-preview

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

Przykład

Tworzy kompletację dla dostarczonego pliku Mongo DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "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
    }
  }
}

Przykład

Tworzy uzupełnienie dla dostarczonego Elasticsearch.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

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 kompletację dla dostarczonego zasobu Pinecone.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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=2025-04-01-preview

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 znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
model	ciąg	Identyfikacja modelu, którego należy użyć. Opcje to gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1, oraz .gpt-4o-transcribe-diarize	Tak
plik	ciąg	Plik audio wymaga transkrypcji.	Tak
język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 poprawia dokładność i opóźnienia.	No
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 ją na 0, model wykorzystuje logarytmiczne prawdopodobieństwo do automatycznego podnoszenia temperatury aż do osiągnięcia określonych progów.	No	0
timestamp_granularities[]	macierz	Szczegóły dotyczące znaczników czasowych do wypełnienia dla tej transkrypcji. response_format musi być ustawiony verbose_json tak, aby używać szczegółowości znaczników czasu. Obsługiwane są te opcje lub obie: word, lub segment. Uwaga: Nie ma dodatkowego opóźnienia dla znaczników czasu segmentów, ale generowanie znaczników czasu słów powoduje dodatkowe opóźnienia.	No	['segment']

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	obiekt
text/plain	ciąg	Przepisany tekst w formacie wyjściowym (gdy response_format był jednym z text, 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=2025-04-01-preview

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=2025-04-01-preview

"---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=2025-04-01-preview

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 znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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 ją na 0, model wykorzystuje logarytmiczne prawdopodobieństwo 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	obiekt
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=2025-04-01-preview

"---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=2025-04-01-preview

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

Mowa - Stwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Generuje dźwięk z tekstu wejściowego.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
dane wejściowe	ciąg	Tekst do syntezy dźwięku. Maksymalna długość to 4 096 znaków.	Tak
format_odpowiedzi	wyliczenie	Format do syntezy dźwięku. Możliwe wartości: mp3, opus, aac, , flac, wav, pcm	No
Prędkość	number	Szybkość syntetycznego dźwięku. Wybierz wartość z 0.25 do .4.0 1.0 jest domyślna.	No	1.0
voice	wyliczenie	Głos do syntezy mowy. Możliwe wartości: alloy, echo, fable, , onyx, nova, shimmer	Tak

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/octet-stream	ciąg

Examples

Przykład

Syntetyzuje dźwięk z dostarczonego tekstu.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Odpowiedzi: Kod statusu: 200

{
  "body": "101010101"
}

Generowanie obrazów - Stwórz

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Generuje partię obrazów z podpisu tekstowego przy wdrożeniu modelu generowania obrazów

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
tło	imageBackground	Pozwala ustawić przezroczystość tła wygenerowanych obrazów. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1.	No	samochód
n	liczba całkowita	Liczba obrazów do wygenerowania. Dla dall-e-3 obsługiwane jest tylko n=1.	No	1
kompresja wyjściowa	liczba całkowita	Poziom kompresji (0-100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1 z formatem wyjściowym jpeg.	No	100
format_wyjściowy	imagesOutputFormat	Format pliku, w którym zwracane są wygenerowane obrazy. Obsługiwane tylko dla modeli z serii gpt-image-1.	No	png
monit	ciąg	Tekstowy opis pożądanego obrazu(ów). Maksymalna długość to 32000 znaków dla serii gpt-image-1 i 4000 znaków dla dall-e-3	Tak
częściowe_obrazy	liczba całkowita	Liczba częściowych obrazów do wygenerowania. Ten parametr jest używany do strumieniowania odpowiedzi, które zwracają częściowe obrazy. Wartość musi mieścić się między 0 a 3. Po ustawieniu na 0 odpowiedź będzie pojedynczym obrazem wysłanym w jednym zdarzeniu streamingowym. Należy zauważyć, że ostateczny obraz może zostać wysłany przed wygenerowaniem pełnej liczby częściowych obrazów, jeśli pełny obraz zostanie wygenerowany szybciej.	0
odtwarzać strumieniowo	boolean	Edytuj obraz w trybie streamingu.	nie	false
jakość	imageQuality	Jakość wygenerowanego obrazu.	No	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym zwracane są wygenerowane obrazy. Ten parametr nie jest obsługiwany dla gpt-image-1modeli serii -series, które zawsze zwracają obrazy kodowane w base64. Możliwe wartości: url, b64_json.	No	Adres url
size	imageSize	Rozmiar wygenerowanych obrazów.	No	samochód
styl	imageStyle	Styl generowanych obrazów. Obsługiwane tylko dla dall-e-3.	No	żywy
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	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=2025-04-01-preview

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Generowanie obrazów - Edytuj

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Edytuje obraz z podpisu tekstowego przy danym wdrożeniu modelu gpt-image-1

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
obraz	ciąg lub tablica	Obraz(y) do edycji. Musi to być wspierany plik obrazów lub tablica obrazów. Każdy obraz powinien mieć format png, czyli plik jpg mniejszy niż 50MB.	Tak
input_fidelity	ciąg	Kontroluj, ile wysiłku model włoży, aby dopasować styl i cechy, zwłaszcza rysy twarzy, do obrazów wejściowych. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1. Podpory high i low.	nie	low.
maska	ciąg	Dodatkowy obraz, którego w pełni przezroczyste obszary (np. gdzie alfa wynosi zero) wskazują, gdzie należy edytować obraz. Jeśli podano wiele obrazów, maska zostanie nałożona na pierwszy obraz. Musi to być poprawny plik PNG, mniejszy niż 4MB i mieć takie same wymiary jak obraz.	No
n	liczba całkowita	Liczba obrazów do wygenerowania. Musi być między 1 a 10.	No	1
monit	ciąg	Tekstowy opis pożądanego obrazu(ów). Maksymalna długość to 32000 znaków.	Tak
jakość	imageQuality	Jakość wygenerowanego obrazu.	No	samochód
częściowe_obrazy	Liczba częściowych obrazów do wygenerowania. Ten parametr jest używany do strumieniowania odpowiedzi, które zwracają częściowe obrazy. Wartość musi mieścić się między 0 a 3. Po ustawieniu na 0 odpowiedź będzie pojedynczym obrazem wysłanym w jednym zdarzeniu streamingowym. Należy zauważyć, że ostateczny obraz może zostać wysłany przed wygenerowaniem pełnej liczby częściowych obrazów, jeśli pełny obraz zostanie wygenerowany szybciej.
odtwarzać strumieniowo	boolean	Edytuj obraz w trybie streamingu.	nie	false
format_odpowiedzi	imagesResponseFormat	Format, w którym zwracane są wygenerowane obrazy.	No	Adres url
size	imageSize	Rozmiar wygenerowanych obrazów.	No	samochód
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	generateImagesResponse

Kod statusu: domyślny

Opis: Wystąpił błąd.

Typ zawartości	Typ	Opis
application/json	dalleErrorResponse

Lista - Asystenci

Note

API Asystentów jest wycofane i zostanie wycofane 26 sierpnia 2026 roku. Korzystaj z powszechnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować swoje obciążenia. Dowiedz się więcej.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Zwraca listę asystentów.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listAssistantsResponse

Examples

Przykład

Zwraca listę asystentów.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Stwórz - Asystent

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Stwórz asystenta z modelem i instrukcjami.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	No
instructions	ciąg	System instruuje asystenta. Maksymalna długość to 256 000 znaków.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg		Tak
nazwa	ciąg	Imię asystenta. Maksymalna długość to 256 znaków.	No
format_odpowiedzi	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
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.	No	1
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorów przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
└─ przechowalnie_wektorów	macierz	Pomocnik do utworzenia magazynu wektorowego za pomocą file_ids i dołączenia go do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Lista narzędzi włączonych na asystencie. Maksymalnie 128 narzędzi na asystenta może być przeznaczonych. Narzędzia mogą mieć typy code_interpreter, retrieval, lub function.	No	[]
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	assistantObject

Examples

Przykład

Stwórz asystenta z modelem i instrukcjami.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Pobierz - Asystent

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odzyskuje asystenta.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
assistant_id	ścieżka	Tak	ciąg	Identyfikacja asystenta do odzyskania.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	assistantObject

Examples

Przykład

Odzyskuje asystenta.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modyfikacja - Asystent

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Modyfikuje asystenta.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
assistant_id	ścieżka	Tak	ciąg	Identyfikacja asystenta do modyfikacji.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	No
instructions	ciąg	System instruuje asystenta. Maksymalna długość to 32768 znaków.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg		No
nazwa	ciąg	Imię asystenta. Maksymalna długość to 256 znaków.	No
format_odpowiedzi	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
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.	No	1
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Nadpisuje listę identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	To nadpisuje wektorowy magazyn przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Lista narzędzi włączonych na asystencie. Maksymalnie 128 narzędzi na asystenta może być przeznaczonych. Narzędzia mogą mieć typy code_interpreter, retrieval, lub function.	No	[]
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	assistantObject

Examples

Przykład

Modyfikuje asystenta.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Usuń - Asystent

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Usuń asystenta.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
assistant_id	ścieżka	Tak	ciąg	ID asystenta do usunięcia.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	deleteAssistantResponse

Examples

Przykład

Usuwa asystenta.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Stwórz - Wątek

Note

API Asystentów jest wycofane i zostanie wycofane 26 sierpnia 2026 roku. Korzystaj z powszechnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować swoje obciążenia. Dowiedz się więcej.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Załóż wątek.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
messages	macierz	Lista wiadomości, od których warto zacząć wątek.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
tool_resources	obiekt	Zestaw zasobów dostępnych dla narzędzi asystenta w tym wątku. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorowy dołączony do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No
└─ przechowalnie_wektorów	macierz	Pomocnik do stworzenia magazynu wektorowego z file_ids i dołączenia go do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	threadObject

Examples

Przykład

Tworzy wątek.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Pobierz — wątek

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Pobiera wątek.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku do pobrania.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	threadObject

Examples

Przykład

Pobiera wątek.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modyfikacja - Wątek

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Modyfikuje wątek.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku do modyfikacji. Tylko one metadata mogą być modyfikowane.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
tool_resources	obiekt	Zestaw zasobów dostępnych dla narzędzi asystenta w tym wątku. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorowy dołączony do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	threadObject

Examples

Przykład

Modyfikuje wątek.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Usuń - Wątek

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Usuń wątek.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku do usunięcia.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	deleteThreadResponse

Examples

Przykład

Usuwa wątek.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Lista - Wiadomości

Note

API Asystentów jest wycofane i zostanie wycofane 26 sierpnia 2026 roku. Korzystaj z powszechnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować swoje obciążenia. Dowiedz się więcej.

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Zwraca listę wiadomości dla danego wątku.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątków, do których należą te wiadomości.
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
run_id	kwerenda	No	ciąg	Filtruj wiadomości według identyfikatora uruchomienia, który je wygenerował.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listMessagesResponse

Examples

Przykład

Lista komunikatów

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Stwórz - Wiadomość

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Stwórz wiadomość.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątków, dla których należy utworzyć wiadomość.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzi, do których powinny zostać dodane.	No
zawartość	ciąg	Treść wiadomości.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
rola	ciąg	Rola podmiotu, który tworzy przekaz. Dozwolone wartości obejmują: - user: Oznacza, że wiadomość została wysłana przez rzeczywistego użytkownika i powinna być w większości przypadków używana do reprezentowania wiadomości generowanych przez użytkowników. - assistant: Oznacza, że wiadomość jest generowana przez asystenta. Użyj tej wartości, aby wstawić wiadomości od asystenta do rozmowy.	Tak

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	messageObject

Examples

Przykład

Stwórz wiadomość.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Pobierz - Wiadomość

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Pobierz wiadomość.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątków, do których należy ta wiadomość.
message_id	ścieżka	Tak	ciąg	ID wiadomości do pobrania.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	messageObject

Examples

Przykład

Pobierz wiadomość.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Zmodyfikuj - Wiadomość

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Modyfikuje wiadomość.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku, do którego należy ta wiadomość.
message_id	ścieżka	Tak	ciąg	ID wiadomości do modyfikacji.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	messageObject

Examples

Przykład

Zmodyfikuj wiadomość.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Stwórz - Wątkaj i Uruchom

Note

API Asystentów jest wycofane i zostanie wycofane 26 sierpnia 2026 roku. Korzystaj z powszechnie dostępnej usługi Microsoft Foundry Agents. Postępuj zgodnie z przewodnikiem migracji , aby zaktualizować swoje obciążenia. Dowiedz się więcej.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Stwórz wątek i uruchom go w jednym żądaniu.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
assistant_id	ciąg	ID asystenta, którego należy użyć do wykonania tego przebiegu.	Tak
instructions	ciąg	Nadpisz domyślny komunikat systemowy asystenta. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które można użyć w trakcie trwania rozgrywki. Run stara się używać tylko określonej liczby tokenów ukończenia przez kilka tur rozgrywki. Jeśli przebieg przekroczy podaną liczbę tokenów ukończenia, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów promptów, które można użyć w trakcie trwania biegu. Run stara się używać tylko określonej liczby tokenów promptu przez kilka tur rozgrywki. Jeśli przebieg przekroczy określoną liczbę tokenów promptu, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg	ID modeli, które mają zostać użyte do wykonania tego przebiegu. Jeśli tutaj podana jest wartość, zostanie ona nadpisana przez model powiązany z asystentem. Jeśli nie, zostanie użyty model powiązany z asystentem.	No
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	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
odtwarzać strumieniowo	boolean	Jeśli true, zwraca strumień zdarzeń, które mają miejsce podczas Run jako zdarzenia wysyłane przez serwer, kończąc się, gdy Run wchodzi w stan terminalowy z wiadomością data: [DONE] .	No
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi na streaming. Ustawiam to tylko wtedy, gdy ustawiasz stream: true.	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.	No	1
konwersacja	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none Oznacza to, że model nie wywołuje żadnych narzędzi, lecz generuje wiadomość. auto jest wartością domyślną i oznacza, że model może wybrać między generowaniem wiadomości a wywołaniem narzędzia. Określenie konkretnego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymuszanie wywołania tego narzędzia, wymusza model.	No
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Identyfikator magazynu wektorów przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Nadpisz narzędzia, których asystent może użyć w tym biegu. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1
truncation_strategy	obcięcie obiektuObject	Kontrole dotyczące tego, jak wątek zostanie obcięty przed uruchomieniem. Użyj tego do kontrolowania początkowego okna kontekstu przebiegu.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runObject

Examples

Przykład

Stwórz wątek i uruchom go w jednym żądaniu.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Lista - Biegi

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Zwraca listę przebiegów należących do wątku.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku, do którego należy ten przebieg.
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listRunsResponse

Examples

Przykład

Zwraca listę przebiegów należących do wątku.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Stwórz - Uciekaj

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Stwórz bieg.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku do uruchomienia.
include[]	kwerenda	No	macierz	Lista dodatkowych pól do uwzględnienia w odpowiedzi. Obecnie jedyną obsługiwaną wartością step_details.tool_calls[*].file_search.results[*].content jest pobieranie wyników wyszukiwania plików.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
additional_instructions	ciąg	Dodaje dodatkowe instrukcje na końcu instrukcji dotyczących przebiegu. Jest to przydatne do modyfikacji zachowania na każdy bieg bez nadpisywania innych instrukcji.	No
additional_messages	macierz	Dodaje dodatkowe wiadomości do wątku przed utworzeniem uruchomienia.	No
assistant_id	ciąg	ID asystenta, którego należy użyć do wykonania tego przebiegu.	Tak
instructions	ciąg	Nadpisz domyślny komunikat systemowy asystenta. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które można użyć w trakcie trwania rozgrywki. Run stara się używać tylko określonej liczby tokenów ukończenia przez kilka tur rozgrywki. Jeśli przebieg przekroczy podaną liczbę tokenów ukończenia, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów promptów, które można użyć w trakcie trwania biegu. Run stara się używać tylko określonej liczby tokenów promptu przez kilka tur rozgrywki. Jeśli przebieg przekroczy określoną liczbę tokenów promptu, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg	ID Modelu użytego do wykonania tego przebiegu. Jeśli tutaj podana jest wartość, zostanie ona nadpisana przez model powiązany z asystentem. Jeśli nie, zostanie użyty model powiązany z asystentem.	No
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	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
odtwarzać strumieniowo	boolean	Jeśli true, zwraca strumień zdarzeń, które mają miejsce podczas Run jako zdarzenia wysyłane przez serwer, kończąc się, gdy Run wchodzi w stan terminalowy z wiadomością data: [DONE] .	No
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.	No	1
tool_choice	assistantsApiToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none Oznacza to, że model nie wywołuje żadnych narzędzi, lecz generuje wiadomość. auto jest wartością domyślną i oznacza, że model może wybrać między generowaniem wiadomości a wywołaniem narzędzia. Określenie konkretnego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymuszanie wywołania tego narzędzia, wymusza model.	No
Narzędzia	macierz	Nadpisz narzędzia, których asystent może użyć w tym biegu. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1
truncation_strategy	obcięcie obiektuObject	Kontrole dotyczące tego, jak wątek zostanie obcięty przed uruchomieniem. Użyj tego do kontrolowania początkowego okna kontekstu przebiegu.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runObject

Examples

Przykład

Stwórz bieg.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Uciekaj - Uciekaj

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Odzyskuje bieg.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątków, które zostały uruchomione.
run_id	ścieżka	Tak	ciąg	Identyfikacja biegu do odzyskania.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runObject

Examples

Przykład

Dostaje bieg.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Modyfikacja - Uruchom

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Modyfikuje rozgrywkę.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątków, które zostały uruchomione.
run_id	ścieżka	Tak	ciąg	ID biegu do modyfikacji.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runObject

Examples

Przykład

Modyfikuje rozgrywkę.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Submit - Narzędzia do uruchomienia

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Gdy uruchomienie ma i status: "requires_action"required_action.type jest , submit_tool_outputsten punkt końcowy może być użyty do przesłania wyników wywołań narzędzi po ich zakończeniu wszystkim. Wszystkie wyniki muszą być przesłane w jednym żądaniu.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątków, do których należy ten przebieg.
run_id	ścieżka	Tak	ciąg	ID serii, która wymaga przesłania wyjścia narzędzia.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
odtwarzać strumieniowo	boolean	Jeśli true, zwraca strumień zdarzeń, które mają miejsce podczas Run jako zdarzenia wysyłane przez serwer, kończąc się, gdy Run wchodzi w stan terminalowy z wiadomością data: [DONE] .	No
tool_outputs	macierz	Lista narzędzi, dla których przesyłane są wyniki.	Tak

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runObject

Examples

Przykład

Gdy uruchomienie ma i status: "requires_action"required_action.type jest , submit_tool_outputsten punkt końcowy może być użyty do przesłania wyników wywołań narzędzi po ich zakończeniu wszystkim. Wszystkie wyniki muszą być przesłane w jednym żądaniu.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Anuluj - Uciekaj

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Anuluje przebieg, który jest .in_progress

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku, do którego należy ten przebieg.
run_id	ścieżka	Tak	ciąg	Identyfikator biegu do odwołania.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runObject

Examples

Przykład

Anuluje przebieg, który jest .in_progress

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Lista - Run Steps

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Zwraca listę kroków przebiegu należących do przebiegu.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku, do którego należą kroki run i run.
run_id	ścieżka	Tak	ciąg	ID biegu, do którego należą te kroki.
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
wersja API	kwerenda	Tak	ciąg
include[]	kwerenda	No	macierz	Lista dodatkowych pól do uwzględnienia w odpowiedzi. Obecnie jedyną obsługiwaną wartością step_details.tool_calls[*].file_search.results[*].content jest pobieranie wyników wyszukiwania plików.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listRunStepsResponse

Examples

Przykład

Zwraca listę kroków przebiegu należących do przebiegu.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Pobieranie — krok uruchamiania

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Odzyskuje krok biegu.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
thread_id	ścieżka	Tak	ciąg	ID wątku, do którego należy krok run i run.
run_id	ścieżka	Tak	ciąg	ID serii, do której należy ten krok.
step_id	ścieżka	Tak	ciąg	ID kroku biegu do pobrania.
include[]	kwerenda	No	macierz	Lista dodatkowych pól do uwzględnienia w odpowiedzi. Obecnie jedyną obsługiwaną wartością step_details.tool_calls[*].file_search.results[*].content jest pobieranie wyników wyszukiwania plików.
wersja API	kwerenda	Tak	ciąg

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	runStepObject

Examples

Przykład

Odzyskuje krok biegu.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Lista - Sklepy Wektorowe

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Zwraca listę zapisów wektorowych.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listVectorStoresResponse

Examples

Przykład

Zwraca listę zapisów wektorowych.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Utwórz - Vector Store

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Stwórz magazyn wektorów.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
chunking_strategy	autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto . Dotyczy tylko wtedy, gdy file_ids jest niepusty.	No
wygasa po	vectorStoreExpirationAfter	Polityka wygaśnięcia sklepu wektorowego.	No
identyfikatory_plików	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorowy. Przydatne do takich narzędzi file_search do dostępu do plików.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
nazwa	ciąg	Nazwa magazynu wektorowego.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreObject

Examples

Przykład

Tworzy magazyn wektorowy.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Pobierz - Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odzyskuje zapis wektorowy.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID magazynu wektorowego do pobrania.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreObject

Examples

Przykład

Odzyskuje zapis wektorowy.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modyfikuj — magazyn wektorów

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Modyfikuje magazyn wektorów.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID zapisu wektorowego do modyfikacji.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
wygasa po	vectorStoreExpirationAfter	Polityka wygaśnięcia sklepu wektorowego.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
nazwa	ciąg	Nazwa magazynu wektorowego.	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreObject

Examples

Przykład

Modyfikuje magazyn wektorów.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Usuń - Vector Store

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Usuń magazyn wektorowy.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID wektorowego zapisu do usunięcia.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	deleteVectorStoreResponse

Examples

Przykład

Usuwa magazyn wektorowy.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Lista - pliki pamięci wektorowej

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Zwraca listę plików pamięci wektorowej.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID pamięci wektorowej, do której należą pliki.
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
filtr	kwerenda	No	ciąg Możliwe wartości: in_progress, completed, , failedcancelled	Filtruj według statusu pliku. Jeden z in_progress, , , completed. failedcancelled
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listVectorStoreFilesResponse

Examples

Przykład

Zwraca listę plików pamięci wektorowej.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Utwórz - plik pamięci wektorowej

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Utwórz plik pamięci wektorowej, dołączając plik do magazynu wektorowego.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID wektorowego zapisu, dla którego należy utworzyć plik.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
chunking_strategy	fragmentingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto .	No
identyfikator_pliku	ciąg	Identyfikator pliku, którego powinien używać magazyn wektorowy. Przydatne do takich narzędzi file_search do dostępu do plików.	Tak

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreFileObject

Examples

Przykład

Utwórz plik pamięci wektorowej, dołączając plik do magazynu wektorowego.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Pobierz - plik pamięci wektorowej

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Pobiera plik pamięci wektorowej.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID magazynu wektorowego, do którego należy plik.
identyfikator_pliku	ścieżka	Tak	ciąg	Identyfikacja pliku pobieranego.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreFileObject

Examples

Przykład

Pobiera plik pamięci wektorowej.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Usuń - plik pamięci wektorowej

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Usuń plik pamięci wektorowej. To usunie plik z pamięci wektorowej, ale sam plik nie zostanie usunięty. Aby usunąć plik, użyj endpointu usuwania plików.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID magazynu wektorowego, do którego należy plik.
identyfikator_pliku	ścieżka	Tak	ciąg	ID pliku do usunięcia.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	deleteVectorStoreFileResponse

Examples

Przykład

Usuń plik pamięci wektorowej. To usunie plik z pamięci wektorowej, ale sam plik nie zostanie usunięty. Aby usunąć plik, użyj endpointu usuwania plików.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Aktualizuj atrybuty w pliku pamięci wektorowej.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID wektorowego przechowywania, do którego należy plik.
identyfikator_pliku	ścieżka	Tak	ciąg	ID pliku do aktualizacji atrybutów.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
attributes	VectorStoreFileAttributes	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości boole lub liczby.	Tak

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreFileObject

Pobieranie wektorowego przechowywania zawartości pliku

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Pobierz przeanalizowaną zawartość pliku pamięci wektorowej.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID magazynu wektorowego.
identyfikator_pliku	ścieżka	Tak	ciąg	ID pliku w magazynie wektorowym.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	VectorStoreFileContentResponse

Wyszukiwanie w pamięci wektorowej

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Przeszukaj magazyn wektorowy pod kątem odpowiednich fragmentów na podstawie filtra zapytań i atrybutów pliku.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID wektora do wyszukiwania.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
filters	ComparisonFilter lub CompoundFilter	Filtr do stosowania na podstawie atrybutów pliku.	No
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna mieścić się w zakresie od 1 do 50 włącznie.	No	10
kwerenda	ciąg lub tablica	Ciąg zapytania do wyszukiwania	Tak
opcje rankingu	obiekt	Opcje rankingu w wyszukiwarce.	No
└} ranker	wyliczenie	Możliwe wartości: auto, default-2024-11-15	No
└─ próg_punktowy	number		No	0
rewrite_query	boolean	Czy przepisać zapytanie w języku naturalnym dla wyszukiwania wektorowego.	No	Nieprawda

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	VectorStoreSearchResultsPage

Stwórz - Partia plików Vector Store

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Utwórz partię plików do pamięci wektorowej.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID magazynu wektorowego, dla którego należy utworzyć File Batch.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
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
chunking_strategy	fragmentingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto .	No
identyfikatory_plików	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorowy. Przydatne do takich narzędzi file_search do dostępu do plików.	Tak

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreFileBatchObject

Examples

Przykład

Utwórz partię plików do pamięci wektorowej.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Odpowiedzi: Kod statusu: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Pobierz - Partia plików Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Pobiera partię plików z pamięci wektorowej.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID pamięci wektorowej, do której należy partia plików.
batch_id	ścieżka	Tak	ciąg	ID pobieranej partii plików.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreFileBatchObject

Examples

Przykład

Pobiera partię plików z pamięci wektorowej.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Anuluj - Partia plików pamięci wektorowej

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Anuluj partię plików z pamięci wektorowej. Próbuje to jak najszybciej anulować przetwarzanie plików w tej partii.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID pamięci wektorowej, do której należy partia plików.
batch_id	ścieżka	Tak	ciąg	ID partii plików do anulowania.
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	vectorStoreFileBatchObject

Examples

Przykład

Anuluj partię plików z pamięci wektorowej. Próbuje to jak najszybciej anulować przetwarzanie plików w tej partii.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Lista - pliki wsadowe Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Zwraca listę plików pamięci wektorowej w partii.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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_magazynu_wektorów	ścieżka	Tak	ciąg	ID pamięci wektorowej, do której należą pliki.
batch_id	ścieżka	Tak	ciąg	ID partii plików, do której należą te pliki.
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Sortuj kolejność według znacznika created_at czasu obiektów. asc dla kolejności rosnącej i desc malejącej.
Po	kwerenda	No	ciąg	Kursor do użycia w paginacji. after to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.
przed	kwerenda	No	ciąg	Kursor do użycia w paginacji. before to identyfikator obiektu, który definiuje twoje miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów, zaczynając od obj_foo, kolejne wywołanie może zawierać zanim=obj_foo, aby pobrać poprzednią stronę listy.
filtr	kwerenda	No	ciąg Możliwe wartości: in_progress, completed, , failedcancelled	Filtruj według statusu pliku. Jeden z in_progress, , , completed. failedcancelled
wersja API	kwerenda	Tak	ciąg	wersja interfejsu API

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	listVectorStoreFilesResponse

Examples

Przykład

Zwraca listę plików pamięci wektorowej.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Odpowiedzi: Kod statusu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Utwórz - Sesja w czasie rzeczywistym

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Stwórz efemeryczny token API do użycia w aplikacjach po stronie klienta z API czasu rzeczywistego. Można skonfigurować z tymi samymi parametrami sesji co zdarzenie session.update klienta. Odpowiada obiektem sesji oraz kluczem client_secret zawierającym użyteczny, efemeryczny token API, który może być używany do uwierzytelniania klientów przeglądarki dla API czasu rzeczywistego.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
input_audio_format	wyliczenie	Format dźwięku wejściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw. Dla pcm16, dźwięk wejściowy musi być 16-bitowy PCM przy częstotliwości próbkowania 24kHz, jednokanałowy (mono) i w rzędzie bajtów little-endian. Możliwe wartości: pcm16, g711_ulaw, g711_alaw	No
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumów audio wejściowych. Można to ustawić na null wyłączenie. Redukcja szumów filtruje dźwięk dodawany do bufora audio wejściowego przed wysłaniem do VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i skrętów (zmniejszając liczbę fałszywych alarmów) oraz modelować wydajność poprzez lepszą percepcję dźwięku wejściowego.	No
└typ	wyliczenie	Rodzaj redukcji szumów. near_field jest dla mikrofonów do bliskiego rozmowy, takich jak słuchawki, jest dla mikrofonów dalekiego pola, far_field takich jak laptopy lub mikrofony konferencyjne. Możliwe wartości: near_field, far_field	No
input_audio_transcription	obiekt	Konfiguracja transkrypcji audio wejściowej domyślnie jest wyłączona i można ustawić null na wyłączenie po włączeniu. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model konsumuje dźwięk bezpośrednio. Transkrypcja działa asynchronicznie przez punkt końcowy Transcriptions i powinna być traktowana jako wskazówka dla treści audio wejściowej, a nie dokładnie to, co model usłyszał. Klient może opcjonalnie ustawić język i prompt transkrypcji, co zapewnia dodatkowe wskazówki dla usługi transkrypcji.	No
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np.) enpoprawia dokładność i opóźnienia.	No
└─ Model	ciąg	Model do transkrypcji, obecnie dostępne opcje to gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, oraz whisper-1.	No
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Dla whisper-1, prompt to lista słów kluczowych. W modelach gpt-4o-transcribe prompt to wolny ciąg tekstowy, na przykład "expect words related to technology".	No
instructions	ciąg	Domyślne instrukcje systemowe (czyli komunikat systemowy) były dołączane do wywołań modelu. To pole pozwala klientowi kierować modelem na żądane odpowiedzi. Model można pouczać na temat treści i formatu odpowiedzi (np. "bądź bardzo zwięzły", "zachowuj się przyjaźnie", "oto przykłady dobrych odpowiedzi") oraz zachowania audio (np. "mów szybko", "wprowadź emocje do głosu", "często się śmiej"). Instrukcje nie są gwarantowane przez model przestrzegania, ale dostarczają mu wskazówek dotyczących pożądanego zachowania. Należy zauważyć, że serwer ustawia domyślne instrukcje, które będą używane, jeśli to pole nie jest ustawione i są widoczne w zdarzeniu session.created na początku sesji.	No
max_response_output_tokens	liczba całkowita lub ciąg tekstu	Maksymalna liczba tokenów wyjściowych dla jednej odpowiedzi asystenta, wliczając wywołania narzędzi. Podaj liczbę całkowitą od 1 do 4096, aby ograniczyć tokeny wyjściowe lub inf dla maksymalnej dostępności tokenów dla danego modelu. Domyślnie przyjmuje .inf	No
Sposoby		Zestaw modalności, z którymi model może reagować. Aby wyłączyć dźwięk, ustaw to na ["text"].	No
model	ciąg	Nazwa wdrożenia użytego podczas tej sesji.	No
output_audio_format	wyliczenie	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw. Dla pcm16, dźwięk wyjściowy jest próbkowany z częstotliwością 24kHz. Możliwe wartości: pcm16, g711_ulaw, g711_alaw	No
temperatura	number	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. W przypadku modeli audio zaleca się temperaturę 0,8 dla najlepszej wydajności.	No	0.8
tool_choice	ciąg	Jak model wybiera narzędzia. Opcje to auto, none, required, lub określ funkcję.	No	samochód
Narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	No
turn_detection	obiekt	Konfiguracja wykrywania tur, np. Server VAD lub Semantic VAD. Można to ustawić na null wyłączenie, w takim przypadku klient musi ręcznie wywołać odpowiedź modelu. Server VAD oznacza, że model wykrywa początek i koniec mowy na podstawie głośności dźwięku i odpowiada na końcu wypowiedzi użytkownika. Semantyczny VAD jest bardziej zaawansowany i wykorzystuje model wykrywania skrętów (we współpracy z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika kończy się na , uhhmmodel uzyska niskie prawdopodobieństwo zakończenia tury i dłużej czeka, aż użytkownik będzie kontynuował mówienie. Może to być przydatne przy bardziej naturalnych rozmowach, ale może mieć wyższe opóźnienia.	No
└create_response	boolean	Czy automatycznie generować odpowiedź, gdy wystąpi zdarzenie VAD stop.	No	True
└* gotowość	wyliczenie	Używany tylko w semantic_vad trybie pracy. Chęć modelu do odpowiedzi. low poczeka dłużej, aż użytkownik będzie kontynuował mówienie, odpowiada high szybciej. autojest domyślnym i jest równoważny .medium Możliwe wartości: low, medium, , highauto	No
└reakcja_na_przerwanie	boolean	Czy automatycznie przerwać każdą bieżącą odpowiedź z wyjściem do domyślnej rozmowy (czyli conversation z), autogdy wystąpi zdarzenie startowe VAD.	No	True
└─prefix_padding_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Domyślnie ustawione jest 300ms.	No
└czas_trwania_ciszy_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Czas trwania ciszy do wykrycia zatrzymania mowy (w milisekundach). Domyślnie ustawione jest 500ms. Przy krótszych wartościach model odpowiada szybciej, ale może wtrącać się na krótkie przerwy użytkownika.	No
└* próg	number	Używany tylko w server_vad trybie pracy. Próg aktywacji dla VAD (0,0 do 1,0), domyślnie wynosi 0,5. Wyższy próg wymaga głośniejszego dźwięku do aktywacji modelu, dlatego może działać lepiej w hałaśliwym środowisku.	No
└typ	wyliczenie	Rodzaj wykrywania skrętów. Możliwe wartości: server_vad, semantic_vad	No
voice	VoiceIdsShared		No

Responses

Kod statusu: 200

Opis: Sesja została pomyślnie utworzona.

Typ zawartości	Typ	Opis
application/json	RealtimeSessionCreateResponse

Utwórz - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Stwórz efemeryczny token API do użycia w aplikacjach po stronie klienta z API czasu rzeczywistego specjalnie do transkrypcji w czasie rzeczywistym. Można skonfigurować z tymi samymi parametrami sesji co zdarzenie transcription_session.update klienta. Odpowiada obiektem sesji oraz kluczem client_secret zawierającym użyteczny, efemeryczny token API, który może być używany do uwierzytelniania klientów przeglądarki dla API czasu rzeczywistego.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
include	macierz	Zestaw elementów do uwzględnienia w transkrypcji. Obecnie dostępne przedmioty to: - item.input_audio_transcription.logprobs	No
input_audio_format	wyliczenie	Format dźwięku wejściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw. Dla pcm16, dźwięk wejściowy musi być 16-bitowy PCM przy częstotliwości próbkowania 24kHz, jednokanałowy (mono) i w rzędzie bajtów little-endian. Możliwe wartości: pcm16, g711_ulaw, g711_alaw	No
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumów audio wejściowych. Można to ustawić na null wyłączenie. Redukcja szumów filtruje dźwięk dodawany do bufora audio wejściowego przed wysłaniem do VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i skrętów (zmniejszając liczbę fałszywych alarmów) oraz modelować wydajność poprzez lepszą percepcję dźwięku wejściowego.	No
└typ	wyliczenie	Rodzaj redukcji szumów. near_field jest dla mikrofonów do bliskiego rozmowy, takich jak słuchawki, jest dla mikrofonów dalekiego pola, far_field takich jak laptopy lub mikrofony konferencyjne. Możliwe wartości: near_field, far_field	No
input_audio_transcription	obiekt	Konfiguracja do transkrypcji audio wejściowej. Klient może opcjonalnie ustawić język i prompt transkrypcji, co zapewnia dodatkowe wskazówki dla usługi transkrypcji.	No
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np.) enpoprawia dokładność i opóźnienia.	No
└─ Model	wyliczenie	Model do transkrypcji, obecnie dostępne opcje to gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, oraz whisper-1. Możliwe wartości: gpt-4o-transcribe, gpt-4o-mini-transcribe, , gpt-4o-mini-transcribe-2025-12-15whisper-1	No
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Dla whisper-1, prompt to lista słów kluczowych. W modelach gpt-4o-transcribe prompt to wolny ciąg tekstowy, na przykład "expect words related to technology".	No
Sposoby		Zestaw modalności, z którymi model może reagować. Aby wyłączyć dźwięk, ustaw to na ["text"].	No
turn_detection	obiekt	Konfiguracja wykrywania tur, np. Server VAD lub Semantic VAD. Można to ustawić na null wyłączenie, w takim przypadku klient musi ręcznie wywołać odpowiedź modelu. Server VAD oznacza, że model wykrywa początek i koniec mowy na podstawie głośności dźwięku i odpowiada na końcu wypowiedzi użytkownika. Semantyczny VAD jest bardziej zaawansowany i wykorzystuje model wykrywania skrętów (we współpracy z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika kończy się na , uhhmmodel uzyska niskie prawdopodobieństwo zakończenia tury i dłużej czeka, aż użytkownik będzie kontynuował mówienie. Może to być przydatne przy bardziej naturalnych rozmowach, ale może mieć wyższe opóźnienia.	No
└create_response	boolean	Czy automatycznie generować odpowiedź, gdy wystąpi zdarzenie VAD stop. Niedostępne podczas sesji transkrypcji.	No	True
└* gotowość	wyliczenie	Używany tylko w semantic_vad trybie pracy. Chęć modelu do odpowiedzi. low poczeka dłużej, aż użytkownik będzie kontynuował mówienie, odpowiada high szybciej. autojest domyślnym i jest równoważny .medium Możliwe wartości: low, medium, , highauto	No
└reakcja_na_przerwanie	boolean	Czy automatycznie przerwać każdą bieżącą odpowiedź z wyjściem do domyślnej rozmowy (czyli conversation z), autogdy wystąpi zdarzenie startowe VAD. Niedostępne podczas sesji transkrypcji.	No	True
└─prefix_padding_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Domyślnie ustawione jest 300ms.	No
└czas_trwania_ciszy_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Czas trwania ciszy do wykrycia zatrzymania mowy (w milisekundach). Domyślnie ustawione jest 500ms. Przy krótszych wartościach model odpowiada szybciej, ale może wtrącać się na krótkie przerwy użytkownika.	No
└* próg	number	Używany tylko w server_vad trybie pracy. Próg aktywacji dla VAD (0,0 do 1,0), domyślnie wynosi 0,5. Wyższy próg wymaga głośniejszego dźwięku do aktywacji modelu, dlatego może działać lepiej w hałaśliwym środowisku.	No
└typ	wyliczenie	Rodzaj wykrywania skrętów. Możliwe wartości: server_vad, semantic_vad	No

Responses

Kod statusu: 200

Opis: Sesja została pomyślnie utworzona.

Typ zawartości	Typ	Opis
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Tworzy modelową odpowiedź.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
include	macierz		No
dane wejściowe	ciąg lub tablica	Dane wejściowe modelu	Tak
instructions	ciąg	Wprowadza komunikat systemowy (lub deweloperski) jako pierwszy element w kontekście modelu. Używając razem z previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperskich) w nowych odpowiedziach.	No
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widocznych tokenów wyjściowych i stanu rozmowy.	No
wywołania_narzędzia_równoległe	boolean	Czy pozwolić modelu na wykonywanie wywołań narzędzi równolegle.	No	True
previous_response_id	ciąg	Unikalne ID poprzedniej odpowiedzi na model. Wykorzystaj to do tworzenia wieloturowych rozmów. Dowiedz się więcej o stanie rozmowy.	No
reasoning	Reasoning	Opcje konfiguracyjne modeli rozumowania.	No
przechowywać	boolean	Czy przechowywać wygenerowaną odpowiedź modelu do późniejszego pobrania za pomocą API.	No	True
odtwarzać strumieniowo	boolean	Jeśli ustawiono na true, dane odpowiedzi modelu będą przesyłane do klienta w momencie generowania za pomocą zdarzeń wysyłanych przez serwer. Zobacz sekcję Streaming poniżej, aby uzyskać więcej informacji.	No	Nieprawda
SMS	obiekt	Opcje konfiguracyjne odpowiedzi tekstowej z modelu. Może to być tekst zwykły lub ustrukturyzowane dane JSON. Więcej informacji: - Wejścia i wyjścia tekstowe - Strukturalne wyniki	No
Format └─	TextResponseFormatConfiguration	Obiekt określający format, który model musi wyprowadzać. Konfiguracja { "type": "json_schema" } umożliwia Structured Outputs, co zapewnia, że model odpowiada dostarczonemu schematowi JSON. Domyślny format to { "type": "text" } brak dodatkowych opcji. Nie zaleca się dla modeli GPT-4O i nowszych: Ustawienie na { "type": "json_object" } włączenie starszego trybu JSON, który zapewnia, że komunikat generowany przez model jest poprawny w JSON. Preferowane jest używanie json_schema w modelach, które go obsługują.	No
tool_choice	ToolChoiceOptions,ToolChoiceTypes lub ToolChoiceFunction	Jak model powinien wybierać, którego narzędzia (lub narzędzi) użyć podczas generowania odpowiedzi. Zobacz parametr, tools aby zobaczyć, jak określić, które narzędzia model może wywołać.	No
Narzędzia	macierz	Zestaw narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając parametr.tool_choice Dwie kategorie narzędzi, które możesz udostępnić modelowi, to: - Wbudowane narzędzia: Narzędzia udostępniane przez OpenAI, które rozszerzają możliwości modelu	No
truncation	wyliczenie	Strategia obcięcia do wykorzystania w odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstowego modelu, model obcina odpowiedź, aby dopasowała się do okna kontekstu, rezygnując z elementów wejściowych w trakcie rozmowy. - disabled (domyślnie): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstowego dla modelu, żądanie nie zostanie zadane z błędem 400. Możliwe wartości: auto, disabled	No

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	response
text/event-stream	responseStreamEvent

Kod statusu: domyślny

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
application/json	errorResponse

API Responses - elementy wejściowe

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Pobiera odpowiedź modelu z podanym ID.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
response_id	ścieżka	Tak	ciąg	ID odpowiedzi do pobrania.
include	kwerenda	No	macierz	Dodatkowe pola do uwzględnienia w odpowiedzi. Zobacz include parametr tworzenia odpowiedzi powyżej, aby uzyskać więcej informacji.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	response

Kod statusu: domyślny

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
application/json	errorResponse

Usuń odpowiedź

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Usuwa odpowiedź modelu z podanym ID.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
response_id	ścieżka	Tak	ciąg	ID odpowiedzi do usunięcia.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Kod statusu: 404

Opis: Nie znaleziono

Typ zawartości	Typ	Opis
application/json	error

Kod statusu: domyślny

Opis: Usługa niedostępna

Typ zawartości	Typ	Opis
application/json	errorResponse

Responses API – lista elementów response

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Zwraca listę elementów wejściowych dla danej odpowiedzi.

Parametry identyfikatora URI

Name	W	Obowiązkowy	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg znaków 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
response_id	ścieżka	Tak	ciąg	ID odpowiedzi do pobrania elementów wejściowych dla.
limit	kwerenda	No	liczba całkowita	Limit liczby obiektów, które należy zwrócić. Limit może wahać się od 1 do 100, a domyślny to 20.
porządek	kwerenda	No	ciąg Możliwe wartości: asc, desc	Kolejność zwracania elementów wejściowych. Domyślnie jest asc. - asc: Zwróć elementy wejściowe w kolejności rosnącej. - desc: Zwróć elementy wejściowe w kolejności malejącej.
Po	kwerenda	No	ciąg	ID przedmiotu do listy elementów, używany w paginacji.
przed	kwerenda	No	ciąg	ID przedmiotu do wcześniejszej listy elementów, używany w paginacji.

Nagłówek żądania

Używaj uwierzytelniania opartego na tokenach lub klucza API. Zaleca się uwierzytelnianie za pomocą tokenów, które jest bardziej bezpieczne.

Name	Obowiązkowy	Typ	Opis
Autoryzacja	True	ciąg	Przykład:Authorization: Bearer {Azure_OpenAI_Auth_Token} Aby wygenerować token uwierzytelniający za pomocą Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize ZAKRES: https://ai.azure.com/.default
klucz API	True	ciąg	Udostępnij klucz API Azure OpenAI tutaj

Responses

Kod statusu: 200

Opis: OK

Typ zawartości	Typ	Opis
application/json	responseItemList

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	Wartość domyślna
inner_error	innerError	Błąd wewnętrzny z dodatkowymi szczegółami.	No
param	ciąg		No
typ	ciąg		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 blokowanych klientów, czy została przefiltrowana i jej identyfikatorze.	No

innerErrorCode

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

Majątek	Wartość
Opis	Kody błędów dla wewnętrznego obiektu błędu.
Typ	ciąg
Wartości	ResponsibleAIPolicyViolation

dalleErrorResponse

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

dalleError

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

dalleInnerError

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	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 blokowanych klientów, 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

contentFilterCompletionTextSpan

Opisuje zakres w wygenerowanym tekście uzupełnienia. Przesunięcie 0 to pierwszy punkt kodowy UTF32 tekstu uzupełnienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
completion_end_offset	liczba całkowita	Przesunięcie pierwszego punktu kodowego UTF32, który jest wyłączony z rozpiętości. To pole jest zawsze równe completion_start_offset dla rozpiętości pustych. To pole jest zawsze większe niż completion_start_offset dla rozpięć niepustych.	Tak
completion_start_offset	liczba całkowita	Przesunięcie punktu kodowego UTF32, który rozpoczyna rozpiętość.	Tak

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
detected	boolean		No
filtered	boolean		Tak

Filtr treści wykryty z wynikiem cytowania

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
cytat	obiekt		No
└* adres URL	ciąg		No
└─ Licencja	ciąg		No

contentFilterDetectedWithCompletionTextSpansResult

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
details	macierz		No

contentFilterIdResult

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

PodstawaWynikówFiltraZawartości

Informacje o wynikach filtrowania treści.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
custom_blocklists	contentFilterDetailedResults	Filtrowanie treści daje szczegółowe identyfikatory filtrów treści dla przefiltrowanych segmentów.	No
błąd	errorBase		No
hate	WynikFiltrowaniaZawartościWedługNasilenia		No
profanity	wynikWykrywaniaFiltruZawartości		No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia		No
sexual	WynikFiltrowaniaZawartościWedługNasilenia		No
violence	WynikFiltrowaniaZawartościWedługNasilenia		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 blokowanych klientów, czy została przefiltrowana i jej identyfikatorze.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
custom_blocklists	contentFilterDetailedResults	Filtrowanie treści daje szczegółowe identyfikatory filtrów treści dla przefiltrowanych segmentów.	No
błąd	errorBase		No
hate	WynikFiltrowaniaZawartościWedługNasilenia		No
indirect_attack	wynikWykrywaniaFiltruZawartości		No
jailbreak	wynikWykrywaniaFiltruZawartości		No
profanity	wynikWykrywaniaFiltruZawartości		No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia		No
sexual	WynikFiltrowaniaZawartościWedługNasilenia		No
violence	WynikFiltrowaniaZawartościWedługNasilenia		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 blokowanych klientów, czy została przefiltrowana i jej identyfikatorze.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
custom_blocklists	contentFilterDetailedResults	Filtrowanie treści daje szczegółowe identyfikatory filtrów treści dla przefiltrowanych segmentów.	No
błąd	errorBase		No
hate	WynikFiltrowaniaZawartościWedługNasilenia		No
profanity	wynikWykrywaniaFiltruZawartości		No
protected_material_code	wykryto filtr treści z wynikiem cytowania		No
protected_material_text	wynikWykrywaniaFiltruZawartości		No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia		No
sexual	WynikFiltrowaniaZawartościWedługNasilenia		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No
violence	WynikFiltrowaniaZawartościWedługNasilenia		No

contentFilterDetailedResults

Filtrowanie treści daje szczegółowe identyfikatory filtrów treści dla przefiltrowanych segmentów.

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

WynikFiltrowaniaPromptu

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

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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 blokowanych klientów, czy została przefiltrowana i jej identyfikatorze.	No
prompt_index	liczba całkowita		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	Opis	Obowiązkowy	Wartość domyślna
hate	WynikFiltrowaniaZawartościWedługNasilenia		No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia		No
sexual	WynikFiltrowaniaZawartościWedługNasilenia		No
violence	WynikFiltrowaniaZawartościWedługNasilenia		No

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 blokowanych klientów, czy została przefiltrowana i jej identyfikatorze.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
custom_blocklists	contentFilterDetailedResults	Filtrowanie treści daje szczegółowe identyfikatory filtrów treści dla przefiltrowanych segmentów.	No
hate	WynikFiltrowaniaZawartościWedługNasilenia		No
jailbreak	wynikWykrywaniaFiltruZawartości		No
profanity	wynikWykrywaniaFiltruZawartości		No
self_harm	WynikFiltrowaniaZawartościWedługNasilenia		No
sexual	WynikFiltrowaniaZawartościWedługNasilenia		No
violence	WynikFiltrowaniaZawartościWedługNasilenia		No

ŻądanieKończeniaCzatuWspólne

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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 różni się 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
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
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). To nie jest kompatybilne z modelami serii O1.	No	4096
metadane	obiekt	Tagi i wartości definiowane przez dewelopera używane do filtrowania zakończeń w pulpicie z przechowywanymi kompletacjami.	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
stop	ciąg lub tablica	Do 4 sekwencji, w których API przestaje generować kolejne tokeny.	No
przechowywać	boolean	Czy przechowywać wynik tego żądania zakończenia czatu do wykorzystania w naszych produktach do destylacji lub oceny modelu.	No
odtwarzać strumieniowo	boolean	Jeśli jest ustawiona, wysyłane są częściowe delta wiadomości, jak w ChatGPT. Tokeny są wysyłane jako zdarzenia wysyłane wyłącznie przez serwer za pośrednictwem danych, gdy tylko stają się dostępne, a strumień kończy się wiadomością data: [DONE] .	No	Nieprawda
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 może pomóc Azure OpenAI monitorować i wykrywać nadużycia.	No

utwórzŻądanieZakończenia

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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żywa się n , best_ofkontroluje liczbę kandydatów na ukończenia i określa, n ile należy zwrócić. best_of musi być większy 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 różni się 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ę 5 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
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
seed	liczba całkowita	Jeśli jest to określone, nasz system podejmuje najlepsze starania, aby próbkować deterministyczne, tak aby powtarzające się żądania z tymi samymi seed parametrami i powinny zwracać 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 4 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 są wysyłane jako zdarzenia wysyłane tylko na serwer z danymi, gdy tylko stają się dostępne, a strumień kończy się wiadomością data: [DONE] . Przykład Python kod.	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 streamowane, jak i niestreamowane mają ten sam kształt (w przeciwieństwie do endpointu czatu).

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
id	ciąg	Unikalny identyfikator zakończenia.	Tak
model	ciąg	Model używany do ukończenia.	Tak
obiekt	wyliczenie	Typ obiektu, który zawsze jest "text_completion" Możliwe wartości: text_completion	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
użycie	completionUsage	Statystyki wykorzystania wniosku o zakończenie.	No

UtwórzŻądanieZakończeniaCzatu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
audio	obiekt	Parametry wyjścia audio. Wymagane, gdy żądane jest wyjście audio z .modalities: ["audio"]	No
Format └─	wyliczenie	Określa format wyjściowego dźwięku. Musi być jednym z wav, mp3, flac, opus, lub pcm16. Możliwe wartości: wav, mp3, flac, , opuspcm16	No
└─ głos	wyliczenie	Określa typ głosu. Głosy wspierane to alloy, echo, fable, onyx, nova, oraz .shimmer Możliwe wartości: alloy, echo, fable, , onyx, nova, shimmer	No
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
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
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
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 różni się 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
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
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
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
messages	macierz	Lista wiadomości składających się na dotychczasową rozmowę. Przykład Python kod.	Tak
metadane	obiekt	Tagi i wartości definiowane przez dewelopera używane do filtrowania zakończeń w pulpicie z przechowywanymi kompletacjami.	No
Sposoby	ChatCompletionModalities	Typy wyników, które model chciałby wygenerować dla tego żądania. Większość modeli potrafi generować tekst, co jest domyślne: ["text"] Model ten gpt-4o-audio-preview może być również używany do generowania dźwięku. Aby poprosić ten model o generowanie zarówno odpowiedzi tekstowych, jak i audio, możesz użyć: ["text", "audio"]	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żana 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
przewidywanie	PredictionContent	Konfiguracja dla przewidywanego wyjścia, która może znacznie poprawić czas reakcji, gdy duże części odpowiedzi modelu są znane z wyprzedzeniem. Najczęściej dzieje się to przy regeneracji pliku z jedynie drobnymi zmianami w większości treści.	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
wysiłek rozumowania	wyliczenie	Tylko modele O1 Ogranicza wysiłek związany z rozumowaniem dla modeli rozumowania. Obecnie obsługiwane wartości to low, medium, oraz high. Zmniejszenie wysiłku rozumowania może skutkować szybszymi odpowiedziami i mniejszą liczbą tokenów używanych do rozumowania w odpowiedzi. Możliwe wartości: low, medium, high	No
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": {...} } aktywne Structured Outputs, które gwarantują, że model odpowiada 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 jest to określone, nasz system podejmuje najlepsze starania, aby próbkować deterministyczne, tak aby powtarzające się żądania z tymi samymi seed parametrami i powinny zwracać 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 4 sekwencji, w których API przestaje generować kolejne tokeny.	No
przechowywać	boolean	Czy przechowywać wynik tego żądania zakończenia czatu do wykorzystania w naszych produktach do destylacji lub oceny modelu.	No
odtwarzać strumieniowo	boolean	Jeśli jest ustawiona, wysyłane są częściowe delta wiadomości, jak w ChatGPT. Tokeny są wysyłane jako zdarzenia wysyłane wyłącznie przez serwer za pośrednictwem danych, gdy tylko stają się dostępne, a strumień kończy się wiadomością data: [DONE] . Przykład Python kod.	No	Nieprawda
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi na streaming. Ustawiam to tylko wtedy, gdy ustawiasz stream: true.	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
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
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
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
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
user_security_context	userSecurityContext	Kontekst bezpieczeństwa użytkownika zawiera kilka parametrów opisujących samą aplikację AI oraz użytkownika końcowego, który z nią wchodzi. Te obszary pomagają zespołom operacji bezpieczeństwa badać i ograniczać incydenty bezpieczeństwa, oferując kompleksowe podejście do ochrony aplikacji AI. Dowiedz się więcej o ochronie aplikacji AI za pomocą Microsoft Defender dla Chmury.	No

userSecurityContext

Kontekst bezpieczeństwa użytkownika zawiera kilka parametrów opisujących samą aplikację AI oraz użytkownika końcowego, który z nią wchodzi. Te obszary pomagają zespołom operacji bezpieczeństwa badać i ograniczać incydenty bezpieczeństwa, oferując kompleksowe podejście do ochrony aplikacji AI. Dowiedz się więcej o ochronie aplikacji AI za pomocą Microsoft Defender dla Chmury.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
application_name	ciąg	Nazwa aplikacji. Wrażliwe dane osobowe nie powinny być uwzględniane w tej dziedzinie.	No
end_user_id	ciąg	Ten identyfikator to Microsoft Entra ID (dawniej Azure Active Directory) identyfikator użytkownika używany do uwierzytelniania użytkowników końcowych w aplikacji generatywnej AI. Wrażliwe dane osobowe nie powinny być uwzględniane w tej dziedzinie.	No
end_user_tenant_id	ciąg	Identyfikator tenanta Microsoft 365, do którego należy użytkownik końcowy. Jest to wymagane, gdy generatywna aplikacja AI jest wielodzierżawcą.	No
source_ip	ciąg	Rejestruje adres IP oryginalnego klienta, akceptując zarówno formaty IPv4, jak i IPv6.	No

funkcjeUkończeniaChatu

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

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

chatCompletionFunctionParameters

Parametry, które funkcje akceptują, są opisane jako obiekt schematu JSON. Zobacz przewodnik/ dla przykładów oraz w JSON Schema jako źródło dokumentacji dotyczącej formatu.

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

chatCompletionRequestMessage

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

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

Instrukcje dostarczane przez deweloperów, których model powinien przestrzegać, niezależnie od komunikatów wysyłanych przez użytkownika. W modelach o1 i nowszych, developer wiadomości zastępują poprzednie system komunikaty.

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

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

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
function_call	obiekt	Wycofane i zastąpione przez tool_calls. Nazwa i argumenty funkcji, którą należy wywołać, wygenerowane przez model.	No
└─ Argumenty	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje prawidłowy JSON i może halucynować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	No
nazwa	ciąg	Opcjonalne imię uczestnika. Dostarcza informacji modelowych pozwalających rozróżnić uczestników tej samej roli.	No
refusal	ciąg	Wiadomość odmowy od asystenta.	No
rola	wyliczenie	Rola autora wiadomości, w tym przypadku assistant. Możliwe wartości: assistant	Tak
tool_calls	chatCompletionMessageToolCalls	Wywołania narzędzi generowane przez model, takie jak wywołania funkcji.	No

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestDeveloperMessageContentPart

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

• chatCompletionRequestMessageContentPartText

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

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

• chatCompletionRequestMessageContentPartText

częśćZawartościWiadomościUżytkownikaChatCompletionRequest

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

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

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

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

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

• chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartAudio

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
input_audio	obiekt		Tak
└─ dane	ciąg	Dane audio zakodowane w Base64.	No
Format └─	wyliczenie	Format zakodowanych danych audio. Obecnie obsługuje "wav" i "mp3". Możliwe wartości: wav, mp3	No
typ	wyliczenie	Rodzaj treści. Zawsze input_audio. Możliwe wartości: input_audio	Tak

chatCompletionRequestMessageContentPartImage

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
image_url	obiekt		Tak
└* szczegóły	wyliczenie	Określa poziom szczegółowości obrazu. Dowiedz się więcej w przewodniku Vision. Możliwe wartości: auto, low, high	No
└─ adres URL	ciąg	Można to być albo adresem URL obrazu, albo danymi obrazowymi zakodowanymi w base64.	No
typ	wyliczenie	Rodzaj treści. Możliwe wartości: image_url	Tak

chatCompletionRequestMessageContentPartRefusal

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
refusal	ciąg	Komunikat odmowy generowany przez model.	Tak
typ	wyliczenie	Rodzaj treści. Możliwe wartości: refusal	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.

###Discriminator dla azureChatExtensionConfiguration

Ten składnik wykorzystuje tę właściwość type do rozróżniania różnych typów:

Typ wartości	Schema
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	azureChatExtensionType	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.	Tak

Typ rozszerzenia czatu Azure

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.

Majątek	Wartość
Opis	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.
Typ	ciąg
Wartości	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

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
parameters	azureSearchChatExtensionParameters	Parametry dla Azure Search gdy jest używany jako rozszerzenie czatu Azure OpenAI.	No
typ	azureChatExtensionType	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.	Tak

azureSearchChatExtensionParameters

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

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
allow_partial_result	boolean	Jeśli zostanie oznaczone jako prawdziwe, system pozwoli na użycie częściowych wyników wyszukiwania, a żądanie nie przestaje działać, jeśli wszystkie zapytania się nie powiedzą. Jeśli nie zostanie określona lub zostanie oznaczona jako fałszywa, żądanie nie zostanie zapowiedziane, jeśli jakiekolwiek zapytanie nie powiodę się.	No	Nieprawda
uwierzytelnianie	onYourDataApiKeyAuthenticationOptions lub onYourDataSystemAssignedManagedIdentityAuthenticationOptions albo onYourDataUserAssignedManagedIdentityAuthenticationOptions albo onYourDataAccessTokenAuthenticationOptions		Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource albo onYourDataIntegratedVectorizationSource		No
punkt końcowy	ciąg	Absolutna ścieżka końcowa dla zasobu Azure Search do wykorzystania.	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
filtr	ciąg	Filtr wyszukiwania.	No
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie jest to określone, wartość domyślna to citations i .intent	No
nazwa_indeksu	ciąg	Nazwa indeksu, którą można użyć w zasobach Azure Search, do którego się odwołuje.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysłana do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie jest to określone, system zdecyduje o liczbie zapytań do wysłania.	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
ścisłość	liczba całkowita	Konfigurowana rygorystyka filtrowania trafności wyszukiwania. Im bardziej rygorystyczna, tym większa precyzja, ale mniej pamiętana odpowiedź.	No
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	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	Wartość domyślna
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
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
image_vector_fields	macierz	Nazwy pól reprezentujących dane wektorowe obrazu.	No
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
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.

Majątek	Wartość
Opis	Typ zapytania wyszukiwania Azure Search, który powinien być wykonywany podczas używania go jako rozszerzenia czatu Azure OpenAI.
Typ	ciąg
Wartości	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

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
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 MongoDB vCore.	No
typ	azureChatExtensionType	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.	Tak

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	Wartość domyślna
allow_partial_result	boolean	Jeśli zostanie oznaczone jako prawdziwe, system pozwoli na użycie częściowych wyników wyszukiwania, a żądanie nie przestaje działać, jeśli wszystkie zapytania się nie powiedzą. Jeśli nie zostanie określona lub zostanie oznaczona jako fałszywa, żądanie nie zostanie zapowiedziane, jeśli jakiekolwiek zapytanie nie powiodę się.	No	Nieprawda
uwierzytelnianie	onYourDataConnectionStringOpcjeUwierzytelniania	Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu parametry połączenia.	Tak
nazwa_kontenera	ciąg	Nazwa kontenera zasobów Azure Cosmos DB.	Tak
nazwa_bazy_danych	ciąg	Nazwa bazy MongoDB vCore do użycia z Azure Cosmos DB.	Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak
mapowanie pól	azureCosmosDBFieldMappingOptions	Opcjonalne ustawienia do kontroli przetwarzania pól podczas korzystania z skonfigurowanego zasobu bazy Azure Cosmos DB.	Tak
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie jest to określone, wartość domyślna to citations i .intent	No
nazwa_indeksu	ciąg	Nazwa indeksu MongoDB vCore do użycia z Azure Cosmos DB.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysłana do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie jest to określone, system zdecyduje o liczbie zapytań do wysłania.	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
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	No

azureCosmosDBFieldMappingOptions

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

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
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
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

elasticsearchChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji dla Elasticsearch podczas używania go jako rozszerzenia czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
parameters	elasticsearchChatExtensionParameters	Parametry, których należy użyć podczas konfigurowania Elasticsearch® jako rozszerzenia czatu Azure OpenAI.	No
typ	azureChatExtensionType	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.	Tak

elasticsearchChatExtensionParameters

Parametry, których należy użyć podczas konfigurowania Elasticsearch® jako rozszerzenia czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
allow_partial_result	boolean	Jeśli zostanie oznaczone jako prawdziwe, system pozwoli na użycie częściowych wyników wyszukiwania, a żądanie nie przestaje działać, jeśli wszystkie zapytania się nie powiedzą. Jeśli nie zostanie określona lub zostanie oznaczona jako fałszywa, żądanie nie zostanie zapowiedziane, jeśli jakiekolwiek zapytanie nie powiodę się.	No	Nieprawda
uwierzytelnianie	onYourDataKeyandKeyIdAuthenticationOptions lub onYourDataEncodedApiKeyAuthenticationOptions		Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource albo onYourDataModelIdVectorizationSource		No
punkt końcowy	ciąg	Punkt końcowy Elasticsearch.®	Tak
mapowanie pól	elasticsearchIndexFieldMappingOptions	Opcjonalne ustawienia kontrolujące sposób przetwarzania pól przy użyciu skonfigurowanego zasobu Elasticsearch.®	No
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie jest to określone, wartość domyślna to citations i .intent	No
nazwa_indeksu	ciąg	Nazwa indeksowa Elasticsearch.®	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysłana do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie jest to określone, system zdecyduje o liczbie zapytań do wysłania.	No
typ zapytania	elasticsearchQueryType	Typ zapytania pobierania Elasticsearch,® który powinien być wykonywany podczas używania go jako rozszerzenia czatu Azure OpenAI.	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
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	No

elasticsearchIndexFieldMappingOptions

Opcjonalne ustawienia kontrolujące sposób przetwarzania pól przy użyciu skonfigurowanego zasobu Elasticsearch.®

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
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
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	No

elasticsearchQueryType

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

Majątek	Wartość
Opis	Typ zapytania pobierania Elasticsearch,® który powinien być wykonywany podczas używania go jako rozszerzenia czatu Azure OpenAI.
Typ	ciąg
Wartości	simple vector

mongoDBChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji dla bazy Mongo DB podczas używania jej jako rozszerzenia czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
parameters	mongoDBChatExtensionParameters	Parametry, których należy używać podczas konfigurowania rozszerzeń czatu Azure OpenAI On Your Data przy korzystaniu z bazy Mongo DB.	No
typ	azureChatExtensionType	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.	Tak

mongoDBChatExtensionParameters

Parametry, których należy używać podczas konfigurowania rozszerzeń czatu Azure OpenAI On Your Data przy korzystaniu z bazy Mongo DB.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
allow_partial_result	boolean	Jeśli zostanie oznaczone jako prawdziwe, system pozwoli na użycie częściowych wyników wyszukiwania, a żądanie nie przestaje działać, jeśli wszystkie zapytania się nie powiedzą. Jeśli nie zostanie określona lub zostanie oznaczona jako fałszywa, żądanie nie zostanie zapowiedziane, jeśli jakiekolwiek zapytanie nie powiodę się.	No	Nieprawda
app_name	ciąg	Nazwa aplikacji bazy danych Mongo.	Tak
uwierzytelnianie	onYourDataUsernameAndPasswordAuthenticationOptions	Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu nazwy użytkownika i hasła.	Tak
collection_name	ciąg	Nazwa kolekcji Mongo DB.	Tak
nazwa_bazy_danych	ciąg	Nazwa bazy danych Mongo DB.	Tak
zależność osadzenia	onYourDataEndpointVectorizationSource lub onYourDataDeploymentNameVectorizationSource		Tak
punkt końcowy	ciąg	Nazwa punktu końcowego klastra Mongo DB.	Tak
mapowanie pól	mongoDBFieldMappingOptions	Opcjonalne ustawienia kontrolujące sposób przetwarzania pól przy użyciu skonfigurowanego zasobu bazy danych Mongo.	Tak
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie jest to określone, wartość domyślna to citations i .intent	No
nazwa_indeksu	ciąg	Nazwa indeksu Mongo DB.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysłana do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie jest to określone, system zdecyduje o liczbie zapytań do wysłania.	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
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	No

mongoDBFieldMappingOptions

Opcjonalne ustawienia kontrolujące sposób przetwarzania pól przy użyciu skonfigurowanego zasobu bazy danych Mongo.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
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
pola wektorowe	macierz	Nazwy pól reprezentujących dane wektorowe.	Tak

pineconeChatExtensionConfiguration

Konkretna reprezentacja konfigurowalnych opcji dla Pinecone podczas używania go jako rozszerzenia czatu Azure OpenAI.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
parameters	pineconeChatExtensionParameters	Parametry do konfigurowania Azure OpenAI Pinecone chat extensions.	No
typ	azureChatExtensionType	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.	Tak

pineconeChatExtensionParameters

Parametry do konfigurowania Azure OpenAI Pinecone chat extensions.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
allow_partial_result	boolean	Jeśli zostanie oznaczone jako prawdziwe, system pozwoli na użycie częściowych wyników wyszukiwania, a żądanie nie przestaje działać, jeśli wszystkie zapytania się nie powiedzą. Jeśli nie zostanie określona lub zostanie oznaczona jako fałszywa, żądanie nie zostanie zapowiedziane, jeśli jakiekolwiek zapytanie nie powiodę się.	No	Nieprawda
uwierzytelnianie	Opcje uwierzytelniania klucza API Twoje Dane	Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu klucza API.	Tak
zależność osadzenia	onYourDataDeploymentNameVectorizationSource	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.	Tak
środowisko	ciąg	Nazwa środowiskowa Pinecone.	Tak
mapowanie pól	pineconeFieldMappingOptions	Opcjonalne ustawienia kontrolujące sposób przetwarzania pól przy użyciu skonfigurowanego zasobu Pinecone.	Tak
w zakresie	boolean	Czy zapytania powinny być ograniczone do wykorzystania danych indeksowanych.	No
include_contexts	macierz	Uwzględnione właściwości kontekstu wyjściowego. Jeśli nie jest to określone, wartość domyślna to citations i .intent	No
nazwa_indeksu	ciąg	Nazwa indeksu bazy danych Pinecone.	Tak
max_search_queries	liczba całkowita	Maksymalna liczba przepisanych zapytań powinna być wysłana do dostawcy wyszukiwania dla jednej wiadomości użytkownika. Jeśli nie jest to określone, system zdecyduje o liczbie zapytań do wysłania.	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
top_n_documents	liczba całkowita	Skonfigurowana maksymalna liczba dokumentów do wykorzystania dla skonfigurowanego zapytania.	No

pineconeFieldMappingOptions

Opcjonalne ustawienia kontrolujące sposób przetwarzania pól przy użyciu skonfigurowanego zasobu Pinecone.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
pole ścieżki pliku	ciąg	Nazwa pola indeksu, którą należy użyć jako ścieżki do pliku.	No
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

OpcjeUwierzytelnianiaTwoichDanych

Opcje uwierzytelniania dla Azure OpenAI na Twoich danych.

Dyskryminator dla opcji uwierzytelniania onYourData

Ten składnik wykorzystuje tę właściwość type do rozróżniania różnych typów:

Typ wartości	Schema
api_key	Opcje uwierzytelniania klucza API Twoje Dane
connection_string	onYourDataConnectionStringOpcjeUwierzytelniania
key_and_key_id	onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key	onYourDataEncodedApiKeyAuthenticationOptions
access_token	onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password	onYourDataUsernameAndPasswordAuthenticationOptions

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

onYourDataContextProperty

Właściwość kontekstu.

Majątek	Wartość
Opis	Właściwość kontekstu.
Typ	ciąg
Wartości	citations intent all_retrieved_documents

typUwierzytelnieniaTwoichDanych

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

Majątek	Wartość
Opis	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.
Typ	ciąg
Wartości	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

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
klucz	ciąg	Klucz API do uwierzytelniania.	No
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak

onYourDataConnectionStringOpcjeUwierzytelniania

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

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

onYourDataKeyAndKeyIdAuthenticationOptions

Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu pary klucza Elasticsearch i ID klucza.

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

onYourDataEncodedApiKeyAuthenticationOptions

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

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

onYourDataAccessTokenAuthenticationOptions

Opcje uwierzytelniania dla Azure OpenAI On Your Data podczas korzystania z tokena dostępu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
access_token	ciąg	Token dostępu do uwierzytelniania.	No
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak

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
managed_identity_resource_id	ciąg	Identyfikator zasobu przypisanej przez użytkownika tożsamości zarządzanej do uwierzytelniania.	No
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak

onYourDataUsernameAndPasswordAuthenticationOptions

Opcje uwierzytelniania dla Azure OpenAI On Your Data przy użyciu nazwy użytkownika i hasła.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
hasło	ciąg	Hasło. do uwierzytelniania.	No
typ	typUwierzytelnieniaTwoichDanych	Typy uwierzytelniania obsługiwane przez Azure OpenAI On Your Data.	Tak
nazwa użytkownika	ciąg	Nazwa użytkownika do uwierzytelniania.	No

ŹródłoWeWektorzeDanych

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

Ten składnik wykorzystuje tę właściwość type do rozróżniania różnych typów:

Typ wartości	Schema
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

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 wyszukiwania wektorowego.	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.

Majątek	Wartość
Opis	Reprezentuje dostępne źródła, które Azure OpenAI On Your Data może wykorzystać do konfiguracji wektoryzacji danych do wyszukiwania wektorowego.
Typ	ciąg
Wartości	endpoint deployment_name integrated model_id

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	Wartość domyślna
uwierzytelnianie	onYourDataApiKeyOpcje uwierzytelniania lub onYourDataAccessTokenOpcje uwierzytelniania		No
wymiary	liczba całkowita	Liczba wymiarów, jakie powinny mieć osadzenia. Obsługiwane tylko w text-embedding-3 modelach i późniejszych.	No
punkt końcowy	ciąg	Określa adres URL endpoint zasobu, z którego należy pobierać osadzenia. Powinien mieć formę https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Parametr zapytania do wersji API nie jest dozwolony.	No
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 wyszukiwania wektorowego.	Tak

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
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
wymiary	liczba całkowita	Liczba wymiarów, jakie powinny mieć osadzenia. Obsługiwane tylko w text-embedding-3 modelach i późniejszych.	No
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 wyszukiwania wektorowego.	Tak

onYourDataIntegratedVectorizationSource

Reprezentuje zintegrowany wektorizator zdefiniowany w zasobach wyszukiwania.

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 wyszukiwania wektorowego.	Tak

onYourDataModelIdVectorizationSource

Szczegóły źródła wektoryzacji, wykorzystywanego przez Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego, opartego na ID modelu usługi wyszukiwania. Obecnie obsługiwany jest wyłącznie przez Elasticsearch.®

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
model_id	ciąg	Określa identyfikator modelu, który ma być użyty do wektoryzacji. Ten identyfikator modelu musi być zdefiniowany w usłudze wyszukiwania.	No
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 wyszukiwania wektorowego.	Tak

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
all_retrieved_documents	macierz	Wszystkie odzyskane dokumenty.	No
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	Wartość domyślna
identyfikator_kawałka	ciąg	Numer numeru cytowania.	No
zawartość	ciąg	Treść uzasadnienia.	Tak
ścieżka pliku	ciąg	Ścieżka pliku do cytatu.	No
rerank_score	number	Ocena ponownego rankingu pobranego dokumentu.	No
tytuł	ciąg	Tytuł uzasadnienia.	No
Adres url	ciąg	URL cytowania.	No

retrievedDocument

Odzyskany dokument.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
identyfikator_kawałka	ciąg	Numer numeru cytowania.	No
zawartość	ciąg	Treść uzasadnienia.	Tak
data_source_index	liczba całkowita	Indeks źródła danych.	No
ścieżka pliku	ciąg	Ścieżka pliku do cytatu.	No
filter_reason	filterReason	Powód filtrowania pobranego dokumentu.	No
original_search_score	number	Oryginalny wynik wyszukiwania pobranego dokumentu.	No
rerank_score	number	Ocena ponownego rankingu pobranego dokumentu.	No
search_queries	macierz	Zapytania wyszukiwania używane do pobrania dokumentu.	No
tytuł	ciąg	Tytuł uzasadnienia.	No
Adres url	ciąg	URL cytowania.	No

filterReason

Powód filtrowania pobranego dokumentu.

Majątek	Wartość
Opis	Powód filtrowania pobranego dokumentu.
Typ	ciąg
Wartości	score rerank

KomunikatZakończeniaRozmowyNarzędziaCall

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt	Funkcja, którą model wywoływał.	Tak
└─ Argumenty	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje prawidłowy JSON i może halucynować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	No
id	ciąg	ID wywołania narzędzia.	Tak
typ	toolCallType	Typ wywołania narzędzia, w tym przypadku function.	Tak

typWywołaniaNarzędzia

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

Majątek	Wartość
Opis	Typ wywołania narzędzia, w tym przypadku function.
Typ	ciąg
Wartości	function

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

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

chatCompletionRequestMessageFunction

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

utwórzOdpowiedźNaZakończenieCzatu

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

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
id	ciąg	Unikalny identyfikator zakończenia czatu.	Tak
model	ciąg	Model użyty do zakończenia czatu.	Tak
obiekt	wyliczenie	Typ obiektu, który zawsze chat.completionjest . Możliwe wartości: chat.completion	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
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	Wartość domyślna
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
id	ciąg	Unikalny identyfikator zakończenia czatu. Każdy chunk ma ten sam identyfikator.	Tak
model	ciąg	Model do wygenerowania zakończenia.	Tak
obiekt	wyliczenie	Typ obiektu, który zawsze chat.completion.chunkjest . Możliwe wartości: chat.completion.chunk	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

chatCompletionStreamResponseDelta

Delta zakończenia czatu generowana przez odpowiedzi streamowanych modeli.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
└─ Argumenty	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje prawidłowy JSON i może halucynować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	No
refusal	ciąg	Komunikat odmowy generowany przez model.	No
rola	wyliczenie	Rola autora tego przesłania. Możliwe wartości: system, user, , assistanttool	No
tool_calls	macierz		No

Segment wywołania narzędzia wiadomości chatCompletion

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt		No
└─ Argumenty	ciąg	Argumenty, które mają wywołać funkcję, generowane przez model w formacie JSON. Należy zauważyć, że model nie zawsze generuje prawidłowy JSON i może halucynować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	No
id	ciąg	ID wywołania narzędzia.	No
indeks	liczba całkowita		Tak
typ	wyliczenie	Rodzaj narzędzia. Obecnie obsługiwany jest tylko function on. Możliwe wartości: function	No

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	Wartość domyślna
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 reprezentuje bajtów.	Tak
logprob	number	Log probability tego tokena.	Tak
kod przedpłaty	ciąg	Znacznik.	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	Wartość domyślna
audio	obiekt	Jeśli zażądana jest modalność wyjściowa dźwięku, obiekt ten zawiera dane dotyczące odpowiedzi audio z modelu.	No
└─ dane	ciąg	Base64 kodował bajty audio generowane przez model, w formacie określonym w żądaniu.	No
└─ wygasa_o	liczba całkowita	Znacznik czasu Uniksa (w sekundach), kiedy ta odpowiedź dźwiękowa nie będzie już dostępna na serwerze do wieloturowych rozmów.	No
└─ ID	ciąg	Unikalny identyfikator tej odpowiedzi audio.	No
└* transkrypcja	ciąg	Transkrypcja dźwięku generowanego przez model.	No
zawartość	ciąg	Treść wiadomości.	Tak
kontekst	azureChatExtensionsMessageContext	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.	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
refusal	ciąg	Komunikat odmowy generowany przez model.	Tak
rola	chatCompletionResponseMessageRole	Rola autora wiadomości odpowiedzi.	Tak
tool_calls	macierz	Wywołania narzędzi generowane przez model, takie jak wywołania funkcji.	No

chatCompletionResponseMessageRole

Rola autora wiadomości odpowiedzi.

Majątek	Wartość
Opis	Rola autora wiadomości odpowiedzi.
Typ	ciąg
Wartości	assistant

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

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
funkcja	obiekt		Tak
└─ nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	No
typ	wyliczenie	Rodzaj narzędzia. Obecnie obsługiwany jest tylko function on. Możliwe wartości: function	Tak

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.

PredictionContent

Statyczna przewidywana treść wyjściowa, taka jak zawartość pliku tekstowego, który jest regenerowany.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	ciąg lub tablica	Treść, którą należy dopasować podczas generowania odpowiedzi modelu. Jeśli wygenerowane tokeny będą odpowiadać tej treści, cała odpowiedź modelu może być zwracana znacznie szybciej.	Tak
typ	wyliczenie	Rodzaj przewidywanych treści, które chcesz dostarczyć. Ten typ jest obecnie zawsze content. Możliwe wartości: content	Tak

chatCompletionMessageToolCalls

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

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

ChatCompletionModalities

Typy wyników, które model chciałby wygenerować dla tego żądania. Większość modeli potrafi generować tekst, co jest domyślne:

["text"]

Model ten gpt-4o-audio-preview może być również używany do generowania dźwięku. Aby poprosić ten model o generowanie zarówno odpowiedzi tekstowych, jak i audio, możesz użyć:

["text", "audio"]

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
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 prawidłowy JSON i może halucynować parametry niezdefiniowane przez schemat funkcji. Zweryfikowaj argumenty w swoim kodzie przed wywołaniem funkcji.	Tak
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	Tak

completionUsage

Statystyki wykorzystania wniosku o zakończenie.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
completion_tokens	liczba całkowita	Liczba tokenów w wygenerowanym ukończeniu.	Tak
completion_tokens_details	obiekt	Podział tokenów używanych w zakończeniu transakcji.	No
└zaakceptowane_tokeny_predykcji	liczba całkowita	Przy użyciu Predicted Outputs, liczba tokenów w przewidywaniu, które pojawiły się podczas zakończenia.	No
└audio_tokens	liczba całkowita	Tokeny wejściowe audio generowane przez model.	No
└─ tokeny_rozumowania	liczba całkowita	Tokeny generowane przez model do rozumowania.	No
└─ odrzucone_żetony_predykcji	liczba całkowita	Przy użyciu Predicted Outputs, liczba tokenów w przewidywaniu, które nie pojawiły się w ukończeniu. Jednak podobnie jak tokeny rozumowania, te tokeny są nadal liczone do tokenów całkowitego ukończenia na potrzeby rozliczeń, wyników i limitów okien kontekstowych.	No
prompt_tokens	liczba całkowita	Liczba żetonów w promptie.	Tak
prompt_tokens_details	obiekt	Szczegóły tokenów promptu.	No
└audio_tokens	liczba całkowita	Tokeny wejściowe audio obecne w poleceniu.	No
└cached_tokens	liczba całkowita	Liczba zbuforowanych tokenów promptów.	No
total_tokens	liczba całkowita	Całkowita liczba tokenów użytych w żądaniu (prompt + zakończenie).	Tak

narzędzie do zakończenia czatu

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	FunctionObject		Tak
typ	wyliczenie	Rodzaj narzędzia. Obecnie obsługiwany jest tylko function on. Możliwe wartości: function	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: text	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
json_schema	obiekt		Tak
Opis └*	ciąg	Opis formatu odpowiedzi, używany przez model do określenia, jak odpowiedzieć w formacie.	No
└─ 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.	No
Schemat └*	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.	No
└* ścisłe	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	No	Nieprawda
typ	wyliczenie	Typ definiowanego formatu odpowiedzi: json_schema Możliwe wartości: json_schema	Tak

Opcja ukończenia rozmowy wspólna

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
powód zakończenia	ciąg		No
indeks	liczba całkowita		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 ją na 0, model wykorzystuje logarytmiczne prawdopodobieństwo 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	Wartość domyślna
duration	number	Czas trwania.	No
język	ciąg	Language.	No
segments	macierz		No
zadanie	ciąg	Rodzaj zadania audio.	No
SMS	ciąg	Tekst przetłumaczony lub przepisany.	Tak
Słowy	macierz		No

audioResponseFormat

Definiuje format wyjścia.

Majątek	Wartość
Opis	Definiuje format wyjścia.
Typ	ciąg
Wartości	json text 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
język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 poprawia dokładność i opóźnienia.	No
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 ją na 0, model wykorzystuje logarytmiczne prawdopodobieństwo do automatycznego podnoszenia temperatury aż do osiągnięcia określonych progów.	No	0
timestamp_granularities[]	macierz	Szczegóły dotyczące znaczników czasowych do wypełnienia dla tej transkrypcji. response_format musi być ustawiony verbose_json tak, aby używać szczegółowości znaczników czasu. Obsługiwane są te opcje lub obie: word, lub segment. Uwaga: Nie ma dodatkowego opóźnienia dla znaczników czasu segmentów, ale generowanie znaczników czasu słów powoduje dodatkowe opóźnienia.	No	['segment']

Fragment dźwiękowy

Segment transkrypcji lub tłumaczenia.

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

audioWord

Transkrypcja lub tłumaczenie.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
end	number	Word przesunięcie końcowe.	No
początek	number	Word Start offset.	No
słowo	ciąg	Słowo	No

createSpeechRequest

Żądanie mowy.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane wejściowe	ciąg	Tekst do syntezy dźwięku. Maksymalna długość to 4 096 znaków.	Tak
format_odpowiedzi	wyliczenie	Format do syntezy dźwięku. Możliwe wartości: mp3, opus, aac, , flac, wav, pcm	No
Prędkość	number	Szybkość syntetycznego dźwięku. Wybierz wartość z 0.25 do .4.0 1.0 jest domyślna.	No	1.0
voice	wyliczenie	Głos do syntezy mowy. Możliwe wartości: alloy, echo, fable, , onyx, nova, shimmer	Tak

imageQuality

Jakość wygenerowanego obrazu.

Majątek	Wartość
Opis	Jakość wygenerowanego obrazu.
Typ	ciąg
Wartość domyślna	samochód
Wartości	auto high medium low hd standard

imagesResponseFormat

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

Majątek	Wartość
Opis	Format, w którym zwracane są wygenerowane obrazy.
Typ	ciąg
Wartość domyślna	Adres url
Wartości	url b64_json

imagesOutputFormat

Format pliku, w którym zwracane są wygenerowane obrazy. Obsługiwane tylko dla modeli serialowych.

Majątek	Wartość
Opis	Format pliku, w którym zwracane są wygenerowane obrazy. Obsługiwane tylko dla modeli z serii gpt-image-1.
Typ	ciąg
Wartość domyślna	png
Wartości	png jpeg

imageSize

Rozmiar wygenerowanych obrazów.

Majątek	Wartość
Opis	Rozmiar wygenerowanych obrazów.
Typ	ciąg
Wartość domyślna	samochód
Wartości	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

imageStyle

Styl generowanych obrazów. Obsługiwane tylko dla dall-e-3.

Majątek	Wartość
Opis	Styl generowanych obrazów. Obsługiwane tylko dla dall-e-3.
Typ	ciąg
Wartość domyślna	żywy
Wartości	vivid natural

imageBackground

Pozwala ustawić przezroczystość tła wygenerowanego obrazu. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1.

Majątek	Wartość
Opis	Pozwala ustawić przezroczystość tła wygenerowanego obrazu. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1.
Typ	ciąg
Wartość domyślna	samochód
Wartości	transparent opaque auto

żądanieGeneracjiObrazów

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
tło	imageBackground	Pozwala ustawić przezroczystość tła wygenerowanego obrazu. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1.	No	samochód
n	liczba całkowita	Liczba obrazów do wygenerowania. Dla dall-e-3 obsługiwane jest tylko n=1.	No	1
kompresja wyjściowa	liczba całkowita	Poziom kompresji (0-100%) dla wygenerowanych obrazów. Ten parametr jest obsługiwany tylko dla modeli serii gpt-image-1 z formatem wyjściowym jpeg.	No	100
format_wyjściowy	imagesOutputFormat	Format pliku, w którym zwracane są wygenerowane obrazy. Obsługiwane tylko dla modeli z serii gpt-image-1.	No	png
monit	ciąg	Tekstowy opis pożądanego obrazu(ów). Maksymalna długość to 32000 znaków dla modeli serii gpt-image-1 oraz 4000 znaków dla dall-e-3	Tak
jakość	imageQuality	Jakość wygenerowanego obrazu.	No	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym zwracane są wygenerowane obrazy. Obsługiwane tylko dla dall-e-3.	No	Adres url
size	imageSize	Rozmiar wygenerowanych obrazów.	No	samochód
styl	imageStyle	Styl generowanych obrazów. Obsługiwane tylko dla dall-e-3.	No	żywy
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No

imageEditsRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
obraz	ciąg lub tablica	Obraz(y) do edycji. Musi to być wspierany plik obrazów lub tablica obrazów. Każdy obraz powinien mieć plik png, czyli plik jpg mniejszy niż 25MB.	Tak
maska	ciąg	Dodatkowy obraz, którego w pełni przezroczyste obszary (np. gdzie alfa wynosi zero) wskazują, gdzie należy edytować obraz. Jeśli podano wiele obrazów, maska zostanie nałożona na pierwszy obraz. Musi to być poprawny plik PNG, mniejszy niż 4MB i mieć takie same wymiary jak obraz.	No
n	liczba całkowita	Liczba obrazów do wygenerowania.	No	1
monit	ciąg	Tekstowy opis pożądanego obrazu(ów). Maksymalna długość to 32000 znaków.	Tak
jakość	imageQuality	Jakość wygenerowanego obrazu.	No	samochód
format_odpowiedzi	imagesResponseFormat	Format, w którym zwracane są wygenerowane obrazy.	No	Adres url
size	imageSize	Rozmiar wygenerowanych obrazów.	No	samochód
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który pomaga monitorować i wykrywać nadużycia.	No

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
użycie	imageGenerationsUsage	Reprezentuje szczegóły użycia tokenów dla żądań generowania obrazów. Tylko dla modeli z serii GPT-Image-1.	No

wynikObrazu

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

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
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
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 blokowanych klientów, 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
Adres url	ciąg	URL obrazu.	No

imageGenerationsUsage

Reprezentuje szczegóły użycia tokenów dla żądań generowania obrazów. Tylko dla modeli z serii GPT-Image-1.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	No
input_tokens_details	obiekt	Szczegółowy podział tokenów wejściowych.	No
└image_tokens	liczba całkowita	Liczba tokenów obrazu.	No
└ text_tokens	liczba całkowita	Liczba tokenów tekstowych.	No
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	No
total_tokens	liczba całkowita	Całkowita liczba użytych żetonów.	No

linia

Obiekt linii treści składający się z sąsiedniej sekwencji elementów treści, takich jak słowa i znaki zaznaczenia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
Obejmuje	macierz	Tablica rozpięć reprezentujących wykryte obiekty oraz informacje o ich ramkach ograniczających.	Tak
SMS	ciąg		Tak

Span

Obiekt span reprezentujący wykryty obiekt oraz informacje o jego ramce ograniczającej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
length	liczba całkowita	Długość rozpiętości w znakach, mierzona w punktach kodowych Unicode.	Tak
przesunąć	liczba całkowita	Przesunięcie znaku w tekście, gdzie zaczyna się rozpiętość. Ten offset definiuje się jako pozycję pierwszego znaku w rozpiętości, licząc od początku tekstu jako punkty kodowe Unicode.	Tak
polygon	macierz	Tablica obiektów reprezentujących punkty w wielokątu, który otacza wykryty obiekt.	Tak
SMS	ciąg	Zawartość tekstu w rozpiętości reprezentującej wykryty obiekt.	Tak

runCompletionUsage

Statystyki użytkowania związane z biegiem. Ta wartość będzie wtedy, null gdy run nie jest w stanie terminalnym (np. in_progress, queued, itd.).

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
completion_tokens	liczba całkowita	Liczba tokenów ukończenia użytych w trakcie rozgrywki.	Tak
prompt_tokens	liczba całkowita	Liczba tokenów promptu użytych w trakcie trwania rozgrywki.	Tak
total_tokens	liczba całkowita	Łączna liczba użytych tokenów (prompt + ukończenie).	Tak

runStepCompletionUsage

Statystyki użytkowania związane ze krokiem uruchomienia. Ta wartość będzie wynosiła, null gdy status kroku run wynosi .in_progress

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
completion_tokens	liczba całkowita	Liczba tokenów ukończenia użytych w trakcie kroku przebiegu.	Tak
prompt_tokens	liczba całkowita	Liczba tokenów promptu użytych w trakcie kroku uruchomienia.	Tak
total_tokens	liczba całkowita	Łączna liczba użytych tokenów (prompt + ukończenie).	Tak

assistantsApiResponseFormatOption

Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106

Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs.

Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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.

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

• ResponseFormatText
• ResponseFormatJsonObject
• ResponseFormatJsonSchema

assistantsApiResponseFormat

Obiekt opisujący oczekiwany wynik modelu. json_object Jeśli tylko function typy tools mogą być przekazywane do Run. Jeśli text model może zwrócić tekst lub dowolną wartość,

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	ciąg	Musi być jednym z lub textjson_object.	No	SMS

typ Enum: AssistantsApiResponseFormat

Wartość	Opis
SMS
json_object

assistantObject

Reprezentuje , assistant która może wywołać model i używać narzędzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
utworzono_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) oznaczający moment utworzenia asystenta.	Tak
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	Tak
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
instructions	ciąg	System instruuje asystenta. Maksymalna długość to 256 000 znaków.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	Tak
model	ciąg	Identyfikacja modelu, którego należy użyć.	Tak
nazwa	ciąg	Imię asystenta. Maksymalna długość to 256 znaków.	Tak
obiekt	ciąg	Typ obiektu, który zawsze assistantjest .	Tak
format_odpowiedzi	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
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.	No	1
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Identyfikator magazynu wektorów przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Lista narzędzi włączonych na asystencie. Maksymalnie 128 narzędzi na asystenta może być przeznaczonych. Narzędzia mogą mieć typy code_interpreter, file_search, lub function.	Tak	[]
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1

obiekt Enum: AssistantObjectType

Wartość	Opis
asystent	Typ obiektu, którym zawsze jest asystent

createAssistantRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	No
instructions	ciąg	System instruuje asystenta. Maksymalna długość to 256 000 znaków.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg		Tak
nazwa	ciąg	Imię asystenta. Maksymalna długość to 256 znaków.	No
format_odpowiedzi	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
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.	No	1
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorów przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
└─ przechowalnie_wektorów	macierz	Pomocnik do utworzenia magazynu wektorowego za pomocą file_ids i dołączenia go do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Lista narzędzi włączonych na asystencie. Maksymalnie 128 narzędzi na asystenta może być przeznaczonych. Narzędzia mogą mieć typy code_interpreter, retrieval, lub function.	No	[]
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1

modifyAssistantRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis asystenta. Maksymalna długość to 512 znaków.	No
instructions	ciąg	System instruuje asystenta. Maksymalna długość to 32768 znaków.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg		No
nazwa	ciąg	Imię asystenta. Maksymalna długość to 256 znaków.	No
format_odpowiedzi	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
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.	No	1
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Nadpisuje listę identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	To nadpisuje wektorowy magazyn przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Lista narzędzi włączonych na asystencie. Maksymalnie 128 narzędzi na asystenta może być przeznaczonych. Narzędzia mogą mieć typy code_interpreter, retrieval, lub function.	No	[]
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1

deleteAssistantResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
usunięta	boolean		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

obiekt Enum: DeleteAssistantResponseState

Wartość	Opis
assistant.deleted

listAssistantsResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

assistantToolsCode

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	ciąg	Rodzaj narzędzia definiowanego: code_interpreter	Tak

typ Enum: assistantToolsCodeType

Wartość	Opis
code_interpreter

assistantToolsFileSearch

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
file_search	obiekt	Nadpisuje narzędzie wyszukiwania plików.	No
└max_num_results	liczba całkowita	Maksymalna liczba wyników, jakie powinno wygenerować narzędzie do wyszukiwania plików. Domyślnie to 20 dla modeli GPT-4* i 5 dla GPT-3.5-turbo. Ta liczba powinna mieścić się w zakresie od 1 do 50 włącznie. Należy zauważyć, że narzędzie do wyszukiwania plików może wygenerować mniej niż max_num_results wyniki.	No
typ	ciąg	Rodzaj narzędzia definiowanego: file_search	Tak

type Enum: typWyszukiwaniaPlikówNarzędziAsystenta

Wartość	Opis
file_search

assistantToolsFileSearchTypeOnly

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	ciąg	Rodzaj narzędzia definiowanego: file_search	Tak

type Enum: typWyszukiwaniaPlikówNarzędziAsystenta

Wartość	Opis
file_search

assistantToolsFunction

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt	Definicja funkcji.	Tak
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.	No
Parametry	chatCompletionFunctionParameters	Parametry, które funkcje akceptują, są opisane jako obiekt schematu JSON. Zobacz przewodnik/ dla przykładów oraz w JSON Schema jako źródło dokumentacji dotyczącej formatu.	No
typ	ciąg	Rodzaj narzędzia definiowanego: function	Tak

type Enum: assistantToolsFunction

Wartość	Opis
funkcja

obcięcie obiektuObject

Kontrole dotyczące tego, jak wątek zostanie obcięty przed uruchomieniem. Użyj tego do kontrolowania początkowego okna kontekstu przebiegu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
last_messages	liczba całkowita	Liczba najnowszych wiadomości z wątku podczas tworzenia kontekstu do przebiegu.	No
typ	ciąg	Strategia obcinania do zastosowania dla wątku. Wartość domyślna to auto. Jeśli ustawimy na , last_messageswątek zostanie obcięty do n najnowszych wiadomości w wątku. Po ustawieniu na auto, wiadomości w środku wątku zostaną usunięte, aby dopasować się do długości kontekstu modelu, max_prompt_tokens.	Tak

typ Enum: Truncation Type

Wartość	Opis
samochód
last_messages

assistantsApiToolChoiceOption

Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none oznacza to, że model nie wywołuje żadnych narzędzi, lecz generuje wiadomość. auto jest wartością domyślną i oznacza, że model może wybrać między generowaniem wiadomości a wywołaniem narzędzia. Określenie konkretnego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymuszanie wywołania tego narzędzia, wymusza model.

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

• assistantsNamedToolChoice

assistantsNamedToolChoice

Określa narzędzie, którego model powinien używać. Używam go do wymuszenia wywołania konkretnego narzędzia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt		No
└─ nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	No
typ	ciąg	Rodzaj narzędzia. Jeśli typ jest , functionnazwa funkcji musi być ustawiona	Tak

typ Enum: AssistantsNamedToolChoiceType

Wartość	Opis
funkcja
code_interpreter
file_search

runObject

Reprezentuje wykonanie wykonane na wątku.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
assistant_id	ciąg	ID asystenta użytego do wykonania tego przebiegu.	Tak
anulowano_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) oznaczający moment anulowania rozgrywki.	Tak
zakończono_o	liczba całkowita	Znacznik czasu w Unixie (w sekundach) oznaczający moment zakończenia przebiegu.	Tak
utworzono_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) oznaczający moment tworzenia przebiegu.	Tak
wygasa_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) oznaczający wygaśnięcie rozgrywki.	Tak
nie powiodło się o	liczba całkowita	Znacznik czasu w Unixie (w sekundach) oznaczający moment, gdy uruchomienie się nie powiodło.	Tak
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
incomplete_details	obiekt	Szczegóły dotyczące tego, dlaczego run jest niekompletny. Będzie null , jeśli run nie będzie niekompletny.	Tak
└* przyczyna	ciąg	Powód, dla którego ta seria jest niekompletna. To wskaże, który konkretny limit tokenów został osiągnięty w trakcie trwania rozgrywki.	No
instructions	ciąg	Instrukcje, których asystent użył do tego biegu.	Tak
ostatni błąd	obiekt	Ostatni błąd związany z tym biegiem. Będę null , jeśli nie ma błędów.	Tak
└─ kod	ciąg	Jeden z server_error lub rate_limit_exceeded.	No
└─ Komunikat	ciąg	Czytelny opis błędu.	No
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia określona do wykorzystania w trakcie trwania przebiegu.	Tak
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów promptu określona do wykorzystania w trakcie biegu.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	Tak
model	ciąg	Model, którego asystent użył w tym biegu.	Tak
obiekt	ciąg	Typ obiektu, który zawsze thread.runjest .	Tak
wywołania_narzędzia_równoległe	ParallelToolCalls	Czy włączyć równoległe wywoływanie funkcji podczas użycia narzędzia.	No	True
required_action	obiekt	Szczegóły dotyczące działań potrzebnych do kontynuowania trasy. Będzie null , jeśli nie będzie wymagane żadne działanie.	Tak
└submit_tool_outputs	obiekt	Szczegóły dotyczące potrzebnych wydruków narzędzi do tej serii będą kontynuowane.	No
└tool_calls	macierz	Lista odpowiednich wywołań narzędzi.	No
└typ	wyliczenie	Na razie to zawsze submit_tool_outputsjest . Możliwe wartości: submit_tool_outputs	No
format_odpowiedzi	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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.	Tak
started_at	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) oznaczający moment rozpoczęcia rozgrywki.	Tak
stan	ciąg	Status sekwencji, który może być albo queued, in_progress, requires_action, cancelling, cancelled, failed, , completed, lub expired.	Tak
temperatura	number	Temperatura próbkowania użyta w tym przebiegu. Jeśli nie jest ustawione, domyślnie jest ustawione na 1.	No
thread_id	ciąg	ID wątków, które zostały wykonane w ramach tego uruchomienia.	Tak
tool_choice	assistantsApiToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none oznacza to, że model nie wywołuje żadnych narzędzi, lecz generuje wiadomość. auto jest wartością domyślną i oznacza, że model może wybrać między generowaniem wiadomości a wywołaniem narzędzia. Określenie konkretnego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymuszanie wywołania tego narzędzia, wymusza model.	Tak
Narzędzia	macierz	Lista narzędzi, których asystent użył podczas tej rozgrywki.	Tak	[]
top_p	number	Wartość próbkowania jądra użyta w tym przebiegu. Jeśli nie jest ustawione, domyślnie jest ustawione na 1.	No
truncation_strategy	obcięcie obiektuObject	Kontrole dotyczące tego, jak wątek zostanie obcięty przed uruchomieniem. Użyj tego do kontrolowania początkowego okna kontekstu przebiegu.	Tak
użycie	runCompletionUsage	Statystyki użytkowania związane z biegiem. Ta wartość będzie wtedy, null gdy run nie jest w stanie terminalnym (np. in_progress, queued, itd.).	Tak

obiekt Enum: runObjectType

Wartość	Opis
thread.run	Typ obiektu run, który zawsze jest thread.run

status Enum: StatusUruchomieniaObiektu

Wartość	Opis
w kolejce	Stan kolejki
in_progress	Stan in_progress
requires_action	Stan required_action
Anulowanie	Stan anulujący
cancelled	Stan anulowany
niepowodzenie	Państwo upadłe
Zakończone	Stan ukończony
Wygasłe	Stan wygasłości

createRunRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
additional_instructions	ciąg	Dodaje dodatkowe instrukcje na końcu instrukcji dotyczących przebiegu. Jest to przydatne do modyfikacji zachowania na każdy bieg bez nadpisywania innych instrukcji.	No
additional_messages	macierz	Dodaje dodatkowe wiadomości do wątku przed utworzeniem uruchomienia.	No
assistant_id	ciąg	ID asystenta, którego należy użyć do wykonania tego przebiegu.	Tak
instructions	ciąg	Nadpisz domyślny komunikat systemowy asystenta. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które można użyć w trakcie trwania rozgrywki. Run stara się używać tylko określonej liczby tokenów ukończenia przez kilka tur rozgrywki. Jeśli przebieg przekroczy podaną liczbę tokenów ukończenia, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów promptów, które można użyć w trakcie trwania biegu. Run stara się używać tylko określonej liczby tokenów promptu przez kilka tur rozgrywki. Jeśli przebieg przekroczy określoną liczbę tokenów promptu, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg	ID Modelu użytego do wykonania tego przebiegu. Jeśli tutaj podana jest wartość, zostanie ona nadpisana przez model powiązany z asystentem. Jeśli nie, zostanie użyty model powiązany z asystentem.	No
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	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
odtwarzać strumieniowo	boolean	Jeśli true, zwraca strumień zdarzeń, które mają miejsce podczas Run jako zdarzenia wysyłane przez serwer, kończąc się, gdy Run wchodzi w stan terminalowy z wiadomością data: [DONE] .	No
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.	No	1
tool_choice	assistantsApiToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none oznacza to, że model nie wywołuje żadnych narzędzi, lecz generuje wiadomość. auto jest wartością domyślną i oznacza, że model może wybrać między generowaniem wiadomości a wywołaniem narzędzia. Określenie konkretnego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymuszanie wywołania tego narzędzia, wymusza model.	No
Narzędzia	macierz	Nadpisz narzędzia, których asystent może użyć w tym biegu. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1
truncation_strategy	obcięcie obiektuObject	Kontrole dotyczące tego, jak wątek zostanie obcięty przed uruchomieniem. Użyj tego do kontrolowania początkowego okna kontekstu przebiegu.	No

listRunsResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

modifyRunRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No

submitToolOutputsRunRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
odtwarzać strumieniowo	boolean	Jeśli true, zwraca strumień zdarzeń, które mają miejsce podczas Run jako zdarzenia wysyłane przez serwer, kończąc się, gdy Run wchodzi w stan terminalowy z wiadomością data: [DONE] .	No
tool_outputs	macierz	Lista narzędzi, dla których przesyłane są wyniki.	Tak

runToolCallObject

Obiekty wywołań narzędzi

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt	Definicja funkcji.	Tak
└─ Argumenty	ciąg	Argumenty, które model oczekuje, że przekażesz do funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji.	No
id	ciąg	ID wywołania narzędzia. Ten identyfikator musi być podany podczas przesyłania wyjść narzędzia, używając wyjść narzędzia do uruchomienia endpointendpoint.	Tak
typ	ciąg	Rodzaj wywołania narzędzia jest wymagane dla wyjścia. Na razie to zawsze functionjest .	Tak

Typ Enum: RunToolCallObjectType

Wartość	Opis
funkcja

createThreadAndRunRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
assistant_id	ciąg	ID asystenta, którego należy użyć do wykonania tego przebiegu.	Tak
instructions	ciąg	Nadpisz domyślny komunikat systemowy asystenta. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów ukończenia, które można użyć w trakcie trwania rozgrywki. Run stara się używać tylko określonej liczby tokenów ukończenia przez kilka tur rozgrywki. Jeśli przebieg przekroczy podaną liczbę tokenów ukończenia, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
max_prompt_tokens	liczba całkowita	Maksymalna liczba tokenów promptów, które można użyć w trakcie trwania biegu. Run stara się używać tylko określonej liczby tokenów promptu przez kilka tur rozgrywki. Jeśli przebieg przekroczy określoną liczbę tokenów promptu, zakończy się ze statusem incomplete. Zobacz więcej incomplete_details informacji.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
model	ciąg	ID modeli, które mają zostać użyte do wykonania tego przebiegu. Jeśli tutaj podana jest wartość, zostanie ona nadpisana przez model powiązany z asystentem. Jeśli nie, zostanie użyty model powiązany z asystentem.	No
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	assistantsApiResponseFormatOption	Określa format, który model musi wyprowadzać. Kompatybilny z GPT-4o, GPT-4 Turbo oraz wszystkimi modelami GPT-3.5 Turbo od .gpt-3.5-turbo-1106 Ustawienie na { "type": "json_schema", "json_schema": {...} } aktywne Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON. Dowiedz się więcej w przewodniku po Structured Outputs. Ustawienie na { "type": "json_object" } włączenie trybu JSON, który zapewnia, że komunikat generowany przez model 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
odtwarzać strumieniowo	boolean	Jeśli true, zwraca strumień zdarzeń, które mają miejsce podczas Run jako zdarzenia wysyłane przez serwer, kończąc się, gdy Run wchodzi w stan terminalowy z wiadomością data: [DONE] .	No
stream_options	chatCompletionStreamOptions	Opcje odpowiedzi na streaming. Ustawiam to tylko wtedy, gdy ustawiasz stream: true.	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.	No	1
konwersacja	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	Kontroluje, które (jeśli w ogóle) narzędzie jest wywoływane przez model. none oznacza to, że model nie wywołuje żadnych narzędzi, lecz generuje wiadomość. auto jest wartością domyślną i oznacza, że model może wybrać między generowaniem wiadomości a wywołaniem narzędzia. Określenie konkretnego narzędzia, takiego jak {"type": "file_search"} lub {"type": "function", "function": {"name": "my_function"}} wymuszanie wywołania tego narzędzia, wymusza model.	No
tool_resources	obiekt	Zestaw zasobów wykorzystywanych przez narzędzia asystenta. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Identyfikator magazynu wektorów przypisany do tego asystenta. Asystent może być dołączony maksymalnie do jednego pamięci wektorowej.	No
Narzędzia	macierz	Nadpisz narzędzia, których asystent może użyć w tym biegu. Jest to przydatne do modyfikacji zachowania na podstawie pojedynczego biegu.	No
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 zmianę tego lub temperatury, ale nie obu naraz.	No	1
truncation_strategy	obcięcie obiektuObject	Kontrole dotyczące tego, jak wątek zostanie obcięty przed uruchomieniem. Użyj tego do kontrolowania początkowego okna kontekstu przebiegu.	No

threadObject

Reprezentuje wątek zawierający wiadomości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
utworzono_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) oznaczający moment utworzenia wątku.	Tak
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	Tak
obiekt	ciąg	Typ obiektu, który zawsze threadjest .	Tak
tool_resources	obiekt	Zestaw zasobów dostępnych dla narzędzi asystenta w tym wątku. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	Tak
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorowy dołączony do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No

obiekt Enum: ThreadObjectType

Wartość	Opis
konwersacja	Typ obiektu wątku, który zawsze jest thread

createThreadRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
messages	macierz	Lista wiadomości, od których warto zacząć wątek.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
tool_resources	obiekt	Zestaw zasobów dostępnych dla narzędzi asystenta w tym wątku. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorowy dołączony do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No
└─ przechowalnie_wektorów	macierz	Pomocnik do stworzenia magazynu wektorowego z file_ids i dołączenia go do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No

modifyThreadRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
tool_resources	obiekt	Zestaw zasobów dostępnych dla narzędzi asystenta w tym wątku. Zasoby są specyficzne dla rodzaju narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, podczas gdy narzędzie file_search wymaga listy identyfikatorów pamięci wektorowej.	No
└ code_interpreter	obiekt		No
└ file_ids	macierz	Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Z narzędziem może być maksymalnie 20 plików.	No	[]
└file_search	obiekt		No
└vector_store_ids	macierz	Magazyn wektorowy dołączony do tego wątku. Do wątku może być dołączony maksymalnie 1 pojemnik wektorowy.	No

deleteThreadResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
usunięta	boolean		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

object Enum: DeleteThreadResponseObjectState

Wartość	Opis
thread.deleted	Stan odpowiedź typu delete thread response (odpowiedź wątku) jest thread.deleted

listThreadsResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

messageObject

Reprezentuje wiadomość w wątkach.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
assistant_id	ciąg	Jeśli dotyczy, ID asystenta, który napisał tę wiadomość.	Tak
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzi, do których zostały dodane.	Tak
zakończono_o	liczba całkowita	Znacznik czasu Unix (w sekundach) oznaczał moment ukończenia wiadomości.	Tak
zawartość	macierz	Treść wiadomości w formie tekstu i/lub obrazów.	Tak
utworzono_o	liczba całkowita	Znacznik czasu w Unixie (w sekundach) oznaczający moment utworzenia wiadomości.	Tak
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
incomplete_at	liczba całkowita	Znacznik czasu w Unix (w sekundach) oznaczał, gdy wiadomość była oznaczona jako niekompletna.	Tak
incomplete_details	obiekt	W przypadku niekompletnej wiadomości szczegóły wyjaśniające, dlaczego wiadomość jest niekompletna.	Tak
└* przyczyna	ciąg	Powód, dla którego wiadomość jest niekompletna.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	Tak
obiekt	ciąg	Typ obiektu, który zawsze thread.messagejest .	Tak
rola	ciąg	Istota, która wyprodukowała wiadomość. Jeden z user lub assistant.	Tak
run_id	ciąg	Jeśli dotyczy, ID wyniku powiązanego z autorem tej wiadomości.	Tak
stan	ciąg	Status wiadomości, który może być albo in_progress, incomplete, lub completed.	Tak
thread_id	ciąg	Wątki wskazują, do których należy ta wiadomość.	Tak

obiekt Enum: MessageObjectType

Wartość	Opis
thread.message	Typ obiektu wiadomości, który jest thread.message

Enum statusu: Status obiektu wiadomości

Wartość	Opis
in_progress
Niekompletna
Zakończone

rola Enum: MessageObjectRole

Wartość	Opis
użytkownik
asystent

messageDeltaObject

Reprezentuje delta wiadomości, czyli wszelkie zmienione pola w wiadomości podczas streamingu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
delta	obiekt	Delta zawierająca pola, które zmieniły się w wiadomości.	Tak
└─ zawartość	macierz	Treść wiadomości w formie tekstu i/lub obrazów.	No
└─ Rola	ciąg	Istota, która wyprodukowała wiadomość. Jeden z user lub assistant.	No
id	ciąg	Identyfikator wiadomości, który może być odwołany w końcowych punktach API.	Tak
obiekt	ciąg	Typ obiektu, który zawsze thread.message.deltajest .	Tak

obiekt Enum: MessageDeltaObjectType

Wartość	Opis
thread.message.delta

createMessageRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
Załączniki	macierz	Lista plików dołączonych do wiadomości oraz narzędzi, do których powinny zostać dodane.	No
zawartość	ciąg	Treść wiadomości.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
rola	ciąg	Rola podmiotu, który tworzy przekaz. Dozwolone wartości obejmują: - user: Oznacza, że wiadomość została wysłana przez rzeczywistego użytkownika i powinna być w większości przypadków używana do reprezentowania wiadomości generowanych przez użytkowników. - assistant: Oznacza, że wiadomość jest generowana przez asystenta. Użyj tej wartości, aby wstawić wiadomości od asystenta do rozmowy.	Tak

role Enum: CreateMessageRequestRole

Wartość	Opis
użytkownik
asystent

modifyMessageRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No

deleteMessageResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
usunięta	boolean		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

obiekt Enum: DeleteMessageResponseObject

Wartość	Opis
thread.message.deleted	Stan obiektu odpowiedzi na wiadomość usuwać

listMessagesResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

messageContentImageFileObject

Odnosi się do pliku obrazu w treści wiadomości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
image_file	obiekt		Tak
└ file_id	ciąg	Identyfikator pliku obrazu w treści wiadomości.	No
typ	ciąg	Zawsze image_file.	Tak

type Enum: MessageContentImageFileType ObjectType

Wartość	Opis
image_file	Typ pliku obrazu treści wiadomości

messageContentTextObject

Treść tekstu będąca częścią wiadomości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
SMS	obiekt		Tak
└* adnotacje	macierz		No
└─ wartość	ciąg	Dane, które tworzą tekst.	No
typ	ciąg	Zawsze text.	Tak

type Enum: TypObiektuTekstowegoTreściWiadomości

Wartość	Opis
SMS	Tekst treści wiadomości Typ obiektu

messageContentTextAnnotationsFileCitationObject

Cytat w wiadomości, który wskazuje na konkretny cytat z konkretnego pliku powiązanego z asystentem lub wiadomością. Generowane przez asystenta używa narzędzia "pobieranie" do przeszukiwania plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
end_index	liczba całkowita		Tak
file_citation	obiekt		Tak
└ file_id	ciąg	Identyfikator konkretnego pliku, z którego pochodzi cytat.	No
start_index	liczba całkowita		Tak
SMS	ciąg	Tekst w treści wiadomości, który trzeba wymienić.	Tak
typ	ciąg	Zawsze file_citation.	Tak

typ Enum: FileCitationObjectType

Wartość	Opis
file_citation	Typ obiektu cytowania pliku

messageContentTextAnnotationsFilePathObject

URL pliku, który został wygenerowany, gdy asystent użył code_interpreter narzędzia do wygenerowania pliku.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
end_index	liczba całkowita		Tak
file_path	obiekt		Tak
└ file_id	ciąg	ID wygenerowanego pliku.	No
start_index	liczba całkowita		Tak
SMS	ciąg	Tekst w treści wiadomości, który trzeba wymienić.	Tak
typ	ciąg	Zawsze file_path.	Tak

typ Enum: FilePathObjectType

Wartość	Opis
file_path	Typ obiektu ścieżki pliku

messageDeltaContentImageFileObject

Odnosi się do pliku obrazu w treści wiadomości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
image_file	obiekt		No
└ file_id	ciąg	Identyfikator pliku obrazu w treści wiadomości.	No
indeks	liczba całkowita	Indeks treści w wiadomości.	Tak
typ	ciąg	Zawsze image_file.	Tak

type Enum: MessageDeltaContentImageFileObjectType

Wartość	Opis
image_file

messageDeltaContentTextObject

Treść tekstu będąca częścią wiadomości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
indeks	liczba całkowita	Indeks treści w wiadomości.	Tak
SMS	obiekt		No
└* adnotacje	macierz		No
└─ wartość	ciąg	Dane, które tworzą tekst.	No
typ	ciąg	Zawsze text.	Tak

type Enum: MessageDeltaContentTextObjectType

Wartość	Opis
SMS

messageDeltaContentTextAnnotationsFileCitationObject

Cytat w wiadomości, który wskazuje na konkretny cytat z konkretnego pliku powiązanego z asystentem lub wiadomością. Generowane przez asystenta używa narzędzia "file_search" do wyszukiwania plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
end_index	liczba całkowita		No
file_citation	obiekt		No
└ file_id	ciąg	Identyfikator konkretnego pliku, z którego pochodzi cytat.	No
└cudzysłów	ciąg	Konkretny cytat w pliku.	No
indeks	liczba całkowita	Indeks adnotacji w części tekstowej.	Tak
start_index	liczba całkowita		No
SMS	ciąg	Tekst w treści wiadomości, który trzeba wymienić.	No
typ	ciąg	Zawsze file_citation.	Tak

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Wartość	Opis
file_citation

messageDeltaContentTextAnnotationsFilePathObject

URL pliku, który został wygenerowany, gdy asystent użył code_interpreter narzędzia do wygenerowania pliku.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
end_index	liczba całkowita		No
file_path	obiekt		No
└ file_id	ciąg	ID wygenerowanego pliku.	No
indeks	liczba całkowita	Indeks adnotacji w części tekstowej.	Tak
start_index	liczba całkowita		No
SMS	ciąg	Tekst w treści wiadomości, który trzeba wymienić.	No
typ	ciąg	Zawsze file_path.	Tak

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Wartość	Opis
file_path

runStepObject

Oznacza krok w wykonaniu przebiegu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
assistant_id	ciąg	ID asystenta powiązanego z krokiem biegu.	Tak
anulowano_o	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) oznaczający moment anulowania kroku uruchomienia.	Tak
zakończono_o	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) oznaczający zakończenie kroku uruchomienia.	Tak
utworzono_o	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) oznaczający moment utworzenia kroku uruchomienia.	Tak
wygasło_o	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) oznaczający moment wygaśnięcia kroku uruchomienia. Krok uważa się za wygasły, jeśli nadrzany run jest wygasły.	Tak
nie powiodło się o	liczba całkowita	Znacznik czasu w Uniksie (w sekundach) oznaczający moment, gdy krok uruchomienia się nie powiódł.	Tak
id	ciąg	Identyfikator kroku uruchomienia, który może być odwołany w końcowych punktach API.	Tak
ostatni błąd	obiekt	Ostatni błąd związany z tym krokiem biegu. Będę null , jeśli nie ma błędów.	Tak
└─ kod	ciąg	Jeden z server_error lub rate_limit_exceeded.	No
└─ Komunikat	ciąg	Czytelny opis błędu.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	Tak
obiekt	ciąg	Typ obiektu, który zawsze assistant.run.stepjest .	Tak
run_id	ciąg	ID biegu, którego jest częścią ten krok.	Tak
stan	ciąg	Status ciągu może być albo in_progress, cancelled, failed, completed, lub expired.	Tak
step_details	runStepDetailsMessageCreationObject lub runStepDetailsToolCallsObject	Szczegóły kroku biegu.	Tak
thread_id	ciąg	ID wątków, które zostały uruchomione.	Tak
typ	ciąg	Typ kroku biegu, który może być albo message_creation albo tool_calls.	Tak

obiekt Enum: RunStepObjectType

Wartość	Opis
assistant.run.step	Typ obiektu, który zawsze jest assistant.run.step

typ Enum: RunStepObjectType

Wartość	Opis
message_creation	Krok message_creation run
tool_calls	Krok tool_calls biegu

Status Enum: RunStepObjectStatus

Wartość	Opis
in_progress	Status in_progress run
cancelled	Status odwołanego kursu
niepowodzenie	Status odwołanego kursu
Zakończone	Status odwołanego kursu
Wygasłe	Status odwołanego kursu

runStepDeltaObject

Reprezentuje delta kroku biegu, czyli wszelkie zmienione pola na kroku biegu podczas streamingu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
delta	obiekt	Delta zawierająca pola, które zmieniły się w kroku biegu.	Tak
└─ szczegóły kroku	runStepDeltaStepDetailsMessageCreationObject,runStepDeltaStepDetailsToolCallsObject.	Szczegóły kroku biegu.	No
id	ciąg	Identyfikator kroku uruchomienia, który może być odwołany w końcowych punktach API.	Tak
obiekt	ciąg	Typ obiektu, który zawsze thread.run.step.deltajest .	Tak

obiekt Enum: RunStepDeltaObjectType

Wartość	Opis
thread.run.step.delta

listRunStepsResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

runStepDetailsMessageCreationObject

Szczegóły tworzenia wiadomości przez krok uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
message_creation	obiekt		Tak
└ message_id	ciąg	ID wiadomości utworzonej przez ten krok uruchomienia.	No
typ	ciąg	Zawsze message_creation.	Tak

type Enum: Typ obiektu tworzenia wiadomości szczegółów kroku wykonania

Wartość	Opis
message_creation

runStepDeltaStepDetailsMessageCreationObject

Szczegóły tworzenia wiadomości przez krok uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
message_creation	obiekt		No
└ message_id	ciąg	ID wiadomości utworzonej przez ten krok uruchomienia.	No
typ	ciąg	Zawsze message_creation.	Tak

typ Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Wartość	Opis
message_creation

runStepDetailsToolCallsObject

Szczegóły wezwania narzędzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
tool_calls	macierz	Etap run był stosowany w wielu wywołaniach narzędzi. Można je kojarzyć z jednym z trzech typów narzędzi code_interpreter: , retrieval lub function.	Tak
typ	ciąg	Zawsze tool_calls.	Tak

type Enum: RunStepDetailsToolCallsObjectType

Wartość	Opis
tool_calls

runStepDeltaStepDetailsToolCallsObject

Szczegóły wezwania narzędzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
tool_calls	macierz	Etap run był stosowany w wielu wywołaniach narzędzi. Można je kojarzyć z jednym z trzech typów narzędzi code_interpreter: , file_search lub function.	No
typ	ciąg	Zawsze tool_calls.	Tak

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Wartość	Opis
tool_calls

runStepDetailsToolCallsCodeObject

Szczegóły narzędzia Code Interpreter nazywa się krokiem uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
code_interpreter	obiekt	Definicja wywołania narzędzia Code Interpreter.	Tak
└─ Wejście	ciąg	Wejście do wywołania narzędzia Code Interpreter.	No
Dane wyjściowe └}	macierz	Wynik z narzędzia Code Interpreter. Code Interpreter może wygenerować jeden lub więcej elementów, w tym tekst (logs) lub obrazy (image). Każdy z nich jest reprezentowany przez inny typ obiektu.	No
id	ciąg	ID wywołania narzędzia.	Tak
typ	ciąg	Rodzaj wezwania narzędzi. To zawsze będzie dotyczyć code_interpreter tego typu narzędzi.	Tak

type Enum: RunStepDetailsToolCallsCodeObjectType

Wartość	Opis
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Szczegóły narzędzia Code Interpreter nazywa się krokiem uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
code_interpreter	obiekt	Definicja wywołania narzędzia Code Interpreter.	No
└─ Wejście	ciąg	Wejście do wywołania narzędzia Code Interpreter.	No
Dane wyjściowe └}	macierz	Wynik z narzędzia Code Interpreter. Code Interpreter może wygenerować jeden lub więcej elementów, w tym tekst (logs) lub obrazy (image). Każdy z nich jest reprezentowany przez inny typ obiektu.	No
id	ciąg	ID wywołania narzędzia.	No
indeks	liczba całkowita	Indeks wywołania narzędzia w tablicy wywołań narzędzi.	Tak
typ	ciąg	Rodzaj wezwania narzędzi. To zawsze będzie dotyczyć code_interpreter tego typu narzędzi.	Tak

typ wyliczeniowy Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Wartość	Opis
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Tekst wywołany przez narzędzie Code Interpreter jako część kroku uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dzienniki	ciąg	Tekst wychodzi z wywołania narzędzia Code Interpreter.	Tak
typ	ciąg	Zawsze logs.	Tak

Typ Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Wartość	Opis
dzienniki

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Tekst wywołany przez narzędzie Code Interpreter jako część kroku uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
indeks	liczba całkowita	Indeks wyjścia w tablicy outputów.	Tak
dzienniki	ciąg	Tekst wychodzi z wywołania narzędzia Code Interpreter.	No
typ	ciąg	Zawsze logs.	Tak

Step 2: Typ wyliczeniowy: Obiekt typu RunStepDeltaStepDetailsToolCallsCodeOutputLogs

Wartość	Opis
dzienniki

runStepDetailsToolCallsCodeOutputImageObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
obraz	obiekt		Tak
└ file_id	ciąg	Identyfikator pliku obrazu.	No
typ	ciąg	Zawsze image.	Tak

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Wartość	Opis
obraz

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
obraz	obiekt		No
└ file_id	ciąg	Identyfikator pliku obrazu.	No
indeks	liczba całkowita	Indeks wyjścia w tablicy outputów.	Tak
typ	ciąg	Zawsze image.	Tak

typ Enum: RunStepDeltaStepDetailsNarzędziaWywołaniaKodWynikowyObiektGraficzny

Wartość	Opis
obraz

runStepDetailsToolCallsFileSearchObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
file_search	obiekt	Na razie to zawsze będzie pusty obiekt.	Tak
Wyniki └}	macierz	Wyniki wyszukiwania plików.	No
id	ciąg	ID obiektu wywołania narzędzia.	Tak
typ	ciąg	Rodzaj wezwania narzędzi. To zawsze będzie dotyczyć file_search tego typu narzędzi.	Tak

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Wartość	Opis
file_search

runStepDetailsToolCallsFileSearchResultObject

Instancja wyników wyszukiwania plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	macierz	Treść znalezionego rezultatu. Treść jest dołączana tylko na żądanie za pomocą parametru zapytania include.	No
identyfikator_pliku	ciąg	Identyfikacja pliku znaleziono w tym wyniku.	Tak
nazwa_pliku	ciąg	Nazwa pliku, w którym znaleziono ten wynik.	Tak
wynik	number	Wynik wyniku. Wszystkie wartości muszą mieć wartość zmiennoprzecinkową od 0 do 1.	Tak

runStepDeltaStepDetailsToolCallsFileSearchObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
file_search	obiekt	Na razie to zawsze będzie pusty obiekt.	Tak
id	ciąg	ID obiektu wywołania narzędzia.	No
indeks	liczba całkowita	Indeks wywołania narzędzia w tablicy wywołań narzędzi.	Tak
typ	ciąg	Rodzaj wezwania narzędzi. To zawsze będzie dotyczyć retrieval tego typu narzędzi.	Tak

type Enum: Typ obiektu wyszukiwania plików w narzędziu wywołań RunStepDeltaStepDetails

Wartość	Opis
file_search

runStepDetailsToolCallsFunctionObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt	Definicja wywołanej funkcji.	Tak
└─ Argumenty	ciąg	Argumenty przechodziły do funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji.	No
└─ Dane wyjściowe	ciąg	Wyjście funkcji. Dotyczy to null sytuacji, gdy wyniki nie zostały jeszcze złożone.	No
id	ciąg	ID obiektu wywołania narzędzia.	Tak
typ	ciąg	Rodzaj wezwania narzędzi. To zawsze będzie dotyczyć function tego typu narzędzi.	Tak

type Enum: RunStepDetailsToolCallsFunctionObjectType

Wartość	Opis
funkcja

runStepDeltaStepDetailsToolCallsFunctionObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
funkcja	obiekt	Definicja wywołanej funkcji.	No
└─ Argumenty	ciąg	Argumenty przechodziły do funkcji.	No
└─ nazwa	ciąg	Nazwa funkcji.	No
└─ Dane wyjściowe	ciąg	Wyjście funkcji. Dotyczy to null sytuacji, gdy wyniki nie zostały jeszcze złożone.	No
id	ciąg	ID obiektu wywołania narzędzia.	No
indeks	liczba całkowita	Indeks wywołania narzędzia w tablicy wywołań narzędzi.	Tak
typ	ciąg	Rodzaj wezwania narzędzi. To zawsze będzie dotyczyć function tego typu narzędzi.	Tak

type Enum: RunStepDetailsToolCallsFunctionObjectType

Wartość	Opis
funkcja

vectorStoreExpirationAfter

Polityka wygaśnięcia sklepu wektorowego.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kotwica	ciąg	Zakotwiczcie znacznik czasu, po którym obowiązuje polityka wygaśnięcia. Kotwicy podtrzymywane: last_active_at.	Tak
Dni	liczba całkowita	Liczba dni po upływie czasu kotwiczenia, w których magazyn wektorowy wygaśnie.	Tak

Enum kotwiczenia: VectorStoreExpirationAfterAnchor

Wartość	Opis
ostatnia_aktywność_w	Oznacza to znacznik czasu kotwicy, po którym obowiązuje polityka wygaśnięcia.

vectorStoreObject

Magazyn wektorowy to zbiór przetworzonych plików, które narzędzie może wykorzystać file_search .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
utworzono_o	liczba całkowita	Znacznik czasu w Unixie (w sekundach) oznaczający moment tworzenia pamięci wektorowej.	Tak
wygasa po	vectorStoreExpirationAfter	Polityka wygaśnięcia sklepu wektorowego.	No
wygasa_o	liczba całkowita	Znacznik czasu Uniksa (w sekundach) oznaczający wygaśnięcie pamięci wektorowej.	No
liczba_plików	obiekt		Tak
└* anulowano	liczba całkowita	Liczba plików anulowana.	No
└─ Ukończono	liczba całkowita	Liczba plików, które zostały pomyślnie przetworzone.	No
└* nie powiodło się	liczba całkowita	Liczba plików, które nie zostały przetworzone.	No
└─ w_toku	liczba całkowita	Liczba plików obecnie przetwarzanych.	No
└─ suma	liczba całkowita	Całkowita liczba plików.	No
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
ostatnia_aktywność_w	liczba całkowita	Znacznik czasu Uniksa (w sekundach) oznaczający ostatni aktywny zapis wektorów.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	Tak
nazwa	ciąg	Nazwa magazynu wektorowego.	Tak
obiekt	wyliczenie	Typ obiektu, który zawsze vector_storejest . Możliwe wartości: vector_store	Tak
stan	ciąg	Status magazynu wektorowego, który może być albo expired, in_progress, lub completed. Status oznacza completed , że magazyn wektorowy jest gotowy do użycia.	Tak
użycie_bajtów	liczba całkowita	Całkowita liczba bajtów używanych przez pliki w pamięci wektorowej.	Tak

status Enum: VectorStoreObjectStatus

Wartość	Opis
Wygasłe
in_progress
Zakończone

createVectorStoreRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
chunking_strategy	autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto . Dotyczy tylko wtedy, gdy file_ids jest niepusty.	No
wygasa po	vectorStoreExpirationAfter	Polityka wygaśnięcia sklepu wektorowego.	No
identyfikatory_plików	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorowy. Przydatne do takich narzędzi file_search do dostępu do plików.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
nazwa	ciąg	Nazwa magazynu wektorowego.	No

updateVectorStoreRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
wygasa po	vectorStoreExpirationAfter	Polityka wygaśnięcia sklepu wektorowego.	No
metadane	obiekt	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie. Klucze mogą mieć maksymalnie 64 znaki, a wartości maksymalnie 512 znaków.	No
nazwa	ciąg	Nazwa magazynu wektorowego.	No

listVectorStoresResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

deleteVectorStoreResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
usunięta	boolean		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

obiekt Enum: DeleteVectorStoreResponseObject

Wartość	Opis
vector_store.deleted	Wektor usuwania przechowuje stan odpowiedzi obiektu

vectorStoreFileObject

Lista plików dołączonych do magazynu wektorowego.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
chunking_strategy	autoChunkingStrategyRequestParam lub staticChunkingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto . Dotyczy tylko wtedy, gdy file_ids jest niepusty.	No
utworzono_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) oznaczający moment tworzenia pliku pamięci wektorowej.	Tak
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
ostatni błąd	obiekt	Ostatni błąd związany z tym plikiem pamięci wektorowej. Będę null , jeśli nie ma błędów.	Tak
└─ kod	ciąg	Jeden z server_error lub invalid_file lub unsupported_file.	No
└─ Komunikat	ciąg	Czytelny opis błędu.	No
obiekt	ciąg	Typ obiektu, który zawsze vector_store.filejest .	Tak
stan	ciąg	Status pliku pamięci wektorowej, który może być albo in_progress, completed, cancelled, lub failed. Status completed wskazuje, że plik pamięci wektorowej jest gotowy do użycia.	Tak
użycie_bajtów	liczba całkowita	Całkowite zużycie wektorów w bajtach. Należy zauważyć, że może to różnić się od oryginalnego rozmiaru pliku.	Tak
identyfikator_magazynu_wektorów	ciąg	ID wektorowego przechowywania, do którego przypisany jest plik.	Tak

obiekt Enum: VectorStoreFileObjectType

Wartość	Opis
vector_store.file

Status Enum: VectorStoreFileObjectStatus

Wartość	Opis
in_progress
Zakończone
cancelled
niepowodzenie

otherChunkingStrategyResponseParam

Zwraca się to, gdy strategia dzielenia jest nieznana. Zazwyczaj wynika to z faktu, że plik został zindeksowany przed wprowadzeniem tego chunking_strategy pojęcia do API.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	ciąg	Zawsze other.	Tak

typ Enum: InneChunkingStrategiaOdpowiedźParamTyp

Wartość	Opis
other

staticChunkingStrategyResponseParam

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
statyczny	staticChunkingStrategy		Tak
typ	ciąg	Zawsze static.	Tak

typ Enum: StaticChunkingStrategyResponseParamType

Wartość	Opis
statyczny

staticChunkingStrategy

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
nakładanie się tokenów segmentu	liczba całkowita	Liczba żetonów nakładających się między chunkami. Domyślna wartość to 400. Należy zauważyć, że nakładanie się nie może przekraczać połowy .max_chunk_size_tokens	Tak
maksymalna_liczba_tokenów_w_kawałku	liczba całkowita	Maksymalna liczba żetonów w każdym chunku. Domyślna wartość to 800. Minimalna wartość to , 100 a maksymalna to 4096.	Tak

autoChunkingStrategyRequestParam

Domyślna strategia. Ta strategia obecnie wykorzystuje a max_chunk_size_tokens i 800chunk_overlap_tokens z 400.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Zawsze auto. Możliwe wartości: auto	Tak

staticChunkingStrategyRequestParam

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
statyczny	staticChunkingStrategy		Tak
typ	wyliczenie	Zawsze static. Możliwe wartości: static	Tak

fragmentingStrategyRequestParam

Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto .

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

• autoChunkingStrategyRequestParam
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
chunking_strategy	fragmentingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto .	No
identyfikator_pliku	ciąg	Identyfikator pliku, którego powinien używać magazyn wektorowy. Przydatne do takich narzędzi file_search do dostępu do plików.	Tak

listVectorStoreFilesResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	boolean		Tak
last_id	ciąg		Tak
obiekt	ciąg		Tak

deleteVectorStoreFileResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
usunięta	boolean		Tak
id	ciąg		Tak
obiekt	ciąg		Tak

obiekt Enum: DeleteVectorStoreFileResponseObject

Wartość	Opis
vector_store.file.deleted

vectorStoreFileBatchObject

Partia plików dołączonych do magazynu wektorowego.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
utworzono_o	liczba całkowita	Znacznik czasu Unixa (w sekundach) dla momentu tworzenia plików pamięci wektorowej wsadowo.	Tak
liczba_plików	obiekt		Tak
└* anulowano	liczba całkowita	Liczba plików anulowana.	No
└─ Ukończono	liczba całkowita	Liczba przetworzonych plików.	No
└* nie powiodło się	liczba całkowita	Liczba plików, które nie zostały przetworzone.	No
└─ w_toku	liczba całkowita	Liczba plików obecnie przetwarzanych.	No
└─ suma	liczba całkowita	Całkowita liczba plików.	No
id	ciąg	Identyfikator, do którego można się odwołać w końcowych punktach API.	Tak
obiekt	ciąg	Typ obiektu, który zawsze vector_store.file_batchjest .	Tak
stan	ciąg	Status partii plików wektorowego, która może być albo , in_progresscompleted, cancelled lub failed.	Tak
identyfikator_magazynu_wektorów	ciąg	ID magazynu wektorowego, do którego przypisany jest plik.	Tak

obiekt Enum: VectorStoreFileBatchObjectType

Wartość	Opis
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Wartość	Opis
in_progress
Zakończone
cancelled
niepowodzenie

createVectorStoreFileBatchRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
chunking_strategy	fragmentingStrategyRequestParam	Strategia chunkingu używana do chunkowania plików. Jeśli nie jest ustawione, użyję tej strategii auto .	No
identyfikatory_plików	macierz	Lista identyfikatorów plików, których powinien używać magazyn wektorowy. Przydatne do takich narzędzi file_search do dostępu do plików.	Tak

assistantStreamEvent

Reprezentuje zdarzenie wyemitowane podczas streamowania Run.

Każde zdarzenie w strumieniu zdarzeń wysyłanych przez serwer ma właściwość event i data :

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Emitujemy zdarzenia za każdym razem, gdy powstaje nowy obiekt, przechodzi do nowego stanu lub jest przesyłany strumieniowo w częściach (delty). Na przykład emitujemy przy thread.run.created tworzeniu nowego przebiegu, thread.run.completed jego zakończeniu i tak dalej. Gdy Asystent decyduje się utworzyć wiadomość podczas rozgrywki, emitujemy thread.message.created event, thread.message.in_progress zdarzenie, wiele thread.message.delta zdarzeń, a na końcu thread.message.completed zdarzenie.

Możemy dodawać kolejne zdarzenia z czasem, dlatego zalecamy delikatne obsługiwanie nieznanych zdarzeń w Twoim kodzie.

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

• threadStreamEvent
• runStreamEvent
• runStepStreamEvent
• messageStreamEvent
• errorEvent
• doneEvent

threadStreamEvent

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

thread.created

Występuje, gdy tworzony jest nowy wątek.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	threadObject	Reprezentuje wątek zawierający wiadomości.	Tak
wydarzenie	ciąg		Tak

Dane: threadObject

Wyliczenie zdarzeń: ThreadStreamEventEnum

Wartość	Opis
thread.created	Zdarzenie utworzone przez wątek

---

runStreamEvent

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

thread.run.created

Dzieje się to, gdy tworzy się nowy przebieg.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventCreated

Wartość	Opis
thread.run.created

---

thread.run.queued

Występuje, gdy przebieg przechodzi do statusu queued .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventQueued

Wartość	Opis
thread.run.queued

---

thread.run.in_progress

Występuje, gdy przebieg przechodzi do statusu in_progress .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wydarzenie Enum: RunStreamEventInProgress

Wartość	Opis
thread.run.in_progress

---

thread.run.requires_action

Występuje, gdy przebieg przechodzi do statusu requires_action .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Event Enum: RunStreamEventRequires Action.

Wartość	Opis
thread.run.requires_action

---

thread.run.completed

Następuje po zakończeniu przebiegu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wydarzenie Enum: RunStreamEventCompleted

Wartość	Opis
thread.run.completed

---

thread.run.failed

Dzieje się, gdy przebieg się nie udaje.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wyliczenie zdarzeń: RunStreamEventFailed

Wartość	Opis
thread.run.failed

---

thread.run.cancelling

Występuje, gdy przebieg przechodzi do statusu cancelling .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wydarzenie Enum: RunStreamEventCancelling

Wartość	Opis
thread.run.cancelling

---

thread.run.cancelled

Występuje, gdy przebieg zostaje anulowany.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wydarzenie Enum: RunStreamWydarzenieAnulowane

Wartość	Opis
thread.run.cancelled

---

thread.run.expired

Dzieje się to, gdy wygasa jeden run.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runObject	Reprezentuje wykonanie wykonane na wątku.	Tak
wydarzenie	ciąg		Tak

Dane: runObject

Wydarzenie Enum: RunStreamEventExpired

Wartość	Opis
thread.run.expired

---

runStepStreamEvent

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

thread.run.step.created

Występuje, gdy zostanie utworzony krok uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepObject	Oznacza krok w wykonaniu przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventCreated

Wartość	Opis
thread.run.step.created

---

thread.run.step.in_progress

Występuje, gdy krok przebiegu przechodzi do stanu in_progress .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepObject	Oznacza krok w wykonaniu przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wyliczenie zdarzeń: RunStepStreamEventInProgress

Wartość	Opis
thread.run.step.in_progress

---

thread.run.step.delta

Występuje, gdy części kroku run są przesyłane strumieniowo.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepDeltaObject	Reprezentuje delta kroku biegu, czyli wszelkie zmienione pola na kroku biegu podczas streamingu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepDeltaObject

Wydarzenie Enum: RunStepStreamEventDelta

Wartość	Opis
thread.run.step.delta

---

thread.run.step.completed

Występuje po zakończeniu kroku uruchomienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepObject	Oznacza krok w wykonaniu przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wydarzenie Enum: RunStepStreamWydarzenieUkończone

Wartość	Opis
thread.run.step.completed

---

thread.run.step.failed

Występuje, gdy krok uruchomienia nie zawodzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepObject	Oznacza krok w wykonaniu przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wydarzenie Enum: RunStepStreamZdarzenieNieudane

Wartość	Opis
thread.run.step.failed

---

thread.run.step.cancelled

Występuje, gdy krok run zostaje anulowany.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepObject	Oznacza krok w wykonaniu przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wydarzenie Enum: RunStepStreamWydarzenieOdwołane

Wartość	Opis
thread.run.step.cancelled

---

thread.run.step.expired

Występuje, gdy krok run wygasa.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	runStepObject	Oznacza krok w wykonaniu przebiegu.	Tak
wydarzenie	ciąg		Tak

Dane: runStepObject

Wydarzenie Enum: RunStepStreamEventExpired

Wartość	Opis
thread.run.step.expired

---

messageStreamEvent

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

thread.message.created

Występuje, gdy wiadomość jest tworzona.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Event Enum: MessageStreamEventCreatedCreated

Wartość	Opis
thread.message.created

---

thread.message.in_progress

Występuje, gdy wiadomość przechodzi do in_progress określonego stanu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventInProgress

Wartość	Opis
thread.message.in_progress

---

thread.message.delta

Występuje, gdy części wiadomości są przesyłane strumieniowo.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	messageDeltaObject	Reprezentuje delta wiadomości, czyli wszelkie zmienione pola w wiadomości podczas streamingu.	Tak
wydarzenie	ciąg		Tak

Dane: messageDeltaObject

Wyliczenie zdarzeń: MessageStreamEventDelta

Wartość	Opis
thread.message.delta

---

thread.message.completed

Występuje po zakończeniu wiadomości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventCompleted

Wartość	Opis
thread.message.completed

---

thread.message.incomplete

Występuje, gdy wiadomość kończy się przed jej zakończeniem.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	messageObject	Reprezentuje wiadomość w wątkach.	Tak
wydarzenie	ciąg		Tak

Dane: messageObject

Wyliczenie zdarzeń: MessageStreamEventIncomplete

Wartość	Opis
thread.message.incomplete

---

Adnotacja

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

• FileCitation
• UrlCitation
• FilePath

Kliknij pozycję

Kliknięcie.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
przycisk	wyliczenie	Wskazuje, który przycisk myszy został naciśnięty podczas kliknięcia. Jeden z left, right, wheel, back, lub forward. Możliwe wartości: left, right, wheel, , backforward	Tak
typ	wyliczenie	Określa typ zdarzenia. Dla akcji kliknięcia ta właściwość jest zawsze ustawiona na .click Możliwe wartości: click	Tak
x	liczba całkowita	Współrzędna x, gdzie nastąpił klik.	Tak
Y	liczba całkowita	Współrzędna y, w której nastąpiło kliknięcie.	Tak

CodeInterpreterFileOutput

Wywołanie narzędzia interpretera kodu, które jest plikiem.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
Pliki	macierz		Tak
typ	wyliczenie	Typ wyjścia pliku interpretera kodu. Zawsze files. Możliwe wartości: files	Tak

CodeInterpreterTextOutput

Wynik wywołania narzędzia interpretera kodu, czyli tekst.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dzienniki	ciąg	Logi narzędzia interpretera kodu.	Tak
typ	wyliczenie	Rodzaj tekstu interpretera kodu wyjściowego. Zawsze logs. Możliwe wartości: logs	Tak

CodeInterpreterTool

Narzędzie, które uruchamia kod.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
identyfikatory_plików	macierz	ID plików, na których można uruchomić kod.	Tak
typ	wyliczenie	Typ narzędzia do interpretera kodu. Zawsze code_interpreter. Możliwe wartości: code_interpreter	Tak

CodeInterpreterToolCall

Wywołanie narzędzia do uruchamiania kodu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	ciąg	Kod do uruchomienia.	Tak
id	ciąg	Unikalny identyfikator wywołania narzędzia interpretera kodu.	Tak
results	macierz	Wyniki wywołania narzędzia interpretera kodu.	Tak
stan	wyliczenie	Status wywołania narzędzia interpretera kodu. Możliwe wartości: in_progress, interpreting, completed	Tak
typ	wyliczenie	Rodzaj wywołania narzędzia interpretera kodu. Zawsze code_interpreter_call. Możliwe wartości: code_interpreter_call	Tak

CodeInterpreterToolOutput

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

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

ComparisonFilter

Filtr używany do porównania określonego klucza atrybutu z daną wartością za pomocą zdefiniowanej operacji porównania.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
klucz	ciąg	Kluczem jest porównanie z wartością.	Tak
typ	wyliczenie	Określa operator porównawczy: eq, ne, gt, gte, , lt. lte - eq: równa się - ne: nie równe - gt: większe niż - gte: większe lub równe - lt: mniej niż - lte: mniej niż lub równe Możliwe wartości: eq, ne, gt, , gte, lt, lte	Tak
wartość	ciąg lub liczba lub boolean	Wartość do porównania z kluczem atrybutu; obsługuje typy ciągowe, liczbowe lub booleowskie.	Tak

CompoundFilter

Połącz wiele filtrów za pomocą and lub or.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
filters	macierz	Zestaw filtrów do połączenia. Elementy mogą być lub ComparisonFilterCompoundFilter.	Tak
typ	wyliczenie	Typ operacji: and lub or. Możliwe wartości: and, or	Tak

ComputerAction

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

• Click
• DoubleClick
• Drag
• KeyPress
• Move
• Screenshot
• Scroll
• Typ
• Czekaj

ComputerScreenshotImage

Zrzut ekranu komputera używany za pomocą narzędzia do korzystania z komputera.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
identyfikator_pliku	ciąg	Identyfikator przesłanego pliku, który zawiera zrzut ekranu.	No
image_url	ciąg	URL ze zdjęcia zrzutu ekranu.	No
typ	wyliczenie	Określa typ zdarzenia. Dla zrzutu ekranu komputera ta właściwość jest zawsze ustawiona na .computer_screenshot Możliwe wartości: computer_screenshot	Tak

ComputerTool

Narzędzie, które steruje wirtualnym komputerem.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
wysokość ekranu	number	Wysokość wyświetlacza komputera.	Tak
szerokość_wyświetlacza	number	Szerokość wyświetlacza komputerowego.	Tak
środowisko	wyliczenie	Rodzaj środowiska komputerowego do kontrolowania. Możliwe wartości: mac, windows, , ubuntubrowser	Tak
typ	wyliczenie	Rodzaj narzędzia do korzystania z komputera. Zawsze computer_use_preview. Możliwe wartości: computer-use-preview	Tak

ComputerToolCall

Narzędzie do korzystania z narzędzia komputerowego.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
akcja	ComputerAction		Tak
call_id	ciąg	Identyfikator używany podczas reagowania na wywołanie narzędzia z wyjściem.	Tak
id	ciąg	Unikalne ID połączenia komputerowego.	Tak
pending_safety_checks	macierz	Nadchodzące sprawdzenia bezpieczeństwa związane z połączeniem komputerowym.	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	Tak
typ	wyliczenie	Rodzaj połączenia komputerowego. Zawsze computer_call. Możliwe wartości: computer_call	Tak

ComputerToolCallOutput

Wynik wywołania narzędzia komputerowego.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
acknowledged_safety_checks	macierz	Kontrole bezpieczeństwa zgłaszane przez API, które zostały zatwierdzone przez dewelopera.	No
call_id	ciąg	ID wywołania narzędzia komputerowego, które wygenerowało wynik.	Tak
id	ciąg	ID wywołania narzędzia komputerowego na wyjściu.	No
We/Wy	ComputerScreenshotImage	Zrzut ekranu komputera używany za pomocą narzędzia do korzystania z komputera.	Tak
stan	wyliczenie	Status wejścia wiadomości. Jeden z in_progress, completed, lub incomplete. Wypełniane, gdy elementy wejściowe są zwracane przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Rodzaj narzędzia komputerowego wywołuje wyjście. Zawsze computer_call_output. Możliwe wartości: computer_call_output	Tak

ComputerToolCallOutputResource

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
acknowledged_safety_checks	macierz	Kontrole bezpieczeństwa zgłaszane przez API, które zostały zatwierdzone przez dewelopera.	No
call_id	ciąg	ID wywołania narzędzia komputerowego, które wygenerowało wynik.	Tak
id	ciąg	Unikalny identyfikator wyjścia narzędzia wywołania komputera.	Tak
We/Wy	ComputerScreenshotImage	Zrzut ekranu komputera używany za pomocą narzędzia do korzystania z komputera.	Tak
stan	wyliczenie	Status wejścia wiadomości. Jeden z in_progress, completed, lub incomplete. Wypełniane, gdy elementy wejściowe są zwracane przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Rodzaj narzędzia komputerowego wywołuje wyjście. Zawsze computer_call_output. Możliwe wartości: computer_call_output	Tak

ComputerToolCallSafetyCheck

Czeka się kontrola bezpieczeństwa dla rozmowy komputerowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	ciąg	Rodzaj nadchodzącej kontroli bezpieczeństwa.	Tak
id	ciąg	Identyfikacja oczekującej kontroli bezpieczeństwa.	Tak
komunikat	ciąg	Szczegóły dotyczące nadchodzącej kontroli bezpieczeństwa.	Tak

Zawartość

Wielomodalne treści wejściowe i wyjściowe.

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

• InputContent
• OutputContent

Współrzędnych

Para współrzędnych x/y, np. { x: 100, y: 200 }.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
x	liczba całkowita	Współrzędna x.	Tak
Y	liczba całkowita	Współrzędna y.	Tak

CreateModelResponseProperties

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
metadane	Metadata	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	No
model	ciąg	Model używany do generowania odpowiedzi.	No
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 może pomóc OpenAI monitorować i wykrywać nadużycia. .	No

createResponse

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
include	macierz	{"$ref": "#/components/schemas/includable/description"}	No
dane wejściowe	ciąg lub tablica	Tekst, obraz lub plik wejściowy do modelu, używany do generowania odpowiedzi.	Tak
instructions	ciąg	Wprowadza komunikat systemowy (lub deweloperski) jako pierwszy element w kontekście modelu. Używając razem z previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperskich) w nowych odpowiedziach.	No
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które mogą być generowane dla odpowiedzi, w tym widocznych tokenów wyjściowych i tokenów rozumowania.	No
wywołania_narzędzia_równoległe	boolean	Czy pozwolić modelu na wykonywanie wywołań narzędzi równolegle.	No	True
previous_response_id	ciąg	Unikalne ID poprzedniej odpowiedzi na model. Wykorzystaj to do tworzenia wieloturowych rozmów.	No
reasoning	Reasoning	Opcje konfiguracyjne modeli rozumowania.	No
przechowywać	boolean	Czy przechowywać wygenerowaną odpowiedź modelu do późniejszego pobrania za pomocą API.	No	True
odtwarzać strumieniowo	boolean	Jeśli ustawiono na true, dane odpowiedzi modelu będą przesyłane do klienta w momencie generowania za pomocą zdarzeń wysyłanych przez serwer.	No	Nieprawda
SMS	obiekt	Opcje konfiguracyjne odpowiedzi tekstowej z modelu. Może to być tekst zwykły lub ustrukturyzowane dane JSON. Więcej informacji: - wejścia i wyjścia tekstowe - Strukturalne wyniki	No
Format └─	TextResponseFormatConfiguration	Obiekt określający format, który model musi wyprowadzać. Konfiguracja { "type": "json_schema" } umożliwia Structured Outputs, co zapewnia, że model odpowiada dostarczonemu schematowi JSON. Domyślny format to { "type": "text" } brak dodatkowych opcji. Nie zaleca się dla modeli GPT-4O i nowszych: Ustawienie na { "type": "json_object" } włączenie starszego trybu JSON, który zapewnia, że komunikat generowany przez model jest poprawny w JSON. Preferowane jest używanie json_schema w modelach, które go obsługują.	No
tool_choice	ToolChoiceOptions,ToolChoiceTypes lub ToolChoiceFunction	Jak model powinien wybierać, którego narzędzia (lub narzędzi) użyć podczas generowania odpowiedzi. Zobacz parametr, tools aby zobaczyć, jak określić, które narzędzia model może wywołać.	No
Narzędzia	macierz	Zestaw narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając parametr.tool_choice Dwie kategorie narzędzi, które możesz udostępnić modelowi, to: - Narzędzia wbudowane	No
truncation	wyliczenie	Strategia obcięcia do wykorzystania w odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstowego modelu, model obcina Odpowiedź, aby dopasować się do okna kontekstu, wyrzucając elementy wejściowe w środku rozmowy. - disabled (domyślnie): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstowego dla modelu, żądanie nie zostanie zadane z błędem 400. Możliwe wartości: auto, disabled	No

DoubleClick

Akcja podwójnego kliknięcia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. Dla akcji podwójnego kliknięcia ta właściwość jest zawsze ustawiona na .double_click Możliwe wartości: double_click	Tak
x	liczba całkowita	Współrzędna x, gdzie wystąpił podwójny klik.	Tak
Y	liczba całkowita	Współrzędna y, gdzie wystąpił podwójny klik.	Tak

Drag

Akcja drag.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
ścieżka	macierz	Tablica współrzędnych reprezentujących ścieżkę działania ociągania. Współrzędne pojawiają się jako tablica obiektów, np.[{ x: 100, y: 200 }, { x: 200, y: 300 }]	Tak
typ	wyliczenie	Określa typ zdarzenia. Dla działania przeciągania ta własność jest zawsze ustawiona na .drag Możliwe wartości: drag	Tak

EasyInputMessage

Wiadomość wejściowa do modelu z rolą wskazującą hierarchię po instrukcji. Instrukcje przekazywane rolą developer lub system mają pierwszeństwo przed instrukcjami przekazywanymi w roli user . Przyjmuje się, że wiadomości z rolą assistant zostały wygenerowane przez model w poprzednich interakcjach.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	string lub InputMessageContentList	Tekst, obraz lub dźwięk wejściowy do modelu używany do generowania odpowiedzi. Może też zawierać wcześniejsze odpowiedzi asystentów.	Tak
rola	wyliczenie	Rola wprowadzania wiadomości. Jeden z user, assistant, system, lub developer. Możliwe wartości: user, assistant, , systemdeveloper	Tak
typ	wyliczenie	Rodzaj wejścia wiadomości. Zawsze message. Możliwe wartości: message	No

FileCitation

Cytat do akt.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
identyfikator_pliku	ciąg	Identyfikator pliku.	Tak
indeks	liczba całkowita	Indeks pliku na liście plików.	Tak
typ	wyliczenie	Rodzaj cytowania pliku. Zawsze file_citation. Możliwe wartości: file_citation	Tak

FilePath

Ścieżka do pliku.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
identyfikator_pliku	ciąg	Identyfikator pliku.	Tak
indeks	liczba całkowita	Indeks pliku na liście plików.	Tak
typ	wyliczenie	Typ ścieżki pliku. Zawsze file_path. Możliwe wartości: file_path	Tak

FileSearchRanker

Ranker do wyszukiwania plików. Jeśli nie jest to określone, użyję rankera auto .

Majątek	Wartość
Opis	Ranker do wyszukiwania plików. Jeśli nie jest to określone, użyję rankera auto .
Typ	ciąg
Wartości	auto default_2024_08_21

FileSearchTool

Narzędzie, które wyszukuje istotne treści z przesłanych plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
filters	ComparisonFilter lub CompoundFilter	Filtr do stosowania na podstawie atrybutów pliku.	No
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna mieścić się w zakresie od 1 do 50 włącznie.	No
opcje rankingu	obiekt	Opcje rankingu w wyszukiwarce.	No
└} ranker	wyliczenie	Ranker do wyszukiwania plików. Możliwe wartości: auto, default-2024-11-15	No
└─ próg_punktowy	number	Próg punktowy dla wyszukiwania plików, to liczba od 0 do 1. Liczby bliższe 1 będą próbowały zwrócić tylko najbardziej istotne wyniki, ale mogą dawać mniej wyników.	No	0
typ	wyliczenie	Typ narzędzia do wyszukiwania plików. Zawsze file_search. Możliwe wartości: file_search	Tak
identyfikatory_sklepu_wektorów	macierz	ID wektora zapisują do wyszukiwania.	Tak

FileSearchToolCall

Wyniki wywołania narzędzia do wyszukiwania plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
id	ciąg	Unikalny identyfikator narzędzia do wyszukiwania plików.	Tak
queries	macierz	Zapytania używane do wyszukiwania plików.	Tak
results	macierz	Wyniki wyszukiwania narzędzi do wyszukiwania plików.	No
stan	wyliczenie	Status wywołania narzędzia do wyszukiwania plików. Jeden z in_progress, searching, incomplete lub failed, Możliwe wartości: in_progress, searching, completed, , incompletefailed	Tak
typ	wyliczenie	Rodzaj wywołania narzędzia do wyszukiwania plików. Zawsze file_search_call. Możliwe wartości: file_search_call	Tak

FunctionTool

Definiuje funkcję w twoim własnym kodzie, którą model może wybrać, by wywołać.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis funkcji. Używany przez model do określenia, czy wywołać funkcję.	No
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	Tak
parameters	obiekt	Obiekt schematu JSON opisujący parametry funkcji.	Tak
surowy	boolean	Czy wymusić ścisłą walidację parametrów. Domyślnie true.	Tak
typ	wyliczenie	Typ narzędzia funkcji. Zawsze function. Możliwe wartości: function	Tak

FunctionToolCall

Wywołanie narzędzia do uruchomienia funkcji.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
arguments	ciąg	Ciąg JSON argumentów do przekazania do funkcji.	Tak
call_id	ciąg	Unikalny identyfikator wywołania narzędzia funkcji wygenerowanego przez model.	Tak
id	ciąg	Unikalny identyfikator wywołania narzędzia funkcji.	Tak
nazwa	ciąg	Nazwa funkcji, którą trzeba uruchomić.	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Typ funkcji wywołanej narzędziem. Zawsze function_call. Możliwe wartości: function_call	Tak

FunctionToolCallOutput

Wynik wywołania narzędzia funkcji.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikalny identyfikator wywołania narzędzia funkcji wygenerowanego przez model.	Tak
id	ciąg	Unikalny identyfikator funkcji wywołania narzędzia output. Wypełnia się, gdy ten element zostanie zwrócony przez API.	No
We/Wy	ciąg	Ciąg JSON z wywołania narzędzia funkcji.	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Typ funkcji wywołania narzędzia output. Zawsze function_call_output. Możliwe wartości: function_call_output	Tak

FunctionToolCallOutputResource

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikalny identyfikator wywołania narzędzia funkcji wygenerowanego przez model.	Tak
id	ciąg	Unikalny identyfikator funkcji wywołanej jako narzędzie wyjściowe.	Tak
We/Wy	ciąg	Ciąg JSON z wywołania narzędzia funkcji.	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Typ funkcji wywołania narzędzia output. Zawsze function_call_output. Możliwe wartości: function_call_output	Tak

includable

Określ dodatkowe dane wyjściowe, które mają zostać uwzględnione w odpowiedzi modelu. Obecnie wspierane wartości to:

• file_search_call.results: Dołącz wyniki wyszukiwania wywołania narzędzia do wyszukiwania plików.
• message.input_image.image_url: Uwzględnij URL obrazów z wiadomości wejściowej.
• computer_call_output.output.image_url: Uwzględnij URL obrazów z wyjścia wywołań komputerowych.

Majątek	Wartość
Opis	Określ dodatkowe dane wyjściowe, które mają zostać uwzględnione w odpowiedzi modelu. Obecnie wspierane wartości to: - file_search_call.results: Dołącz wyniki wyszukiwania wywołania narzędzia do wyszukiwania plików. - message.input_image.image_url: Uwzględnij URL obrazów z wiadomości wejściowej. - computer_call_output.output.image_url: Uwzględnij URL obrazów z wyjścia wywołań komputerowych.
Typ	ciąg
Wartości	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Wejście audio do modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	ciąg	Dane audio kodowane w Base64.	Tak
format	wyliczenie	Format danych audio. Obecnie obsługiwane formaty to mp3 oraz wav. Możliwe wartości: mp3, wav	Tak
typ	wyliczenie	Rodzaj elementu wejściowego. Zawsze input_audio. Możliwe wartości: input_audio	Tak

InputContent

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

• InputText
• InputImage
• InputFile

InputFile

Plik wejściowy do modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
file_data	ciąg	Treść pliku do wysłania do modelu.	No
identyfikator_pliku	ciąg	ID pliku do wysłania modelowi.	No
filename	ciąg	Nazwa pliku do wysłania modelowi.	No
typ	wyliczenie	Rodzaj elementu wejściowego. Zawsze input_file. Możliwe wartości: input_file	Tak

InputImage

Obraz wejściowy do modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
detail	wyliczenie	Poziom szczegółowości obrazu, który ma być przesłany modelowi. Jeden z high, low, lub auto. Domyślnie przyjmuje .auto Możliwe wartości: high, low, auto	Tak
identyfikator_pliku	ciąg	ID pliku do wysłania modelowi.	No
image_url	ciąg	URL obrazu, który ma zostać wysłany do modelu. W pełni kwalifikowany adres URL lub obraz zakodowany w base64 w adresie URL danych.	No
typ	wyliczenie	Rodzaj elementu wejściowego. Zawsze input_image. Możliwe wartości: input_image	Tak

InputItem

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

• EasyInputMessage
• Produkt
• ItemReference

WiadomośćWejściowa

Wiadomość wejściowa do modelu z rolą wskazującą hierarchię po instrukcji. Instrukcje przekazywane rolą developer lub system mają pierwszeństwo przed instrukcjami przekazywanymi w roli user .

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu, zawierających różne treści types.	Tak
rola	wyliczenie	Rola wprowadzania wiadomości. Jeden z user, system, lub developer. Możliwe wartości: user, system, developer	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Rodzaj wejścia wiadomości. Zawsze ustawione na message. Możliwe wartości: message	No

InputMessageContentList

Lista jednego lub wielu elementów wejściowych do modelu, zawierająca różne typy zawartości.

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

InputMessageResource

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu, zawierających różne treści types.	Tak
id	ciąg	Unikalny identyfikator wejścia wiadomości.	Tak
rola	wyliczenie	Rola wprowadzania wiadomości. Jeden z user, system, lub developer. Możliwe wartości: user, system, developer	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Rodzaj wejścia wiadomości. Zawsze ustawione na message. Możliwe wartości: message	No

Tekst wejściowy

Tekst wejściowy do modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst wejściowy do modelu.	Tak
typ	wyliczenie	Rodzaj elementu wejściowego. Zawsze input_text. Możliwe wartości: input_text	Tak

Produkt

Element treści używany do generowania odpowiedzi.

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

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• ReasoningItem

ItemReference

Wewnętrzny identyfikator dla elementu do odniesienia.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
id	ciąg	Identyfikator przedmiotu do odniesienia.	Tak
typ	wyliczenie	Rodzaj przedmiotu, do którego warto się odwołać. Zawsze item_reference. Możliwe wartości: item_reference	Tak

ItemResource

Element treści używany do generowania odpowiedzi.

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

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

KeyPress

Zbiór naciśnięcia klawiszy, które model chciałby wykonać.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
keys	macierz	Kombinacja klawiszy, które model żąda do naciśnięcia. Jest to tablica ciągów znaków, z których każdy reprezentuje klucz.	Tak
typ	wyliczenie	Określa typ zdarzenia. Dla akcji naciśnięcia klawisza ta właściwość jest zawsze ustawiona na .keypress Możliwe wartości: keypress	Tak

Metadane

Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu.

Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.

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

ModelResponseProperties

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
metadane	Metadata	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	No
model	ciąg	Model używany do generowania odpowiedzi.	No
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 może pomóc OpenAI monitorować i wykrywać nadużycia. .	No

Przenieś

Akcja ruchu myszką.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. Dla akcji ruchu ta własność jest zawsze ustawiona na .move Możliwe wartości: move	Tak
x	liczba całkowita	Współrzędna x, do której należy się przesunąć.	Tak
Y	liczba całkowita	Współrzędna y do przejścia.	Tak

OutputAudio

Wyjście audio z modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	ciąg	Dane audio zakodowane w Base64 z modelu.	Tak
transkrypcja	ciąg	Transkrypcja danych audio z modelu.	Tak
typ	wyliczenie	Rodzaj dźwięku wyjściowego. Zawsze output_audio. Możliwe wartości: output_audio	Tak

OutputContent

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

• OutputText
• Refusal

OutputItem

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
akcja	ComputerAction		Tak
arguments	ciąg	Ciąg JSON argumentów do przekazania do funkcji.	Tak
call_id	ciąg	Identyfikator używany podczas reagowania na wywołanie narzędzia z wyjściem.	Tak
zawartość	macierz	Rozumowanie treści tekstu.	Tak
id	ciąg	Unikalny identyfikator treści rozumowania.	Tak
nazwa	ciąg	Nazwa funkcji, którą trzeba uruchomić.	Tak
pending_safety_checks	macierz	Nadchodzące sprawdzenia bezpieczeństwa związane z połączeniem komputerowym.	Tak
queries	macierz	Zapytania używane do wyszukiwania plików.	Tak
results	macierz	Wyniki wyszukiwania narzędzi do wyszukiwania plików.	No
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze assistant. Możliwe wartości: assistant	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	Tak
typ	wyliczenie	Typ przedmiotu. Zawsze reasoning. Możliwe wartości: reasoning	Tak

OutputMessage

Komunikat wyjściowy z modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	macierz	Treść komunikatu wyjściowego.	Tak
id	ciąg	Unikalny identyfikator wiadomości wyjściowej.	Tak
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze assistant. Możliwe wartości: assistant	Tak
stan	wyliczenie	Status wejścia wiadomości. Jeden z in_progress, completed, lub incomplete. Wypełniane, gdy elementy wejściowe są zwracane przez API. Możliwe wartości: in_progress, completed, incomplete	Tak
typ	wyliczenie	Typ wiadomości wyjściowej. Zawsze message. Możliwe wartości: message	Tak

OutputText

Tekst wychodzący z modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
annotations	macierz	Adnotacje w wyjściu tekstowym.	Tak
SMS	ciąg	Tekst wychodzi z modelu.	Tak
typ	wyliczenie	Typ tekstu wyjściowego. Zawsze output_text. Możliwe wartości: output_text	Tak

RealtimeSessionCreateRequest

Konfiguracja obiektu sesji w czasie rzeczywistym.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
input_audio_format	wyliczenie	Format dźwięku wejściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw. Dla pcm16, dźwięk wejściowy musi być 16-bitowy PCM przy częstotliwości próbkowania 24kHz, jednokanałowy (mono) i w rzędzie bajtów little-endian. Możliwe wartości: pcm16, g711_ulaw, g711_alaw	No
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumów audio wejściowych. Można to ustawić na null wyłączenie. Redukcja szumów filtruje dźwięk dodawany do bufora audio wejściowego przed wysłaniem do VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i skrętów (zmniejszając liczbę fałszywych alarmów) oraz modelować wydajność poprzez lepszą percepcję dźwięku wejściowego.	No
└typ	wyliczenie	Rodzaj redukcji szumów. near_field jest dla mikrofonów do bliskiego rozmowy, takich jak słuchawki, jest dla mikrofonów dalekiego pola, far_field takich jak laptopy lub mikrofony konferencyjne. Możliwe wartości: near_field, far_field	No
input_audio_transcription	obiekt	Konfiguracja transkrypcji audio wejściowej domyślnie jest wyłączona i można ustawić null na wyłączenie po włączeniu. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model konsumuje dźwięk bezpośrednio. Transkrypcja działa asynchronicznie przez punkt końcowy Transcriptions i powinna być traktowana jako wskazówka dla treści audio wejściowej, a nie dokładnie to, co model usłyszał. Klient może opcjonalnie ustawić język i prompt transkrypcji, co zapewnia dodatkowe wskazówki dla usługi transkrypcji.	No
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np.) enpoprawia dokładność i opóźnienia.	No
└─ Model	ciąg	Model do transkrypcji, obecnie dostępne opcje to gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, oraz whisper-1.	No
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Dla whisper-1, prompt to lista słów kluczowych. W modelach gpt-4o-transcribe prompt to wolny ciąg tekstowy, na przykład "expect words related to technology".	No
instructions	ciąg	Domyślne instrukcje systemowe (czyli komunikat systemowy) były dołączane do wywołań modelu. To pole pozwala klientowi kierować modelem na żądane odpowiedzi. Model można pouczać na temat treści i formatu odpowiedzi (np. "bądź bardzo zwięzły", "zachowuj się przyjaźnie", "oto przykłady dobrych odpowiedzi") oraz zachowania audio (np. "mów szybko", "wprowadź emocje do głosu", "często się śmiej"). Instrukcje nie są gwarantowane przez model przestrzegania, ale dostarczają mu wskazówek dotyczących pożądanego zachowania. Należy zauważyć, że serwer ustawia domyślne instrukcje, które będą używane, jeśli to pole nie jest ustawione i są widoczne w zdarzeniu session.created na początku sesji.	No
max_response_output_tokens	liczba całkowita lub ciąg tekstu	Maksymalna liczba tokenów wyjściowych dla jednej odpowiedzi asystenta, wliczając wywołania narzędzi. Podaj liczbę całkowitą od 1 do 4096, aby ograniczyć tokeny wyjściowe lub inf dla maksymalnej dostępności tokenów dla danego modelu. Domyślnie przyjmuje .inf	No
Sposoby		Zestaw modalności, z którymi model może reagować. Aby wyłączyć dźwięk, ustaw to na ["text"].	No
model	ciąg	Nazwa wdrożenia użytego podczas tej sesji.	No
output_audio_format	wyliczenie	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw. Dla pcm16, dźwięk wyjściowy jest próbkowany z częstotliwością 24kHz. Możliwe wartości: pcm16, g711_ulaw, g711_alaw	No
temperatura	number	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. W przypadku modeli audio zaleca się temperaturę 0,8 dla najlepszej wydajności.	No	0.8
tool_choice	ciąg	Jak model wybiera narzędzia. Opcje to auto, none, required, lub określ funkcję.	No	samochód
Narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	No
turn_detection	obiekt	Konfiguracja wykrywania tur, np. Server VAD lub Semantic VAD. Można to ustawić na null wyłączenie, w takim przypadku klient musi ręcznie wywołać odpowiedź modelu. Server VAD oznacza, że model wykrywa początek i koniec mowy na podstawie głośności dźwięku i odpowiada na końcu wypowiedzi użytkownika. Semantyczny VAD jest bardziej zaawansowany i wykorzystuje model wykrywania skrętów (we współpracy z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika kończy się na , uhhmmodel uzyska niskie prawdopodobieństwo zakończenia tury i dłużej czeka, aż użytkownik będzie kontynuował mówienie. Może to być przydatne przy bardziej naturalnych rozmowach, ale może mieć wyższe opóźnienia.	No
└create_response	boolean	Czy automatycznie generować odpowiedź, gdy wystąpi zdarzenie VAD stop.	No	True
└* gotowość	wyliczenie	Używany tylko w semantic_vad trybie pracy. Chęć modelu do odpowiedzi. low poczeka dłużej, aż użytkownik będzie kontynuował mówienie, odpowiada high szybciej. autojest domyślnym i jest równoważny .medium Możliwe wartości: low, medium, , highauto	No
└reakcja_na_przerwanie	boolean	Czy automatycznie przerwać każdą bieżącą odpowiedź z wyjściem do domyślnej rozmowy (czyli conversation z), autogdy wystąpi zdarzenie startowe VAD.	No	True
└─prefix_padding_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Domyślnie ustawione jest 300ms.	No
└czas_trwania_ciszy_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Czas trwania ciszy do wykrycia zatrzymania mowy (w milisekundach). Domyślnie ustawione jest 500ms. Przy krótszych wartościach model odpowiada szybciej, ale może wtrącać się na krótkie przerwy użytkownika.	No
└* próg	number	Używany tylko w server_vad trybie pracy. Próg aktywacji dla VAD (0,0 do 1,0), domyślnie wynosi 0,5. Wyższy próg wymaga głośniejszego dźwięku do aktywacji modelu, dlatego może działać lepiej w hałaśliwym środowisku.	No
└typ	wyliczenie	Rodzaj wykrywania skrętów. Możliwe wartości: server_vad, semantic_vad	No
voice	VoiceIdsShared		No

RealtimeSessionCreateResponse

Nowa konfiguracja sesji w czasie rzeczywistym, z efemerycznym kluczem. Domyślny TTL dla klawiszy to jedna minuta.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
client_secret	obiekt	Klucz efemeryczny zwracany przez API.	Tak
└─ wygasa_o	liczba całkowita	Znacznik czasu wygaśnięcia tokena. Obecnie wszystkie tokeny wygasają po jednej minucie.	No
└─ wartość	ciąg	Klucz efemeryczny możliwy do uwierzytelniania połączeń z API czasu rzeczywistego w środowiskach klienckich. Używaj tego w środowiskach po stronie klienta, a nie standardowego tokena API, który powinien być używany tylko po stronie serwera.	No
input_audio_format	ciąg	Format dźwięku wejściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw.	No
input_audio_transcription	obiekt	Konfiguracja transkrypcji audio wejściowej domyślnie jest wyłączona i można ustawić null na wyłączenie po włączeniu. Transkrypcja audio wejściowego nie jest natywna dla modelu, ponieważ model konsumuje dźwięk bezpośrednio. Transkrypcja działa asynchronicznie przez Whisper i powinna być traktowana jako przybliżone wskazówki, a nie jako reprezentacja rozumiana przez model.	No
└─ Model	ciąg	Model używany do transkrypcji whisper-1 jest jedynym obecnie obsługiwanym modelem.	No
instructions	ciąg	Domyślne instrukcje systemowe (czyli komunikat systemowy) były dołączane do wywołań modelu. To pole pozwala klientowi kierować modelem na żądane odpowiedzi. Model można instruować na temat treści i formatu odpowiedzi (np. "bądź bardzo zwięzły", "zachowuj się przyjaźnie", "oto przykłady dobrych odpowiedzi") oraz zachowania audio (np. "mów szybko", "wprowadź emocje do głosu", "często się śmiej"). Instrukcje nie są gwarantowane przez model przestrzegania, ale dostarczają mu wskazówek dotyczących pożądanego zachowania. Należy zauważyć, że serwer ustawia domyślne instrukcje, które będą używane, jeśli to pole nie jest ustawione i są widoczne w zdarzeniu session.created na początku sesji.	No
max_response_output_tokens	liczba całkowita lub ciąg tekstu	Maksymalna liczba tokenów wyjściowych dla jednej odpowiedzi asystenta, wliczając wywołania narzędzi. Podaj liczbę całkowitą od 1 do 4096, aby ograniczyć tokeny wyjściowe lub inf dla maksymalnej dostępności tokenów dla danego modelu. Domyślnie przyjmuje .inf	No
Sposoby		Zestaw modalności, z którymi model może reagować. Aby wyłączyć dźwięk, ustaw to na ["text"].	No
output_audio_format	ciąg	Format dźwięku wyjściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw.	No
temperatura	number	Temperatura próbkowania dla modelu ograniczona do [0.6, 1.2]. Domyślnie ustawia się na 0,8.	No
tool_choice	ciąg	Jak model wybiera narzędzia. Opcje to auto, none, required, lub określ funkcję.	No
Narzędzia	macierz	Narzędzia (funkcje) dostępne dla modelu.	No
turn_detection	obiekt	Konfiguracja wykrywania skrętów. Można ustawić na null wyłączenie. Server VAD oznacza, że model wykrywa początek i koniec mowy na podstawie głośności dźwięku i odpowiada na końcu wypowiedzi użytkownika.	No
└─prefix_padding_ms	liczba całkowita	Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Domyślnie ustawione jest 300ms.	No
└czas_trwania_ciszy_ms	liczba całkowita	Czas trwania ciszy do wykrycia zatrzymania mowy (w milisekundach). Domyślnie ustawione jest 500ms. Przy krótszych wartościach model odpowiada szybciej, ale może wtrącać się na krótkie przerwy użytkownika.	No
└* próg	number	Próg aktywacji dla VAD (0,0 do 1,0), domyślnie wynosi 0,5. Wyższy próg wymaga głośniejszego dźwięku do aktywacji modelu, dlatego może działać lepiej w hałaśliwym środowisku.	No
└typ	ciąg	Obecnie wspierany jest tylko rodzaj wykrywania server_vad skrętów.	No
voice	VoiceIdsShared		No

RealtimeTranscriptionSessionCreateRequest

Konfiguracja obiektu sesji transkrypcji w czasie rzeczywistym.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
include	macierz	Zestaw elementów do uwzględnienia w transkrypcji. Obecnie dostępne przedmioty to: - item.input_audio_transcription.logprobs	No
input_audio_format	wyliczenie	Format dźwięku wejściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw. Dla pcm16, dźwięk wejściowy musi być 16-bitowy PCM przy częstotliwości próbkowania 24kHz, jednokanałowy (mono) i w rzędzie bajtów little-endian. Możliwe wartości: pcm16, g711_ulaw, g711_alaw	No
input_audio_noise_reduction	obiekt	Konfiguracja redukcji szumów audio wejściowych. Można to ustawić na null wyłączenie. Redukcja szumów filtruje dźwięk dodawany do bufora audio wejściowego przed wysłaniem do VAD i modelu. Filtrowanie dźwięku może poprawić dokładność wykrywania VAD i skrętów (zmniejszając liczbę fałszywych alarmów) oraz modelować wydajność poprzez lepszą percepcję dźwięku wejściowego.	No
└typ	wyliczenie	Rodzaj redukcji szumów. near_field jest dla mikrofonów do bliskiego rozmowy, takich jak słuchawki, jest dla mikrofonów dalekiego pola, far_field takich jak laptopy lub mikrofony konferencyjne. Możliwe wartości: near_field, far_field	No
input_audio_transcription	obiekt	Konfiguracja do transkrypcji audio wejściowej. Klient może opcjonalnie ustawić język i prompt transkrypcji, co zapewnia dodatkowe wskazówki dla usługi transkrypcji.	No
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np.) enpoprawia dokładność i opóźnienia.	No
└─ Model	wyliczenie	Model do transkrypcji, obecnie dostępne opcje to gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, oraz whisper-1. Możliwe wartości: gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, , gpt-4o-mini-transcribe-2025-12-15whisper-1	No
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Dla whisper-1, prompt to lista słów kluczowych. W modelach gpt-4o-transcribe prompt to wolny ciąg tekstowy, na przykład "expect words related to technology".	No
Sposoby		Zestaw modalności, z którymi model może reagować. Aby wyłączyć dźwięk, ustaw to na ["text"].	No
turn_detection	obiekt	Konfiguracja wykrywania tur, np. Server VAD lub Semantic VAD. Można to ustawić na null wyłączenie, w takim przypadku klient musi ręcznie wywołać odpowiedź modelu. Server VAD oznacza, że model wykrywa początek i koniec mowy na podstawie głośności dźwięku i odpowiada na końcu wypowiedzi użytkownika. Semantyczny VAD jest bardziej zaawansowany i wykorzystuje model wykrywania skrętów (we współpracy z VAD), aby semantycznie oszacować, czy użytkownik skończył mówić, a następnie dynamicznie ustawia limit czasu na podstawie tego prawdopodobieństwa. Na przykład, jeśli dźwięk użytkownika kończy się na , uhhmmodel uzyska niskie prawdopodobieństwo zakończenia tury i dłużej czeka, aż użytkownik będzie kontynuował mówienie. Może to być przydatne przy bardziej naturalnych rozmowach, ale może mieć wyższe opóźnienia.	No
└create_response	boolean	Czy automatycznie generować odpowiedź, gdy wystąpi zdarzenie VAD stop. Niedostępne podczas sesji transkrypcji.	No	True
└* gotowość	wyliczenie	Używany tylko w semantic_vad trybie pracy. Chęć modelu do odpowiedzi. low poczeka dłużej, aż użytkownik będzie kontynuował mówienie, odpowiada high szybciej. autojest domyślnym i jest równoważny .medium Możliwe wartości: low, medium, , highauto	No
└reakcja_na_przerwanie	boolean	Czy automatycznie przerwać każdą bieżącą odpowiedź z wyjściem do domyślnej rozmowy (czyli conversation z), autogdy wystąpi zdarzenie startowe VAD. Niedostępne podczas sesji transkrypcji.	No	True
└─prefix_padding_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Domyślnie ustawione jest 300ms.	No
└czas_trwania_ciszy_ms	liczba całkowita	Używany tylko w server_vad trybie pracy. Czas trwania ciszy do wykrycia zatrzymania mowy (w milisekundach). Domyślnie ustawione jest 500ms. Przy krótszych wartościach model odpowiada szybciej, ale może wtrącać się na krótkie przerwy użytkownika.	No
└* próg	number	Używany tylko w server_vad trybie pracy. Próg aktywacji dla VAD (0,0 do 1,0), domyślnie wynosi 0,5. Wyższy próg wymaga głośniejszego dźwięku do aktywacji modelu, dlatego może działać lepiej w hałaśliwym środowisku.	No
└typ	wyliczenie	Rodzaj wykrywania skrętów. Możliwe wartości: server_vad, semantic_vad	No

RealtimeTranscriptionSessionCreateResponse

Nowa konfiguracja sesji transkrypcji w czasie rzeczywistym.

Gdy sesja jest tworzona na serwerze za pomocą REST API, obiekt sesji zawiera również klucz efemeryczny. Domyślny TTL dla klawiszy to jedna minuta. Ta właściwość nie występuje, gdy sesja jest aktualizowana za pomocą API WebSocket.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
client_secret	obiekt	Klucz efemeryczny zwracany przez API. Występuje tylko wtedy, gdy sesja jest tworzona na serwerze przez REST API.	Tak
└─ wygasa_o	liczba całkowita	Znacznik czasu wygaśnięcia tokena. Obecnie wszystkie tokeny wygasają po jednej minucie.	No
└─ wartość	ciąg	Klucz efemeryczny możliwy do uwierzytelniania połączeń z API czasu rzeczywistego w środowiskach klienckich. Używaj tego w środowiskach po stronie klienta, a nie standardowego tokena API, który powinien być używany tylko po stronie serwera.	No
input_audio_format	ciąg	Format dźwięku wejściowego. Opcje to pcm16, g711_ulaw, lub g711_alaw.	No
input_audio_transcription	obiekt	Konfiguracja modelu transkrypcji.	No
└* język	ciąg	Język wejściowego dźwięku. Dostarczanie języka wejściowego w formacie ISO-639-1 (np.) enpoprawia dokładność i opóźnienia.	No
└─ Model	wyliczenie	Model do transkrypcji. Może być , gpt-4o-transcribegpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, lub whisper-1. Możliwe wartości: gpt-4o-transcribe, gpt-4o-mini-transcribe, , gpt-4o-mini-transcribe-2025-12-15whisper-1	No
Zachęta └*	ciąg	Opcjonalny tekst wskazujący styl modelu lub kontynuujący wcześniejszy segment audio. Prompt powinien odpowiadać językowi dźwięku.	No
Sposoby		Zestaw modalności, z którymi model może reagować. Aby wyłączyć dźwięk, ustaw to na ["text"].	No
turn_detection	obiekt	Konfiguracja wykrywania skrętów. Można ustawić na null wyłączenie. Server VAD oznacza, że model wykrywa początek i koniec mowy na podstawie głośności dźwięku i odpowiada na końcu wypowiedzi użytkownika.	No
└─prefix_padding_ms	liczba całkowita	Ilość dźwięku do uwzględnienia przed wykryciem mowy przez VAD (w milisekundach). Domyślnie ustawione jest 300ms.	No
└czas_trwania_ciszy_ms	liczba całkowita	Czas trwania ciszy do wykrycia zatrzymania mowy (w milisekundach). Domyślnie ustawione jest 500ms. Przy krótszych wartościach model odpowiada szybciej, ale może wtrącać się na krótkie przerwy użytkownika.	No
└* próg	number	Próg aktywacji dla VAD (0,0 do 1,0), domyślnie wynosi 0,5. Wyższy próg wymaga głośniejszego dźwięku do aktywacji modelu, dlatego może działać lepiej w hałaśliwym środowisku.	No
└typ	ciąg	Obecnie wspierany jest tylko rodzaj wykrywania server_vad skrętów.	No

Reasoning

Opcje konfiguracyjne modeli rozumowania.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
nakład pracy	ReasoningEffort	Ogranicza wysiłek związany z rozumowaniem dla modeli rozumowania. Obecnie obsługiwane wartości to low, medium, oraz high. Zmniejszenie wysiłku rozumowania może skutkować szybszymi odpowiedziami i mniejszą liczbą tokenów używanych do rozumowania w odpowiedzi.	Tak	nośnik
podsumowanie	wyliczenie	Podsumowanie rozumowania przeprowadzonego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. Jeden z concise lub detailed. Możliwe wartości: concise, detailed	No

ReasoningItem

Opis łańcucha myślenia używanego przez model rozumowania podczas generowania odpowiedzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
zawartość	macierz	Rozumowanie treści tekstu.	Tak
id	ciąg	Unikalny identyfikator treści rozumowania.	Tak
stan	wyliczenie	Status przedmiotu. Jeden z in_progress, completed, lub incomplete. Wypełniane po zwróceniu elementów przez API. Możliwe wartości: in_progress, completed, incomplete	No
typ	wyliczenie	Typ przedmiotu. Zawsze reasoning. Możliwe wartości: reasoning	Tak

Refusal

Odmowa ze strony modelki.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
refusal	ciąg	Wyjaśnienie odmowy ze strony modelki.	Tak
typ	wyliczenie	Rodzaj odmowy. Zawsze refusal. Możliwe wartości: refusal	Tak

response

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
utworzono_o	number	Znacznik czasu Uniksa (w sekundach) od momentu utworzenia tej odpowiedzi.	Tak
błąd	ResponseError	Obiekt błędu zwracany, gdy model nie generuje odpowiedzi.	Tak
id	ciąg	Unikalny identyfikator tej odpowiedzi.	Tak
incomplete_details	obiekt	Szczegóły wyjaśniające, dlaczego odpowiedź jest niepełna.	Tak
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niepełna. Możliwe wartości: max_output_tokens, content_filter	No
instructions	ciąg	Wprowadza komunikat systemowy (lub deweloperski) jako pierwszy element w kontekście modelu. Używając razem z previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperskich) w nowych odpowiedziach.	Tak
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widocznych tokenów wyjściowych i stanu rozmowy.	No
metadane	Metadata	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Tak
model	ciąg	Model używany do generowania odpowiedzi.	Tak
obiekt	wyliczenie	Typ obiektu tego zasobu – zawsze ustawiony na .response Możliwe wartości: response	Tak
We/Wy	macierz	Zestaw elementów treści generowanych przez model. - Długość i kolejność elementów w tablicy output zależy od odpowiedzi modelu. - Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i zakładać, że jest assistant to komunikat z treścią generowaną przez model, możesz rozważyć użycie tej output_text właściwości tam, gdzie jest to obsługiwane w SDK.	Tak
output_text	ciąg	Właściwość wygody tylko SDK, która zawiera zagregowany tekst wyjściowy ze wszystkich output_text elementów w tablicy output , jeśli w ogóle są obecne. Obsługiwane w SDK Python i JavaScript.	No
wywołania_narzędzia_równoległe	boolean	Czy pozwolić modelu na wykonywanie wywołań narzędzi równolegle.	Tak	True
previous_response_id	ciąg	Unikalne ID poprzedniej odpowiedzi na model. Wykorzystaj to do tworzenia wieloturowych rozmów.	No
reasoning	Reasoning	Opcje konfiguracyjne modeli rozumowania.	No
stan	wyliczenie	Status generowania odpowiedzi. Jeden z completed, failed, in_progress, lub incomplete. Możliwe wartości: completed, failed, , in_progressincomplete	No
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.	Tak	1
SMS	obiekt	Opcje konfiguracyjne odpowiedzi tekstowej z modelu. Może to być tekst zwykły lub ustrukturyzowane dane JSON. Więcej informacji: - wejścia i wyjścia tekstowe - Strukturalne wyniki	No
Format └─	TextResponseFormatConfiguration	Obiekt określający format, który model musi wyprowadzać. Konfiguracja { "type": "json_schema" } umożliwia Structured Outputs, co zapewnia, że model odpowiada dostarczonemu schematowi JSON. Domyślny format to { "type": "text" } brak dodatkowych opcji. Nie zaleca się dla modeli GPT-4O i nowszych: Ustawienie na { "type": "json_object" } włączenie starszego trybu JSON, który zapewnia, że komunikat generowany przez model jest poprawny w JSON. Preferowane jest używanie json_schema w modelach, które go obsługują.	No
tool_choice	ToolChoiceOptions,ToolChoiceTypes lub ToolChoiceFunction	Jak model powinien wybierać, którego narzędzia (lub narzędzi) użyć podczas generowania odpowiedzi. Zobacz parametr, tools aby zobaczyć, jak określić, które narzędzia model może wywołać.	Tak
Narzędzia	macierz	Zestaw narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając parametr.tool_choice Dwie kategorie narzędzi, które możesz udostępnić modelowi, to: - Narzędzia wbudowane	Tak
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.	Tak	1
truncation	wyliczenie	Strategia obcięcia do wykorzystania w odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstowego modelu, model obcina odpowiedź, aby dopasowała się do okna kontekstu, rezygnując z elementów wejściowych w trakcie rozmowy. - disabled (domyślnie): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstowego dla modelu, żądanie nie zostanie zadane z błędem 400. Możliwe wartości: auto, disabled	No
użycie	ResponseUsage	Reprezentuje szczegóły dotyczące użycia tokenów, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych oraz łączną liczbę użytych tokenów.	No
użytkownik	ciąg	Unikalny identyfikator reprezentujący użytkownika końcowego, który może pomóc OpenAI monitorować i wykrywać nadużycia. .	No

ResponseAudioDeltaEvent

Emitowany jest przy częściowej odpowiedzi dźwiękowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
delta	ciąg	Fragment bajtów audio zakodowanych w Base64.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.audio.delta. Możliwe wartości: response.audio.delta	Tak

ResponseAudioDoneEvent

Emitowany po zakończeniu odpowiedzi audio.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.audio.done. Możliwe wartości: response.audio.done	Tak

ResponseAudioTranscriptDeltaEvent

Emitowany jest wtedy, gdy istnieje częściowy zapis audio.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
delta	ciąg	Częściowa transkrypcja odpowiedzi audio.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.audio.transcript.delta. Możliwe wartości: response.audio.transcript.delta	Tak

ResponseAudioTranscriptDoneEvent

Emitowany po ukończeniu pełnej transkrypcji audio.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.audio.transcript.done. Możliwe wartości: response.audio.transcript.done	Tak

ResponseCodeInterpreterCallCodeDeltaEvent

Emitowany po dodaniu częściowego fragmentu kodu przez interpreter kodu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
delta	ciąg	Częściowy fragment kodu dodany przez interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który wywołuje interpreter kodu, jest w trakcie działania.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.code_interpreter_call.code.delta. Możliwe wartości: response.code_interpreter_call.code.delta	Tak

ResponseCodeInterpreterCallCodeDoneEvent

Emitowany po finalizacji fragmentu kodu przez interpreter kodu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	ciąg	Ostateczny fragment kodu wychodzący przez interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który wywołuje interpreter kodu, jest w trakcie działania.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.code_interpreter_call.code.done. Możliwe wartości: response.code_interpreter_call.code.done	Tak

ResponseCodeInterpreterCallCompletedEvent

Emitowany po zakończeniu wywołania interpretera kodu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia do uruchamiania kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który wywołuje interpreter kodu, jest w trakcie działania.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.code_interpreter_call.completed. Możliwe wartości: response.code_interpreter_call.completed	Tak

ResponseCodeInterpreterCallInProgressEvent

Emitowany podczas wywołania interpretera kodu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia do uruchamiania kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który wywołuje interpreter kodu, jest w trakcie działania.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.code_interpreter_call.in_progress. Możliwe wartości: response.code_interpreter_call.in_progress	Tak

ResponseCodeInterpreterCallInterpretingEvent

Emitowany jest, gdy interpreter kodu aktywnie interpretuje fragment kodu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia do uruchamiania kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który wywołuje interpreter kodu, jest w trakcie działania.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.code_interpreter_call.interpreting. Możliwe wartości: response.code_interpreter_call.interpreting	Tak

ResponseCompletedEvent

Emitowany po zakończeniu odpowiedzi modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
response	response		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.completed. Możliwe wartości: response.completed	Tak

ResponseContentPartAddedEvent

Emitowany jest po dodaniu nowej części zawartości.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
content_index	liczba całkowita	Indeks części zawartości, która została dodana.	Tak
item_id	ciąg	ID elementu wyjściowego, do którego dodano część zawartości.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano część zawartości.	Tak
część	OutputContent		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.content_part.added. Możliwe wartości: response.content_part.added	Tak

ResponseContentPartDoneEvent

Emitowany po zakończeniu części treści.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
content_index	liczba całkowita	Indeks części treści, która jest wykonana.	Tak
item_id	ciąg	ID elementu wyjściowego, do którego dodano część zawartości.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano część zawartości.	Tak
część	OutputContent		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.content_part.done. Możliwe wartości: response.content_part.done	Tak

ResponseCreatedEvent

Zdarzenie, które jest emitowane podczas tworzenia odpowiedzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
response	response		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.created. Możliwe wartości: response.created	Tak

ResponseError

Obiekt błędu zwracany, gdy model nie generuje odpowiedzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	ResponseErrorCode	Kod błędu odpowiedzi.	Tak
komunikat	ciąg	Czytelny opis błędu.	Tak

ResponseErrorCode

Kod błędu odpowiedzi.

Majątek	Wartość
Opis	Kod błędu odpowiedzi.
Typ	ciąg
Wartości	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

ResponseErrorEvent

Emitowany po wystąpieniu błędu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
kod	ciąg	Kod błędu.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak
param	ciąg	Parametr błędu.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze error. Możliwe wartości: error	Tak

ResponseFailedEvent

Zdarzenie, które jest emitowane, gdy odpowiedź nie zadziała.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
response	response		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.failed. Możliwe wartości: response.failed	Tak

ResponseFileSearchCallCompletedEvent

Emitowany po zakończeniu wywołania wyszukiwania plików (znaleziono wyniki).

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
item_id	ciąg	ID elementu wyjściowego, który jest inicjowany przez wyszukiwanie plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest inicjowany przez wyszukiwanie plików.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.file_search_call.completed. Możliwe wartości: response.file_search_call.completed	Tak

ResponseFileSearchCallInProgressEvent

Emitowany podczas inicjowania wywołania wyszukiwania plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
item_id	ciąg	ID elementu wyjściowego, który jest inicjowany przez wyszukiwanie plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który jest inicjowany przez wyszukiwanie plików.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.file_search_call.in_progress. Możliwe wartości: response.file_search_call.in_progress	Tak

ResponseFileSearchCallSearchingEvent

Emitowany podczas aktualnego wyszukiwania plików.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
item_id	ciąg	ID elementu wyjściowego, który jest inicjowany przez wyszukiwanie plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, który wywołuje wyszukiwanie plików.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.file_search_call.searching. Możliwe wartości: response.file_search_call.searching	Tak

ResponseFunctionCallArgumentsDeltaEvent

Emitowany, gdy istnieje częściowa delta argumentów wywołania funkcji.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
delta	ciąg	Argumenty wywołania funkcji są dodawane.	Tak
item_id	ciąg	ID elementu wyjściowego, do którego dodaje się delta argumentów wywołania funkcji.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodawany jest delta argumentów wywołania funkcji.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.function_call_arguments.delta. Możliwe wartości: response.function_call_arguments.delta	Tak

ResponseFunctionCallArgumentsDoneEvent

Emitowany podczas finalizacji argumentów wywołania funkcji.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
arguments	ciąg	Argumenty wywołania funkcji.	Tak
item_id	ciąg	Identyfikacja przedmiotu.	Tak
output_index	liczba całkowita	Indeks pozycji wyjściowej.	Tak
typ	wyliczenie	Możliwe wartości: response.function_call_arguments.done	Tak

ResponseInProgressEvent

Emitowany podczas trwania odpowiedzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
response	response		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.in_progress. Możliwe wartości: response.in_progress	Tak

ResponseIncompleteEvent

Zdarzenie emitowane, gdy odpowiedź kończy się jako niepełna.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
response	response		Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.incomplete. Możliwe wartości: response.incomplete	Tak

responseItemList

Lista zadań odpowiedzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz	Lista elementów użytych do wygenerowania tej odpowiedzi.	Tak
first_id	ciąg	ID pierwszego elementu na liście.	Tak
zawiera_więcej	boolean	Czy dostępnych jest więcej przedmiotów.	Tak
last_id	ciąg	ID ostatniego elementu na liście.	Tak
obiekt	wyliczenie	Typ zwróconego obiektu musi być .list Możliwe wartości: list	Tak

ResponseModalities

Typy wyników, które chcesz, aby model generował. Większość modeli potrafi generować tekst, co jest domyślne:

["text"]

Model ten gpt-4o-audio-preview może być również używany do generowania dźwięku. Aby poprosić ten model o generowanie zarówno odpowiedzi tekstowych, jak i audio, możesz użyć:

["text", "audio"]

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

ResponseModalitiesTextOnly

Typy wyników, które chcesz, aby model generował. Większość modeli potrafi generować tekst, co jest domyślne:

["text"]

To API wkrótce będzie wspierać inne modalności wyjściowe, w tym dźwięk i obrazy.

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

ResponseOutputItemAddedEvent

Emitowany jest po dodaniu nowego elementu wyjściowego.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
element	OutputItem		Tak
output_index	liczba całkowita	Indeks dodanego elementu wyjściowego.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.output_item.added. Możliwe wartości: response.output_item.added	Tak

ResponseOutputItemDoneEvent

Emitowane, gdy element wyjściowy jest oznaczony jako zakończony.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
element	OutputItem		Tak
output_index	liczba całkowita	Indeks pozycji wyjściowej, która została oznaczona jako wykonana.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.output_item.done. Możliwe wartości: response.output_item.done	Tak

ResponseProperties

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
instructions	ciąg	Wprowadza komunikat systemowy (lub deweloperski) jako pierwszy element w kontekście modelu. Używając razem z previous_response_id, instrukcje z poprzedniej odpowiedzi nie zostaną przeniesione do następnej odpowiedzi. Ułatwia to zamianę komunikatów systemowych (lub deweloperskich) w nowych odpowiedziach.	No
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widocznych tokenów wyjściowych i stanu rozmowy.	No
previous_response_id	ciąg	Unikalne ID poprzedniej odpowiedzi na model. Wykorzystaj to do tworzenia wieloturowych rozmów.	No
reasoning	Reasoning	Opcje konfiguracyjne modeli rozumowania.	No
SMS	obiekt	Opcje konfiguracyjne odpowiedzi tekstowej z modelu. Może to być tekst zwykły lub ustrukturyzowane dane JSON. Więcej informacji: - wejścia i wyjścia tekstowe - Strukturalne wyniki	No
Format └─	TextResponseFormatConfiguration	Obiekt określający format, który model musi wyprowadzać. Konfiguracja { "type": "json_schema" } umożliwia Structured Outputs, co zapewnia, że model odpowiada dostarczonemu schematowi JSON. Domyślny format to { "type": "text" } brak dodatkowych opcji. Nie zaleca się dla modeli GPT-4O i nowszych: Ustawienie na { "type": "json_object" } włączenie starszego trybu JSON, który zapewnia, że komunikat generowany przez model jest poprawny w JSON. Preferowane jest używanie json_schema w modelach, które go obsługują.	No
tool_choice	ToolChoiceOptions,ToolChoiceTypes lub ToolChoiceFunction	Jak model powinien wybierać, którego narzędzia (lub narzędzi) użyć podczas generowania odpowiedzi. Zobacz parametr, tools aby zobaczyć, jak określić, które narzędzia model może wywołać.	No
Narzędzia	macierz	Zestaw narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając parametr.tool_choice Dwie kategorie narzędzi, które możesz udostępnić modelowi, to: - Narzędzia wbudowane	No
truncation	wyliczenie	Strategia obcięcia do wykorzystania w odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy rozmiar okna kontekstowego modelu, model obcina odpowiedź, aby dopasowała się do okna kontekstu, rezygnując z elementów wejściowych w trakcie rozmowy. - disabled (domyślnie): Jeśli odpowiedź modelu przekroczy rozmiar okna kontekstowego dla modelu, żądanie nie zostanie zadane z błędem 400. Możliwe wartości: auto, disabled	No

ResponseRefusalDeltaEvent

Emitowany jest przy częściowej odmowie.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
content_index	liczba całkowita	Indeks części treści, do której dodany jest tekst odmowy.	Tak
delta	ciąg	Tekst odmowy, który jest dodawany.	Tak
item_id	ciąg	ID elementu wyjściowego, do którego dodany jest tekst odmowy.	Tak
output_index	liczba całkowita	Indeks pozycji wyjściowej, do której dodawany jest tekst odmowy.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.refusal.delta. Możliwe wartości: response.refusal.delta	Tak

ResponseRefusalDoneEvent

Emitowany jest, gdy tekst odmowy jest finalizowany.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
content_index	liczba całkowita	Indeks części treści, w której tekst odmowy jest finalizowany.	Tak
item_id	ciąg	ID pozycji wyjściowej, którą tekst odmowy jest finalizowany.	Tak
output_index	liczba całkowita	Indeks pozycji wyjściowej, w której tekst odmowy jest finalizowany.	Tak
refusal	ciąg	Tekst odmowy, który jest finalizowany.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.refusal.done. Możliwe wartości: response.refusal.done	Tak

responseStreamEvent

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
adnotacja	Annotation		Tak
annotation_index	liczba całkowita	Indeks dodanej adnotacji.	Tak
arguments	ciąg	Argumenty wywołania funkcji.	Tak
kod	ciąg	Kod błędu.	Tak
code_interpreter_call	CodeInterpreterToolCall	Wywołanie narzędzia do uruchamiania kodu.	Tak
content_index	liczba całkowita	Indeks części treści, w której tekst jest finalizowany.	Tak
delta	ciąg	Dodana delta tekstu.	Tak
element	OutputItem	Element wyjściowy, który został oznaczony jako gotowy.	Tak
item_id	ciąg	ID elementu wyjściowego, którego treść tekstu jest finalizowana.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, którego treść tekstu jest finalizowana.	Tak
param	ciąg	Parametr błędu.	Tak
część	OutputContent	Część dotycząca treści jest już załatwiona.	Tak
refusal	ciąg	Tekst odmowy, który jest finalizowany.	Tak
response	response	Odpowiedź była niepełna.	Tak
SMS	ciąg	Treść tekstu, która jest finalizowana.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.output_text.done. Możliwe wartości: response.output_text.done	Tak

ResponseTextAnnotationDeltaEvent

Emitowany jest przy dodawaniu adnotacji tekstowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
adnotacja	Annotation		Tak
annotation_index	liczba całkowita	Indeks dodanej adnotacji.	Tak
content_index	liczba całkowita	Indeks części treści, do której dodano adnotację tekstową.	Tak
item_id	ciąg	ID elementu wyjściowego, do którego dodano adnotację tekstową.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano adnotację tekstową.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.output_text.annotation.added. Możliwe wartości: response.output_text.annotation.added	Tak

ResponseTextDeltaEvent

Emitowany jest, gdy pojawia się dodatkowa delta tekstu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
content_index	liczba całkowita	Indeks części treści, do której dodano delta tekstu.	Tak
delta	ciąg	Dodana delta tekstu.	Tak
item_id	ciąg	ID elementu wyjściowego, do którego dodano delta tekstu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano delta tekstu.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.output_text.delta. Możliwe wartości: response.output_text.delta	Tak

ResponseTextDoneEvent

Emitowany podczas finalizacji treści tekstowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
content_index	liczba całkowita	Indeks części treści, w której tekst jest finalizowany.	Tak
item_id	ciąg	ID elementu wyjściowego, którego treść tekstu jest finalizowana.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, którego treść tekstu jest finalizowana.	Tak
SMS	ciąg	Treść tekstu, która jest finalizowana.	Tak
typ	wyliczenie	Rodzaj wydarzenia. Zawsze response.output_text.done. Możliwe wartości: response.output_text.done	Tak

ResponseUsage

Reprezentuje szczegóły dotyczące użycia tokenów, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych oraz łączną liczbę użytych tokenów.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Tak
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	Tak
output_tokens_details	obiekt	Szczegółowy podział tokenów wyjściowych.	Tak
└─ tokeny_rozumowania	liczba całkowita	Liczba tokenów rozumowania.	No
total_tokens	liczba całkowita	Całkowita liczba użytych żetonów.	Tak

Screenshot

Akcja zrzutu ekranu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. Dla akcji zrzutu ekranu ta właściwość jest zawsze ustawiona na .screenshot Możliwe wartości: screenshot	Tak

Scroll

Akcja przewijania.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
scroll_x	liczba całkowita	Odległość przewijania pozioma.	Tak
scroll_y	liczba całkowita	Pionowy przewijanie.	Tak
typ	wyliczenie	Określa typ zdarzenia. Dla akcji przewijania ta właściwość jest zawsze ustawiona na .scroll Możliwe wartości: scroll	Tak
x	liczba całkowita	Współrzędna x, gdzie powstał zwój.	Tak
Y	liczba całkowita	Współrzędna y, gdzie powstał zwój.	Tak

StopConfiguration

Do 4 sekwencji, w których API przestaje generować kolejne tokeny. Zwrócony tekst nie będzie zawierał sekwencji stop.

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

TextResponseFormatConfiguration

Obiekt określający format, który model musi wyprowadzać.

Konfiguracja { "type": "json_schema" } umożliwia Structured Outputs, które zapewniają, że model odpowiada dostarczonemu schematowi JSON.

Domyślny format to { "type": "text" } brak dodatkowych opcji.

Nie zaleca się dla modeli GPT-4O i nowszych:

Ustawienie na { "type": "json_object" } włączenie starszego trybu JSON, który zapewnia, że komunikat generowany przez model jest poprawny w JSON. Preferowane jest używanie json_schema w modelach, które go obsługują.

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

• ResponseFormatText
• TextResponseFormatJsonSchema
• ResponseFormatJsonObject

TextResponseFormatJsonSchema

Format odpowiedzi JSON Schema. Używany do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o Structured Outputs.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis formatu odpowiedzi, używany przez model do określenia, jak odpowiedzieć w formacie.	No
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.	No
schemat	ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON.	Tak
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	No	Nieprawda
typ	wyliczenie	Rodzaj formatu odpowiedzi, który jest definiowany. Zawsze json_schema. Możliwe wartości: json_schema	Tak

Narzędzie

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

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

Użyj tej opcji, aby wymusić wywołanie konkretnej funkcji w modelu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
nazwa	ciąg	Nazwa funkcji, którą trzeba wywołać.	Tak
typ	wyliczenie	Dla wywoływania funkcji typ zawsze jest .function Możliwe wartości: function	Tak

ToolChoiceOptions

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.

Majątek	Wartość
Opis	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.
Typ	ciąg
Wartości	none auto required

ToolChoiceTypes

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ narzędzia hostowanego, którego model powinien używać. Dozwolone wartości to: - file_search - computer_use_preview Możliwe wartości: file_search, computer_use_preview	Tak

Typ

To akcja wpisywania tekstu.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst do wpisania.	Tak
typ	wyliczenie	Określa typ zdarzenia. Dla działania typu ta własność jest zawsze ustawiona na .type Możliwe wartości: type	Tak

UpdateVectorStoreFileAttributesRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
attributes	VectorStoreFileAttributes	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości boole lub liczby.	Tak

UrlCitation

Cytowanie dla zasobu internetowego używanego do generowania odpowiedzi modelowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
end_index	liczba całkowita	Indeks ostatniego znaku cytowania URL w wiadomości.	Tak
start_index	liczba całkowita	Indeks pierwszego znaku cytowania URL w wiadomości.	Tak
tytuł	ciąg	Tytuł zasobu internetowego.	Tak
typ	wyliczenie	Rodzaj cytowania URL. Zawsze url_citation. Możliwe wartości: url_citation	Tak
Adres url	ciąg	URL zasobu internetowego.	Tak

VectorStoreFileAttributes

Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości boole lub liczby.

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

VectorStoreFileContentResponse

Reprezentuje analizę zawartości pliku pamięci wektorowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz	Przeanalizowałem zawartość pliku.	Tak
zawiera_więcej	boolean	Wskazuje, czy jest więcej stron z treścią do pobrania.	Tak
next_page	ciąg	Żeton na następną stronę, jeśli taki jest.	Tak
obiekt	wyliczenie	Typ obiektu, który zawsze jest vector_store.file_content.page Możliwe wartości: vector_store.file_content.page	Tak

VectorStoreSearchRequest

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
filters	ComparisonFilter lub CompoundFilter	Filtr do stosowania na podstawie atrybutów pliku.	No
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna mieścić się w zakresie od 1 do 50 włącznie.	No	10
kwerenda	ciąg lub tablica	Ciąg zapytania do wyszukiwania	Tak
opcje rankingu	obiekt	Opcje rankingu w wyszukiwarce.	No
└} ranker	wyliczenie	Możliwe wartości: auto, default-2024-11-15	No
└─ próg_punktowy	number		No	0
rewrite_query	boolean	Czy przepisać zapytanie w języku naturalnym dla wyszukiwania wektorowego.	No	Nieprawda

VectorStoreSearchResultContentObject

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
SMS	ciąg	Treść tekstu wróciła z wyszukiwania.	Tak
typ	wyliczenie	Rodzaj treści. Możliwe wartości: text	Tak

VectorStoreSearchResultItem

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
attributes	VectorStoreFileAttributes	Zestaw 16 par klucz-wartość, które można przypisać do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w uporządkowanym formacie oraz do zapytań o obiekty za pomocą API lub pulpitu. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości boole lub liczby.	Tak
zawartość	macierz	Fragmenty zawartości z pliku.	Tak
identyfikator_pliku	ciąg	ID pliku pamięci wektorowej.	Tak
filename	ciąg	Nazwa pliku pamięci wektorowej.	Tak
wynik	number	Ocena podobieństwa do efektu.	Tak

VectorStoreSearchResultsPage

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	macierz	Lista wyników wyszukiwania.	Tak
zawiera_więcej	boolean	Wskazuje, czy jest więcej wyników do pobrania.	Tak
next_page	ciąg	Żeton na następną stronę, jeśli taki jest.	Tak
obiekt	wyliczenie	Typ obiektu, który zawsze jest vector_store.search_results.page Możliwe wartości: vector_store.search_results.page	Tak
search_query	macierz		Tak

VoiceIdsShared

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

Wait

Akcja czekania.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. Dla akcji oczekiwania ta właściwość jest zawsze ustawiona na .wait Możliwe wartości: wait	Tak

ReasoningEffort

Ogranicza wysiłek związany z rozumowaniem dla modeli rozumowania. Obecnie obsługiwane wartości to low, medium, oraz high. Zmniejszenie wysiłku rozumowania może skutkować szybszymi odpowiedziami i mniejszą liczbą tokenów używanych do rozumowania w odpowiedzi.

Majątek	Wartość
Opis	Ogranicza wysiłek związany z rozumowaniem dla modeli rozumowania. Obecnie obsługiwane wartości to low, medium, oraz high. Zmniejszenie wysiłku rozumowania może skutkować szybszymi odpowiedziami i mniejszą liczbą tokenów używanych do rozumowania w odpowiedzi.
Typ	ciąg
Wartość domyślna	nośnik
Wartości	low medium high

errorEvent

Występuje, gdy pojawia się błąd. Może się to zdarzyć z powodu wewnętrznego błędu serwera lub przerwy czasowej.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	error		Tak
wydarzenie	ciąg		Tak

event Enum: ErrorEventEnum

Wartość	Opis
błąd

doneEvent

Dzieje się, gdy strumień się kończy.

Name	Typ	Opis	Obowiązkowy	Wartość domyślna
dane	ciąg		Tak
wydarzenie	ciąg		Tak

event Enum: DoneEventEnum

Wartość	Opis
Gotowe

data Enum: DoneEventDataEnum

Wartość	Opis
[GOTOWE]

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.