Azure OpenAI odpowiedzi

Wersja interfejsu API: wersja 1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API

Zmienne serwera:

Variable	Wartość domyślna	Description
punkt końcowy		Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Authentication

ApiKeyAuth (klucz API)

Przekaż swój klucz API w nagłówku api-key .

ApiKeyAuth_ (Klucz API)

Przekaż swój klucz API w nagłówku authorization .

OAuth2Auth (OAuth 2.0)

Przepływ: niejawny

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

Zakresów:

https://cognitiveservices.azure.com/.default

Wymagania dotyczące zabezpieczeń

Punkty końcowe akceptują dowolną z następujących metod uwierzytelniania:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (zakresy: https://cognitiveservices.azure.com/.default)

Tworzenie odpowiedzi

POST {endpoint}/openai/v1/responses

Tworzy odpowiedź modelu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: `v1`, `preview`	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. `v1` jeśli nie określono inaczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
tło	wartość logiczna lub null		Nie.
context_management	array of OpenAI.ContextManagementParam lub null	Konfiguracja zarządzania kontekstem dla tego żądania.	Nie.
konwersacja	OpenAI.ConversationParam lub null		Nie.
Obejmują	tablica wartości OpenAI.IncludeEnum lub null		Nie.
dane wejściowe	OpenAI.InputParam	Dane wejściowe tekstu, obrazu lub pliku w modelu używane do generowania odpowiedzi. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Dane wejściowe obrazowe - Wejścia plików - Stan konwersacji - Wywoływanie funkcji	Nie.
instructions	ciąg znaków lub null		Nie.
max_output_tokens	liczba całkowita lub null		Nie.
maks_liczba_wywołań_narzędzi	liczba całkowita lub null		Nie.
metadane	OpenAI.Metadata lub null		Nie.
model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
wywołania_narzędzia_równoległe	wartość logiczna lub null		Nie.
previous_response_id	ciąg znaków lub null		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
prompt_cache_retention	ciąg znaków lub null		Nie.
reasoning	OpenAI.Reasoning lub null		Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
przechowywać	wartość logiczna lub null		Nie.
odtwarzać strumieniowo	wartość logiczna lub null		Nie.
stream_options	OpenAI.ResponseStreamOptions lub null		Nie.
temperatura	liczba lub wartość null		Nie.
SMS	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Dwie kategorie narzędzi, które można modelowi podać, to: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie plików. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu.	Nie.
top_logprobs	liczba całkowita lub null		Nie.
top_p	liczba lub wartość null		Nie.
truncation	ciąg znaków lub null		Nie.
użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt
text/event-stream	obiekt

Name	Typ	Description	Obowiązkowy	Wartość domyślna
tło	wartość logiczna lub null		Nie.
zakończono_o	ciąg znaków lub null		Nie.
content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
konwersacja	OpenAI.ConversationReference lub null		Nie.
utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
błąd	OpenAI.ResponseError lub null		Yes
id	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails lub null		Yes
instructions	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
max_output_tokens	liczba całkowita lub null		Nie.
maks_liczba_wywołań_narzędzi	liczba całkowita lub null		Nie.
metadane	OpenAI.Metadata lub null		Nie.
model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
We/Wy	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
output_text	ciąg znaków lub null		Nie.
wywołania_narzędzia_równoległe	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
previous_response_id	ciąg znaków lub null		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
prompt_cache_retention	ciąg znaków lub null		Nie.
reasoning	OpenAI.Reasoning lub null		Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
stan	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
temperatura	liczba lub wartość null		Nie.
SMS	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
top_logprobs	liczba całkowita lub null		Nie.
top_p	liczba lub wartość null		Nie.
truncation	ciąg znaków lub null		Nie.
użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Obowiązkowy
kod	ciąg znaków lub null	Yes
inner_error		Nie.
komunikat	ciąg	Yes
param	ciąg znaków lub null	Nie.
typ	ciąg	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Examples

Przykład

Utwórz odpowiedź wzorcową

POST {endpoint}/openai/v1/responses?api-version=v1

Uzyskiwanie odpowiedzi

GET {endpoint}/openai/v1/responses/{response_id}

Pobiera odpowiedź modelu z danym identyfikatorem.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: `v1`, `preview`	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. `v1` jeśli nie określono inaczej.
response_id	ścieżka	Yes	ciąg
include[]	kwerenda	Nie.	macierz	Dodatkowe pola do uwzględnienia w odpowiedzi. Aby uzyskać więcej informacji, zobacz parametr include dla tworzenia odpowiedzi powyżej.
odtwarzać strumieniowo	kwerenda	Nie.	boolean	W przypadku ustawienia wartości true dane odpowiedzi modelu będą przesyłane strumieniowo do klienta, ponieważ są generowane przy użyciu zdarzeń wysyłanych przez serwer. Serializacja: explode: false
starting_after	kwerenda	Nie.	liczba całkowita (int32)	Numer sekwencji zdarzenia, po którym należy rozpocząć przesyłanie strumieniowe. Serializacja: explode: false
include_obfuscation	kwerenda	Nie.	boolean	W przypadku wartości true funkcja zaciemnienia strumienia zostanie włączona. Zaciemnianie strumienia dodaje losowe znaki do pola `obfuscation` w zdarzeniach delta przesyłania strumieniowego w celu normalizacji rozmiarów ładunków jako środka zapobiegawczego dla niektórych ataków kanału bocznego. Te pola zaciemniania są domyślnie uwzględniane, ale wprowadzają niewielki narzut do strumienia danych. Możesz ustawić `include_obfuscation` wartość false, aby zoptymalizować przepustowość, jeśli ufasz linkom sieciowym między aplikacją a interfejsem API OpenAI. Serializacja: explode: false

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Description	Obowiązkowy	Wartość domyślna
tło	wartość logiczna lub null		Nie.
zakończono_o	ciąg znaków lub null		Nie.
content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
konwersacja	OpenAI.ConversationReference lub null		Nie.
utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
błąd	OpenAI.ResponseError lub null		Yes
id	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails lub null		Yes
instructions	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
max_output_tokens	liczba całkowita lub null		Nie.
maks_liczba_wywołań_narzędzi	liczba całkowita lub null		Nie.
metadane	OpenAI.Metadata lub null		Nie.
model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
We/Wy	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
output_text	ciąg znaków lub null		Nie.
wywołania_narzędzia_równoległe	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
previous_response_id	ciąg znaków lub null		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
prompt_cache_retention	ciąg znaków lub null		Nie.
reasoning	OpenAI.Reasoning lub null		Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
stan	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
temperatura	liczba lub wartość null		Nie.
SMS	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
top_logprobs	liczba całkowita lub null		Nie.
top_p	liczba lub wartość null		Nie.
truncation	ciąg znaków lub null		Nie.
użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Obowiązkowy
kod	ciąg znaków lub null	Yes
inner_error		Nie.
komunikat	ciąg	Yes
param	ciąg znaków lub null	Nie.
typ	ciąg	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Usuń odpowiedź

DELETE {endpoint}/openai/v1/responses/{response_id}

Usuwa odpowiedź według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: `v1`, `preview`	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. `v1` jeśli nie określono inaczej.
response_id	ścieżka	Yes	ciąg

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Description	Obowiązkowy
usunięta	wyliczenie	Możliwe wartości: `True`	Yes
id	ciąg		Yes
obiekt	wyliczenie	Możliwe wartości: `response.deleted`	Yes

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Obowiązkowy
kod	ciąg znaków lub null	Yes
inner_error		Nie.
komunikat	ciąg	Yes
param	ciąg znaków lub null	Nie.
typ	ciąg	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Anuluj odpowiedź

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Anuluje odpowiedź modelu z danym identyfikatorem. Można anulować tylko odpowiedzi utworzone przy użyciu parametru w tle ustawionego na wartość true.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: `v1`, `preview`	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. `v1` jeśli nie określono inaczej.
response_id	ścieżka	Yes	ciąg

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Description	Obowiązkowy	Wartość domyślna
tło	wartość logiczna lub null		Nie.
zakończono_o	ciąg znaków lub null		Nie.
content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
konwersacja	OpenAI.ConversationReference lub null		Nie.
utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
błąd	OpenAI.ResponseError lub null		Yes
id	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails lub null		Yes
instructions	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
max_output_tokens	liczba całkowita lub null		Nie.
maks_liczba_wywołań_narzędzi	liczba całkowita lub null		Nie.
metadane	OpenAI.Metadata lub null		Nie.
model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
We/Wy	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
output_text	ciąg znaków lub null		Nie.
wywołania_narzędzia_równoległe	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
previous_response_id	ciąg znaków lub null		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
prompt_cache_retention	ciąg znaków lub null		Nie.
reasoning	OpenAI.Reasoning lub null		Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
stan	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
temperatura	liczba lub wartość null		Nie.
SMS	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
top_logprobs	liczba całkowita lub null		Nie.
top_p	liczba lub wartość null		Nie.
truncation	ciąg znaków lub null		Nie.
użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Obowiązkowy
kod	ciąg znaków lub null	Yes
inner_error		Nie.
komunikat	ciąg	Yes
param	ciąg znaków lub null	Nie.
typ	ciąg	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Wyświetlanie listy elementów wejściowych

GET {endpoint}/openai/v1/responses/{response_id}/input_items

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

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: `v1`, `preview`	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. `v1` jeśli nie określono inaczej.
response_id	ścieżka	Yes	ciąg
limit	kwerenda	Nie.	liczba całkowita (int32)	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20. Serializacja: explode: false
porządek	kwerenda	Nie.	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` dla kolejności malejącej. Serializacja: explode: false
Po	kwerenda	Nie.	ciąg	Kursor do wykorzystania w stronicowaniu. `after` jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład utworzysz żądanie listy i otrzymasz 100 obiektów, kończąc na obj_foo, Kolejne wywołanie może zawierać parametr after=obj_foo, co pozwoli pobrać następną stronę listy. Serializacja: explode: false
przed	kwerenda	Nie.	ciąg	Kursor do wykorzystania w stronicowaniu. `before` jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład utworzysz żądanie listy i otrzymasz 100 obiektów, kończąc na obj_foo, Kolejne wywołanie może zawierać parametr before=obj_foo, aby pobrać poprzednią stronę listy. Serializacja: explode: false

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	OpenAI.ResponseItemList

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Obowiązkowy
kod	ciąg znaków lub null	Yes
inner_error		Nie.
komunikat	ciąg	Yes
param	ciąg znaków lub null	Nie.
typ	ciąg	Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Components

AzureAIFoundryModelsApiVersion

Property	Value
Type	ciąg
Wartości	`v1` `preview`

AzureContentFilterBlocklistResult

Kolekcja wyników filtrowania true/false dla skonfigurowanych niestandardowych list zablokowanych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
details	tablica obiektu	Pary poszczególnych identyfikatorów listy bloków i tego, czy spowodowały one akcję filtrowania.	Nie.
filtered	boolean	Wartość wskazująca, czy którakolwiek ze szczegółowych list zablokowanych spowodowała akcję filtrowania.	Yes

AzureContentFilterCompletionTextSpan

Reprezentacja zakresu tekstu uzupełniania używanego przez wyniki filtru zawartości usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
completion_end_offset	liczba całkowita (int32)	Przesunięcie pierwszego punktu kodu UTF32, który jest wykluczony z zakresu. To pole jest zawsze równe completion_start_offset dla pustych zakresów. To pole jest zawsze większe niż completion_start_offset w przypadku niepustych zakresów.	Yes
completion_start_offset	liczba całkowita (int32)	Przesunięcie punktu kodu UTF32, który rozpoczyna zakres.	Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name	Typ	Description	Obowiązkowy
details	tablica elementu AzureContentFilterCompletionTextSpan	Szczegółowe informacje o wykrytych zakresach tekstu uzupełniania.	Yes
detected	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
filtered	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes

AzureContentFilterCustomTopicResult

Kolekcja wyników filtrowania true/false dla skonfigurowanych tematów niestandardowych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
details	tablica obiektu	Pary poszczególnych identyfikatorów tematów i informacje o ich wykryciu.	Nie.
filtered	boolean	Wartość wskazująca, czy którykolwiek ze szczegółowych tematów spowodował akcję filtrowania.	Yes

AzureContentFilterDetectionResult

Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została wykryta i czy zawartość została odfiltrowana.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detected	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
filtered	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes

AzureContentFilterForResponsesAPI

Name	Typ	Description	Obowiązkowy
Zablokowany	boolean	Określ, czy odpowiedź jest zablokowana.	Yes
content_filter_offsets	AzureContentFilterResultOffsets		Yes
content_filter_results	AzureContentFilterResultsForResponsesAPI		Yes
└listy_blokowania_niestandardowe	AzureContentFilterBlocklistResult	Kolekcja wyników filtrowania binarnego dla skonfigurowanych niestandardowych list bloków.	Nie.
└ custom_topics	AzureContentFilterCustomTopicResult	Kolekcja wyników filtrowania binarnego dla skonfigurowanych tematów niestandardowych.	Nie.
└─ błąd	obiekt	Jeśli jest obecny, szczegółowe informacje o błędzie uniemożliwiającym filtrowanie zawartości przed ukończeniem oceny.	Nie.
└─ kod	liczba całkowita (int32)	Unikatowy kod czytelny dla maszyny skojarzony z błędem.	Yes
└─ Komunikat	ciąg	Czytelny dla człowieka komunikat skojarzony z błędem.	Yes
└* nienawiść	AzureContentFilterSeverityResult	Kategoria filtru zawartości, która może odwoływać się do dowolnej zawartości, która atakuje lub używa metody pejoracyjnej lub dyskryminującej język z odwołaniem do osoby lub grupy tożsamości na podstawie niektórych atrybutów różnicowych tych grup łącznie z rasą, pochodzeniem etnicznym, narodowością, tożsamością płci i wyrażeniem, orientacją seksualną, religia, status imigracyjny, status zdolności, wygląd osobisty i rozmiar ciała.	Nie.
└atak pośredni	AzureContentFilterDetectionResult	Wynik wykrywania opisujący ataki na systemy oparte na modelach generowania sztucznej inteligencji, które mogą wystąpić za każdym razem aplikacja przetwarza informacje, które nie zostały bezpośrednio utworzone przez dewelopera aplikacji lub użytkownik.	Nie.
└─ złamanie zabezpieczeń	AzureContentFilterDetectionResult	Wynik wykrywania opisujący ataki polegające na wstrzyknięciu monitu użytkownika, w którym złośliwi użytkownicy celowo wykorzystują luki w zabezpieczeniach systemu w celu wywołania nieautoryzowanego zachowania z poziomu usługi LLM. Może to prowadzić do nieodpowiedniej zawartości generowanie lub naruszenie ograniczeń nakładanych przez system.	Yes
└personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Wynik wykrywania, który opisuje dopasowania do danych osobowych z konfigurowalnymi podkategoriami.	Nie.
└* wulgaryzm	AzureContentFilterDetectionResult	Wynik wykrywania określający, czy w języku sprzeciwu znajduje się ropa, wulgarna czy inny język sprzeciwu Zawartości.	Nie.
└protected_material_code	obiekt	Wynik wykrywania opisujący dopasowanie do licencjonowanego kodu lub innego chronionego materiału źródłowego.	Nie.
└* cytat	obiekt	Jeśli są dostępne, szczegóły cytowania opisujące skojarzoną licencję i jej lokalizację.	Nie.
└* adres URL	string (identyfikator URI)	Adres URL skojarzony z licencją.	Nie.
└─ Licencja	ciąg	Nazwa lub identyfikator licencji skojarzonej z wykrywaniem.	Nie.
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
└protected_material_text	AzureContentFilterDetectionResult	Wynik wykrywania opisujący dopasowanie tekstu chronionego prawami autorskimi lub inny stan.	Nie.
└samouszkodzenie	AzureContentFilterSeverityResult	Kategoria filtru zawartości, która opisuje język związany z działaniami fizycznymi, które mają na celu szkodę, szkodę, uszkodzić ciało lub zabić siebie.	Nie.
└* seksualny	AzureContentFilterSeverityResult	Kategoria filtru zawartości dla języka związanego z anatomicznymi narządami i genitaliami, romantycznymi relacjami, aktami przedstawiane w kategoriach erotycznych lub pieszczotliwych, ciąży, fizycznych aktów seksualnych, w tym tych przedstawianych jako napaść lub wymuszony akt przemocy seksualnej przeciwko woli, prostytucji, pornografii i nadużyć.	Nie.
└task_adherence	AzureContentFilterDetectionResult	Wynik wykrywania wskazujący, czy przepływ wykonywania nadal trzyma plan.	Yes
└ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Nie.
└* przemoc	AzureContentFilterSeverityResult	Kategoria filtru zawartości dla języka związanego z działaniami fizycznymi, które mają zaszkodzić, zranić, uszkodzić lub zabić ktoś lub coś; opisuje broń, broń i powiązane jednostki, takie jak produkcje, stowarzyszenia, i tak dalej.	Nie.
source_type	ciąg	Nazwa typu źródłowego komunikatu.	Yes
tool_call_id	ciąg	ID wywołania narzędzia powiązanego z tym wynikiem filtra treści, jeśli ma zastosowanie.	Nie.

FiltrZawartościAzureInformacjePozwalająceNaIdentyfikacjęOsobyWynik

Wynik wykrywania filtru zawartości dla danych osobowych zawierających rozszerzenia dotyczące szkód.

Name	Typ	Description	Obowiązkowy
detected	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
filtered	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
redacted_text	ciąg	Zredagowany tekst z usuniętymi lub zamaskowanymi informacjami o danych osobowych.	Nie.
podkategorie	tablica elementów AzurePiiSubCategoryResult	Szczegółowe wyniki poszczególnych kategorii PIIHarmSubCategory.	Nie.

AzureContentFilterResultOffsets

Name	Typ	Obowiązkowy
check_offset	liczba całkowita (int32)	Yes
end_offset	liczba całkowita (int32)	Yes
start_offset	liczba całkowita (int32)	Yes

AzureContentFilterResultsForResponsesAPI

Name	Typ	Description	Obowiązkowy
custom_blocklists	AzureContentFilterBlocklistResult	Kolekcja wyników filtrowania true/false dla skonfigurowanych niestandardowych list zablokowanych.	Nie.
└szczegóły	tablica obiektu	Pary poszczególnych identyfikatorów listy bloków i tego, czy spowodowały one akcję filtrowania.	Nie.
└─ Filtrowane	boolean	Wartość wskazująca, czy lista bloków wygenerowała akcję filtrowania.	Yes
└─ ID	ciąg	Identyfikator ocenianej listy bloków niestandardowych.	Yes
└─ Filtrowane	boolean	Wartość wskazująca, czy którakolwiek ze szczegółowych list zablokowanych spowodowała akcję filtrowania.	Yes
tematy niestandardowe	AzureContentFilterCustomTopicResult	Kolekcja wyników filtrowania true/false dla skonfigurowanych tematów niestandardowych.	Nie.
└szczegóły	tablica obiektu	Pary poszczególnych identyfikatorów tematów i informacje o ich wykryciu.	Nie.
Wykryto	boolean	Wartość wskazująca, czy temat został wykryty.	Yes
└─ ID	ciąg	Identyfikator ocenianego tematu niestandardowego.	Yes
└─ Filtrowane	boolean	Wartość wskazująca, czy którykolwiek ze szczegółowych tematów spowodował akcję filtrowania.	Yes
błąd	obiekt	Jeśli jest obecny, szczegółowe informacje o błędzie uniemożliwiającym filtrowanie zawartości przed ukończeniem oceny.	Nie.
└─ kod	liczba całkowita (int32)	Unikatowy kod czytelny dla maszyny skojarzony z błędem.	Yes
└─ Komunikat	ciąg	Czytelny dla człowieka komunikat skojarzony z błędem.	Yes
hate	AzureContentFilterSeverityResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została odfiltrowana i jaka jest jakość poziom powagi zawartości był oceniony względem konfiguracji filtru zawartości dla kategorii.	Nie.
└─ Filtrowane	boolean	Określa, czy dotkliwość zawartości spowodowała akcję filtrowania zawartości.	Yes
Ważność └*	wyliczenie	Ważność oznaczona etykietą zawartości. Możliwe wartości: `safe`, , `low`, `mediumhigh`	Yes
indirect_attack	AzureContentFilterDetectionResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została wykryta i, jeśli tak, czy została zablokowana. Filtrowane.	Nie.
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
jailbreak	AzureContentFilterDetectionResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została wykryta i, jeśli tak, czy została zablokowana. Filtrowane.	Yes
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
informacje umożliwiające identyfikację osoby	AzureContentFilterPersonallyIdentifiableInformationResult	Wynik wykrywania filtru zawartości dla danych osobowych zawierających rozszerzenia dotyczące szkód.	Nie.
└redacted_text	ciąg	Zredagowany tekst z usuniętymi lub zamaskowanymi informacjami o danych osobowych.	Nie.
└─ podkategorie	tablica elementów AzurePiiSubCategoryResult	Szczegółowe wyniki poszczególnych kategorii PIIHarmSubCategory.	Nie.
profanity	AzureContentFilterDetectionResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została wykryta i, jeśli tak, czy została zablokowana. Filtrowane.	Nie.
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
protected_material_code	obiekt	Wynik wykrywania opisujący dopasowanie do licencjonowanego kodu lub innego chronionego materiału źródłowego.	Nie.
└* cytat	obiekt	Jeśli są dostępne, szczegóły cytowania opisujące skojarzoną licencję i jej lokalizację.	Nie.
└* adres URL	string (identyfikator URI)	Adres URL skojarzony z licencją.	Nie.
└─ Licencja	ciąg	Nazwa lub identyfikator licencji skojarzonej z wykrywaniem.	Nie.
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
protected_material_text	AzureContentFilterDetectionResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została wykryta i, jeśli tak, czy została zablokowana. Filtrowane.	Nie.
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
self_harm	AzureContentFilterSeverityResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została odfiltrowana i jaka jest jakość poziom powagi zawartości był oceniony względem konfiguracji filtru zawartości dla kategorii.	Nie.
└─ Filtrowane	boolean	Określa, czy dotkliwość zawartości spowodowała akcję filtrowania zawartości.	Yes
Ważność └*	wyliczenie	Ważność oznaczona etykietą zawartości. Możliwe wartości: `safe`, , `low`, `mediumhigh`	Yes
sexual	AzureContentFilterSeverityResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została odfiltrowana i jaka jest jakość poziom powagi zawartości był oceniony względem konfiguracji filtru zawartości dla kategorii.	Nie.
└─ Filtrowane	boolean	Określa, czy dotkliwość zawartości spowodowała akcję filtrowania zawartości.	Yes
Ważność └*	wyliczenie	Ważność oznaczona etykietą zawartości. Możliwe wartości: `safe`, , `low`, `mediumhigh`	Yes
task_adherence	AzureContentFilterDetectionResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została wykryta i, jeśli tak, czy została zablokowana. Filtrowane.	Yes
Wykryto	boolean	Czy kategoria zawartości oznaczonej etykietą została wykryta w zawartości.	Yes
└─ Filtrowane	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości.	Yes
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Nie.
violence	AzureContentFilterSeverityResult	Element wyniku filtru zawartości z etykietą wskazujący, czy zawartość została odfiltrowana i jaka jest jakość poziom powagi zawartości był oceniony względem konfiguracji filtru zawartości dla kategorii.	Nie.
└─ Filtrowane	boolean	Określa, czy dotkliwość zawartości spowodowała akcję filtrowania zawartości.	Yes
Ważność └*	wyliczenie	Ważność oznaczona etykietą zawartości. Możliwe wartości: `safe`, , `low`, `mediumhigh`	Yes

AzureContentFilterSeverityResult

Element wyniku filtru zawartości z etykietą, który wskazuje, czy zawartość została przefiltrowana i jaki był poziom ważności jakościowej zawartości, obliczony względem konfiguracji filtru zawartości dla kategorii.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
filtered	boolean	Określa, czy dotkliwość zawartości spowodowała akcję filtrowania zawartości.	Yes
severity	wyliczenie	Ważność oznaczona etykietą zawartości. Możliwe wartości: `safe`, , `low`, `mediumhigh`	Yes

AzurePiiSubCategoryResult

Szczegóły wyników dla poszczególnych kategorii PIIHarmSubCategory.

Name	Typ	Description	Obowiązkowy
detected	boolean	Czy w zawartości wykryto podkategorię zawartości oznaczonej etykietą.	Yes
filtered	boolean	Czy wykrywanie zawartości spowodowało akcję filtrowania zawartości dla tej podkategorii.	Yes
Redakcja	boolean	Czy zawartość została zredagowana dla tej podkategorii.	Yes
podkategoria	ciąg	Obliczona kategoria PIIHarmSubCategory.	Yes

AzureToolApprovalRequest

Azure tool approval request

Żądanie zatwierdzenia narzędzia Azure w wyjściu odpowiedzi.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Ciąg JSON argumentów dla narzędzia.	Yes
call_id	ciąg	ID wywołania narzędzia wymagającego zatwierdzenia.	Yes
id	ciąg	Unikatowy identyfikator żądania zatwierdzenia.	Yes
etykieta	ciąg	Etykieta narzędzia (np. 'remote_functions').	Yes
nazwa	ciąg	Nazwa funkcji narzędzia (np. 'output_binding').	Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_approval_request`. Możliwe wartości: `tool_approval_request`	Yes

AzureToolApprovalResponse

Azure tool approval response

Odpowiedź zatwierdzająca narzędzia Azure w wejściu żądania.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg	Identyfikator odpowiedzi na żądanie zatwierdzenia.	Yes
approve	boolean	Czy żądanie zostało zatwierdzone.	Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_approval_response`. Możliwe wartości: `tool_approval_response`	Yes

OpenAI.Annotation

Adnotacja, która ma zastosowanie do zakresu tekstu wyjściowego.

Dyskryminator dla OpenAI.Annotation.

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

Property	Value
Type	ciąg
Wartości	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Type	ciąg
Wartości	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Zastosowanie statusu wyjścia wywołania poprawki

Wartości wyników zgłaszane dla danych wyjściowych wywołań narzędzia apply_patch.

Property	Value
Type	ciąg
Wartości	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Value
Type	ciąg
Wartości	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Zastosowanie statusu wywołania łatki

Wartości stanu zgłaszane dla wywołań narzędzi apply_patch.

Property	Value
Type	ciąg
Wartości	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Zastosowanie operacji poprawki i tworzenia pliku

Instrukcja opisująca sposób tworzenia pliku za pomocą narzędzia apply_patch.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Różn	ciąg	Różnice, które mają być stosowane.	Yes
ścieżka	ciąg	Ścieżka pliku do utworzenia.	Yes
typ	wyliczenie	Utwórz nowy plik z podaną różnicą. Możliwe wartości: `create_file`	Yes	create_file

OpenAI.ApplyPatchCreateFileOperationParam

Zastosowanie operacji poprawki i tworzenia pliku

Instrukcja tworzenia nowego pliku za pomocą narzędzia apply_patch.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Różn	ciąg	Ujednolicona zawartość różnic do zastosowania podczas tworzenia pliku. Ograniczenia: maxLength: 10485760	Yes
ścieżka	ciąg	Ścieżka pliku do utworzenia względem katalogu głównego obszaru roboczego. Ograniczenia: minLength: 1	Yes
typ	wyliczenie	Typ operacji. Zawsze `create_file`. Możliwe wartości: `create_file`	Yes	create_file

OpenAI.ApplyPatchDeleteFileOperation

Zastosowanie operacji usuwania plików z poprawką

Instrukcja opisująca sposób usuwania pliku za pośrednictwem narzędzia apply_patch.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
ścieżka	ciąg	Ścieżka pliku do usunięcia.	Yes
typ	wyliczenie	Usuń określony plik. Możliwe wartości: `delete_file`	Yes	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Zastosowanie operacji usuwania plików z poprawką

Instrukcja usuwania istniejącego pliku za pośrednictwem narzędzia apply_patch.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
ścieżka	ciąg	Ścieżka pliku do usunięcia względem katalogu głównego obszaru roboczego. Ograniczenia: minLength: 1	Yes
typ	wyliczenie	Typ operacji. Zawsze `delete_file`. Możliwe wartości: `delete_file`	Yes	delete_file

OpenAI.ApplyPatchFileOperation

Zastosowanie operacji patch

Jedną z operacji create_file, delete_file lub update_file stosowanych za pośrednictwem apply_patch.

Dyskryminujące dla openAI.ApplyPatchFileOperation

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Property	Value
Type	ciąg
Wartości	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Zastosowanie operacji patch

Jeden z create_file, delete_file lub update_file operacji dostarczonych do narzędzia apply_patch.

Dyskryminujące dla openAI.ApplyPatchOperationParam

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

Property	Value
Type	ciąg
Wartości	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Narzędzie do aplikacji łatek

Umożliwia asystentowi tworzenie, usuwanie lub aktualizowanie plików przy użyciu ujednoliconych różnic.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ narzędzia. Zawsze `apply_patch`. Możliwe wartości: `apply_patch`	Yes	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Zastosowanie operacji aktualizacji pliku

Instrukcja opisująca sposób aktualizowania pliku za pomocą narzędzia apply_patch.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Różn	ciąg	Różnice, które mają być stosowane.	Yes
ścieżka	ciąg	Ścieżka pliku do aktualizacji.	Yes
typ	wyliczenie	Zaktualizuj istniejący plik przy użyciu podanej różnicy. Możliwe wartości: `update_file`	Yes	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Zastosowanie operacji aktualizacji pliku

Instrukcja aktualizowania istniejącego pliku za pomocą narzędzia apply_patch.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Różn	ciąg	Ujednolicona zawartość różnicowa, która ma być stosowana do istniejącego pliku. Ograniczenia: maxLength: 10485760	Yes
ścieżka	ciąg	Ścieżka pliku do aktualizacji względem katalogu głównego obszaru roboczego. Ograniczenia: minLength: 1	Yes
typ	wyliczenie	Typ operacji. Zawsze `update_file`. Możliwe wartości: `update_file`	Yes	update_file

OpenAI.PrzybliżonaLokalizacja

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Miasta	ciąg znaków lub null		Nie.
kraj	ciąg znaków lub null		Nie.
region	ciąg znaków lub null		Nie.
timezone	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ przybliżenia lokalizacji. Zawsze `approximate`. Możliwe wartości: `approximate`	Yes	Przybliżony

OpenAI.AutoCodeInterpreterToolParam

Parametry narzędzia automatycznego interpretera kodu

Konfiguracja kontenera interpretera kodu. Opcjonalnie określ identyfikatory plików do uruchomienia kodu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
identyfikatory_plików	tablica ciągów	Opcjonalna lista przesłanych plików, które mają być dostępne w Twoim kodzie. Ograniczenia: maksymalneElementy: 50	Nie.
limit_pamięci	OpenAI.ContainerMemoryLimit lub null		Nie.
network_policy	OpenAI.ContainerNetworkPolicyParam	Polityka dostępu sieciowego dla kontenera.	Nie.
typ	wyliczenie	Zawsze `auto`. Możliwe wartości: `auto`	Yes	samochód

OpenAI.ClickButtonType

Property	Value
Type	ciąg
Wartości	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Akcja kliknięcia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
przycisk	OpenAI.ClickButtonType		Yes
keys	tablica ciągów lub wartości null		Nie.
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji kliknięcia ta właściwość jest zawsze `click`. Możliwe wartości: `click`	Yes	click
x	liczba całkowita	Współrzędna x, w której wystąpiło kliknięcie.	Yes
y	liczba całkowita	Współrzędna y, w której wystąpiło kliknięcie.	Yes

OpenAI.CodeInterpreterOutputImage

Obraz wyjściowy interpretera kodu

Wynik obrazowy z interpretera kodu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ danych wyjściowych. Zawsze `image`. Możliwe wartości: `image`	Yes	obraz
url	string (identyfikator URI)	Adres URL wyjścia obrazu z interpretera kodu.	Yes

OpenAI.CodeInterpreterOutputLogs

Logi wyjściowe interpretera kodu

Dane wyjściowe dzienników z interpretera kodu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
dzienniki	ciąg	Dane wyjściowe dzienników z interpretera kodu.	Yes
typ	wyliczenie	Typ danych wyjściowych. Zawsze `logs`. Możliwe wartości: `logs`	Yes	dzienniki

OpenAI.CodeInterpreterTool

Interpreter kodu

Narzędzie, które uruchamia kod języka Python, aby pomóc wygenerować odpowiedź na monit.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kontener	string lub OpenAI.AutoCodeInterpreterToolParam	Kontener interpretera kodu. Może być identyfikatorem kontenera lub obiektem, który określa przekazane identyfikatory plików, aby udostępnić kod wraz z opcjonalne `memory_limit` ustawienie.	Yes
typ	wyliczenie	Typ narzędzia interpretera kodu. Zawsze `code_interpreter`. Możliwe wartości: `code_interpreter`	Yes

OpenAI.ComparisonFilter

Filtr porównawczy

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

Name	Typ	Description	Obowiązkowy	Wartość domyślna
klucz	ciąg	Klucz do porównania z wartością.	Yes
typ	wyliczenie	Określa operator porównania: `eq`, , `negt`, `gte`, `lt`, `lte`, `in`, . `nin` - `eq`:Equals - `ne`: nie równa się - `gt`: większe niż - `gte`: większe niż lub równe - `lt`: mniejsze niż - `lte`: mniejsze niż lub równe - `in`:Cala - `nin`: nie w Możliwe wartości: `eq`, , `negt`, `gtelt`, , `lte`, , `innin`	Yes	eq
value	ciąg lub liczba, boolean lub tablica ciągu lub liczba	Wartość do porównania z kluczem atrybutu; obsługuje typy ciągów, liczb lub wartości logicznych.	Yes

OpenAI.CompoundFilter

Filtr złożony

Połącz wiele filtrów przy użyciu polecenia and lub or.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
filters	tablica obiektów OpenAI.ComparisonFilter lub	Tablica filtrów do połączenia. Elementy mogą mieć wartość `ComparisonFilter` lub `CompoundFilter`.	Yes
typ	wyliczenie	Typ operacji: `and` lub `or`. Możliwe wartości: `and`, `or`	Yes

OpenAI.ComputerAction

Dyskryminujące dla openAI.ComputerAction

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.WaitParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionList

Lista akcji komputerowych

Spłaszczone partie dla computer_use. Każda akcja zawiera type dyskryminator oraz pola specyficzne dla akcji.

Tablica: OpenAI.ComputerAction

OpenAI.ComputerActionType

Property	Value
Type	ciąg
Wartości	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Zaplanowana kontrola bezpieczeństwa dla komputerowego wezwania.

Name	Typ	Description	Obowiązkowy
kod	ciąg znaków lub null		Nie.
id	ciąg	Identyfikator oczekującego sprawdzenia bezpieczeństwa.	Yes
komunikat	ciąg znaków lub null		Nie.

OpenAI.ComputerŚrodowisko

Property	Value
Type	ciąg
Wartości	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Zrzut ekranu komputera

Zrzut ekranu przedstawiający komputer.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg znaków lub null		Yes
image_url	ciąg znaków lub null		Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku zrzutu ekranu komputera ta właściwość jest zawsze ustawiona na `computer_screenshot`. Możliwe wartości: `computer_screenshot`	Yes	computer_screenshot

OpenAI.ComputerScreenshotImage

Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
identyfikator_pliku	ciąg	Identyfikator przekazanego pliku zawierającego zrzut ekranu.	Nie.
image_url	string (identyfikator URI)	Adres URL obrazu zrzutu ekranu.	Nie.
typ	wyliczenie	Określa typ zdarzenia. W przypadku zrzutu ekranu komputera ta właściwość to zawsze ustawiony na `computer_screenshot`. Możliwe wartości: `computer_screenshot`	Yes	computer_screenshot

OpenAI.ComputerTool

Komputer

Narzędzie kontrolujące komputer wirtualny.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Rodzaj narzędzia komputerowego. Zawsze `computer`. Możliwe wartości: `computer`	Yes	komputer

OpenAI.NarzędziePodgląduUżytkowaniaKomputera

Podgląd użycia komputera

Narzędzie kontrolujące komputer wirtualny.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
wysokość ekranu	liczba całkowita	Wysokość wyświetlacza komputera.	Yes
szerokość_wyświetlacza	liczba całkowita	Szerokość ekranu komputera.	Yes
środowisko	OpenAI.ComputerŚrodowisko		Yes
typ	wyliczenie	Typ narzędzia do użycia komputera. Zawsze `computer_use_preview`. Możliwe wartości: `computer_use_preview`	Yes	computer_use_preview

OpenAI.ContainerAutoParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
identyfikatory_plików	tablica ciągów	Opcjonalna lista przesłanych plików, które mają być dostępne w Twoim kodzie. Ograniczenia: maksymalneElementy: 50	Nie.
limit_pamięci	OpenAI.ContainerMemoryLimit lub null		Nie.
network_policy	OpenAI.ContainerNetworkPolicyParam	Polityka dostępu sieciowego dla kontenera.	Nie.
Umiejętności	array OpenAI.ContainerSkill	Opcjonalna lista umiejętności odwoływanych przez id lub dane inline. Ograniczenia: maksymalneElementy: 200	Nie.
typ	wyliczenie	Automatycznie tworzy kontener dla tego żądania Możliwe wartości: `container_auto`	Yes	container_auto

OpenAI.ContainerFileCitationBody

Cytowanie pliku kontenerowego

Cytat dla pliku kontenera używanego do generowania odpowiedzi modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
container_id	ciąg	Identyfikator pliku kontenera.	Yes
end_index	liczba całkowita	Indeks ostatniego znaku cytatu pliku kontenera w komunikacie.	Yes
identyfikator_pliku	ciąg	Identyfikator pliku.	Yes
filename	ciąg	Nazwa pliku kontenera przytoczony.	Yes
start_index	liczba całkowita	Indeks pierwszego znaku cytatu pliku kontenera w komunikacie.	Yes
typ	wyliczenie	Typ cytatu pliku kontenera. Zawsze `container_file_citation`. Możliwe wartości: `container_file_citation`	Yes	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Value
Type	ciąg
Wartości	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
allowed_domains	tablica ciągów	Lista dozwolonych dziedzin, gdy typ jest .`allowlist` Ograniczenia: minElementy: 1	Yes
typ	wyliczenie	Zezwalaj na dostęp do sieci wychodzącej tylko do określonych domen. Zawsze `allowlist`. Możliwe wartości: `allowlist`	Yes	lista dozwolonych

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Wyłącz dostęp do sieci wychodzącej. Zawsze `disabled`. Możliwe wartości: `disabled`	Yes	wygaszony

OpenAI.ContainerNetworkPolicyParam

Polityka dostępu sieciowego dla kontenera.

Discriminator for OpenAI.ContainerNetworkPolicyParam

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ContainerNetworkPolicyParamType		Yes

OpenAI.ContainerNetworkPolicyParamType

Property	Value
Type	ciąg
Wartości	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

Referencja kontenera

Reprezentuje kontener utworzony za pomocą /v1/containers.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
container_id	ciąg		Yes
typ	wyliczenie	Typ środowiska. Zawsze `container_reference`. Możliwe wartości: `container_reference`	Yes	container_reference

OpenAI.ContainerSkill

Discriminator for OpenAI.ContainerSkill

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ContainerSkillType		Yes

OpenAI.ContainerSkillType

Property	Value
Type	ciąg
Wartości	`skill_reference` `inline`

OpenAI.ContextManagementParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
compact_threshold	liczba całkowita lub null		Nie.
typ	ciąg	Typ wpisu do zarządzania kontekstem. Obecnie obsługiwane jest tylko "zagęszczenie".	Yes

OpenAI.ConversationParam

Konwersacja, do którego należy ta odpowiedź. Elementy z tej konwersacji są poprzedzane input_items dla tego żądania odpowiedzi. Elementy wejściowe i elementy wyjściowe z tej odpowiedzi są automatycznie dodawane do tej konwersacji po zakończeniu tej odpowiedzi.

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

string
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Obiekt rozmowy

Konwersacja, do którego należy ta odpowiedź.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
id	ciąg	Unikatowy identyfikator konwersacji.	Yes

OpenAI.ConversationReference

Konwersacja

Konwersacja, do którego należała ta odpowiedź. Elementy wejściowe i elementy wyjściowe z tej odpowiedzi zostały automatycznie dodane do tej konwersacji.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
id	ciąg	Unikatowy identyfikator konwersacji, z którą została skojarzona ta odpowiedź.	Yes

OpenAI.CoordParam

Współrzędne

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

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

OpenAI.CreateResponse

Name	Typ	Description	Obowiązkowy
tło	wartość logiczna lub null		Nie.
context_management	array of OpenAI.ContextManagementParam lub null	Konfiguracja zarządzania kontekstem dla tego żądania.	Nie.
konwersacja	OpenAI.ConversationParam lub null		Nie.
Obejmują	tablica wartości OpenAI.IncludeEnum lub null		Nie.
dane wejściowe	OpenAI.InputParam	Dane wejściowe tekstu, obrazu lub pliku w modelu używane do generowania odpowiedzi. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Dane wejściowe obrazowe - Wejścia plików - Stan konwersacji - Wywoływanie funkcji	Nie.
instructions	ciąg znaków lub null		Nie.
max_output_tokens	liczba całkowita lub null		Nie.
maks_liczba_wywołań_narzędzi	liczba całkowita lub null		Nie.
metadane	OpenAI.Metadata lub null		Nie.
model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
wywołania_narzędzia_równoległe	wartość logiczna lub null		Nie.
previous_response_id	ciąg znaków lub null		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
prompt_cache_retention	ciąg znaków lub null		Nie.
reasoning	OpenAI.Reasoning lub null		Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
przechowywać	wartość logiczna lub null		Nie.
odtwarzać strumieniowo	wartość logiczna lub null		Nie.
stream_options	OpenAI.ResponseStreamOptions lub null		Nie.
temperatura	liczba lub wartość null		Nie.
SMS	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Dwie kategorie narzędzi, które można modelowi podać, to: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie plików. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu.	Nie.
top_logprobs	liczba całkowita lub null		Nie.
top_p	liczba lub wartość null		Nie.
truncation	ciąg znaków lub null		Nie.
użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.

OpenAI.CustomGrammarFormatParam

Format gramatyczny

Gramatyka zdefiniowana przez użytkownika.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
definicja	ciąg	Definicja gramatyki.	Yes
Składni	OpenAI.GrammarSyntax1		Yes
typ	wyliczenie	Format gramatyki. Zawsze `grammar`. Możliwe wartości: `grammar`	Yes	Gramatyki

OpenAI.CustomTextFormatParam

Format tekstu

Nieprzeciętny tekst bez ograniczeń.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Format tekstu bez ograniczeń. Zawsze `text`. Możliwe wartości: `text`	Yes	SMS

OpenAI.CustomToolParam

Narzędzie niestandardowe

Niestandardowe narzędzie, które przetwarza dane wejściowe przy użyciu określonego formatu. Dowiedz się więcej o narzędziach niestandardowych

Name	Typ	Description	Obowiązkowy	Wartość domyślna
defer_loading	boolean	Czy to narzędzie powinno zostać odroczone i odkryte przez wyszukiwanie narzędzi.	Nie.
opis	ciąg	Opcjonalny opis narzędzia niestandardowego używany do udostępniania większej liczby kontekstów.	Nie.
format	OpenAI.CustomToolParamFormat	Format danych wejściowych dla narzędzia niestandardowego. Wartość domyślna to nieprzeciętny tekst.	Nie.
└typ	OpenAI.CustomToolParamFormatType		Yes
nazwa	ciąg	Nazwa narzędzia niestandardowego używana do identyfikowania go w wywołaniach narzędzi.	Yes
typ	wyliczenie	Typ narzędzia niestandardowego. Zawsze `custom`. Możliwe wartości: `custom`	Yes	Niestandardowe

OpenAI.CustomToolParamFormat

Format danych wejściowych dla narzędzia niestandardowego. Wartość domyślna to nieprzeciętny tekst.

Dyskryminujący format OpenAI.CustomToolParamFormat

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Property	Value
Type	ciąg
Wartości	`text` `grammar`

OpenAI.DetailEnum

Property	Value
Type	ciąg
Wartości	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

Dwukrotne kliknięcie myszy.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
keys	tablica ciągów lub wartości null		Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji dwukrotnego kliknięcia ta właściwość jest zawsze ustawiana jako `double_click`. Możliwe wartości: `double_click`	Yes	double_click
x	liczba całkowita	Współrzędna x, w której wystąpiło dwukrotne kliknięcie.	Yes
y	liczba całkowita	Współrzędna y, w której wystąpiło dwukrotne kliknięcie.	Yes

OpenAI.DragParam

Drag

Czynność przeciągania.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
keys	tablica ciągów lub wartości null		Nie.
ścieżka	array OpenAI.CoordParam	Tablica współrzędnych reprezentujących ścieżkę operacji przeciągania. Współrzędne będą wyświetlane jako tablica obiektów, np. `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przeciągania ta właściwość jest zawsze ustawiana na `drag`. Możliwe wartości: `drag`	Yes	przeciągnąć

OpenAI.EasyInputMessage

Wiadomość wejściowa

Wiadomość jako wejście do modelu z rolą wskazującą przestrzeganie hierarchii instrukcji. Instrukcje przypisane do roli developer lub system mają pierwszeństwo przed instrukcjami przypisanymi do roli user. Przyjmuje się, że komunikaty z rolą assistant zostały wygenerowane przez model w poprzednich interakcjach.

Name	Typ	Description	Obowiązkowy
zawartość	string lub OpenAI.InputMessageContentList	Tekst, obraz lub dane wejściowe audio w modelu używane do generowania odpowiedzi. Może również zawierać poprzednie odpowiedzi asystenta.	Yes
faza	OpenAI.MessagePhase lub null		Nie.
rola	wyliczenie	Rola wejścia komunikatu. `user`Jeden z, `assistant`, `system` lub `developer`. Możliwe wartości: `user`, , `assistant`, `systemdeveloper`	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze `message`. Możliwe wartości: `message`	Yes

OpenAI.EmptyModelParam

Typ: obiekt

OpenAI.FileCitationBody

Cytowanie w pliku

Cytat do pliku.

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

OpenAI.FileInputDetail

Property	Value
Type	ciąg
Wartości	`low` `high`

OpenAI.FilePath

Ścieżka pliku

Ścieżka do pliku.

Name	Typ	Description	Obowiązkowy
identyfikator_pliku	ciąg	Identyfikator pliku.	Yes
indeks	liczba całkowita	Indeks pliku na liście plików.	Yes
typ	wyliczenie	Typ ścieżki pliku. Zawsze `file_path`. Możliwe wartości: `file_path`	Yes

OpenAI.FileSearchTool

Wyszukiwanie plików

Narzędzie wyszukujące odpowiednią zawartość z przekazanych plików.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
filters	OpenAI.Filters lub null		Nie.
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nie.
opcje rankingu	OpenAI.RankingOptions		Nie.
└hybrid_search	OpenAI.HybridSearchOptions	Wagi kontrolujące sposób wzajemnego łączenia rangi równoważy semantyczne dopasowania osadzania w porównaniu z rozrzedzonych dopasowaniami słów kluczowych po włączeniu wyszukiwania hybrydowego.	Nie.
└─ ranker	OpenAI.RankerVersionType	Klasyfikator używany do wyszukiwania plików.	Nie.
└─ próg_punktowy	number	Próg oceny dla wyszukiwania plików, liczba z zakresu od 0 do 1. Liczby bliżej 1 będą próbować zwracać tylko najbardziej odpowiednie wyniki, ale mogą zwracać mniej wyników.	Nie.
typ	wyliczenie	Typ narzędzia wyszukiwania plików. Zawsze `file_search`. Możliwe wartości: `file_search`	Yes	file_search
identyfikatory_sklepu_wektorów	tablica ciągów	Identyfikatory wektorów są przechowywane do wyszukiwania.	Yes

OpenAI.FileSearchToolCallResults

Name	Typ	Obowiązkowy
attributes	OpenAI.VectorStoreFileAttributes lub null	Nie.
identyfikator_pliku	ciąg	Nie.
filename	ciąg	Nie.
wynik	liczba (float)	Nie.
SMS	ciąg	Nie.

OpenAI.Filters

Typ: OpenAI.ComparisonFilter lub OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Dyskryminujące dla openAI.FunctionAndCustomToolCallOutput

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Plik wejściowy

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.FileInputDetail		Nie.
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg znaków lub null		Nie.
file_url	string (identyfikator URI)	Adres URL pliku, który ma zostać wysłany do modelu.	Nie.
filename	ciąg	Nazwa pliku, który ma zostać wysłany do modelu.	Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_file`. Możliwe wartości: `input_file`	Yes	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Obraz wejściowy

Dane wejściowe obrazu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg znaków lub null		Nie.
image_url	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Wprowadzanie tekstu do modelu.	Yes
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_text`. Możliwe wartości: `input_text`	Yes	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Property	Value
Type	ciąg
Wartości	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Akcja wykonawcza Shell

Wykonaj polecenie powłoki.

Name	Typ	Obowiązkowy
commands	tablica ciągów	Yes
max_output_length	liczba całkowita lub null	Yes
limit_czasu_ms	liczba całkowita lub null	Yes

OpenAI.FunctionShellActionParam

Walka pocisków

Polecenia i limity opisujące sposób uruchamiania wywołania narzędzia powłoki.

Name	Typ	Description	Obowiązkowy
commands	tablica ciągów	Uporządkowane polecenia powłoki dla środowiska wykonawczego do uruchomienia.	Yes
max_output_length	liczba całkowita lub null		Nie.
limit_czasu_ms	liczba całkowita lub null		Nie.

OpenAI.FunctionShellCallEnvironment

Discriminator for OpenAI.FunctionShellCallEnvironment

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.FunctionShellCallEnvironmentType		Yes

OpenAI.FunctionShellCallEnvironmentType

Property	Value
Type	ciąg
Wartości	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

Środowisko do wykonywania poleceń powłoki.

Discriminator for OpenAI.FunctionShellCallItemParamEnvironment

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.FunctionShellCallItemParamEnvironmentType		Yes

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
container_id	ciąg	ID wskazanego kontenera.	Yes
typ	wyliczenie	Odnosi się do kontenera utworzonego z punktem końcowym /v1/containers Możliwe wartości: `container_reference`	Yes	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Umiejętności	array of OpenAI.LocalSkillParam	Opcjonalna lista umiejętności. Ograniczenia: maksymalneElementy: 200	Nie.
typ	wyliczenie	Korzystaj z lokalnego środowiska komputerowego. Możliwe wartości: `local`	Yes	lokalny

OpenAI.FunctionShellCallItemParamEnvironmentType

Property	Value
Type	ciąg
Wartości	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Status połączenia shell

Wartości stanu zgłaszane dla wywołań narzędzi powłoki.

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Zawartość wyjściowa wywołań shell

Zawartość danych wyjściowych wywołania narzędzia powłoki, które zostały wyemitowane.

Name	Typ	Description	Obowiązkowy
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
wynik	OpenAI.FunctionShellCallOutputOutcome	Reprezentuje wynik zakończenia (z kodem zakończenia) lub wynik przekroczenia limitu czasu dla fragmentu wyjściowego wywołania powłoki.	Yes
└typ	OpenAI.FunctionShellCallOutputOutcomeType		Yes
Stderr	ciąg	Standardowe dane wyjściowe błędu przechwycone.	Yes
stdout	ciąg	Standardowe dane wyjściowe przechwycone.	Yes

OpenAI.FunctionShellCallOutputContentParam

Zawartość wyjściowa powłoki

Przechwycono stdout i stderr dla części danych wyjściowych wywołania narzędzia powłoki.

Name	Typ	Description	Obowiązkowy
wynik	OpenAI.FunctionShellCallOutputOutcomeParam	Wynik zakończenia lub przekroczenia limitu czasu skojarzony z tym wywołaniem powłoki.	Yes
└typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
Stderr	ciąg	Przechwycone dane wyjściowe stderr dla wywołania powłoki. Ograniczenia: maxLength: 10485760	Yes
stdout	ciąg	Przechwycone dane wyjściowe stdout dla wywołania powłoki. Ograniczenia: maxLength: 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Wynik wyjścia z połączenia shell

Wskazuje, że polecenia powłoki zostały zakończone i zwróciły kod zakończenia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
exit_code	liczba całkowita	Zakończ kod z procesu powłoki.	Yes
typ	wyliczenie	Typ wyniku. Zawsze `exit`. Możliwe wartości: `exit`	Yes	wyjść

OpenAI.FunctionShellCallOutputExitOutcomeParam

Wynik wyjścia z połączenia shell

Wskazuje, że polecenia powłoki zostały zakończone i zwróciły kod zakończenia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
exit_code	liczba całkowita	Kod wyjścia zwracany przez proces powłoki.	Yes
typ	wyliczenie	Typ wyniku. Zawsze `exit`. Możliwe wartości: `exit`	Yes	wyjść

OpenAI.FunctionShellCallOutputOutcome

Wynik połączenia shell

Reprezentuje wynik zakończenia (z kodem zakończenia) lub wynik przekroczenia limitu czasu dla fragmentu wyjściowego wywołania powłoki.

Dyskryminujące dla openAI.FunctionShellCallOutputOutcome

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

Wynik połączenia shell

Wynik zakończenia lub przekroczenia limitu czasu skojarzony z tym wywołaniem powłoki.

Dyskryminujące dla openAI.FunctionShellCallOutputOutcomeParam

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Value
Type	ciąg
Wartości	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Type	ciąg
Wartości	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Rezultat timeoutu wezwania Shell

Wskazuje, że wywołanie powłoki przekroczyło skonfigurowany limit czasu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ wyniku. Zawsze `timeout`. Możliwe wartości: `timeout`	Yes	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Rezultat timeoutu wezwania Shell

Wskazuje, że wywołanie powłoki przekroczyło skonfigurowany limit czasu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ wyniku. Zawsze `timeout`. Możliwe wartości: `timeout`	Yes	timeout

OpenAI.FunctionShellCallStatus

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Narzędzie powłoki

Narzędzie, które umożliwia modelowi wykonywanie poleceń powłoki.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
środowisko	OpenAI.FunctionShellToolParamEnvironment lub null		Nie.
typ	wyliczenie	Typ narzędzia powłoki. Zawsze `shell`. Możliwe wartości: `shell`	Yes	powłoka

OpenAI.FunctionShellToolParamEnvironment

Discriminator for OpenAI.FunctionShellToolParamEnvironment

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.FunctionShellToolParamEnvironmentType		Yes

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
container_id	ciąg	ID wskazanego kontenera.	Yes
typ	wyliczenie	Odnosi się do kontenera utworzonego z punktem końcowym /v1/containers Możliwe wartości: `container_reference`	Yes	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Umiejętności	array of OpenAI.LocalSkillParam	Opcjonalna lista umiejętności. Ograniczenia: maksymalneElementy: 200	Nie.
typ	wyliczenie	Korzystaj z lokalnego środowiska komputerowego. Możliwe wartości: `local`	Yes	lokalny

OpenAI.FunctionShellToolParamEnvironmentType

Property	Value
Type	ciąg
Wartości	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Function

Definiuje funkcję w swoim kodzie, którą model może wywołać.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
defer_loading	boolean	Czy ta funkcja jest odroczona i ładowana za pomocą wyszukiwania narzędzi.	Nie.
opis	ciąg znaków lub null		Nie.
nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
parameters	obiekt lub wartość null		Yes
surowy	wartość logiczna lub null		Yes
typ	wyliczenie	Typ narzędzia funkcji. Zawsze `function`. Możliwe wartości: `function`	Yes	funkcja

OpenAI.FunctionToolParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
defer_loading	boolean	Czy tę funkcję należy odłożyć i odkryć za pomocą wyszukiwania narzędzi.	Nie.
opis	ciąg znaków lub null		Nie.
nazwa	ciąg	Ograniczenia: minDługość: 1, maksymalna Długość: 128, wzór: `^[a-zA-Z0-9_-]+$`	Yes
parameters	OpenAI.EmptyModelParam lub null		Nie.
surowy	wartość logiczna lub null		Nie.
typ	wyliczenie	Możliwe wartości: `function`	Yes	funkcja

OpenAI.GrammarSyntax1

Property	Value
Type	ciąg
Wartości	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Typ	Description	Obowiązkowy	Wartość domyślna
embedding_weight	number	Waga osadzania w wzajemnym połączeniu rankingowym.	Yes
text_weight	number	Waga tekstu w wzajemnym połączeniu klasyfikacji.	Yes

OpenAI.ImageDetail

Property	Value
Type	ciąg
Wartości	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Property	Value
Type	ciąg
Wartości	`generate` `edit` `auto`

OpenAI.ImageGenTool

Narzędzie do generowania obrazów

Narzędzie, które generuje obrazy przy użyciu modeli obrazów GPT.

Prawidłowe modele:

gpt-image-1
gpt-image-1-mini
gpt-image-1.5

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.ImageGenActionEnum		Nie.
tło	wyliczenie	Typ tła wygenerowanego obrazu. Jeden z `transparent` `opaque`lub `auto`. Wartość domyślna: `auto`. Możliwe wartości: `transparent`, , `opaqueauto`	Nie.	samochód
input_fidelity	OpenAI.InputFidelity lub null		Nie.
maska_wprowadzania_obrazu	OpenAI.ImageGenToolInputImageMask		Nie.
└ file_id	ciąg		Nie.
└─ image_url	string (identyfikator URI)		Nie.
model	ciąg (zobacz prawidłowe modele poniżej)		Nie.
Umiarem	wyliczenie	Poziom moderowania wygenerowanego obrazu. Wartość domyślna: `auto`. Możliwe wartości: `auto`, `low`	Nie.	samochód
kompresja wyjściowa	liczba całkowita	Poziom kompresji obrazu wyjściowego. Wartość domyślna: 100. Ograniczenia: min: 0, maksimum: 100	Nie.	100
format_wyjściowy	wyliczenie	Format danych wyjściowych wygenerowanego obrazu. `png`Jeden z`webp`, lub `jpeg`. Wartość domyślna: `png`. Możliwe wartości: `png`, , `webpjpeg`	Nie.	png
częściowe_obrazy	liczba całkowita	Liczba częściowych obrazów do wygenerowania w trybie przesyłania strumieniowego z zakresu od 0 (wartość domyślna) do 3. Ograniczenia: min: 0, maksimum: 3	Nie.
jakość	wyliczenie	Jakość wygenerowanego obrazu. Jeden z `low`, , `medium`, , `high` lub `auto`. Wartość domyślna: `auto`. Możliwe wartości: `low`, , `medium`, `highauto`	Nie.	samochód
size	ciąg (zobacz prawidłowe modele poniżej)	Rozmiar wygenerowanych obrazów. Dla `gpt-image-2` i `gpt-image-2-2026-04-21`, dowolne rezolucje są obsługiwane jako `WIDTHxHEIGHT` ciągi znaków, na przykład `1536x864`. Szerokość i wysokość muszą być podzielne przez 16, a żądany współczynnik obrazu musi wynosić od 1:3 do 3:1. Powyższe `2560x1440` rozdzielczości są eksperymentalne, a maksymalna obsługiwana rozdzielczość to `3840x2160`. Wymagany rozmiar musi również spełniać aktualne limity pikseli i krawędzi modelu. Standardowe rozmiary `1024x1024`, `1536x1024`, i `1024x1536` są obsługiwane przez modele obrazów GPT; `auto` jest obsługiwany dla modeli umożliwiających automatyczne dostosowanie rozmiarów. Dla `dall-e-2`, użyj jednego z `256x256`, `512x512`, lub `1024x1024`. Dla `dall-e-3`, użyj jednego z `1024x1024`, `1792x1024`, lub `1024x1792`.	Nie.
typ	wyliczenie	Typ narzędzia do generowania obrazów. Zawsze `image_generation`. Możliwe wartości: `image_generation`	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Typ	Description	Obowiązkowy	Wartość domyślna
identyfikator_pliku	ciąg		Nie.
image_url	string (identyfikator URI)		Nie.

OpenAI.IncludeEnum

Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to:

web_search_call.results: Uwzględnij wyniki wyszukiwania wywołania narzędzia wyszukiwania internetowego.
web_search_call.action.sources: dołącz źródła wywołania narzędzia wyszukiwania internetowego.
code_interpreter_call.outputs: Zawiera dane wyjściowe z wykonywania kodu w języku Python w elementach wywołań narzędzia interpretera kodu.
computer_call_output.output.image_url: dołącz adresy URL obrazów z wyniku wywołania komputera.
file_search_call.results: uwzględnij wyniki operacji narzędzia do wyszukiwania plików.
message.input_image.image_url: dołącz adresy URL obrazów z komunikatu wejściowego.
message.output_text.logprobs: Dołącz logprobs do komunikatów asystenta.
reasoning.encrypted_content: zawiera zaszyfrowaną wersję tokenów rozumowania w danych wyjściowych elementu rozumowania. Dzięki temu elementy rozumowania mogą być używane w wielowariantowych rozmowach podczas bezstanowego korzystania z interfejsu API odpowiedzi (na przykład gdy store parametr jest ustawiony na false, lub gdy organizacja jest zarejestrowana w programie zerowego przechowywania danych).

Property	Value
Opis	Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to: - `web_search_call.results`: Uwzględnij wyniki wyszukiwania wywołania narzędzia wyszukiwania internetowego. - `web_search_call.action.sources`: Uwzględnij źródła wywołania narzędzia wyszukiwania internetowego. - `code_interpreter_call.outputs`: Obejmuje dane wyjściowe z wykonywania kodu Python w elementach wywołania narzędzia do interpretacji kodu. - `computer_call_output.output.image_url`: dołącz adresy URL obrazów z wyników procesu komputerowego. - `file_search_call.results`: Dołącz wyniki wyszukiwania uzyskane z wezwania narzędzia do wyszukiwania plików. - `message.input_image.image_url`: dołącz adresy URL obrazów z komunikatu wejściowego. - `message.output_text.logprobs`: Uwzględnij logprobs w wiadomościach asystenta. - `reasoning.encrypted_content`: zawiera zaszyfrowaną wersję tokenów rozumowania w danych wyjściowych elementu rozumowania. Dzięki temu elementy rozumowania mogą być używane w wielowariantowych rozmowach podczas bezstanowego korzystania z interfejsu API odpowiedzi (na przykład gdy `store` parametr jest ustawiony na `false`, lub gdy organizacja jest zarejestrowana w programie zerowego przechowywania danych).
Type	ciąg
Wartości	`file_search_call.results` `web_search_call.results` `web_search_call.action.sources` `message.input_image.image_url` `computer_call_output.output.image_url` `code_interpreter_call.outputs` `reasoning.encrypted_content` `message.output_text.logprobs`

OpenAI.InlineSkillParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis umiejętności.	Yes
nazwa	ciąg	Nazwa umiejętności.	Yes
przesłać źródło	OpenAI.InlineSkillSourceParam	Ładunek umiejętności inline	Yes
└─ dane	ciąg	Pakiet zip z umiejętnościami kodowanym w bazie 64. Ograniczenia: minDługość: 1, maksymalna Długość: 70254592	Yes
└─ media_type	wyliczenie	Typ nośnika ładunku umiejętności inline. Musi mieć wartość `application/zip`. Możliwe wartości: `application/zip`	Yes	aplikacja/zip
└typ	wyliczenie	Typ źródła umiejętności inline. Musi mieć wartość `base64`. Możliwe wartości: `base64`	Yes	base64
typ	wyliczenie	Definiuje umiejętność inline dla tego żądania. Możliwe wartości: `inline`	Yes	śródwierszowy

OpenAI.InlineSkillSourceParam

Ładunek umiejętności inline

Name	Typ	Description	Obowiązkowy	Wartość domyślna
dane	ciąg	Pakiet zip z umiejętnościami kodowanym w bazie 64. Ograniczenia: minDługość: 1, maksymalna Długość: 70254592	Yes
media_type	wyliczenie	Typ nośnika ładunku umiejętności inline. Musi mieć wartość `application/zip`. Możliwe wartości: `application/zip`	Yes	aplikacja/zip
typ	wyliczenie	Typ źródła umiejętności inline. Musi mieć wartość `base64`. Możliwe wartości: `base64`	Yes	base64

OpenAI.InputContent

Dyskryminujący dla interfejsu OpenAI.InputContent

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Plik wejściowy

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.FileInputDetail		Nie.
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg znaków lub null		Nie.
file_url	string (identyfikator URI)	Adres URL pliku, który ma zostać wysłany do modelu.	Nie.
filename	ciąg	Nazwa pliku, który ma zostać wysłany do modelu.	Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_file`. Możliwe wartości: `input_file`	Yes	input_file

OpenAI.InputContentInputImageContent

Obraz wejściowy

Dane wejściowe obrazu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg znaków lub null		Nie.
image_url	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes	input_image

OpenAI.InputContentInputTextContent

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Wprowadzanie tekstu do modelu.	Yes
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_text`. Możliwe wartości: `input_text`	Yes	input_text

OpenAI.InputContentType

Property	Value
Type	ciąg
Wartości	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Kontroluj, ile wysiłku model podejmie, aby dopasować styl i cechy, zwłaszcza cechy twarzy, obrazów wejściowych. Ten parametr jest obsługiwany tylko dla gpt-image-1 i gpt-image-1.5 późniejszych modeli, nieobsługiwanych dla gpt-image-1-mini. Obsługuje i highlow. Wartość domyślna to low.

Property	Value
Type	ciąg
Wartości	`high` `low`

OpenAI.InputFileContent

Plik wejściowy

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.FileInputDetail		Nie.
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg znaków lub null		Nie.
file_url	string (identyfikator URI)	Adres URL pliku, który ma zostać wysłany do modelu.	Nie.
filename	ciąg	Nazwa pliku, który ma zostać wysłany do modelu.	Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_file`. Możliwe wartości: `input_file`	Yes	input_file

OpenAI.InputFileContentParam

Plik wejściowy

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.FileInputDetail		Nie.
file_data	ciąg znaków lub null		Nie.
identyfikator_pliku	ciąg znaków lub null		Nie.
file_url	ciąg znaków lub null		Nie.
filename	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_file`. Możliwe wartości: `input_file`	Yes	input_file

OpenAI.InputImageContent

Obraz wejściowy

Dane wejściowe obrazu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg znaków lub null		Nie.
image_url	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes	input_image

OpenAI.InputImageContentParamAutoParam

Obraz wejściowy

Dane wejściowe obrazu do modelu. Dowiedz się o wejściach obrazowych

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.DetailEnum or null		Nie.
identyfikator_pliku	ciąg znaków lub null		Nie.
image_url	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes	input_image

OpenAI.InputItem

Element reprezentujący część kontekstu odpowiedzi, która ma zostać wygenerowana przez model. Może zawierać tekst, obrazy i dane wejściowe audio, a także poprzednie odpowiedzi asystenta i dane wyjściowe wywołania narzędzia.

Dyskryminator openAI.InputItem

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`tool_search_call`	OpenAI.InputItemToolSearchCallItemParam
`tool_search_output`	OpenAI.InputItemToolSearchOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItemItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall
`tool_approval_response`	AzureToolApprovalResponse

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

Zastosowanie wywołania narzędzia patch

Wywołanie narzędzia reprezentujące żądanie tworzenia, usuwania lub aktualizowania plików przy użyciu poprawek różnicowych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg znaków lub null		Nie.
operacja	OpenAI.ApplyPatchOperationParam	Jeden z create_file, delete_file lub update_file operacji dostarczonych do narzędzia apply_patch.	Yes
└typ	OpenAI.ApplyPatchOperationParamType		Yes
stan	OpenAI.ApplyPatchCallStatusParam	Wartości stanu zgłaszane dla wywołań narzędzi apply_patch.	Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call`. Możliwe wartości: `apply_patch_call`	Yes	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Zastosowanie wywołania narzędzia patch output

Przesyłane strumieniowo dane wyjściowe emitowane przez wywołanie narzędzia zastosuj poprawkę.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg znaków lub null		Nie.
We/Wy	ciąg znaków lub null		Nie.
stan	OpenAI.ApplyPatchCallOutputStatusParam	Wartości wyników zgłaszane dla danych wyjściowych wywołań narzędzia apply_patch.	Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call_output`. Możliwe wartości: `apply_patch_call_output`	Yes	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Narzędzie do interpretera kodu wywołane

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg znaków lub null		Yes
container_id	ciąg	Identyfikator kontenera używanego do uruchamiania kodu.	Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia interpretera kodu.	Yes
outputs	tablica obiektów OpenAI.CodeInterpreterOutputLogs lub OpenAI.CodeInterpreterOutputImage lub null		Yes
stan	wyliczenie	Stan wywołania narzędzia interpretera kodu. Prawidłowe wartości to `in_progress`, , `completedincomplete`, `interpreting`, i `failed`. Możliwe wartości: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia interpretera kodu. Zawsze `code_interpreter_call`. Możliwe wartości: `code_interpreter_call`	Yes	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Element kompaktowy

Element kompaktowy generowany przez v1/responses/compact API.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
encrypted_content	ciąg	Zaszyfrowana zawartość podsumowania kompaktowania. Ograniczenia: maxLength: 10485760	Yes
id	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `compaction`. Możliwe wartości: `compaction`	Yes	Zgęszczenie

OpenAI.InputItemComputerCallOutputItemParam

Wyjście wywołań narzędzi komputerowych

Dane wyjściowe z wywołania narzędzia komputerowego.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
acknowledged_safety_checks	tablica OpenAI.ComputerCallSafetyCheckParam lub null		Nie.
call_id	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg znaków lub null		Nie.
We/Wy	OpenAI.ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.	Yes
stan	OpenAI.FunctionCallItemStatus lub null		Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze `computer_call_output`. Możliwe wartości: `computer_call_output`	Yes	computer_call_output

OpenAI.InputItemComputerToolCall

Wołanie narzędzi komputerowych

Narzędzie wywołujące narzędzie do korzystania z komputera.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.ComputerAction		Nie.
actions	OpenAI.ComputerActionList	Spłaszczone partie dla `computer_use`. Każda akcja zawiera `type` Dziedziny dyskryminatorskie i specyficzne dla działań.	Nie.
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Yes
id	ciąg	Unikatowy identyfikator wywołania komputera.	Yes
pending_safety_checks	tablica openAI.ComputerCallSafetyCheckParam	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ wywołania komputera. Zawsze `computer_call`. Możliwe wartości: `computer_call`	Yes	computer_call

OpenAI.InputItemCustomToolCall

Wołanie narzędzia niestandardowego

Wywołanie niestandardowego narzędzia utworzonego przez model.

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Identyfikator używany do mapowania tego niestandardowego wywołania narzędzia na dane wyjściowe wywołania narzędzia.	Yes
id	ciąg	Unikatowy identyfikator niestandardowego wywołania narzędzia na platformie OpenAI.	Nie.
dane wejściowe	ciąg	Dane wejściowe dla niestandardowego wywołania narzędzia wygenerowanego przez model.	Yes
nazwa	ciąg	Nazwa wywoływanego narzędzia niestandardowego.	Yes
obszar nazw	ciąg	Przestrzeń nazw wywoływanego narzędzia niestandardowego.	Nie.
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.InputItemCustomToolCallOutput

Wyjście wywołań narzędzi niestandardowych

Dane wyjściowe niestandardowego wywołania narzędzia z kodu wysyłanego z powrotem do modelu.

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Identyfikator wywołania używany do mapowania tego niestandardowego narzędzia wywołania danych wyjściowych do niestandardowego wywołania narzędzia.	Yes
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania niestandardowego narzędzia na platformie OpenAI.	Nie.
We/Wy	ciąg lub tablica obiektu OpenAI.FunctionAndCustomToolCallOutput	Dane wyjściowe z wywołania niestandardowego narzędzia wygenerowanego przez kod. Może być ciągiem lub listą zawartości wyjściowej.	Yes
typ	wyliczenie	Typ danych wyjściowych wywołania niestandardowego narzędzia. Zawsze `custom_tool_call_output`. Możliwe wartości: `custom_tool_call_output`	Yes

OpenAI.InputItemFileSearchToolCall

Wywołanie narzędzia do wyszukiwania plików

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

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania plików.	Yes
queries	tablica ciągów	Zapytania używane do wyszukiwania plików.	Yes
results	tablica openAI.FileSearchToolCallResults lub null		Nie.
stan	wyliczenie	Stan wywołania narzędzia do wyszukiwania plików. Jeden z `in_progress` `searching`, lub `incomplete`, `failed` Możliwe wartości: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania plików. Zawsze `file_search_call`. Możliwe wartości: `file_search_call`	Yes

OpenAI.InputItemFunctionCallOutputItemParam

Wywołanie funkcji wywołania narzędzia

Dane wyjściowe wywołania narzędzia funkcji.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg znaków lub null		Nie.
We/Wy	ciąg lub tablica wartości OpenAI.InputTextContentParam lub OpenAI.InputImageContentParamAutoParam lub OpenAI.InputFileContentParam	Tekst, obraz lub dane wyjściowe pliku wywołania narzędzia funkcji.	Yes
stan	OpenAI.FunctionCallItemStatus lub null		Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia funkcji. Zawsze `function_call_output`. Możliwe wartości: `function_call_output`	Yes	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Wołanie narzędzi powłoki

Narzędzie reprezentujące żądanie wykonania co najmniej jednego polecenia powłoki.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.FunctionShellActionParam	Polecenia i limity opisujące sposób uruchamiania wywołania narzędzia powłoki.	Yes
Polecenia └*	tablica ciągów	Uporządkowane polecenia powłoki dla środowiska wykonawczego do uruchomienia.	Yes
└max_output_length	liczba całkowita lub null		Nie.
└timeout_ms	liczba całkowita lub null		Nie.
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
środowisko	OpenAI.FunctionShellCallItemParamEnvironment lub null		Nie.
id	ciąg znaków lub null		Nie.
stan	OpenAI.FunctionShellCallItemStatus lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Wyjście wywołań narzędzia powłoki

Przesyłane strumieniowo elementy wyjściowe emitowane przez wywołanie narzędzia powłoki.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg znaków lub null		Nie.
max_output_length	liczba całkowita lub null		Nie.
We/Wy	tablica openAI.FunctionShellCallOutputContentParam	Przechwycone fragmenty danych wyjściowych stdout i stderr wraz ze skojarzonymi wynikami.	Yes
stan	OpenAI.FunctionShellCallItemStatus lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes	shell_call_output

OpenAI.InputItemFunctionToolCall

Wywołanie narzędzia funkcji

Wywołanie narzędzia w celu uruchomienia funkcji.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Yes
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Yes
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Yes
obszar nazw	ciąg	Przestrzeń nazw funkcji, którą trzeba uruchomić.	Nie.
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.InputItemImageGenToolCall

Wywołanie generowania obrazu

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg znaków lub null		Yes
stan	wyliczenie	Stan wywołania generowania obrazu. Możliwe wartości: `in_progress`, , `completed`, `generatingfailed`	Yes
typ	wyliczenie	Typ wywołania generowania obrazu. Zawsze `image_generation_call`. Możliwe wartości: `image_generation_call`	Yes

OpenAI.InputItemLocalShellToolCall

Lokalne wezwanie shell

Wywołanie narzędzia w celu uruchomienia polecenia w lokalnej powłoce.

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.LocalShellExecAction	Wykonaj polecenie powłoki na serwerze.	Yes
call_id	ciąg	Unikalny identyfikator wywołania lokalnego narzędzia shella wygenerowanego przez model.	Yes
id	ciąg	Unikatowy identyfikator lokalnego wywołania powłoki.	Yes
stan	wyliczenie	Stan lokalnego wywołania powłoki. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ lokalnego wywołania powłoki. Zawsze `local_shell_call`. Możliwe wartości: `local_shell_call`	Yes

OpenAI.InputItemLocalShellToolCallOutput

Wyjście lokalnych wywołań shell

Dane wyjściowe lokalnego wywołania narzędzia powłoki.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikalny identyfikator wywołania lokalnego narzędzia shella wygenerowanego przez model.	Yes
We/Wy	ciąg	Ciąg JSON reprezentujący dane wyjściowe z wywołania lokalnego narzędzia powłoki.	Yes
stan	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ lokalnego narzędzia powłoki wywołuje dane wyjściowe. Zawsze `local_shell_call_output`. Możliwe wartości: `local_shell_call_output`	Yes

OpenAI.InputItemMcpApprovalRequest

Prośba o zatwierdzenie MCP

Wniosek o zatwierdzenie przez człowieka wywołania narzędzia.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Ciąg JSON argumentów dla narzędzia.	Yes
id	ciąg	Unikatowy identyfikator żądania zatwierdzenia.	Yes
nazwa	ciąg	Nazwa narzędzia do uruchomienia.	Yes
etykieta_serwera	ciąg	Etykieta serwera MCP wysyłającego żądanie.	Yes
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_request`. Możliwe wartości: `mcp_approval_request`	Yes

OpenAI.InputItemMcpApprovalResponse

Odpowiedź na zatwierdzenie MCP

Odpowiedź na żądanie zatwierdzenia MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg	Identyfikator odpowiedzi na żądanie zatwierdzenia.	Yes
approve	boolean	Czy żądanie zostało zatwierdzone.	Yes
id	ciąg znaków lub null		Nie.
powód	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.InputItemMcpListTools

Narzędzia do listy MCP

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	OpenAI.RealtimeMCPError		Nie.
id	ciąg	Unikatowy identyfikator listy.	Yes
etykieta_serwera	ciąg	Etykieta serwera MCP.	Yes
Narzędzia	tablica narzędzi OpenAI.MCPListToolsTools	Narzędzia dostępne na serwerze.	Yes
typ	wyliczenie	Typ elementu. Zawsze `mcp_list_tools`. Możliwe wartości: `mcp_list_tools`	Yes

OpenAI.InputItemMcpToolCall

Wywołanie narzędzi MCP

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg znaków lub null		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	OpenAI.RealtimeMCPError		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg znaków lub null		Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP z uruchomionym narzędziem.	Yes
stan	OpenAI.MCPToolCallStatus		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_call`. Możliwe wartości: `mcp_call`	Yes

OpenAI.InputItemOutputMessage

Komunikat wyjściowy

Komunikat wyjściowy z modelu.

Name	Typ	Description	Obowiązkowy
zawartość	tablica elementów OpenAI.OutputMessageContent	Zawartość komunikatu wyjściowego.	Yes
id	ciąg	Unikatowy identyfikator komunikatu wyjściowego.	Yes
faza	OpenAI.MessagePhase lub null		Nie.
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze `assistant`. Możliwe wartości: `assistant`	Yes
stan	wyliczenie	Stan danych wejściowych komunikatu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ komunikatu wyjściowego. Zawsze `message`. Możliwe wartości: `output_message`	Yes

OpenAI.InputItemReasoningItemItem

Reasoning

Opis łańcucha myśli używanego przez model rozumowania podczas generowania odpowiedzi. Pamiętaj, aby uwzględnić te elementy w API Odpowiedzi input podczas kolejnych tur rozmowy, jeśli zarządzasz kontekstem ręcznie.

Name	Typ	Description	Obowiązkowy
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg znaków lub null		Nie.
id	ciąg	Unikatowy identyfikator zawartości rozumowania.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
podsumowanie	array OpenAI.SummaryTextContent	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

OpenAI.InputItemToolSearchCallItemParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Argumenty	OpenAI.EmptyModelParam		Yes
call_id	ciąg znaków lub null		Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Nie.
id	ciąg znaków lub null		Nie.
stan	OpenAI.FunctionCallItemStatus lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `tool_search_call`. Możliwe wartości: `tool_search_call`	Yes	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg znaków lub null		Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Nie.
id	ciąg znaków lub null		Nie.
stan	OpenAI.FunctionCallItemStatus lub null		Nie.
Narzędzia	tablica narzędzi OpenAI.Tool	Załadowane definicje narzędzi zwracane przez wynik wyszukiwania narzędzi.	Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_search_output`. Możliwe wartości: `tool_search_output`	Yes	tool_search_output

OpenAI.InputItemType

Property Value

Type ciąg

Wartości message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
tool_search_call
tool_search_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference
tool_approval_response

OpenAI.InputItemWebSearchToolCall

Wezwanie narzędzia do wyszukiwania stron internetowych

Wyniki wywołania narzędzia wyszukiwania w Internecie.

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.WebSearchActionSearch lub OpenAI.WebSearchActionOpenPage lub OpenAI.WebSearchActionFind	Obiekt opisujący określoną akcję podjętą w tym wywołaniu wyszukiwania w sieci Web. Zawiera szczegóły dotyczące tego, jak model korzystał z sieci internetowej (wyszukiwanie, open_page, find_in_page).	Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania w Internecie.	Yes
stan	wyliczenie	Stan działania wyszukiwarki internetowej. Możliwe wartości: `in_progress`, , `searching`, `completedfailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania w Internecie. Zawsze `web_search_call`. Możliwe wartości: `web_search_call`	Yes

OpenAI.InputMessageContentList

Lista zawartości elementów wejściowych

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

Tablica: OpenAI.InputContent

OpenAI.InputParam

Dane wejściowe tekstu, obrazu lub pliku w modelu używane do generowania odpowiedzi. Więcej informacji:

Wejścia i wyjścia tekstu
Dane wejściowe obrazowe
Pliki wejściowe
Stan konwersacji
Wywoływanie funkcji

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

string
array

OpenAI.InputTextContent

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Wprowadzanie tekstu do modelu.	Yes
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_text`. Możliwe wartości: `input_text`	Yes	input_text

OpenAI.InputTextContentParam

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Wprowadzanie tekstu do modelu. Ograniczenia: maxLength: 10485760	Yes
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_text`. Możliwe wartości: `input_text`	Yes	input_text

OpenAI.ItemReferenceParam

Referencja elementu

Wewnętrzny identyfikator elementu do celów odniesienia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
id	ciąg	Identyfikator elementu referencyjnego.	Yes
typ	wyliczenie	Typ elementu referencyjnego. Zawsze `item_reference`. Możliwe wartości: `item_reference`	Yes	item_reference

OpenAI.ItemResource

Element zawartości używany do generowania odpowiedzi.

Dyskryminujący element OpenAI.ItemResource

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`message`	OpenAI.ItemResourceInputMessage
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutput
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCall
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutput
`tool_search_call`	OpenAI.ItemResourceToolSearchCall
`tool_search_output`	OpenAI.ItemResourceToolSearchOutput
`reasoning`	OpenAI.ItemResourceReasoningItem
`compaction`	OpenAI.ItemResourceCompactionBody
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall
`custom_tool_call`	OpenAI.ItemResourceCustomToolCallResource
`custom_tool_call_output`	OpenAI.ItemResourceCustomToolCallOutputResource

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Zastosowanie wywołania narzędzia patch

Wywołanie narzędzia, które stosuje różnice plików przez tworzenie, usuwanie lub aktualizowanie plików.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator jednostki, która utworzyła to wywołanie narzędzia.	Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
operacja	OpenAI.ApplyPatchFileOperation	Jedną z operacji create_file, delete_file lub update_file stosowanych za pośrednictwem apply_patch.	Yes
└typ	OpenAI.ApplyPatchFileOperationType		Yes
stan	OpenAI.ApplyPatchCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call`. Możliwe wartości: `apply_patch_call`	Yes	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Zastosowanie wywołania narzędzia patch output

Dane wyjściowe emitowane przez wywołanie narzędzia zastosuj poprawkę.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator jednostki, która utworzyła to narzędzie, wywołuje dane wyjściowe.	Nie.
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania narzędzia stosowania poprawek. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
We/Wy	ciąg znaków lub null		Nie.
stan	OpenAI.ApplyPatchCallOutputStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call_output`. Możliwe wartości: `apply_patch_call_output`	Yes	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Narzędzie do interpretera kodu wywołane

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg znaków lub null		Yes
container_id	ciąg	Identyfikator kontenera używanego do uruchamiania kodu.	Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia interpretera kodu.	Yes
outputs	tablica obiektów OpenAI.CodeInterpreterOutputLogs lub OpenAI.CodeInterpreterOutputImage lub null		Yes
stan	wyliczenie	Stan wywołania narzędzia interpretera kodu. Prawidłowe wartości to `in_progress`, , `completedincomplete`, `interpreting`, i `failed`. Możliwe wartości: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia interpretera kodu. Zawsze `code_interpreter_call`. Możliwe wartości: `code_interpreter_call`	Yes	code_interpreter_call

OpenAI.ItemResourceCompactionBody

Element kompaktowy

Element kompaktowy generowany przez v1/responses/compact API.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
encrypted_content	ciąg	Zaszyfrowana zawartość, która została utworzona przez kompaktowanie.	Yes
id	ciąg	Unikatowy identyfikator elementu kompaktowania.	Yes
typ	wyliczenie	Typ elementu. Zawsze `compaction`. Możliwe wartości: `compaction`	Yes	Zgęszczenie

OpenAI.ItemResourceComputerToolCall

Wołanie narzędzi komputerowych

Narzędzie wywołujące narzędzie do korzystania z komputera.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.ComputerAction		Nie.
actions	OpenAI.ComputerActionList	Spłaszczone partie dla `computer_use`. Każda akcja zawiera `type` Dziedziny dyskryminatorskie i specyficzne dla działań.	Nie.
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Yes
id	ciąg	Unikatowy identyfikator wywołania komputera.	Yes
pending_safety_checks	tablica openAI.ComputerCallSafetyCheckParam	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ wywołania komputera. Zawsze `computer_call`. Możliwe wartości: `computer_call`	Yes	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Wyjście wywołań narzędzi komputerowych

Dane wyjściowe z wywołania narzędzia komputerowego.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
acknowledged_safety_checks	tablica openAI.ComputerCallSafetyCheckParam	Kontrole bezpieczeństwa, które zgłoszono za pomocą interfejsu API i zostały potwierdzone przez wywoływacz.	Nie.
call_id	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe.	Yes
id	ciąg (tylko do odczytu)	Identyfikator wyniku wywołania komputerowego narzędzia.	Yes
We/Wy	OpenAI.ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.	Yes
stan	wyliczenie	Stan danych wejściowych komunikatu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze `computer_call_output`. Możliwe wartości: `computer_call_output`	Yes	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Identyfikator wywołania używany do mapowania tego niestandardowego narzędzia wywołania danych wyjściowych do niestandardowego wywołania narzędzia.	Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania niestandardowego narzędzia na platformie OpenAI.	Nie.
We/Wy	ciąg lub tablica obiektu OpenAI.FunctionAndCustomToolCallOutput	Dane wyjściowe z wywołania niestandardowego narzędzia wygenerowanego przez kod. Może być ciągiem lub listą zawartości wyjściowej.	Yes
stan	OpenAI.FunctionCallOutputStatusEnum		Yes
typ	wyliczenie	Typ danych wyjściowych wywołania niestandardowego narzędzia. Zawsze `custom_tool_call_output`. Możliwe wartości: `custom_tool_call_output`	Yes

OpenAI.ItemResourceCustomToolCallResource

ResponseCustomToolCallItem

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Identyfikator używany do mapowania tego niestandardowego wywołania narzędzia na dane wyjściowe wywołania narzędzia.	Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
id	ciąg	Unikatowy identyfikator niestandardowego wywołania narzędzia na platformie OpenAI.	Nie.
dane wejściowe	ciąg	Dane wejściowe dla niestandardowego wywołania narzędzia wygenerowanego przez model.	Yes
nazwa	ciąg	Nazwa wywoływanego narzędzia niestandardowego.	Yes
obszar nazw	ciąg	Przestrzeń nazw wywoływanego narzędzia niestandardowego.	Nie.
stan	OpenAI.FunctionCallStatus		Yes
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.ItemResourceFileSearchToolCall

Wywołanie narzędzia do wyszukiwania plików

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

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania plików.	Yes
queries	tablica ciągów	Zapytania używane do wyszukiwania plików.	Yes
results	tablica openAI.FileSearchToolCallResults lub null		Nie.
stan	wyliczenie	Stan wywołania narzędzia do wyszukiwania plików. Jeden z `in_progress` `searching`, lub `incomplete`, `failed` Możliwe wartości: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania plików. Zawsze `file_search_call`. Możliwe wartości: `file_search_call`	Yes

OpenAI.ItemResourceFunctionShellCall

Wołanie narzędzi powłoki

Wywołanie narzędzia, które wykonuje co najmniej jedno polecenie powłoki w środowisku zarządzanym.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.FunctionShellAction	Wykonaj polecenie powłoki.	Yes
Polecenia └*	tablica ciągów		Yes
└max_output_length	liczba całkowita lub null		Yes
└timeout_ms	liczba całkowita lub null		Yes
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator jednostki, która utworzyła to wywołanie narzędzia.	Nie.
środowisko	OpenAI.FunctionShellCallEnvironment lub null		Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
stan	OpenAI.FunctionShellCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Wyjście wywołań shell

Dane wyjściowe wywołania narzędzia powłoki, które zostało wyemitowane.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania powłoki. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
max_output_length	liczba całkowita lub null		Yes
We/Wy	tablica elementów OpenAI.FunctionShellCallOutputContent	Tablica zawartości danych wyjściowych wywołań powłoki	Yes
stan	OpenAI.FunctionShellCallOutputStatusEnum		Yes
typ	wyliczenie	Typ danych wyjściowych wywołania powłoki. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes	shell_call_output

OpenAI.ItemResourceFunctionToolCall

Wywołanie narzędzia funkcji

Wywołanie narzędzia w celu uruchomienia funkcji.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Yes
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Yes
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Yes
obszar nazw	ciąg	Przestrzeń nazw funkcji, którą trzeba uruchomić.	Nie.
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.ItemResourceFunctionToolCallOutput

Wywołanie funkcji wywołania narzędzia

Dane wyjściowe wywołania narzędzia funkcji.

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator danych wyjściowych wywołania narzędzia funkcji. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
We/Wy	ciąg lub tablica obiektu OpenAI.FunctionAndCustomToolCallOutput	Dane wyjściowe wywołania funkcji wygenerowanego przez kod. Może być ciągiem lub listą zawartości wyjściowej.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia funkcji. Zawsze `function_call_output`. Możliwe wartości: `function_call_output`	Yes

OpenAI.ItemResourceImageGenToolCall

Wywołanie generowania obrazu

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg znaków lub null		Yes
stan	wyliczenie	Stan wywołania generowania obrazu. Możliwe wartości: `in_progress`, , `completed`, `generatingfailed`	Yes
typ	wyliczenie	Typ wywołania generowania obrazu. Zawsze `image_generation_call`. Możliwe wartości: `image_generation_call`	Yes

OpenAI.ItemResourceInputMessage

Wiadomość wejściowa

Name	Typ	Description	Obowiązkowy	Wartość domyślna
zawartość	OpenAI.InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość types.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator wejściowy wiadomości.	Yes
rola	wyliczenie	Rola wejścia komunikatu. `user`Jeden z , `system`lub `developer`. Możliwe wartości: `user`, , `systemdeveloper`	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze ustaw na `message`. Możliwe wartości: `message`	Yes	komunikat

OpenAI.ItemResourceLocalShellToolCall

Lokalne wezwanie shell

Wywołanie narzędzia w celu uruchomienia polecenia w lokalnej powłoce.

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.LocalShellExecAction	Wykonaj polecenie powłoki na serwerze.	Yes
call_id	ciąg	Unikalny identyfikator wywołania lokalnego narzędzia shella wygenerowanego przez model.	Yes
id	ciąg	Unikatowy identyfikator lokalnego wywołania powłoki.	Yes
stan	wyliczenie	Stan lokalnego wywołania powłoki. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ lokalnego wywołania powłoki. Zawsze `local_shell_call`. Możliwe wartości: `local_shell_call`	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

Wyjście lokalnych wywołań shell

Dane wyjściowe lokalnego wywołania narzędzia powłoki.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikalny identyfikator wywołania lokalnego narzędzia shella wygenerowanego przez model.	Yes
We/Wy	ciąg	Ciąg JSON reprezentujący dane wyjściowe z wywołania lokalnego narzędzia powłoki.	Yes
stan	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ lokalnego narzędzia powłoki wywołuje dane wyjściowe. Zawsze `local_shell_call_output`. Możliwe wartości: `local_shell_call_output`	Yes

OpenAI.ItemResourceMcpApprovalRequest

Prośba o zatwierdzenie MCP

Wniosek o zatwierdzenie przez człowieka wywołania narzędzia.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Ciąg JSON argumentów dla narzędzia.	Yes
id	ciąg	Unikatowy identyfikator żądania zatwierdzenia.	Yes
nazwa	ciąg	Nazwa narzędzia do uruchomienia.	Yes
etykieta_serwera	ciąg	Etykieta serwera MCP wysyłającego żądanie.	Yes
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_request`. Możliwe wartości: `mcp_approval_request`	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

Odpowiedź na zatwierdzenie MCP

Odpowiedź na żądanie zatwierdzenia MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg	Identyfikator odpowiedzi na żądanie zatwierdzenia.	Yes
approve	boolean	Czy żądanie zostało zatwierdzone.	Yes
id	ciąg	Unikatowy identyfikator odpowiedzi zatwierdzenia	Yes
powód	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.ItemResourceMcpListTools

Narzędzia do listy MCP

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	OpenAI.RealtimeMCPError		Nie.
id	ciąg	Unikatowy identyfikator listy.	Yes
etykieta_serwera	ciąg	Etykieta serwera MCP.	Yes
Narzędzia	tablica narzędzi OpenAI.MCPListToolsTools	Narzędzia dostępne na serwerze.	Yes
typ	wyliczenie	Typ elementu. Zawsze `mcp_list_tools`. Możliwe wartości: `mcp_list_tools`	Yes

OpenAI.ItemResourceMcpToolCall

Wywołanie narzędzi MCP

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg znaków lub null		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	OpenAI.RealtimeMCPError		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg znaków lub null		Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP z uruchomionym narzędziem.	Yes
stan	OpenAI.MCPToolCallStatus		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_call`. Możliwe wartości: `mcp_call`	Yes

OpenAI.ItemResourceOutputMessage

Komunikat wyjściowy

Komunikat wyjściowy z modelu.

Name	Typ	Description	Obowiązkowy
zawartość	tablica elementów OpenAI.OutputMessageContent	Zawartość komunikatu wyjściowego.	Yes
id	ciąg	Unikatowy identyfikator komunikatu wyjściowego.	Yes
faza	OpenAI.MessagePhase lub null		Nie.
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze `assistant`. Możliwe wartości: `assistant`	Yes
stan	wyliczenie	Stan danych wejściowych komunikatu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ komunikatu wyjściowego. Zawsze `message`. Możliwe wartości: `output_message`	Yes

OpenAI.ItemResourceReasoningItem

Reasoning

Name	Typ	Description	Obowiązkowy
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg znaków lub null		Nie.
id	ciąg	Unikatowy identyfikator zawartości rozumowania.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
podsumowanie	array OpenAI.SummaryTextContent	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

OpenAI.ItemResourceToolSearchCall

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Argumenty		Argumenty używane do wyszukiwania narzędziem.	Yes
call_id	ciąg znaków lub null		Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Yes
id	ciąg	Unikalny identyfikator elementu wyszukiwania narzędzia.	Yes
stan	OpenAI.FunctionCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_search_call`. Możliwe wartości: `tool_search_call`	Yes	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg znaków lub null		Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Yes
id	ciąg	Unikalny identyfikator elementu wyszukiwania narzędzia.	Yes
stan	OpenAI.FunctionCallOutputStatusEnum		Yes
Narzędzia	tablica narzędzi OpenAI.Tool	Załadowane definicje narzędzi zwracane przez wyszukiwanie narzędzi.	Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_search_output`. Możliwe wartości: `tool_search_output`	Yes	tool_search_output

OpenAI.ItemResourceType

Property Value

Type ciąg

OpenAI.ItemResourceWebSearchToolCall

Wezwanie narzędzia do wyszukiwania stron internetowych

Wyniki wywołania narzędzia wyszukiwania w Internecie.

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.WebSearchActionSearch lub OpenAI.WebSearchActionOpenPage lub OpenAI.WebSearchActionFind	Obiekt opisujący określoną akcję podjętą w tym wywołaniu wyszukiwania w sieci Web. Zawiera szczegóły dotyczące tego, jak model korzystał z sieci internetowej (wyszukiwanie, open_page, find_in_page).	Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania w Internecie.	Yes
stan	wyliczenie	Stan działania wyszukiwarki internetowej. Możliwe wartości: `in_progress`, , `searching`, `completedfailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania w Internecie. Zawsze `web_search_call`. Możliwe wartości: `web_search_call`	Yes

OpenAI.KeyPressAction

KeyPress

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

Name	Typ	Description	Obowiązkowy	Wartość domyślna
keys	tablica ciągów	Kombinacja klawiszy, którą model żąda naciśnięcia. Jest to tablica ciągów, z których każdy reprezentuje klucz.	Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji keypress ta właściwość jest zawsze ustawiona na wartość `keypress`. Możliwe wartości: `keypress`	Yes	Naciśnięcie klawiszy

OpenAI.LocalEnvironmentResource

Środowisko lokalne

Oznacza wykorzystanie lokalnego środowiska do wykonywania działań powłoki.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ środowiska. Zawsze `local`. Możliwe wartości: `local`	Yes	lokalny

OpenAI.LocalShellExecAction

Lokalna akcja szefa shell

Wykonaj polecenie powłoki na serwerze.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
polecenie	tablica ciągów	Polecenie do uruchomienia.	Yes
środowisko	obiekt	Zmienne środowiskowe, które należy ustawić dla polecenia.	Yes
limit_czasu_ms	liczba całkowita lub null		Nie.
typ	wyliczenie	Typ akcji lokalnego interfejsu powłoki. Zawsze `exec`. Możliwe wartości: `exec`	Yes	exec
użytkownik	ciąg znaków lub null		Nie.
katalog roboczy	ciąg znaków lub null		Nie.

OpenAI.LocalShellToolParam

Narzędzie lokalnej powłoki

Narzędzie, które umożliwia modelowi wykonywanie poleceń powłoki w środowisku lokalnym.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ lokalnego narzędzia powłoki systemowej. Zawsze `local_shell`. Możliwe wartości: `local_shell`	Yes	local_shell

OpenAI.LocalSkillParam

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis umiejętności.	Yes
nazwa	ciąg	Nazwa umiejętności.	Yes
ścieżka	ciąg	Ścieżka do katalogu zawierającego umiejętność.	Yes

OpenAI.LogProb

Log probability

Prawdopodobieństwo logarytmiczne tokenu.

Name	Typ	Obowiązkowy
bytes	tablica liczb całkowitych	Yes
logprob	number	Yes
kod przedpłaty	ciąg	Yes
top_logprobs	tablica biblioteki OpenAI.TopLogProb	Yes

OpenAI.MCPListToolsTool

Narzędzie narzędzi do listy MCP

Narzędzie dostępne na serwerze MCP.

Name	Typ	Description	Obowiązkowy
annotations	OpenAI.MCPListToolsToolsAnnotations lub null		Nie.
opis	ciąg znaków lub null		Nie.
input_schema	OpenAI.MCPListToolsToolsToolInputSchema		Yes
nazwa	ciąg	Nazwa narzędzia.	Yes

OpenAI.MCPListToolsToolsAnnotations

Typ: obiekt

OpenAI.MCPListToolsToolsToolInputSchema

Typ: obiekt

OpenAI.MCPTool

Narzędzie MCP

Nadaj modelowi dostęp do dodatkowych narzędzi za pośrednictwem zdalnych serwerów protokołu MCP (Model Context Protocol).

Name	Typ	Description	Obowiązkowy
dozwolone_narzędzia	tablica ciągów lub OpenAI.MCPToolFilter lub null		Nie.
autoryzacja	ciąg	Token dostępu OAuth, który może być używany ze zdalnym serwerem MCP, albo z niestandardowym adresem URL serwera MCP lub łącznikiem usługi. Twoja aplikacja Musi obsługiwać przepływ autoryzacji OAuth i podać tutaj token.	Nie.
connector_id	wyliczenie	Identyfikator łączników usług, takich jak te dostępne w module ChatGPT. Jeden z `server_url` lub `connector_id` musi być podany. Dowiedz się więcej o usłudze Tutaj złącza. Obecnie obsługiwane `connector_id` wartości to: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Kalendarz Google: `connector_googlecalendar` - Dysk Google: `connector_googledrive` — Microsoft Teams: `connector_microsoftteams` - Kalendarz programu Outlook: `connector_outlookcalendar` - Poczta e-mail programu Outlook: `connector_outlookemail` -Programu sharepoint: `connector_sharepoint` Możliwe wartości: `connector_dropbox`, , `connector_gmailconnector_googlecalendar`, `connector_googledriveconnector_microsoftteams`, , `connector_outlookcalendar`, , `connector_outlookemailconnector_sharepoint`	Nie.
defer_loading	boolean	Czy to narzędzie MCP zostanie odroczone i odkryte przez wyszukiwanie narzędzi.	Nie.
headers	obiekt lub wartość null		Nie.
wymaga_akceptacji	OpenAI.MCPToolRequireApproval lub ciąg lub wartość null		Nie.
server_description	ciąg	Opcjonalny opis serwera MCP używany do zapewnienia większej liczby kontekstów.	Nie.
etykieta_serwera	ciąg	Etykieta dla tego serwera MCP używana do identyfikowania go w wywołaniach narzędzi.	Yes
adres_serwera	string (identyfikator URI)	Adres URL serwera MCP. Jeden z lub `server_urlconnector_id` musi być Dostarczane.	Nie.
typ	wyliczenie	Typ narzędzia MCP. Zawsze `mcp`. Możliwe wartości: `mcp`	Yes

OpenAI.MCPToolCallStatus

Property	Value
Type	ciąg
Wartości	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Filtr narzędziowy MCP

Obiekt filtru określający, które narzędzia są dozwolone.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Tylko_do_odczytu	boolean	Wskazuje, czy narzędzie modyfikuje dane, czy jest tylko do odczytu. Jeśli Serwer MCP jest oznaczony adnotacjami za pomocą polecenia `readOnlyHint`, będzie pasować do tego filtru.	Nie.
tool_names	tablica ciągów	Lista dozwolonych nazw narzędzi.	Nie.

OpenAI.MCPToolRequireApproval

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Zawsze	OpenAI.MCPToolFilter	Obiekt filtru określający, które narzędzia są dozwolone.	Nie.
nigdy	OpenAI.MCPToolFilter	Obiekt filtru określający, które narzędzia są dozwolone.	Nie.

OpenAI.MessageContent

Część zawartości tworząca element wejściowy lub wyjściowy.

Dyskryminujący plik OpenAI.MessageContent

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`text`	OpenAI.TextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent
`summary_text`	OpenAI.SummaryTextContent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.MessageContentType		Yes

OpenAI.MessageContentInputFileContent

Plik wejściowy

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.FileInputDetail		Nie.
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg znaków lub null		Nie.
file_url	string (identyfikator URI)	Adres URL pliku, który ma zostać wysłany do modelu.	Nie.
filename	ciąg	Nazwa pliku, który ma zostać wysłany do modelu.	Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_file`. Możliwe wartości: `input_file`	Yes	input_file

OpenAI.MessageContentInputImageContent

Obraz wejściowy

Dane wejściowe obrazu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg znaków lub null		Nie.
image_url	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes	input_image

OpenAI.MessageContentInputTextContent

Tekst wejściowy

Wprowadzanie tekstu do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Wprowadzanie tekstu do modelu.	Yes
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_text`. Możliwe wartości: `input_text`	Yes	input_text

OpenAI.MessageContentOutputTextContent

Tekst wyjściowy

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
annotations	tablica adnotacji OpenAI.Annotation	Adnotacje tekstu wyjściowego.	Yes
logprobs	tablica biblioteki OpenAI.LogProb		Yes
SMS	ciąg	Dane wyjściowe tekstu z modelu.	Yes
typ	wyliczenie	Typ tekstu wyjściowego. Zawsze `output_text`. Możliwe wartości: `output_text`	Yes	output_text

OpenAI.MessageContentReasoningTextContent

Tekst rozumowania

Tekst rozumowania z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst rozumowania z modelu.	Yes
typ	wyliczenie	Typ tekstu rozumowania. Zawsze `reasoning_text`. Możliwe wartości: `reasoning_text`	Yes	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

Odmowa ze strony modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
refusal	ciąg	Wyjaśnienie odmowy dostarczone przez model.	Yes
typ	wyliczenie	Rodzaj odmowy. Zawsze `refusal`. Możliwe wartości: `refusal`	Yes	refusal

OpenAI.MessageContentType

Property	Value
Type	ciąg
Wartości	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

Oznacza assistant wiadomość jako komentarz pośredni (commentary) lub ostateczną odpowiedź (final_answer). W modelach takich jak gpt-5.3-codex i nie, przy wysyłaniu kolejnych żądań zachowaj i ponownie wysyłaj fazę wszystkich wiadomości asystenta — jej rezygnacja może pogorszyć wydajność. Nie używa się do wiadomości użytkowników.

Property	Value
Type	ciąg
Wartości	`commentary` `final_answer`

OpenAI.Metadata

Zestaw 16 par kluczy i wartości, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. 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.

Typ: obiekt

OpenAI.MoveParam

Move

Akcja ruchu myszy.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
keys	tablica ciągów lub wartości null		Nie.
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przenoszenia ta właściwość jest zawsze ustawiona na `move`. Możliwe wartości: `move`	Yes	przenieś
x	liczba całkowita	Współrzędna x, do której należy się przesunąć.	Yes
y	liczba całkowita	Współrzędna y, do której należy się przesunąć.	Yes

OpenAI.NamespaceToolParam

Namespace

Grupuje funkcje/narzędzia niestandardowe pod wspólną przestrzenią nazw.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
opis	ciąg	Opis przestrzeni nazw pokazany modelowi. Ograniczenia: minLength: 1	Yes
nazwa	ciąg	Nazwa przestrzeni nazw używana w wywołaniach narzędzi (na przykład `crm`). Ograniczenia: minLength: 1	Yes
Narzędzia	array of OpenAI.FunctionToolParam lub OpenAI.CustomToolParam	Funkcje i narzędzia niestandardowe dostępne w tej przestrzeni nazw. Ograniczenia: minElementy: 1	Yes
typ	wyliczenie	Typ narzędzia. Zawsze `namespace`. Możliwe wartości: `namespace`	Yes	obszar nazw

OpenAI.OutputContent

Dyskryminujące dla interfejsu OpenAI.OutputContent

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Tekst wyjściowy

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
annotations	tablica adnotacji OpenAI.Annotation	Adnotacje tekstu wyjściowego.	Yes
logprobs	tablica biblioteki OpenAI.LogProb		Yes
SMS	ciąg	Dane wyjściowe tekstu z modelu.	Yes
typ	wyliczenie	Typ tekstu wyjściowego. Zawsze `output_text`. Możliwe wartości: `output_text`	Yes	output_text

OpenAI.OutputContentReasoningTextContent

Tekst rozumowania

Tekst rozumowania z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst rozumowania z modelu.	Yes
typ	wyliczenie	Typ tekstu rozumowania. Zawsze `reasoning_text`. Możliwe wartości: `reasoning_text`	Yes	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

Odmowa ze strony modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
refusal	ciąg	Wyjaśnienie odmowy dostarczone przez model.	Yes
typ	wyliczenie	Rodzaj odmowy. Zawsze `refusal`. Możliwe wartości: `refusal`	Yes	refusal

OpenAI.OutputContentType

Property	Value
Type	ciąg
Wartości	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Dyskryminujące dla openAI.OutputItem

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.OutputItemFunctionToolCallOutput
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemComputerToolCallOutput
`reasoning`	OpenAI.OutputItemReasoningItem
`tool_search_call`	OpenAI.OutputItemToolSearchCall
`tool_search_output`	OpenAI.OutputItemToolSearchOutput
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.OutputItemLocalShellToolCallOutput
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Zastosowanie wywołania narzędzia patch

Wywołanie narzędzia, które stosuje różnice plików przez tworzenie, usuwanie lub aktualizowanie plików.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator jednostki, która utworzyła to wywołanie narzędzia.	Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
operacja	OpenAI.ApplyPatchFileOperation	Jedną z operacji create_file, delete_file lub update_file stosowanych za pośrednictwem apply_patch.	Yes
└typ	OpenAI.ApplyPatchFileOperationType		Yes
stan	OpenAI.ApplyPatchCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call`. Możliwe wartości: `apply_patch_call`	Yes	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Zastosowanie wywołania narzędzia patch output

Dane wyjściowe emitowane przez wywołanie narzędzia zastosuj poprawkę.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator jednostki, która utworzyła to narzędzie, wywołuje dane wyjściowe.	Nie.
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania narzędzia stosowania poprawek. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
We/Wy	ciąg znaków lub null		Nie.
stan	OpenAI.ApplyPatchCallOutputStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call_output`. Możliwe wartości: `apply_patch_call_output`	Yes	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Narzędzie do interpretera kodu wywołane

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg znaków lub null		Yes
container_id	ciąg	Identyfikator kontenera używanego do uruchamiania kodu.	Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia interpretera kodu.	Yes
outputs	tablica obiektów OpenAI.CodeInterpreterOutputLogs lub OpenAI.CodeInterpreterOutputImage lub null		Yes
stan	wyliczenie	Stan wywołania narzędzia interpretera kodu. Prawidłowe wartości to `in_progress`, , `completedincomplete`, `interpreting`, i `failed`. Możliwe wartości: `in_progress`, , `completedincomplete`, , `interpretingfailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia interpretera kodu. Zawsze `code_interpreter_call`. Możliwe wartości: `code_interpreter_call`	Yes	code_interpreter_call

OpenAI.OutputItemCompactionBody

Element kompaktowy

Element kompaktowy generowany przez v1/responses/compact API.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
encrypted_content	ciąg	Zaszyfrowana zawartość, która została utworzona przez kompaktowanie.	Yes
id	ciąg	Unikatowy identyfikator elementu kompaktowania.	Yes
typ	wyliczenie	Typ elementu. Zawsze `compaction`. Możliwe wartości: `compaction`	Yes	Zgęszczenie

OpenAI.OutputItemComputerToolCall

Wołanie narzędzi komputerowych

Narzędzie wywołujące narzędzie do korzystania z komputera.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.ComputerAction		Nie.
actions	OpenAI.ComputerActionList	Spłaszczone partie dla `computer_use`. Każda akcja zawiera `type` Dziedziny dyskryminatorskie i specyficzne dla działań.	Nie.
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Yes
id	ciąg	Unikatowy identyfikator wywołania komputera.	Yes
pending_safety_checks	tablica openAI.ComputerCallSafetyCheckParam	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ wywołania komputera. Zawsze `computer_call`. Możliwe wartości: `computer_call`	Yes	computer_call

OpenAI.OutputItemComputerToolCallOutput

Wyjście wywołań narzędzi komputerowych

Dane wyjściowe z wywołania narzędzia komputerowego.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
acknowledged_safety_checks	tablica openAI.ComputerCallSafetyCheckParam	Kontrole bezpieczeństwa, które zgłoszono za pomocą interfejsu API i zostały potwierdzone przez wywoływacz.	Nie.
call_id	ciąg	Identyfikator wywołania narzędzia komputerowego, które wygenerowało dane wyjściowe.	Yes
id	ciąg (tylko do odczytu)	Identyfikator wyniku wywołania komputerowego narzędzia.	Yes
We/Wy	OpenAI.ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.	Yes
stan	wyliczenie	Stan danych wejściowych komunikatu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia komputerowego. Zawsze `computer_call_output`. Możliwe wartości: `computer_call_output`	Yes	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Identyfikator wywołania używany do mapowania tego niestandardowego narzędzia wywołania danych wyjściowych do niestandardowego wywołania narzędzia.	Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania niestandardowego narzędzia na platformie OpenAI.	Nie.
We/Wy	ciąg lub tablica obiektu OpenAI.FunctionAndCustomToolCallOutput	Dane wyjściowe z wywołania niestandardowego narzędzia wygenerowanego przez kod. Może być ciągiem lub listą zawartości wyjściowej.	Yes
stan	OpenAI.FunctionCallOutputStatusEnum		Yes
typ	wyliczenie	Typ danych wyjściowych wywołania niestandardowego narzędzia. Zawsze `custom_tool_call_output`. Możliwe wartości: `custom_tool_call_output`	Yes

OpenAI.OutputItemCustomToolCallResource

ResponseCustomToolCallItem

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Identyfikator używany do mapowania tego niestandardowego wywołania narzędzia na dane wyjściowe wywołania narzędzia.	Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
id	ciąg	Unikatowy identyfikator niestandardowego wywołania narzędzia na platformie OpenAI.	Nie.
dane wejściowe	ciąg	Dane wejściowe dla niestandardowego wywołania narzędzia wygenerowanego przez model.	Yes
nazwa	ciąg	Nazwa wywoływanego narzędzia niestandardowego.	Yes
obszar nazw	ciąg	Przestrzeń nazw wywoływanego narzędzia niestandardowego.	Nie.
stan	OpenAI.FunctionCallStatus		Yes
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.OutputItemFileSearchToolCall

Wywołanie narzędzia do wyszukiwania plików

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

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania plików.	Yes
queries	tablica ciągów	Zapytania używane do wyszukiwania plików.	Yes
results	tablica openAI.FileSearchToolCallResults lub null		Nie.
stan	wyliczenie	Stan wywołania narzędzia do wyszukiwania plików. Jeden z `in_progress` `searching`, lub `incomplete`, `failed` Możliwe wartości: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania plików. Zawsze `file_search_call`. Możliwe wartości: `file_search_call`	Yes

OpenAI.OutputItemFunctionShellCall

Wołanie narzędzi powłoki

Wywołanie narzędzia, które wykonuje co najmniej jedno polecenie powłoki w środowisku zarządzanym.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
akcja	OpenAI.FunctionShellAction	Wykonaj polecenie powłoki.	Yes
Polecenia └*	tablica ciągów		Yes
└max_output_length	liczba całkowita lub null		Yes
└timeout_ms	liczba całkowita lub null		Yes
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator jednostki, która utworzyła to wywołanie narzędzia.	Nie.
środowisko	OpenAI.FunctionShellCallEnvironment lub null		Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
stan	OpenAI.FunctionShellCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Wyjście wywołań shell

Dane wyjściowe wywołania narzędzia powłoki, które zostało wyemitowane.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model.	Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania powłoki. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
max_output_length	liczba całkowita lub null		Yes
We/Wy	tablica elementów OpenAI.FunctionShellCallOutputContent	Tablica zawartości danych wyjściowych wywołań powłoki	Yes
stan	OpenAI.FunctionShellCallOutputStatusEnum		Yes
typ	wyliczenie	Typ danych wyjściowych wywołania powłoki. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes	shell_call_output

OpenAI.OutputItemFunctionToolCall

Wywołanie narzędzia funkcji

Wywołanie narzędzia w celu uruchomienia funkcji.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Yes
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Yes
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Yes
obszar nazw	ciąg	Przestrzeń nazw funkcji, którą trzeba uruchomić.	Nie.
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.OutputItemFunctionToolCallOutput

Wywołanie funkcji wywołania narzędzia

Dane wyjściowe wywołania narzędzia funkcji.

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator danych wyjściowych wywołania narzędzia funkcji. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
We/Wy	ciąg lub tablica obiektu OpenAI.FunctionAndCustomToolCallOutput	Dane wyjściowe wywołania funkcji wygenerowanego przez kod. Może być ciągiem lub listą zawartości wyjściowej.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania narzędzia funkcji. Zawsze `function_call_output`. Możliwe wartości: `function_call_output`	Yes

OpenAI.OutputItemImageGenToolCall

Wywołanie generowania obrazu

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg znaków lub null		Yes
stan	wyliczenie	Stan wywołania generowania obrazu. Możliwe wartości: `in_progress`, , `completed`, `generatingfailed`	Yes
typ	wyliczenie	Typ wywołania generowania obrazu. Zawsze `image_generation_call`. Możliwe wartości: `image_generation_call`	Yes

OpenAI.OutputItemLocalShellToolCall

Lokalne wezwanie shell

Wywołanie narzędzia w celu uruchomienia polecenia w lokalnej powłoce.

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.LocalShellExecAction	Wykonaj polecenie powłoki na serwerze.	Yes
call_id	ciąg	Unikalny identyfikator wywołania lokalnego narzędzia shella wygenerowanego przez model.	Yes
id	ciąg	Unikatowy identyfikator lokalnego wywołania powłoki.	Yes
stan	wyliczenie	Stan lokalnego wywołania powłoki. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ lokalnego wywołania powłoki. Zawsze `local_shell_call`. Możliwe wartości: `local_shell_call`	Yes

OpenAI.OutputItemLocalShellToolCallOutput

Wyjście lokalnych wywołań shell

Dane wyjściowe lokalnego wywołania narzędzia powłoki.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikalny identyfikator wywołania lokalnego narzędzia shella wygenerowanego przez model.	Yes
We/Wy	ciąg	Ciąg JSON reprezentujący dane wyjściowe z wywołania lokalnego narzędzia powłoki.	Yes
stan	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ lokalnego narzędzia powłoki wywołuje dane wyjściowe. Zawsze `local_shell_call_output`. Możliwe wartości: `local_shell_call_output`	Yes

OpenAI.OutputItemMcpApprovalRequest

Prośba o zatwierdzenie MCP

Wniosek o zatwierdzenie przez człowieka wywołania narzędzia.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Ciąg JSON argumentów dla narzędzia.	Yes
id	ciąg	Unikatowy identyfikator żądania zatwierdzenia.	Yes
nazwa	ciąg	Nazwa narzędzia do uruchomienia.	Yes
etykieta_serwera	ciąg	Etykieta serwera MCP wysyłającego żądanie.	Yes
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_request`. Możliwe wartości: `mcp_approval_request`	Yes

OpenAI.OutputItemMcpApprovalResponseResource

Odpowiedź na zatwierdzenie MCP

Odpowiedź na żądanie zatwierdzenia MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg	Identyfikator odpowiedzi na żądanie zatwierdzenia.	Yes
approve	boolean	Czy żądanie zostało zatwierdzone.	Yes
id	ciąg	Unikatowy identyfikator odpowiedzi zatwierdzenia	Yes
powód	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.OutputItemMcpListTools

Narzędzia do listy MCP

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	OpenAI.RealtimeMCPError		Nie.
id	ciąg	Unikatowy identyfikator listy.	Yes
etykieta_serwera	ciąg	Etykieta serwera MCP.	Yes
Narzędzia	tablica narzędzi OpenAI.MCPListToolsTools	Narzędzia dostępne na serwerze.	Yes
typ	wyliczenie	Typ elementu. Zawsze `mcp_list_tools`. Możliwe wartości: `mcp_list_tools`	Yes

OpenAI.OutputItemMcpToolCall

Wywołanie narzędzi MCP

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg znaków lub null		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	OpenAI.RealtimeMCPError		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg znaków lub null		Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP z uruchomionym narzędziem.	Yes
stan	OpenAI.MCPToolCallStatus		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_call`. Możliwe wartości: `mcp_call`	Yes

OpenAI.OutputItemOutputMessage

Komunikat wyjściowy

Komunikat wyjściowy z modelu.

Name	Typ	Description	Obowiązkowy
zawartość	tablica elementów OpenAI.OutputMessageContent	Zawartość komunikatu wyjściowego.	Yes
id	ciąg	Unikatowy identyfikator komunikatu wyjściowego.	Yes
faza	OpenAI.MessagePhase lub null		Nie.
rola	wyliczenie	Rola komunikatu wyjściowego. Zawsze `assistant`. Możliwe wartości: `assistant`	Yes
stan	wyliczenie	Stan danych wejściowych komunikatu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy wejściowe są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Yes
typ	wyliczenie	Typ komunikatu wyjściowego. Zawsze `message`. Możliwe wartości: `output_message`	Yes

OpenAI.OutputItemReasoningItem

Reasoning

Name	Typ	Description	Obowiązkowy
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg znaków lub null		Nie.
id	ciąg	Unikatowy identyfikator zawartości rozumowania.	Yes
stan	wyliczenie	Stan elementu. `in_progress`Jeden z`completed`, lub `incomplete`. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: `in_progress`, , `completedincomplete`	Nie.
podsumowanie	array OpenAI.SummaryTextContent	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

OpenAI.OutputItemToolSearchCall

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Argumenty		Argumenty używane do wyszukiwania narzędziem.	Yes
call_id	ciąg znaków lub null		Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Yes
id	ciąg	Unikalny identyfikator elementu wyszukiwania narzędzia.	Yes
stan	OpenAI.FunctionCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_search_call`. Możliwe wartości: `tool_search_call`	Yes	tool_search_call

OpenAI.OutputItemToolSearchOutput

Name	Typ	Description	Obowiązkowy	Wartość domyślna
call_id	ciąg znaków lub null		Yes
utworzone_przez	ciąg	Identyfikator aktora, który utworzył element.	Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Yes
id	ciąg	Unikalny identyfikator elementu wyszukiwania narzędzia.	Yes
stan	OpenAI.FunctionCallOutputStatusEnum		Yes
Narzędzia	tablica narzędzi OpenAI.Tool	Załadowane definicje narzędzi zwracane przez wyszukiwanie narzędzi.	Yes
typ	wyliczenie	Typ elementu. Zawsze `tool_search_output`. Możliwe wartości: `tool_search_output`	Yes	tool_search_output

OpenAI.OutputItemType

Property Value

Type ciąg

Wartości output_message
file_search_call
function_call
function_call_output
web_search_call
computer_call
computer_call_output
reasoning
tool_search_call
tool_search_output
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
mcp_approval_response
custom_tool_call
custom_tool_call_output
tool_approval_request

OpenAI.OutputItemWebSearchToolCall

Wezwanie narzędzia do wyszukiwania stron internetowych

Wyniki wywołania narzędzia wyszukiwania w Internecie.

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.WebSearchActionSearch lub OpenAI.WebSearchActionOpenPage lub OpenAI.WebSearchActionFind	Obiekt opisujący określoną akcję podjętą w tym wywołaniu wyszukiwania w sieci Web. Zawiera szczegóły dotyczące tego, jak model korzystał z sieci internetowej (wyszukiwanie, open_page, find_in_page).	Yes
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania w Internecie.	Yes
stan	wyliczenie	Stan działania wyszukiwarki internetowej. Możliwe wartości: `in_progress`, , `searching`, `completedfailed`	Yes
typ	wyliczenie	Typ wywołania narzędzia wyszukiwania w Internecie. Zawsze `web_search_call`. Możliwe wartości: `web_search_call`	Yes

OpenAI.OutputMessageContent

Dyskryminujące dla elementu OpenAI.OutputMessageContent

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Tekst wyjściowy

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
annotations	tablica adnotacji OpenAI.Annotation	Adnotacje tekstu wyjściowego.	Yes
logprobs	tablica biblioteki OpenAI.LogProb		Yes
SMS	ciąg	Dane wyjściowe tekstu z modelu.	Yes
typ	wyliczenie	Typ tekstu wyjściowego. Zawsze `output_text`. Możliwe wartości: `output_text`	Yes	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Odmowa ze strony modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
refusal	ciąg	Wyjaśnienie odmowy dostarczone przez model.	Yes
typ	wyliczenie	Rodzaj odmowy. Zawsze `refusal`. Możliwe wartości: `refusal`	Yes	refusal

OpenAI.OutputMessageContentType

Property	Value
Type	ciąg
Wartości	`output_text` `refusal`

OpenAI.Prompt

Odwołanie do szablonu monitu i jego zmiennych.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator szablonu monitu do użycia.	Yes
variables	OpenAI.ResponsePromptVariables lub null		Nie.
wersja	ciąg znaków lub null		Nie.

OpenAI.RankerVersionType

Property	Value
Type	ciąg
Wartości	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Typ	Description	Obowiązkowy
hybrid_search	OpenAI.HybridSearchOptions		Nie.
└embedding_weight	number	Waga osadzania w wzajemnym połączeniu rankingowym.	Yes
└text_weight	number	Waga tekstu w wzajemnym połączeniu klasyfikacji.	Yes
klasyfikator	OpenAI.RankerVersionType		Nie.
próg punktowy	number	Próg oceny dla wyszukiwania plików, liczba z zakresu od 0 do 1. Liczby bliżej 1 będą próbować zwracać tylko najbardziej odpowiednie wyniki, ale mogą zwracać mniej wyników.	Nie.

OpenAI.RealtimeMCPError

Discriminator for OpenAI.RealtimeMCPError

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.RealtimeMcpErrorType		Yes

OpenAI.RealtimeMCPHTTPError

Błąd HTTP MCP w czasie rzeczywistym

Name	Typ	Description	Obowiązkowy
kod	liczba całkowita		Yes
komunikat	ciąg		Yes
typ	wyliczenie	Możliwe wartości: `http_error`	Yes

OpenAI.RealtimeMCPProtocolError

Błąd protokołu MCP w czasie rzeczywistym

Name	Typ	Description	Obowiązkowy
kod	liczba całkowita		Yes
komunikat	ciąg		Yes
typ	wyliczenie	Możliwe wartości: `protocol_error`	Yes

OpenAI.RealtimeMCPToolExecutionError

Błąd w wykonaniu narzędzia MCP w czasie rzeczywistym

Name	Typ	Description	Obowiązkowy	Wartość domyślna
komunikat	ciąg		Yes
typ	wyliczenie	Możliwe wartości: `tool_execution_error`	Yes

OpenAI.RealtimeMcpErrorType

Property	Value
Type	ciąg
Wartości	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

Tylko modele gpt-5 i serii o Opcje konfiguracji dla modeli rozumowania.

Name	Typ	Description	Obowiązkowy
nakład pracy	OpenAI.ReasoningEffort	Ogranicza wysiłek w rozumowaniu modele rozumowania. Obecnie obsługiwane wartości to `none`, , `minimal`, `lowmedium`, `high`, i `xhigh`. Zmniejszenie wysiłek na rzecz przetwarzania może prowadzić do szybszych odpowiedzi i mniejszej liczby używanych tokenów rozumowanie w odpowiedzi. - `gpt-5.1` wartość domyślna to `none`, która nie wykonuje rozumowania. Obsługiwane wartości `gpt-5.1` rozumowania to `none`, `low`, `medium`i `high`. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. — Wszystkie modele przed `gpt-5.1` ustawieniem domyślnym do `medium` uczenia się i nie obsługują `none`elementu . — Model `gpt-5-pro` domyślnie (i obsługuje tylko) `high` wysiłek rozumowania. - `xhigh` jest obsługiwany dla wszystkich modeli po `gpt-5.1-codex-max`.	Nie.
generate_summary	ciąg znaków lub null		Nie.
podsumowanie	ciąg znaków lub null		Nie.

OpenAI.ReasoningEffort

Ogranicza nakład pracy na modele rozumowania. Obecnie obsługiwane wartości to none, , minimal, lowmedium, high, i xhigh. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi.

gpt-5.1 wartość domyślna to none, która nie wykonuje rozumowania. Obsługiwane wartości gpt-5.1 rozumowania to none, low, mediumi high. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1.
Wszystkie modele przed gpt-5.1 ustawieniem domyślnym na medium potrzeby uczenia się i nie obsługują elementu none.
Domyślnie gpt-5-pro model ma (i obsługuje tylko) high wysiłek rozumowania.
xhigh jest obsługiwany dla wszystkich modeli po gpt-5.1-codex-max.

Property	Value
Opis	Ogranicza wysiłek w rozumowaniu modele rozumowania. Obecnie obsługiwane wartości to `none`, , `minimal`, `lowmedium`, `high`, i `xhigh`. Zmniejszenie wysiłek na rzecz przetwarzania może prowadzić do szybszych odpowiedzi i mniejszej liczby używanych tokenów rozumowanie w odpowiedzi. - `gpt-5.1` wartość domyślna to `none`, która nie wykonuje rozumowania. Obsługiwane wartości `gpt-5.1` rozumowania to `none`, `low`, `medium`i `high`. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. — Wszystkie modele przed `gpt-5.1` ustawieniem domyślnym do `medium` uczenia się i nie obsługują `none`elementu . — Model `gpt-5-pro` domyślnie (i obsługuje tylko) `high` wysiłek rozumowania. - `xhigh` jest obsługiwany dla wszystkich modeli po `gpt-5.1-codex-max`.
Type	ciąg
Wartości	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Tekst rozumowania

Tekst rozumowania z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst rozumowania z modelu.	Yes
typ	wyliczenie	Typ tekstu rozumowania. Zawsze `reasoning_text`. Możliwe wartości: `reasoning_text`	Yes	reasoning_text

OpenAI.Response

Obiekt odpowiedzi

Name	Typ	Description	Obowiązkowy	Wartość domyślna
tło	wartość logiczna lub null		Nie.
zakończono_o	ciąg znaków lub null		Nie.
content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
konwersacja	OpenAI.ConversationReference lub null		Nie.
utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
błąd	OpenAI.ResponseError lub null		Yes
id	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails lub null		Yes
instructions	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
max_output_tokens	liczba całkowita lub null		Nie.
maks_liczba_wywołań_narzędzi	liczba całkowita lub null		Nie.
metadane	OpenAI.Metadata lub null		Nie.
model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
We/Wy	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
output_text	ciąg znaków lub null		Nie.
wywołania_narzędzia_równoległe	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
previous_response_id	ciąg znaków lub null		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
prompt_cache_retention	ciąg znaków lub null		Nie.
reasoning	OpenAI.Reasoning lub null		Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
stan	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
temperatura	liczba lub wartość null		Nie.
SMS	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
top_logprobs	liczba całkowita lub null		Nie.
top_p	liczba lub wartość null		Nie.
truncation	ciąg znaków lub null		Nie.
użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.

OpenAI.ResponseAudioDeltaEvent

Występuje w przypadku częściowej odpowiedzi głosowej.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Fragment bajtów audio odpowiedzi zakodowanych w formacie Base64. Ograniczenia: kodowanie: base64	Yes
sequence_number	liczba całkowita	Numer sekwencji dla tego fragmentu odpowiedzi strumienia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.audio.delta`. Możliwe wartości: `response.audio.delta`	Yes

OpenAI.ResponseAudioDoneEvent

Emitowane po zakończeniu odpowiedzi audio.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
sequence_number	liczba całkowita	Numer sekwencyjny delty.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.audio.done`. Możliwe wartości: `response.audio.done`	Yes

OpenAI.ResponseAudioTranscriptDeltaEvent

Emitowane w przypadku częściowej transkrypcji dźwięku.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Częściowa transkrypcja odpowiedzi audio.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.audio.transcript.delta`. Możliwe wartości: `response.audio.transcript.delta`	Yes

OpenAI.ResponseAudioTranscriptDoneEvent

Emitowany po zakończeniu pełnej transkrypcji audio.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.audio.transcript.done`. Możliwe wartości: `response.audio.transcript.done`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitowane, gdy częściowy fragment kodu jest przesyłany w strumieniu przez interpreter kodu.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Fragment kodu przesyłany strumieniowo przez interpreter kodu.	Yes
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której jest przesyłany strumieniowo kod.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia używany do zamawiania zdarzeń przesyłania strumieniowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.code_interpreter_call_code.delta`. Możliwe wartości: `response.code_interpreter_call_code.delta`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Emitowane, gdy fragment kodu jest finalizowany przez interpreter kodu.

Name	Typ	Description	Obowiązkowy
kod	ciąg	Ostateczny wynik fragmentu kodu generowany przez interpretatora kodu.	Yes
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której kod jest sfinalizowany.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia używany do zamawiania zdarzeń przesyłania strumieniowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.code_interpreter_call_code.done`. Możliwe wartości: `response.code_interpreter_call_code.done`	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Emitowane po zakończeniu wywołania interpretera kodu.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której wykonano wywołanie interpretera kodu.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia używany do zamawiania zdarzeń przesyłania strumieniowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.code_interpreter_call.completed`. Możliwe wartości: `response.code_interpreter_call.completed`	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitowane, gdy trwa wywołanie interpretera kodu.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której trwa wywołanie interpretera kodu.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia używany do zamawiania zdarzeń przesyłania strumieniowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.code_interpreter_call.in_progress`. Możliwe wartości: `response.code_interpreter_call.in_progress`	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitowane, gdy interpreter kodu aktywnie interpretuje fragment kodu.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której interpreter kodu interpretuje kod.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia używany do zamawiania zdarzeń przesyłania strumieniowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.code_interpreter_call.interpreting`. Możliwe wartości: `response.code_interpreter_call.interpreting`	Yes

OpenAI.ResponseCompletedEvent

Emitowane po zakończeniu odpowiedzi modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└* tło	wartość logiczna lub null		Nie.
└completed_at	string lub null (unixTimestamp)		Nie.
└content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
Konwersacja └*	OpenAI.ConversationReference lub null		Nie.
└─ utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError lub null		Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails lub null		Yes
└─ instrukcje	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
└─ max_output_tokens	liczba całkowita lub null		Nie.
└max_tool_calls	liczba całkowita lub null		Nie.
Metadane └*	OpenAI.Metadata lub null		Nie.
└─ Model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
└─ obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
└─ Dane wyjściowe	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
└output_text	ciąg znaków lub null		Nie.
└parallel_tool_calls	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
└previous_response_id	ciąg znaków lub null		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
└prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
└prompt_cache_retention	ciąg znaków lub null		Nie.
└* rozumowanie	OpenAI.Reasoning lub null		Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
└─ Status	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
└* temperatura	liczba lub wartość null		Nie.	1
└* tekst	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
└─ Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	liczba całkowita lub null		Nie.
└─top_p	liczba lub wartość null		Nie.	1
└* skrócenie	ciąg znaków lub null		Nie.	wygaszony
└─ użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
└─ Użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.
sequence_number	liczba całkowita	Numer sekwencji dla tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.completed`. Możliwe wartości: `response.completed`	Yes

OpenAI.ResponseContentPartAddedEvent

Emitowane po dodaniu nowej części zawartości.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks dodanej części zawartości.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Yes
część	OpenAI.OutputContent		Yes
└typ	OpenAI.OutputContentType		Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.content_part.added`. Możliwe wartości: `response.content_part.added`	Yes

OpenAI.ResponseContentPartDoneEvent

Emitowane po zakończeniu części zawartości.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks części zawartości, która jest ukończona.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Yes
część	OpenAI.OutputContent		Yes
└typ	OpenAI.OutputContentType		Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.content_part.done`. Możliwe wartości: `response.content_part.done`	Yes

OpenAI.ResponseCreatedEvent

Zdarzenie emitowane podczas tworzenia odpowiedzi.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└* tło	wartość logiczna lub null		Nie.
└completed_at	string lub null (unixTimestamp)		Nie.
└content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
Konwersacja └*	OpenAI.ConversationReference lub null		Nie.
└─ utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError lub null		Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails lub null		Yes
└─ instrukcje	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
└─ max_output_tokens	liczba całkowita lub null		Nie.
└max_tool_calls	liczba całkowita lub null		Nie.
Metadane └*	OpenAI.Metadata lub null		Nie.
└─ Model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
└─ obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
└─ Dane wyjściowe	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
└output_text	ciąg znaków lub null		Nie.
└parallel_tool_calls	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
└previous_response_id	ciąg znaków lub null		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
└prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
└prompt_cache_retention	ciąg znaków lub null		Nie.
└* rozumowanie	OpenAI.Reasoning lub null		Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
└─ Status	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
└* temperatura	liczba lub wartość null		Nie.	1
└* tekst	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
└─ Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	liczba całkowita lub null		Nie.
└─top_p	liczba lub wartość null		Nie.	1
└* skrócenie	ciąg znaków lub null		Nie.	wygaszony
└─ użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
└─ Użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.
sequence_number	liczba całkowita	Numer sekwencji dla tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.created`. Możliwe wartości: `response.created`	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Zdarzenie reprezentujące różnicę (częściową aktualizację) do danych wejściowych niestandardowego wywołania narzędzia.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Przyrostowe dane wejściowe (delta) dla niestandardowego wywołania narzędzia.	Yes
item_id	ciąg	Unikatowy identyfikator elementu interfejsu API skojarzonego z tym zdarzeniem.	Yes
output_index	liczba całkowita	Indeks danych wyjściowych, do których ma zastosowanie ta funkcja delta.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Identyfikator typu zdarzenia. Możliwe wartości: `response.custom_tool_call_input.delta`	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

ResponseCustomToolCallInputDone

Zdarzenie wskazujące, że dane wejściowe dla niestandardowego wywołania narzędzia są ukończone.

Name	Typ	Description	Obowiązkowy
dane wejściowe	ciąg	Pełne dane wejściowe dla wywołania niestandardowego narzędzia.	Yes
item_id	ciąg	Unikatowy identyfikator elementu interfejsu API skojarzonego z tym zdarzeniem.	Yes
output_index	liczba całkowita	Indeks wyjścia, do którego to zdarzenie się odnosi.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Identyfikator typu zdarzenia. Możliwe wartości: `response.custom_tool_call_input.done`	Yes

OpenAI.ResponseError

Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	OpenAI.ResponseErrorCode	Kod błędu odpowiedzi.	Yes
komunikat	ciąg	Czytelny dla człowieka opis błędu.	Yes

OpenAI.ResponseErrorCode

Kod błędu odpowiedzi.

Property	Value
Type	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`

OpenAI.ResponseErrorEvent

Emitowane w przypadku wystąpienia błędu.

Name	Typ	Description	Obowiązkowy
kod	ciąg znaków lub null		Yes
komunikat	ciąg	Komunikat o błędzie.	Yes
param	ciąg znaków lub null		Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `error`. Możliwe wartości: `error`	Yes

OpenAI.ResponseFailedEvent

Zdarzenie emitowane w przypadku niepowodzenia odpowiedzi.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└* tło	wartość logiczna lub null		Nie.
└completed_at	string lub null (unixTimestamp)		Nie.
└content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
Konwersacja └*	OpenAI.ConversationReference lub null		Nie.
└─ utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError lub null		Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails lub null		Yes
└─ instrukcje	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
└─ max_output_tokens	liczba całkowita lub null		Nie.
└max_tool_calls	liczba całkowita lub null		Nie.
Metadane └*	OpenAI.Metadata lub null		Nie.
└─ Model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
└─ obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
└─ Dane wyjściowe	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
└output_text	ciąg znaków lub null		Nie.
└parallel_tool_calls	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
└previous_response_id	ciąg znaków lub null		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
└prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
└prompt_cache_retention	ciąg znaków lub null		Nie.
└* rozumowanie	OpenAI.Reasoning lub null		Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
└─ Status	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
└* temperatura	liczba lub wartość null		Nie.	1
└* tekst	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
└─ Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	liczba całkowita lub null		Nie.
└─top_p	liczba lub wartość null		Nie.	1
└* skrócenie	ciąg znaków lub null		Nie.	wygaszony
└─ użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
└─ Użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.failed`. Możliwe wartości: `response.failed`	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

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

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.file_search_call.completed`. Możliwe wartości: `response.file_search_call.completed`	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Emitowane po zainicjowaniu wywołania wyszukiwania plików.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.file_search_call.in_progress`. Możliwe wartości: `response.file_search_call.in_progress`	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Emitowane, gdy wyszukiwanie plików jest obecnie przeszukiwane.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego przeszukiwanego przez wywołanie wyszukiwania plików.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.file_search_call.searching`. Możliwe wartości: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormatJsonSchemaSchema

Schemat JSON

Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON. Dowiedz się, jak tworzyć schematy JSON tutaj.

Typ: obiekt

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Emitowane, gdy występuje różnica w argumentach wywołania funkcji częściowej.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Dodano argument delta w wywołaniu funkcji.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę argumentów wywołania funkcji.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego do którego zostanie dodana różnica w argumentach wywołania funkcji.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.function_call_arguments.delta`. Możliwe wartości: `response.function_call_arguments.delta`	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Emitowane, gdy argumenty wywołania funkcji są finalizowane.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Argumenty wywołania funkcji.	Yes
item_id	ciąg	Identyfikator elementu.	Yes
nazwa	ciąg	Nazwa funkcji, która została wywołana.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Możliwe wartości: `response.function_call_arguments.done`	Yes

OpenAI.ResponseImageGenCallCompletedEvent

ReakcjaObrazGenerowanieZakończoneZdarzenie

Emitowane, gdy wywołanie narzędzia do generowania obrazów się zakończyło i dostępny jest końcowy obraz.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.completed". Możliwe wartości: `response.image_generation_call.completed`	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

ObrazReakcjaGenerowanieZdarzenieGenerowanieZdarzenie

Emitowane, gdy wywołanie narzędzia do generowania obrazów aktywnie generuje obraz (stan pośredni).

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji przetwarzanego elementu generowania obrazu.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.generating". Możliwe wartości: `response.image_generation_call.generating`	Yes

OpenAI.ResponseImageGenCallInProgressEvent

OdpowiedźObrazGenerowanieZgłoszenie w trakcie Zdarzenia

Emitowane jest, gdy trwa wywołanie narzędzia do generowania obrazów.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji przetwarzanego elementu generowania obrazu.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.in_progress". Możliwe wartości: `response.image_generation_call.in_progress`	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

ReakcjaObrazGenerowanieWywołanieCzęściowyObrazZdarzenie

Emitowany sygnał, gdy częściowy obraz staje się dostępny podczas przesyłania strumieniowego generowanych obrazów.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
partial_image_b64	ciąg	Dane częściowe obrazu zakodowane w formacie Base64, odpowiednie do renderowania jako obrazu.	Yes
partial_image_index	liczba całkowita	Indeks zaczynający się od 0 dla obrazu częściowego (w systemie backend indeks zaczyna się od 1, ale dla użytkownika jest to indeks od 0).	Yes
sequence_number	liczba całkowita	Numer sekwencji przetwarzanego elementu generowania obrazu.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze „response.image_generation_call.partial_image”. Możliwe wartości: `response.image_generation_call.partial_image`	Yes

OpenAI.ResponseInProgressEvent

Emitowane, gdy odpowiedź jest w toku.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└* tło	wartość logiczna lub null		Nie.
└completed_at	string lub null (unixTimestamp)		Nie.
└content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
Konwersacja └*	OpenAI.ConversationReference lub null		Nie.
└─ utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError lub null		Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails lub null		Yes
└─ instrukcje	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
└─ max_output_tokens	liczba całkowita lub null		Nie.
└max_tool_calls	liczba całkowita lub null		Nie.
Metadane └*	OpenAI.Metadata lub null		Nie.
└─ Model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
└─ obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
└─ Dane wyjściowe	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
└output_text	ciąg znaków lub null		Nie.
└parallel_tool_calls	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
└previous_response_id	ciąg znaków lub null		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
└prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
└prompt_cache_retention	ciąg znaków lub null		Nie.
└* rozumowanie	OpenAI.Reasoning lub null		Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
└─ Status	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
└* temperatura	liczba lub wartość null		Nie.	1
└* tekst	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
└─ Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	liczba całkowita lub null		Nie.
└─top_p	liczba lub wartość null		Nie.	1
└* skrócenie	ciąg znaków lub null		Nie.	wygaszony
└─ użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
└─ Użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.in_progress`. Możliwe wartości: `response.in_progress`	Yes

OpenAI.ResponseIncompleteDetails

Name	Typ	Description	Obowiązkowy	Wartość domyślna
powód	wyliczenie	Możliwe wartości: `max_output_tokens`, `content_filter`	Nie.

OpenAI.ResponseIncompleteEvent

Zdarzenie emitowane, gdy odpowiedź jest zakończona jako niekompletna.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└* tło	wartość logiczna lub null		Nie.
└completed_at	string lub null (unixTimestamp)		Nie.
└content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
Konwersacja └*	OpenAI.ConversationReference lub null		Nie.
└─ utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError lub null		Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails lub null		Yes
└─ instrukcje	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
└─ max_output_tokens	liczba całkowita lub null		Nie.
└max_tool_calls	liczba całkowita lub null		Nie.
Metadane └*	OpenAI.Metadata lub null		Nie.
└─ Model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
└─ obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
└─ Dane wyjściowe	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
└output_text	ciąg znaków lub null		Nie.
└parallel_tool_calls	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
└previous_response_id	ciąg znaków lub null		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
└prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
└prompt_cache_retention	ciąg znaków lub null		Nie.
└* rozumowanie	OpenAI.Reasoning lub null		Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
└─ Status	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
└* temperatura	liczba lub wartość null		Nie.	1
└* tekst	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
└─ Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	liczba całkowita lub null		Nie.
└─top_p	liczba lub wartość null		Nie.	1
└* skrócenie	ciąg znaków lub null		Nie.	wygaszony
└─ użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
└─ Użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.incomplete`. Możliwe wartości: `response.incomplete`	Yes

OpenAI.ResponseItemList

Lista elementów odpowiedzi.

Name	Typ	Description	Obowiązkowy
dane	tablica elementów OpenAI.ItemResource	Lista elementów używanych do wygenerowania tej odpowiedzi.	Yes
first_id	ciąg	Identyfikator pierwszego elementu na liście.	Yes
zawiera_więcej	boolean	Czy dostępnych jest więcej elementów?	Yes
last_id	ciąg	Identyfikator ostatniego elementu na liście.	Yes
obiekt	wyliczenie	Zwracany typ obiektu musi mieć wartość `list`. Możliwe wartości: `list`	Yes

OpenAI.ResponseLogProb

Logprob to prawdopodobieństwo logarytmicznych przypisywane przez model do tworzenia określonego tokenu na danej pozycji w sekwencji. Mniej ujemne (wyższe) wartości logprob wskazują większe zaufanie modelu do wyboru tokenu.

Name	Typ	Description	Obowiązkowy
logprob	number	Logarytm prawdopodobieństwa tego tokenu.	Yes
kod przedpłaty	ciąg	Możliwy token tekstowy.	Yes
top_logprobs	tablica openAI.ResponseLogProbTopLogprobs	Logarytmiczne prawdopodobieństwa do 20 najbardziej prawdopodobnych tokenów.	Nie.

OpenAI.ResponseLogProbTopLogprobs

Name	Typ	Description	Obowiązkowy	Wartość domyślna
logprob	number		Nie.
kod przedpłaty	ciąg		Nie.

OpenAI.ResponseMCPCallArgumentsDeltaEvent

ResponseMCPCallArgumentsDeltaEvent

Emituje się, gdy następuje różnica (częściowa aktualizacja) w argumentach wywołania narzędzia MCP.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Ciąg JSON zawierający częściową aktualizację argumentów wywołania narzędzia MCP.	Yes
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call_arguments.delta". Możliwe wartości: `response.mcp_call_arguments.delta`	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

ResponseMCPCallArgumentsDoneEvent

Emitowane, gdy argumenty wywołania narzędzia MCP są finalizowane.

Name	Typ	Description	Obowiązkowy
Argumenty	ciąg	Ciąg JSON zawierający finalizowane argumenty wywołania narzędzia MCP.	Yes
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call_arguments.done". Możliwe wartości: `response.mcp_call_arguments.done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

ReakcjaMCPCallCompletedEvent

Emitowane po pomyślnym zakończeniu wywołania narzędzia MCP.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wywołania narzędzia MCP, który został ukończony.	Yes
output_index	liczba całkowita	Indeks pozycji wyjściowej, która została ukończona.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.completed". Możliwe wartości: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

OdpowiedźMCPCallFailedEvent

Emitowane, gdy wywołanie narzędzia MCP nie powiodło się.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wywołania narzędzia MCP, który zakończył się niepowodzeniem.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, który zakończył się niepowodzeniem.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.failed". Możliwe wartości: `response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

OdpowiedźMCPCallInProgressEvent

Emitowane, gdy trwa wywołanie narzędzia MCP.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.in_progress". Możliwe wartości: `response.mcp_call.in_progress`	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Reakcja MCPListNarzędziZakończoneZdarzenie

Emitowane po pomyślnym pobraniu listy dostępnych narzędzi MCP.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wywołania narzędzia MCP, który wygenerował te dane wyjściowe.	Yes
output_index	liczba całkowita	Indeks przetworzonego elementu wyjściowego.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze „response.mcp_list_tools.completed”. Możliwe wartości: `response.mcp_list_tools.completed`	Yes

OpenAI.ResponseMCPListToolsFailedEvent

ResponseMCPListToolsFailedEvent

Emitowane, gdy próba wyświetlenia listy dostępnych narzędzi MCP nie powiodła się.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu wywołania narzędzia MCP, który zakończył się niepowodzeniem.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, który zakończył się niepowodzeniem.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_list_tools.failed". Możliwe wartości: `response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Reakcja MCPListToolsInProgressEvent

Emitowane, gdy system jest w trakcie pobierania listy dostępnych narzędzi MCP.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Yes
output_index	liczba całkowita	Indeks przetwarzanego elementu wyjściowego.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_list_tools.in_progress". Możliwe wartości: `response.mcp_list_tools.in_progress`	Yes

OpenAI.ResponseOutputItemAddedEvent

Emitowane po dodaniu nowego elementu wyjściowego.

Name	Typ	Description	Obowiązkowy
element	OpenAI.OutputItem		Yes
└typ	OpenAI.OutputItemType		Yes
output_index	liczba całkowita	Indeks dodanego elementu wyjściowego.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.output_item.added`. Możliwe wartości: `response.output_item.added`	Yes

OpenAI.ResponseOutputItemDoneEvent

Emitowane, gdy element wyjściowy jest oznaczony jako zakończony.

Name	Typ	Description	Obowiązkowy
element	OpenAI.OutputItem		Yes
└typ	OpenAI.OutputItemType		Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, który został oznaczony jako wykonany.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.output_item.done`. Możliwe wartości: `response.output_item.done`	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

ReakcjaWyjścieTekstNotacjaDodaneZdarzenie

Emitowane po dodaniu adnotacji do wyjściowej zawartości tekstowej.

Name	Typ	Description	Obowiązkowy
adnotacja	OpenAI.Annotation	Adnotacja, która ma zastosowanie do zakresu tekstu wyjściowego.	Yes
└typ	OpenAI.AnnotationType		Yes
annotation_index	liczba całkowita	Indeks adnotacji w części zawartości.	Yes
content_index	liczba całkowita	Indeks części zawartości w elemencie wyjściowym.	Yes
item_id	ciąg	Unikatowy identyfikator elementu, do którego jest dodawana adnotacja.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.output_text.adnotacja.added". Możliwe wartości: `response.output_text.annotation.added`	Yes

OpenAI.ResponsePromptVariables

Zmienne promptowe

Opcjonalna mapa wartości, które mają być zastępowane zmiennymi w wierszu polecenia. Wartości podstawienia mogą być ciągami lub innymi typami wejściowymi odpowiedzi, takimi jak obrazy lub pliki.

Typ: obiekt

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Emitowane, gdy odpowiedź czeka w kolejce na przetworzenie.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└* tło	wartość logiczna lub null		Nie.
└completed_at	string lub null (unixTimestamp)		Nie.
└content_filters	tablica interfejsu AzureContentFilterForResponsesAPI	Wyniki filtru zawartości z RAI.	Nie.
Konwersacja └*	OpenAI.ConversationReference lub null		Nie.
└─ utworzono_o	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError lub null		Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails lub null		Yes
└─ instrukcje	ciąg lub tablica typu OpenAI.InputItem lub null		Yes
└─ max_output_tokens	liczba całkowita lub null		Nie.
└max_tool_calls	liczba całkowita lub null		Nie.
Metadane └*	OpenAI.Metadata lub null		Nie.
└─ Model	ciąg	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-4o` lub `o3`. OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, wydajnością cechy i punkty cenowe. Zapoznaj się z przewodnikiem po modelu aby przeglądać i porównywać dostępne modele.	Nie.
└─ obiekt	wyliczenie	Typ obiektu tego zasobu — zawsze ustawiony na `response`. Możliwe wartości: `response`	Yes
└─ Dane wyjściowe	tablica openAI.OutputItem	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy `output` jest zależna na odpowiedzi modelu. Zamiast uzyskać dostęp do pierwszego elementu tablicy `output`: zakładając, że jest to komunikat z zawartością `assistant` wygenerowaną przez modelu, można rozważyć użycie właściwości `output_text`. obsługiwane w zestawach SDK.	Yes
└output_text	ciąg znaków lub null		Nie.
└parallel_tool_calls	boolean	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Yes	True
└previous_response_id	ciąg znaków lub null		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych.	Nie.
└prompt_cache_key	ciąg	Używany przez interfejs OpenAI do buforowania odpowiedzi dla podobnych żądań w celu zoptymalizowania współczynników trafień pamięci podręcznej. `user` Zamienia pole.	Nie.
└prompt_cache_retention	ciąg znaków lub null		Nie.
└* rozumowanie	OpenAI.Reasoning lub null		Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. ID powinny być ciągiem znaków jednoznacznie identyfikującym każdego użytkownika, o maksymalnej długości 64 znaków. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Ograniczenia: maxLength: 64	Nie.
└─ Status	wyliczenie	Stan generowania odpowiedzi. `completed`Jeden z , , `failed` `in_progress`, `cancelled`, `queued` lub `incomplete`. Możliwe wartości: `completed`, , `failedin_progress`, `cancelled`, , `queuedincomplete`	Nie.
└* temperatura	liczba lub wartość null		Nie.	1
└* tekst	OpenAI.ResponseTextParam	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być prosty tekstowe lub ustrukturyzowane dane JSON. Więcej informacji: - Wprowadzanie tekstu i dane wyjściowe - Ustrukturyzowane wyniki	Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceParam		Nie.
└─ Narzędzia	OpenAI.ToolsArray	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru `tool_choice` . Obsługujemy następujące kategorie narzędzi: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają Możliwości modelu, takie jak wyszukiwanie internetowe albo wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. - Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowane łączniki, takie jak Dysk Google i Program SharePoint. Dowiedz się więcej o Narzędzia MCP. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelu wywoływania własnego kodu za pomocą silnie typiowanych argumentów i dane wyjściowe. Dowiedz się więcej o Funkcja wywoływana. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	liczba całkowita lub null		Nie.
└─top_p	liczba lub wartość null		Nie.	1
└* skrócenie	ciąg znaków lub null		Nie.	wygaszony
└─ użycie	OpenAI.ResponseUsage	Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączna liczba użytych tokenów.	Nie.
└─ Użytkownik	ciąg (przestarzałe)	To pole jest zastępowane przez i `safety_identifierprompt_cache_key`. Zamiast tego użyj `prompt_cache_key` polecenia , aby zachować optymalizacje buforowania. Stabilny identyfikator dla użytkowników końcowych. Służy do zwiększania szybkości trafień pamięci podręcznej przez lepsze zasobniki podobnych żądań i pomaga wykrywać i zapobiegać nadużyciom w usłudze OpenAI.	Nie.
sequence_number	liczba całkowita	Numer sekwencji dla tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.queued". Możliwe wartości: `response.queued`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitowane po dodaniu nowej części podsumowania rozumowania.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu, z którym ta część podsumowania jest skojarzona.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego jest skojarzony z tą częścią podsumowania.	Yes
część	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└* tekst	ciąg		Yes
└typ	wyliczenie	Możliwe wartości: `summary_text`	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
summary_index	liczba całkowita	Indeks części podsumowania w podsumowaniu rozumowania.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.reasoning_summary_part.added`. Możliwe wartości: `response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg		Yes
typ	wyliczenie	Możliwe wartości: `summary_text`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitowane po ukończeniu części podsumowującej wnioskowanie.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu, z którym ta część podsumowania jest skojarzona.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego jest skojarzony z tą częścią podsumowania.	Yes
część	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└* tekst	ciąg		Yes
└typ	wyliczenie	Możliwe wartości: `summary_text`	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
summary_index	liczba całkowita	Indeks części podsumowania w podsumowaniu rozumowania.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.reasoning_summary_part.done`. Możliwe wartości: `response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg		Yes
typ	wyliczenie	Możliwe wartości: `summary_text`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitowane po dodaniu zmiany do tekstu podsumowującego rozumowanie.

Name	Typ	Description	Obowiązkowy
delta	ciąg	Delta tekstu dodana do podsumowania.	Yes
item_id	ciąg	Identyfikator elementu, z który jest skojarzona ta delta tekstu podsumowania.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, z którym powiązana jest zmiana tekstu podsumowania.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
summary_index	liczba całkowita	Indeks części podsumowania w podsumowaniu rozumowania.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.reasoning_summary_text.delta`. Możliwe wartości: `response.reasoning_summary_text.delta`	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitowany po zakończeniu tekstu podsumowania rozumowania.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Identyfikator elementu, z którym jest powiązany ten tekst podsumowania.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, z którym związany jest ten tekst podsumowania.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
summary_index	liczba całkowita	Indeks części podsumowania w podsumowaniu rozumowania.	Yes
SMS	ciąg	Pełny tekst ukończonego podsumowania rozumowania.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.reasoning_summary_text.done`. Możliwe wartości: `response.reasoning_summary_text.done`	Yes

OpenAI.ResponseReasoningTextDeltaEvent

Emitowane po dodaniu różnicy do tekstu rozumowania.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks części zawartości rozumowania, z tą różnicą jest skojarzony.	Yes
delta	ciąg	Delta tekstu, która została dodana do zawartości rozumowania.	Yes
item_id	ciąg	Identyfikator elementu, z którego jest skojarzona ta różnica tekstu rozumowania.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, z którego jest skojarzona różnica tekstu rozumowania.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.reasoning_text.delta`. Możliwe wartości: `response.reasoning_text.delta`	Yes

OpenAI.ResponseReasoningTextDoneEvent

Emitowane po zakończeniu tekstu rozumowania.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks treści rozumowania.	Yes
item_id	ciąg	Identyfikator elementu, z tym tekstem rozumowania jest skojarzony.	Yes
output_index	liczba całkowita	Indeks pozycji wyjściowej, z którą ten tekst rozumowania jest powiązany.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
SMS	ciąg	Pełny tekst ukończonej zawartości rozumowania.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.reasoning_text.done`. Możliwe wartości: `response.reasoning_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Emitowane w przypadku częściowego tekstu odmowy.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks części zawartości, do którego jest dodawany tekst odmowy.	Yes
delta	ciąg	Tekst odmowy, który został dodany.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego jest dodawany tekst odmowy.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest dodawany tekst odmowy.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.refusal.delta`. Możliwe wartości: `response.refusal.delta`	Yes

OpenAI.ResponseRefusalDoneEvent

Emitowane, gdy tekst odmowy jest sfinalizowany.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks części treści, w której tekst odmowy jest sfinalizowany.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego tekst odmowy jest finalizowany.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, w którym tekst odmowy został sfinalizowany.	Yes
refusal	ciąg	Tekst odmowy, który jest sfinalizowany.	Yes
sequence_number	liczba całkowita	Numer sekwencji tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.refusal.done`. Możliwe wartości: `response.refusal.done`	Yes

OpenAI.ResponseStreamEvent

Dyskryminator dla OpenAI.ResponseStreamEvent

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`response.custom_tool_call_input.delta`	OpenAI.ResponseCustomToolCallInputDeltaEvent
`response.custom_tool_call_input.done`	OpenAI.ResponseCustomToolCallInputDoneEvent
`error`	OpenAI.ResponseErrorEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.mcp_call_arguments.delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call_arguments.done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.output_text.annotation.added`	OpenAI.ResponseOutputTextAnnotationAddedEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.reasoning_text.delta`	OpenAI.ResponseReasoningTextDeltaEvent
`response.reasoning_text.done`	OpenAI.ResponseReasoningTextDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.audio.delta`	OpenAI.ResponseAudioDeltaEvent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Property Value

Type ciąg

Wartości response.audio.delta
response.audio.done
response.audio.transcript.delta
response.audio.transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.reasoning_text.delta
response.reasoning_text.done
response.refusal.delta
response.refusal.done
response.output_text.delta
response.output_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call_arguments.delta
response.mcp_call_arguments.done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.output_text.annotation.added
response.queued
response.custom_tool_call_input.delta
response.custom_tool_call_input.done

OpenAI.ResponseStreamOptions

Opcje przesyłania strumieniowego odpowiedzi. Ustaw tę wartość tylko po ustawieniu stream: true.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
include_obfuscation	boolean	W przypadku wartości true funkcja zaciemnienia strumienia zostanie włączona. Dodawanie zaciemniania strumienia losowe znaki do pola w przypadku zdarzeń różnicowych przesyłania strumieniowego `obfuscation` do normalizuj rozmiary ładunków jako środki zaradcze dla niektórych ataków kanału bocznego. Te pola zaciemniania są domyślnie uwzględniane, ale dodaj niewielką ilość narzut na strumień danych. Możesz ustawić wartość `include_obfuscation` na false, aby zoptymalizować przepustowość, jeśli ufasz łączem sieciowym między aplikacja i interfejs API openAI.	Nie.

OpenAI.ResponseTextDeltaEvent

Emitowane w przypadku dodatkowej zmiany tekstu.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks części zawartości, do której dodano zmianę tekstową.	Yes
delta	ciąg	Dodano zmianę tekstu.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę tekstu.	Yes
logprobs	tablica biblioteki OpenAI.ResponseLogProb	Prawdopodobieństwo dziennika tokenów w delcie.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano różnicę tekstu.	Yes
sequence_number	liczba całkowita	Numer sekwencji dla tego zdarzenia.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.output_text.delta`. Możliwe wartości: `response.output_text.delta`	Yes

OpenAI.ResponseTextDoneEvent

Emitowane po sfinalizowaniu zawartości tekstowej.

Name	Typ	Description	Obowiązkowy
content_index	liczba całkowita	Indeks części zawartości, w której treść tekstowa jest sfinalizowana.	Yes
item_id	ciąg	Identyfikator elementu wyjściowego, którego zawartość tekstowa jest finalizowana.	Yes
logprobs	tablica biblioteki OpenAI.ResponseLogProb	Prawdopodobieństwo dziennika tokenów w delcie.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, którego treść tekstowa jest sfinalizowana.	Yes
sequence_number	liczba całkowita	Numer sekwencji dla tego zdarzenia.	Yes
SMS	ciąg	Zawartość tekstowa, która jest sfinalizowana.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.output_text.done`. Możliwe wartości: `response.output_text.done`	Yes

OpenAI.ResponseTextParam

Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą. Więcej informacji:

Wejścia i wyjścia tekstu
Dane wyjściowe ze strukturą

Name	Typ	Description	Obowiązkowy	Wartość domyślna
format	OpenAI.TextResponseFormatConfiguration	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie `{ "type": "json_schema" }` włącza dane wyjściowe o strukturze. zapewnia, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej na tej witrynie Domyślny format to `{ "type": "text" }` bez żadnych dodatkowych opcji. Niezalecane w przypadku modeli gpt-4o i nowszych: Ustawienie `{ "type": "json_object" }` włącza starszy tryb JSON, który gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Korzystanie z `json_schema` jest preferowany w przypadku modeli, które go obsługują.	Nie.
szczegółowość	OpenAI.Verbosity	Ogranicza szczegółowość odpowiedzi modelu. Niższe wartości spowodują bardziej zwięzłe odpowiedzi, podczas gdy wyższe wartości spowodują bardziej pełne odpowiedzi. Obecnie obsługiwane wartości to `low`, `medium`i `high`.	Nie.

OpenAI.ResponseUsage

Reprezentuje szczegóły użycia tokenu, w tym tokeny wejściowe, tokeny wyjściowe, podział tokenów wyjściowych i łączną liczbę użytych tokenów.

Name	Typ	Description	Obowiązkowy
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└cached_tokens	liczba całkowita		Yes
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ tokeny_rozumowania	liczba całkowita		Yes
total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Yes

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Obowiązkowy	Wartość domyślna
cached_tokens	liczba całkowita		Yes

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Obowiązkowy	Wartość domyślna
tokeny_rozumowania	liczba całkowita		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Uwaga: web_search nie jest jeszcze dostępna za pośrednictwem usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest skojarzone wywołanie wyszukiwania w Internecie.	Yes
sequence_number	liczba całkowita	Numer sekwencji przetwarzanego wywołania wyszukiwania internetowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.web_search_call.completed`. Możliwe wartości: `response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Uwaga: web_search nie jest jeszcze dostępna za pośrednictwem usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest skojarzone wywołanie wyszukiwania w Internecie.	Yes
sequence_number	liczba całkowita	Numer sekwencji przetwarzanego wywołania wyszukiwania internetowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.web_search_call.in_progress`. Możliwe wartości: `response.web_search_call.in_progress`	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Uwaga: web_search nie jest jeszcze dostępna za pośrednictwem usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Yes
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest skojarzone wywołanie wyszukiwania w Internecie.	Yes
sequence_number	liczba całkowita	Numer sekwencji przetwarzanego wywołania wyszukiwania internetowego.	Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.web_search_call.searching`. Możliwe wartości: `response.web_search_call.searching`	Yes

OpenAI.ScreenshotParam

Screenshot

Akcja zrzutu ekranu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji zrzutu ekranu ta właściwość jest zawsze ustawiona na `screenshot`. Możliwe wartości: `screenshot`	Yes	zrzut ekranu

OpenAI.ScrollParam

Scroll

Akcja przewijania.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
keys	tablica ciągów lub wartości null		Nie.
scroll_x	liczba całkowita	Odległość przewijania poziomego.	Yes
scroll_y	liczba całkowita	Odległość przewijania w pionie.	Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przewijania ta właściwość jest zawsze ustawiona na `scroll`. Możliwe wartości: `scroll`	Yes	Przewiń
x	liczba całkowita	Współrzędna x, w której wystąpiło przewijanie.	Yes
y	liczba całkowita	Współrzędna y, w której wystąpiło przewijanie.	Yes

OpenAI.SearchContentType

Property	Value
Type	ciąg
Wartości	`text` `image`

OpenAI.SearchContextSize

Property	Value
Type	ciąg
Wartości	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
skill_id	ciąg	ID wspomnianej umiejętności. Ograniczenia: minLength: 1, maxLength: 64	Yes
typ	wyliczenie	Odnosi się do umiejętności stworzonej za pomocą endpointu /v1/skills. Możliwe wartości: `skill_reference`	Yes	skill_reference
wersja	ciąg	Opcjonalna wersja umiejętności. Użyj dodatniej liczby całkowitej lub 'najnowszy'. Pomijam dla domyślności.	Nie.

OpenAI.SpecificApplyPatchParam

Wybór narzędzia do konkretnego zastosowania łatek

Wymusza wywołanie narzędzia apply_patch przez model podczas wykonywania wywołania narzędzia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Narzędzie do wywołania. Zawsze `apply_patch`. Możliwe wartości: `apply_patch`	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Wybór konkretnego narzędzia w obudowie

Wymusza wywołanie narzędzia powłoki przez model, gdy jest wymagane wywołanie narzędzia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Narzędzie do wywołania. Zawsze `shell`. Możliwe wartości: `shell`	Yes	powłoka

OpenAI.SummaryTextContent

Tekst podsumowujący

Tekst podsumowania z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Podsumowanie danych wyjściowych rozumowania z modelu do tej pory.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `summary_text`. Możliwe wartości: `summary_text`	Yes	summary_text

OpenAI.TextContent

Treść tekstowa

Zawartość tekstowa.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg		Yes
typ	wyliczenie	Możliwe wartości: `text`	Yes	SMS

OpenAI.TextResponseFormatConfiguration

Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, co zapewnia, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej na tej witrynie

Domyślny format to { "type": "text" } bez żadnych 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. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.

Dyskryminowanie dla elementu OpenAI.TextResponseFormatConfiguration

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Obiekt JSON

Format odpowiedzi obiektu JSON. Starsza metoda generowania odpowiedzi JSON. Użycie json_schema jest zalecane w przypadku modeli, które go obsługują. Należy pamiętać, że model nie wygeneruje kodu JSON bez komunikatu systemu lub użytkownika z instrukcjami, aby to zrobił.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze `json_object`. Możliwe wartości: `json_object`	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text (Tekst)

Domyślny format odpowiedzi. Służy do generowania odpowiedzi tekstowych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze `text`. Możliwe wartości: `text`	Yes

OpenAI.TextResponseFormatConfigurationType

Property	Value
Type	ciąg
Wartości	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Schemat JSON

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON.

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis tego, do czego służy format odpowiedzi, używany przez model do określ, jak reagować w ustalonym formacie.	Nie.
nazwa	ciąg	Nazwa formatu odpowiedzi. Musi być a-z, A-Z, 0-9 lub zawierać podkreślenia i kreski o maksymalnej długości 64.	Yes
schemat	OpenAI.ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON. Dowiedz się, jak tworzyć schematy JSON tutaj.	Yes
surowy	wartość logiczna lub null		Nie.
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze `json_schema`. Możliwe wartości: `json_schema`	Yes

OpenAI.Tool

Narzędzie, które może służyć do generowania odpowiedzi.

Dyskryminator dla OpenAI.Tool

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam
`computer`	OpenAI.ComputerTool
`namespace`	OpenAI.NamespaceToolParam
`tool_search`	OpenAI.ToolSearchToolParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Dozwolone narzędzia

Ogranicza narzędzia dostępne dla modelu do wstępnie zdefiniowanego zestawu.

Name	Typ	Description	Obowiązkowy
mode	wyliczenie	Ogranicza narzędzia dostępne dla modelu do wstępnie zdefiniowanego zestawu. `auto` umożliwia modelowi wybór spośród dozwolonych narzędzi i generowanie wiadomość. `required` wymaga, aby model wywoływać co najmniej jedno z dozwolonych narzędzi. Możliwe wartości: `auto`, `required`	Yes
Narzędzia	tablica obiektu	Lista definicji narzędzi, które powinny być dozwolone do wywołania modelu. W przypadku interfejsu API odpowiedzi lista definicji narzędzi może wyglądać następująco: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Yes
typ	wyliczenie	Dozwolony typ konfiguracji narzędzia. Zawsze `allowed_tools`. Możliwe wartości: `allowed_tools`	Yes

OpenAI.ToolChoiceCodeInterpreter

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `code_interpreter`	Yes

OpenAI.ToolChoiceComputer

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `computer`	Yes

OpenAI.ToolChoiceComputerUse

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `computer_use`	Yes

OpenAI.ToolChoiceComputerUsePreview

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `computer_use_preview`	Yes

OpenAI.ToolChoiceCustom

Narzędzie niestandardowe

Użyj tej opcji, aby wymusić wywołanie określonego narzędzia niestandardowego przez model.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nazwa	ciąg	Nazwa niestandardowego narzędzia do wywołania.	Yes
typ	wyliczenie	W przypadku wywoływania niestandardowych narzędzi typ to zawsze `custom`. Możliwe wartości: `custom`	Yes

OpenAI.ToolChoiceFileSearch

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `file_search`	Yes

OpenAI.ToolChoiceFunction

Narzędzie funkcji

Użyj tej opcji, aby wymusić wywołanie określonej funkcji przez model.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
typ	wyliczenie	W przypadku wywoływania funkcji typ to zawsze `function`. Możliwe wartości: `function`	Yes

OpenAI.ToolChoiceImageGeneration

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `image_generation`	Yes

OpenAI.ToolChoiceMCP

Narzędzie MCP

Użyj tej opcji, aby wymusić wywołanie określonego narzędzia na zdalnym serwerze MCP.

Name	Typ	Description	Obowiązkowy
nazwa	ciąg znaków lub null		Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP do użycia.	Yes
typ	wyliczenie	W przypadku narzędzi MCP typ to zawsze `mcp`. Możliwe wartości: `mcp`	Yes

OpenAI.ToolChoiceOptions

Tryb wyboru narzędzia

Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. none oznacza, że model nie wywoła żadnego narzędzia i zamiast tego generuje komunikat. auto oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem co najmniej jednego narzędzia. required oznacza, że model musi wywoływać co najmniej jedno narzędzie.

Property	Value
Type	ciąg
Wartości	`none` `auto` `required`

OpenAI.ToolChoiceParam

W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia, które może wywołać model.

Dyskryminujące dla openAI.ToolChoiceParam

Ten składnik używa właściwości type do rozróżniania różnych typów:

Typ wartości	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.ToolChoiceComputerUse
`function`	OpenAI.ToolChoiceFunction

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Property	Value
Type	ciąg
Wartości	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter` `computer` `computer_use`

OpenAI.ToolChoiceWebSearchPreview

Uwaga: web_search nie jest jeszcze dostępna za pośrednictwem usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `web_search_preview`	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `web_search_preview_2025_03_11`	Yes

OpenAI.ToolSearchExecutionType

Property	Value
Type	ciąg
Wartości	`server` `client`

OpenAI.ToolSearchToolParam

Narzędzie do wyszukiwania narzędzi

Konfiguracja wyszukiwania narzędzi hostowanych lub BYOT dla narzędzi odroczonych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
opis	ciąg znaków lub null		Nie.
wykonanie	OpenAI.ToolSearchExecutionType		Nie.
parameters	OpenAI.EmptyModelParam lub null		Nie.
typ	wyliczenie	Typ narzędzia. Zawsze `tool_search`. Możliwe wartości: `tool_search`	Yes	tool_search

OpenAI.ToolType

Property	Value
Type	ciąg
Wartości	`function` `file_search` `computer` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `namespace` `tool_search` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając tool_choice parametr . Obsługujemy następujące kategorie narzędzi:

Wbudowane narzędzia: Narzędzia udostępniane przez OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w sieci czy pliki. Dowiedz się więcej o wbudowanych narzędziach.
Narzędzia MCP: integracje z systemami innych firm za pośrednictwem niestandardowych serwerów MCP lub wstępnie zdefiniowanych łączników, takich jak Dysk Google i Program SharePoint. Dowiedz się więcej o narzędziach MCP.
Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika, umożliwiając modelowi wywoływanie własnego kodu za pomocą silnie typiowanych argumentów i danych wyjściowych. Dowiedz się więcej o wywoływaniu funkcji. Możesz również użyć narzędzi niestandardowych do wywołania własnego kodu.

Tablica: OpenAI.Tool

OpenAI.TopLogProb

Najwyższe prawdopodobieństwo logaryczne

Najwyższy logarytm prawdopodobieństwa tokenu.

Name	Typ	Obowiązkowy
bytes	tablica liczb całkowitych	Yes
logprob	number	Yes
kod przedpłaty	ciąg	Yes

OpenAI.TypeParam

Type

Akcja wpisywania tekstu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SMS	ciąg	Tekst do wpisania.	Yes
typ	wyliczenie	Określa typ zdarzenia. Dla akcji typu, ten atrybut jest zawsze ustawiony na `type`. Możliwe wartości: `type`	Yes	typ

OpenAI.UrlCitationBody

Cytowanie URL

Cytat dotyczący zasobu internetowego używanego do generowania odpowiedzi modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
end_index	liczba całkowita	Indeks ostatniego znaku cytatu adresu URL w komunikacie.	Yes
start_index	liczba całkowita	Indeks pierwszego znaku cytatu adresu URL w komunikacie.	Yes
title	ciąg	Tytuł zasobu internetowego.	Yes
typ	wyliczenie	Typ cytatu adresu URL. Zawsze `url_citation`. Możliwe wartości: `url_citation`	Yes	url_citation
url	string (identyfikator URI)	Adres URL zasobu internetowego.	Yes

OpenAI.VectorStoreFileAttributes

Typ: obiekt

OpenAI.Verbosity

Ogranicza szczegółowość odpowiedzi modelu. Niższe wartości spowodują bardziej zwięzłe odpowiedzi, a wyższe wartości spowodują bardziej pełne odpowiedzi. Obecnie obsługiwane wartości to low, mediumi high.

Property	Value
Opis	Ogranicza szczegółowość odpowiedzi modelu. Niższe wartości spowodują bardziej zwięzłe odpowiedzi, podczas gdy wyższe wartości spowodują bardziej pełne odpowiedzi. Obecnie obsługiwane wartości to `low`, `medium`i `high`.
Type	ciąg
Wartości	`low` `medium` `high`

OpenAI.WaitParam

Czekaj

Akcja oczekiwania.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji oczekiwania ta właściwość jest zawsze ustawiona na `wait`. Możliwe wartości: `wait`	Yes	wait

OpenAI.WebSearchActionFind

Znajdź akcję

Typ akcji "find_in_page": Wyszukuje wzór na załadowanej stronie.

Name	Typ	Description	Obowiązkowy
wzorzec	ciąg	Wzorzec lub tekst do wyszukania na stronie.	Yes
typ	wyliczenie	Typ akcji. Możliwe wartości: `find_in_page`	Yes
url	string (identyfikator URI)	Adres URL strony, na której wyszukiwano wzorzec.	Yes

OpenAI.WebSearchActionOpenPage

Akcja otwierania strony

Typ akcji "open_page" — otwiera określony adres URL z wyników wyszukiwania.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ akcji. Możliwe wartości: `open_page`	Yes
url	ciąg znaków lub null	Adres URL otwarty przez model.	Nie.

OpenAI.WebSearchActionSearch

Akcja wyszukiwania

Typ akcji "search" — wykonuje zapytanie wyszukiwania w Internecie.

Name	Typ	Description	Obowiązkowy
queries	tablica ciągów	Zapytania wyszukiwania.	Nie.
kwerenda	ciąg (przestarzałe)	[PRZESTARZAŁE] Zapytanie wyszukiwania.	Yes
Źródeł	tablica obiektów OpenAI.WebSearchActionSearchSources	Źródła używane w wyszukiwaniu.	Nie.
typ	wyliczenie	Typ akcji. Możliwe wartości: `search`	Yes

OpenAI.WebSearchActionSearchSources

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Możliwe wartości: `url`	Yes
url	string (identyfikator URI)		Yes

OpenAI.WebSearchApproximateLocation

Wyszukiwanie w sieci – przybliżona lokalizacja

Przybliżona lokalizacja użytkownika.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Miasta	ciąg znaków lub null		Nie.
kraj	ciąg znaków lub null		Nie.
region	ciąg znaków lub null		Nie.
timezone	ciąg znaków lub null		Nie.
typ	wyliczenie	Typ przybliżenia lokalizacji. Zawsze `approximate`. Możliwe wartości: `approximate`	Yes	Przybliżony

OpenAI.WebSearchPreviewTool

Podgląd wyszukiwania w sieci

Uwaga: web_search nie jest jeszcze dostępna za pośrednictwem usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
search_content_types	array OpenAI.SearchContentType		Nie.
rozmiar_kontekstu_wyszukiwania	OpenAI.SearchContextSize		Nie.
typ	wyliczenie	Typ narzędzia wyszukiwania w Internecie. Jeden z `web_search_preview` lub `web_search_preview_2025_03_11`. Możliwe wartości: `web_search_preview`	Yes	web_search_preview
lokalizacja_użytkownika	OpenAI.ApproximateLocation lub null		Nie.

OpenAI.WebSearchTool

Wyszukiwanie w Internecie

Uwaga: web_search nie jest jeszcze dostępna za pośrednictwem usługi Azure OpenAI.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
filters	OpenAI.WebSearchToolFilters lub null		Nie.
rozmiar_kontekstu_wyszukiwania	wyliczenie	Ogólne wskazówki dotyczące ilości miejsca w oknie kontekstowym do użycia w wyszukiwaniu. `low`Jeden z , `medium`lub `high`. Wartość domyślna to `medium`. Możliwe wartości: `low`, , `mediumhigh`	Nie.	nośnik
typ	wyliczenie	Typ narzędzia wyszukiwania w Internecie. Jeden z `web_search` lub `web_search_2025_08_26`. Możliwe wartości: `web_search`	Yes	wyszukiwanie w sieci
lokalizacja_użytkownika	OpenAI.WebSearchApproximateLocation lub null		Nie.

OpenAI.WebSearchToolFilters

Name	Typ	Description	Obowiązkowy	Wartość domyślna
allowed_domains	tablica ciągów lub wartości null		Nie.

Last updated on 2026-07-10