Microsoft Foundry

Wersja interfejsu API: wersja 1

Authentication

Przepływ: niejawny

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

Zakresów:

https://ai.azure.com/.default

Agents

Agenci — tworzenie agenta

POST {endpoint}/agents?api-version=v1

Tworzy agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
definicja	AgentDefinition		Yes
Rodzaj └*	AgentKind		Yes
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Unikatowa nazwa identyfikująca agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. - Musi rozpoczynać się i kończyć znakiem alfanumerycznym, - Może zawierać łączniki w środku - Nie może przekraczać 63 znaków. Ograniczenia: maxLength: 63	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — lista agentów

GET {endpoint}/agents?api-version=v1

Zwraca listę wszystkich agentów.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
rodzaj	kwerenda	Nie.	ciąg Możliwe wartości: `prompt`, , `hosted`, `container_appworkflow`	Filtruj agentów według rodzaju. Jeśli nie zostanie podana, zostaną zwróconi wszyscy agenci.
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — uzyskiwanie agenta

GET {endpoint}/agents/{agent_name}?api-version=v1

Pobiera agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — aktualizowanie agenta

POST {endpoint}/agents/{agent_name}?api-version=v1

Aktualizuje agenta, dodając nową wersję, jeśli nastąpią jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
definicja	AgentDefinition		Yes
Rodzaj └*	AgentKind		Yes
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — usuwanie agenta

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Usuwa agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do usunięcia.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DeleteAgentResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — aktualizowanie agenta z manifestu

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Aktualizuje agenta z manifestu, dodając nową wersję, jeśli istnieją jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do zaktualizowania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Yes
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — tworzenie wersji agenta

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Utwórz nową wersję agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Unikatowa nazwa identyfikująca agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. - Musi rozpoczynać się i kończyć znakiem alfanumerycznym, - Może zawierać łączniki w środku - Nie może przekraczać 63 znaków.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
definicja	AgentDefinition		Yes
Rodzaj └*	AgentKind		Yes
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentVersionObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — wyświetlanie listy wersji agentów

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Zwraca listę wersji agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do pobrania wersji programu .
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — uzyskiwanie wersji agenta

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Pobiera określoną wersję agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do pobrania.
agent_version	ścieżka	Yes	ciąg	Wersja agenta do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentVersionObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — usuwanie wersji agenta

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Usuwa określoną wersję agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta do usunięcia.
agent_version	ścieżka	Yes	ciąg	Wersja agenta do usunięcia
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DeleteAgentVersionResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — tworzenie wersji agenta na podstawie manifestu

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Utwórz nową wersję agenta na podstawie manifestu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Unikatowa nazwa identyfikująca agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. - Musi rozpoczynać się i kończyć znakiem alfanumerycznym, - Może zawierać łączniki w środku - Nie może przekraczać 63 znaków.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Yes
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentVersionObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Agenci — tworzenie agenta na podstawie manifestu

POST {endpoint}/agents:import?api-version=v1

Tworzy agenta na podstawie manifestu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Yes
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Unikatowa nazwa identyfikująca agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. - Musi rozpoczynać się i kończyć znakiem alfanumerycznym, - Może zawierać łączniki w środku - Nie może przekraczać 63 znaków. Ograniczenia: maxLength: 63	Yes
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów

Kontenery agentów — wyświetlanie listy operacji kontenera agenta

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Wyświetlanie listy operacji kontenera dla agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — pobieranie operacji kontenera agenta

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Uzyskaj stan operacji kontenera dla agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
operation_id	ścieżka	Yes	ciąg	Identyfikator operacji.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentContainerOperationObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — pobieranie kontenera agenta

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Pobierz kontener dla określonej wersji agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AgentContainerObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — wyświetlanie listy operacji kontenera wersji agenta

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Wyświetlanie listy operacji kontenera dla określonej wersji agenta.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — usuwanie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Usuń kontener dla określonej wersji agenta. Jeśli kontener nie istnieje, operacja będzie no-op. Operacja jest długotrwałą operacją. Zgodnie z wytycznymi projektowymi dotyczącymi długotrwałych operacji w interfejsach API REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 202

Opis: Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Typ zawartości	Type	Opis
application/json	AgentContainerOperationObject

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
Lokalizacja operacji	ciąg

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — dzienniki kontenera agenta strumienia

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Wpis dziennika kontenera przesyłany strumieniowo z kontenera jako fragmenty tekstu. Każdy fragment jest ciągiem UTF-8, który może być wierszem dziennika zwykłego tekstu lub wpisem dziennika sformatowanym w formacie JSON, w zależności od typu przesyłanego strumieniowo dziennika kontenera. Klienci powinni traktować każdy fragment jako nieprzezroczystym tekstem i w razie potrzeby próbować przeanalizować go w formacie JSON w oparciu o wymagania dotyczące rejestrowania.

W przypadku dzienników systemowych, format to JSON o następującej strukturze: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName"::null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Pomyślnie nawiązano połączenie ze zdarzeniami server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

W przypadku dzienników konsoli format jest zwykłym tekstem emitowanym przez stdout/stderr kontenera. 2025-12-15T08:43:48.72656 Trwa łączenie z kontenerem "agent-container"... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
rodzaj	kwerenda	Nie.	ciąg Możliwe wartości: `console`, `system`	konsola zwraca strumień zdarzeń kontenera stdout/stderr, system zwraca strumień zdarzeń aplikacji kontenera. wartość domyślna konsoli
replica_name	kwerenda	Nie.	ciąg	Po pominięciu serwer wybiera pierwszą replikę logów konsoli. Wymagane do kierowania na określoną replikę.
końcowa część	kwerenda	Nie.	liczba całkowita	Liczba zwracanych końcowych wierszy. Wymuszone do 1–300. Wartość domyślna to 20
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — uruchamianie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Uruchom kontener dla określonej wersji agenta. Jeśli kontener już działa, operacja będzie no-op. Operacja jest długotrwałą operacją. Zgodnie z wytycznymi projektowymi dotyczącymi długotrwałych operacji w interfejsach API REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
max_replicas	liczba całkowita	Maksymalna liczba replik. Wartość domyślna to 1.	Nie.	1
min_replicas	liczba całkowita	Minimalna liczba replik. Wartość domyślna to 1.	Nie.	1

Responses

Kod stanu: 202

Opis: Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Typ zawartości	Type	Opis
application/json	AgentContainerOperationObject

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
Lokalizacja operacji	ciąg

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — zatrzymywanie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Zatrzymaj kontener dla określonej wersji agenta. Jeśli kontener nie działa lub został już zatrzymany, operacja będzie no-op. Operacja jest długotrwałą operacją. Zgodnie z wytycznymi projektowymi dotyczącymi długotrwałych operacji w interfejsach API REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 202

Opis: Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Typ zawartości	Type	Opis
application/json	AgentContainerOperationObject

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
Lokalizacja operacji	ciąg

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kontenery agentów — aktualizowanie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Aktualizowanie kontenera dla określonej wersji agenta. Jeśli kontener nie działa, operacja będzie no-op. Operacja jest długotrwałą operacją. Zgodnie z wytycznymi projektowymi dotyczącymi długotrwałych operacji w interfejsach API REST Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	ścieżka	Yes	ciąg	Nazwa agenta.
agent_version	ścieżka	Yes	ciąg	Wersja agenta.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `ContainerAgents=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
max_replicas	liczba całkowita	Maksymalna liczba replik.	Nie.
min_replicas	liczba całkowita	Minimalna liczba replik.	Nie.

Responses

Kod stanu: 202

Opis: Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Typ zawartości	Type	Opis
application/json	AgentContainerOperationObject

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
Lokalizacja operacji	ciąg

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Connections

Połączenia — lista

GET {endpoint}/connections?api-version=v1

Wyświetlanie listy wszystkich połączeń w projekcie bez wypełniania poświadczeń połączenia

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ połączenia	kwerenda	Nie.	ciąg Możliwe wartości: `AzureOpenAI`, `AzureBlob`, `AzureStorageAccount`, `CognitiveSearch`, `CosmosDB`, `ApiKey`, `AppConfig`, `AppInsights`, `CustomKeys`, `RemoteTool_Preview`	Wyświetlanie listy połączeń tego określonego typu
defaultConnection	kwerenda	Nie.	boolean	Wyświetlanie listy połączeń, które są połączeniami domyślnymi

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
x-ms-client-request-id	Nieprawda	ciąg	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedConnection

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-client-request-id		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Połączenia — pobierz

GET {endpoint}/connections/{name}?api-version=v1

Uzyskiwanie połączenia według nazwy bez wypełniania poświadczeń połączenia

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Przyjazna nazwa połączenia podana przez użytkownika.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
x-ms-client-request-id	Nieprawda	ciąg	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Connection

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-client-request-id		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Połączenia — pobieranie przy użyciu poświadczeń

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Uzyskiwanie połączenia według nazwy z poświadczeniami połączenia

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Przyjazna nazwa połączenia podana przez użytkownika.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
x-ms-client-request-id	Nieprawda	ciąg	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Connection

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-client-request-id		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Datasets

Zestawy danych — lista najnowszych

GET {endpoint}/datasets?api-version=v1

Wyświetlanie listy najnowszej wersji każdego elementu DatasetVersion

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedDatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Zestawy danych — wersje listy

GET {endpoint}/datasets/{name}/versions?api-version=v1

Wyświetlanie listy wszystkich wersji danego elementu DatasetVersion

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedDatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Zestawy danych — pobieranie wersji

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Pobierz określoną wersję parametru DatasetVersion. Usługa zwraca błąd 404 Nie znaleziono, jeśli element DatasetVersion nie istnieje.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji elementu DatasetVersion do pobrania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Zestawy danych — usuwanie wersji

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Usuń określoną wersję elementu DatasetVersion. Usługa zwraca wartość 204 Brak zawartości, jeśli element DatasetVersion został pomyślnie usunięty lub jeśli element DatasetVersion nie istnieje.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Wersja elementu DatasetVersion do usunięcia.

Responses

Kod stanu: 204

Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Zestawy danych — tworzenie lub aktualizowanie wersji

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Tworzenie nowego lub aktualizowanie istniejącego elementu DatasetVersion przy użyciu podanego identyfikatora wersji

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji elementu DatasetVersion do utworzenia lub zaktualizowania.

Treść żądania

Typ treści: application/merge-patch+json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	Typ zestawu danych	Wyliczenie w celu określenia typu danych.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DatasetVersion

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	DatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Zestawy danych — uzyskiwanie poświadczeń

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Uzyskaj poświadczenia sygnatury dostępu współdzielonego, aby uzyskać dostęp do konta magazynu skojarzonego z wersją zestawu danych.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji elementu DatasetVersion do działania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	AssetCredentialResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Zestawy danych — rozpoczynanie oczekiwania na przekazanie wersji

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Rozpocznij nową lub uzyskaj istniejącą oczekującą na przekazanie zestawu danych dla określonej wersji.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji elementu DatasetVersion do działania.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
Connectionname	ciąg	Nazwa połączenia konta usługi Azure Storage do użycia do generowania tymczasowego tokenu SAS	Nie.
pendingUploadId	ciąg	Jeśli PendingUploadId nie zostanie podany, zostanie użyty losowy identyfikator GUID.	Nie.
pendingUploadType	wyliczenie	Funkcja BlobReference jest jedynym obsługiwanym typem. Możliwe wartości: `BlobReference`	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PendingUploadResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Wdrożenia

Wdrożenia — lista

GET {endpoint}/deployments?api-version=v1

Wyświetlanie listy wszystkich wdrożonych modeli w projekcie

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
modelPublisher	kwerenda	Nie.	ciąg	Wydawca modelu do filtrowania modeli według
modelName	kwerenda	Nie.	ciąg	Nazwa modelu (nazwa specyficzna dla wydawcy) do filtrowania modeli według
deploymentType	kwerenda	Nie.	ciąg Możliwe wartości: `ModelDeployment`	Typ wdrożenia do filtrowania listy według

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
x-ms-client-request-id	Nieprawda	ciąg	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedDeployment

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-client-request-id		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Wdrożenia — pobieranie

GET {endpoint}/deployments/{name}?api-version=v1

Pobierz wdrożony model.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa wdrożenia

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
x-ms-client-request-id	Nieprawda	ciąg	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Wdrożenie

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-client-request-id		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Taksonomie ewaluacyjne

Taksonomie oceny — lista

GET {endpoint}/evaluationtaxonomies?api-version=v1

Lista taksonomii oceny

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
inputName	kwerenda	Nie.	ciąg	Filtruj według nazwy wejściowej oceny.
inputType	kwerenda	Nie.	ciąg	Filtruj według typu danych wejściowych taksonomii.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedEvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Taksonomie oceny — pobierz

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Pobierz przebieg oceny według nazwy.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Taksonomie oceny — usuwanie

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Usuń taksonomię oceny według nazwy.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 204

Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Taksonomie oceny — tworzenie

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Utwórz taksonomię oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa taksonomii oceny.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
properties	obiekt	Dodatkowe właściwości taksonomii oceny.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
taksonomiaKategorie	tablica taksonomiiKategory	Lista kategorii taksonomii.	Nie.
taksonomiaInput	EvaluationTaxonomyInput	Konfiguracja danych wejściowych dla taksonomii oceny.	Yes
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluationTaxonomy

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	EvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Taksonomie oceny — aktualizacja

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Aktualizowanie taksonomii ewaluacyjnej.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa taksonomii oceny.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
properties	obiekt	Dodatkowe właściwości taksonomii oceny.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
taksonomiaKategorie	tablica taksonomiiKategory	Lista kategorii taksonomii.	Nie.
taksonomiaInput	EvaluationTaxonomyInputUpdate	Konfiguracja danych wejściowych dla taksonomii oceny.	Nie.
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Reguły oceny

Reguły oceny — lista

GET {endpoint}/evaluationrules?api-version=v1

Wyświetl listę wszystkich reguł oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
actionType	kwerenda	Nie.	ciąg Możliwe wartości: `continuousEvaluation`, `humanEvaluationPreview`	Filtruj według typu reguły oceny.
agentName	kwerenda	Nie.	ciąg	Filtruj według nazwy agenta.
enabled	kwerenda	Nie.	boolean	Filtruj według stanu włączonego.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedEvaluationRule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Reguły oceny — pobieranie

GET {endpoint}/evaluationrules/{id}?api-version=v1

Uzyskaj regułę oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Unikatowy identyfikator reguły oceny.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluationRule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Reguły oceny — usuwanie

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Usuń regułę oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Unikatowy identyfikator reguły oceny.

Responses

Kod stanu: 204

Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Reguły oceny — tworzenie lub aktualizowanie

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Utwórz lub zaktualizuj regułę oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Unikatowy identyfikator reguły oceny.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	Nieprawda	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
akcja	EvaluationRuleAction	Model działania ewaluacyjnego.	Yes
└typ	EvaluationRuleActionType	Rodzaj działania w ramach oceny.	Yes
opis	ciąg	Opis reguły oceny.	Nie.
displayName	ciąg	Nazwa wyświetlana reguły oceny.	Nie.
enabled	boolean	Wskazuje, czy reguła oceny jest włączona. Wartość domyślna to true.	Yes
eventType	EvaluationRuleEventType	Typ zdarzenia reguły oceny.	Yes
filtr	EvaluationRuleFilter	Model filtru oceny.	Nie.
└} agentName	ciąg	Filtruj według nazwy agenta.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator reguły oceny.	Yes
daneSystemowe	obiekt (tylko do odczytu)	Metadane systemu dla reguły oceny.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluationRule

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	EvaluationRule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Ewaluatorzy

Ewaluatory — lista najnowszych wersji

GET {endpoint}/evaluators?api-version=v1

Lista najnowszych wersji każdego ewaluatora

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ	kwerenda	Nie.	ciąg Możliwe wartości: `builtin`, , `customall`	Filtruj ewaluatory według typu. Możliwe wartości: "all", "custom", "builtin".
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedEvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Ewaluatory — wersje listy

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Lista wszystkich wersji danego ewaluatora

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
typ	kwerenda	Nie.	ciąg Możliwe wartości: `builtin`, , `customall`	Filtruj ewaluatory według typu. Możliwe wartości: "all", "custom", "builtin".
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedEvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Ewaluatory — tworzenie wersji

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Utwórz nową wersję EvaluatorVersion z automatycznie zwiększanym identyfikatorem wersji

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
categories	tablica EwaluatorCategory	Kategorie osoby oceniającej	Yes
definicja	EwaluatorDefinition	Podstawowa konfiguracja ewaluatora z dyskryminatorem	Yes
└data_schema	obiekt	Schemat JSON (wersja robocza 2020-12) dla danych wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
└init_parameters	obiekt	Schemat JSON (wersja robocza 2020-12) dla parametrów wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
Metryki └*	obiekt	Lista wskaźników wyjściowych opracowanych przez tego ewaluatora	Nie.
└typ	EwaluatorDefinitionType	Definicja rodzaju osoby ewaluującej	Yes
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Łatwiej jest znaleźć ewaluatora w AI Foundry. Nie musi być unikalny.	Nie.
evaluator_type	Typ ewaluatora	Rodzaj osoby oceniającej	Yes
metadane	obiekt	Metadane dotyczące osoby oceniającej	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.

Responses

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	EvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Ewaluatory — pobieranie wersji

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Pobierz konkretną wersję EvaluatorVersion. Usługa zwraca błąd 404 Nie znaleziono, jeśli EvaluatorVersion nie istnieje.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji ewaluatorVersion do pobrania.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Ewaluatory — usuwanie wersji

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Usuń określoną wersję EvaluatorVersion. Usługa zwraca wartość 204 No Content, jeśli element EvaluatorVersion został pomyślnie usunięty lub jeśli element EvaluatorVersion nie istnieje.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Wersja ewaluatorVersion do usunięcia.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 204

Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Ewaluatorzy — wersja aktualizacji

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Zaktualizuj istniejącą wersję EvaluatorVersion przy użyciu podanego identyfikatora wersji

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Wersja ewaluatorVersion do aktualizacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Evaluations=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
categories	tablica EwaluatorCategory	Kategorie osoby oceniającej	Nie.
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Łatwiej jest znaleźć ewaluatora w AI Foundry. Nie musi być unikalny.	Nie.
metadane	obiekt	Metadane dotyczące osoby oceniającej	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Indexes

Indeksy — najnowsza lista

GET {endpoint}/indexes?api-version=v1

Wyświetlanie listy najnowszej wersji każdego indeksu

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedIndex

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Indeksy — wersje listy

GET {endpoint}/indexes/{name}/versions?api-version=v1

Wyświetl listę wszystkich wersji danego indeksu

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedIndex

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Indeksy — pobieranie wersji

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Pobierz określoną wersję indeksu. Usługa zwraca błąd 404 Nie znaleziono, jeśli indeks nie istnieje.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji indeksu do pobrania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Indeks

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Indeksy — usuwanie wersji

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Usuń określoną wersję indeksu. Usługa zwraca wartość 204 Brak zawartości, jeśli indeks został pomyślnie usunięty lub indeks nie istnieje.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Wersja indeksu do usunięcia.

Responses

Kod stanu: 204

Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Indeksy — tworzenie lub aktualizowanie wersji

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Tworzenie nowego lub aktualizowanie istniejącego indeksu przy użyciu podanego identyfikatora wersji

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Nazwa zasobu
wersja	ścieżka	Yes	ciąg	Określony identyfikator wersji indeksu do utworzenia lub zaktualizowania.

Treść żądania

Typ treści: application/merge-patch+json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	Typ indeksu		Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Indeks

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	Indeks

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Insights

Szczegółowe informacje — generowanie

POST {endpoint}/insights?api-version=v1

Generowanie szczegółowych informacji

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Insights=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.
Powtarzalność —Request-ID	Nieprawda	ciąg	Unikatowy, wygenerowany przez klienta identyfikator zapewniający idempotentność żądania. Użyj tego samego identyfikatora dla ponownych prób, aby zapobiec zduplikowanym ocenom.
Powtarzalność —First-Sent	Nieprawda	ciąg	Sygnatura czasowa wskazująca, kiedy to żądanie zostało zainicjowane po raz pierwszy. Używany w połączeniu z repeatability-request-id do kontroli idempotentności.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
displayName	ciąg	Przyjazna dla użytkownika nazwa wyświetlana szczegółowych informacji.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator raportu szczegółowych informacji.	Yes
metadane	InsightsMetadata (tylko do odczytu)	Metadane dotyczące szczegółowych informacji.	Yes
└* completedAt	ciąg	Sygnatura czasowa ukończenia szczegółowych informacji.	Nie.
└} createdAt	ciąg	Sygnatura czasowa utworzenia szczegółowych informacji.	Yes
żądanie	InsightRequest	Żądanie raportu szczegółowych informacji.	Yes
└typ	InsightType	Typ żądania.	Yes
result	InsightResult (tylko do odczytu)	Wynik spostrzeżeń.	Nie.
└typ	InsightType	Typ wyniku szczegółowych informacji.	Yes
stan	Azure. Core.Foundations.OperationState (tylko do odczytu)	Wyliczenie opisujące dozwolone stany operacji.	Yes

Responses

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	Wgląd

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Szczegółowe informacje — lista

GET {endpoint}/insights?api-version=v1

Wyświetl wszystkie szczegółowe informacje w odwrotnej kolejności chronologicznej (najnowsza pierwsza).

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ	kwerenda	Nie.	ciąg Możliwe wartości: `EvaluationRunClusterInsight`, , `AgentClusterInsightEvaluationComparison`	Filtrowanie według typu analizy.
evalId	kwerenda	Nie.	ciąg	Filtrowanie według identyfikatora oceny.
identyfikator uruchomienia	kwerenda	Nie.	ciąg	Filtrowanie według identyfikatora przebiegu oceny.
agentName	kwerenda	Nie.	ciąg	Filtruj według nazwy agenta.
includeCoordinates	kwerenda	Nie.	boolean	Określa, czy w odpowiedzi mają być uwzględniane współrzędne wizualizacji. Wartość domyślna to fałsz.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Insights=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedInsight

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Szczegółowe informacje — uzyskiwanie

GET {endpoint}/insights/{id}?api-version=v1

Uzyskaj szczegółowe informacje według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Unikatowy identyfikator raportu szczegółowych informacji.
includeCoordinates	kwerenda	Nie.	boolean	Określa, czy w odpowiedzi mają być uwzględniane współrzędne wizualizacji. Wartość domyślna to fałsz.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Insights=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Wgląd

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Magazyny pamięci

Tworzenie magazynu pamięci

POST {endpoint}/memory_stores?api-version=v1

Utwórz magazyn pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
definicja	MemoryStoreDefinition	Podstawowa definicja konfiguracji magazynu pamięci.	Yes
Rodzaj └*	MemoryStoreKind	Rodzaj magazynu pamięci.	Yes
opis	ciąg	Czytelny dla człowieka opis magazynu pamięci. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	Dowolne metadane klucz-wartość do skojarzenia z magazynem pamięci.	Nie.
nazwa	ciąg	Nazwa magazynu pamięci. Ograniczenia: maxLength: 256	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	MemoryStoreObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Lista magazynów pamięci

GET {endpoint}/memory_stores?api-version=v1

Wyświetla listę wszystkich magazynów pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Aktualizowanie magazynu pamięci

POST {endpoint}/memory_stores/{name}?api-version=v1

Aktualizowanie magazynu pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci do zaktualizowania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
opis	ciąg	Czytelny dla człowieka opis magazynu pamięci. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	Dowolne metadane klucz-wartość do skojarzenia z magazynem pamięci.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	MemoryStoreObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Pobieranie magazynu pamięci

GET {endpoint}/memory_stores/{name}?api-version=v1

Pobieranie magazynu pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	MemoryStoreObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Usuwanie magazynu pamięci

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Usuń magazyn pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci do usunięcia.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DeleteMemoryStoreResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Pobieranie wyniku aktualizacji

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Pobierz wynik aktualizacji magazynu pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci.
update_id	ścieżka	Yes	ciąg	Identyfikator operacji aktualizacji pamięci.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	MemoryStoreUpdateResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Usuwanie wspomnień zakresu

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Usuń wszystkie wspomnienia skojarzone z określonym zakresem z magazynu pamięci.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje pamięci do usunięcia, na przykład identyfikator użytkownika.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	MemoryStoreDeleteScopeResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyszukiwanie wspomnień

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Wyszukaj odpowiednie wspomnienia z magazynu wspomnień na podstawie kontekstu rozmowy.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci do wyszukania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
items	tablica openAI.InputItem	Elementy, dla których należy wyszukać odpowiednie wspomnienia.	Nie.
options	MemorySearchOptions	Opcje wyszukiwania w pamięci.	Nie.
└max_memories	liczba całkowita	Maksymalna liczba elementów pamięci do zwrócenia.	Nie.
previous_search_id	ciąg	Unikatowy identyfikator poprzedniego żądania wyszukiwania, umożliwiający przyrostowe wyszukiwanie pamięci, z którego została przerwana ostatnia operacja.	Nie.
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	MemoryStoreSearchResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Aktualizowanie pamięci

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Zaktualizuj magazyn pamięci o wspomnienia z rozmów.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nazwa	ścieżka	Yes	ciąg	Nazwa magazynu pamięci do zaktualizowania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `MemoryStores=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
items	tablica openAI.InputItem	Elementy konwersacji, z których mają być wyodrębnione wspomnienia.	Nie.
previous_update_id	ciąg	Unikatowy identyfikator poprzedniego żądania aktualizacji, włączając aktualizacje pamięci przyrostowej, z których ostatnia operacja została przerwana.	Nie.
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes
update_delay	liczba całkowita	Limit czasu przed przetworzeniem aktualizacji pamięci w sekundach. Jeśli w tym okresie zostanie odebrane nowe żądanie aktualizacji, anuluje bieżące żądanie i zresetuje limit czasu. Ustaw wartość 0, aby natychmiast wyzwolić aktualizację bez opóźnień. Wartość domyślna to 300 (5 minut).	Nie.	300

Responses

Kod stanu: 202

Opis: Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone.

Typ zawartości	Type	Opis
application/json	MemoryStoreUpdateResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
Lokalizacja operacji	ciąg	Lokalizacja monitorowania stanu operacji.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Rozmowy

Tworzenie konwersacji

POST {endpoint}/openai/v1/conversations

Utwórz konwersację.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
items	tablica openAI.InputItem		Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyświetlanie listy konwersacji

GET {endpoint}/openai/v1/conversations

Zwraca listę wszystkich konwersacji.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
agent_name	kwerenda	Nie.	ciąg	Filtruj według nazwy agenta. Jeśli zostanie podana, zostaną zwrócone tylko elementy skojarzone z określonym agentem.
Agent_id	kwerenda	Nie.	ciąg	Filtruj według identyfikatora agenta w formacie `name:version`. Jeśli zostanie podana, zostaną zwrócone tylko elementy skojarzone z określonym identyfikatorem agenta.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Aktualizowanie konwersacji

POST {endpoint}/openai/v1/conversations/{conversation_id}

Aktualizowanie konwersacji.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji do zaktualizowania.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Yes

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Uzyskiwanie konwersacji

GET {endpoint}/openai/v1/conversations/{conversation_id}

Pobiera konwersację.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji do pobrania.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Usuwanie konwersacji

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Usuwa konwersację.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji do usunięcia.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Tworzenie elementów konwersacji

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Utwórz elementy w konwersacji z danym identyfikatorem.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji, na której należy utworzyć element.
Obejmują	kwerenda	Nie.	macierz	Dodatkowe pola do uwzględnienia w odpowiedzi. `include` Aby uzyskać więcej informacji, zobacz parametr zawierający listę elementów konwersacji.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
items	tablica elementów OpenAI.Item	Elementy do dodania do konwersacji. Jednocześnie możesz dodać maksymalnie 20 elementów.	Yes

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyświetlanie listy elementów konwersacji

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Wyświetl listę wszystkich elementów konwersacji z danym identyfikatorem.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji, na której należy wymienić elementy.
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
item_type	kwerenda	Nie.	ciąg Możliwe wartości: `message`, `output_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action`	Filtruj według typu elementu. Jeśli zostanie podana, zostaną zwrócone tylko elementy określonego typu.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Pobieranie elementu konwersacji

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Pobierz pojedynczy element z konwersacji z podanymi identyfikatorami.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji zawierającej element.
item_id	ścieżka	Yes	ciąg	Identyfikator elementu konwersacji do pobrania.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Usuwanie elementu konwersacji

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Usuń element z konwersacji z podanymi identyfikatorami.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	ścieżka	Yes	ciąg	Identyfikator konwersacji, z której należy usunąć element.
item_id	ścieżka	Yes	ciąg	Identyfikator elementu konwersacji do usunięcia.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals

Evals — evals listy

GET {endpoint}/openai/v1/evals

Wyświetl listę wszystkich ocen Lista ocen dla projektu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Po	kwerenda	Nie.	ciąg	Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba przebiegów do pobrania.
porządek	kwerenda	Nie.	ciąg Możliwe wartości: `asc`, `desc`	Kolejność sortowania przebiegów według znacznika czasu. Użyj `asc` dla kolejności rosnącej lub `desc` dla kolejności malejącej. Wartość domyślna to `asc`.
sortowanie_według	kwerenda	Nie.	ciąg Możliwe wartości: `created_at`, `updated_at`	Oceny mogą być uporządkowane według czasu utworzenia lub czasu ostatniej aktualizacji. Użyj `created_at` dla czasu utworzenia lub `updated_at` dla czasu ostatniej aktualizacji.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — tworzenie eval

POST {endpoint}/openai/v1/evals

Utwórz ocenę Utwórz strukturę oceny, która może służyć do testowania wydajności modelu. Ocena to zestaw kryteriów testowania i konfiguracja źródła danych, która określa schemat danych używanych w ocenie. Po utworzeniu oceny można uruchomić go na różnych modelach i parametrach modelu. Obsługujemy kilka typów klasyrów i źródeł danych. Aby uzyskać więcej informacji, zobacz

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
konfiguracja źródła danych	OpenAI.CreateEvalCustomDataSourceConfig lub OpenAI.CreateEvalLogsDataSourceConfig lub OpenAI.CreateEvalStoredCompletionsDataSourceConfig lub AzureAIDataSourceConfig	Konfiguracja źródła danych używanego do uruchamiania oceny. Określa schemat danych używanych w ocenie.	Yes
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Nazwa oceny.	Nie.
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.
kryteria_testowe	tablica elementów OpenAI.EvalGraderLabelModel lub OpenAI.EvalGraderStringCheck lub OpenAI.EvalGraderTextSimilarity lub OpenAI.EvalGraderPython lub OpenAI.EvalGraderScoreModel lub EvalGraderAzureAIEvaluator	Lista osób oceniających dla wszystkich przebiegów oceny w tej grupie. Klasyfikatory mogą odwoływać się do zmiennych w źródle danych przy użyciu notacji podwójnych nawiasów klamrowych, takich jak `{{item.variable_name}}`. Aby odwołać się do danych wyjściowych modelu, użyj `sample` przestrzeni nazw (tj. `{{sample.output_text}}`).	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Eval

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — usuwanie eval

DELETE {endpoint}/openai/v1/evals/{eval_id}

Usuń ocenę Usuń ocenę.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny do usunięcia.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DeleteEvalResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Oceny – zrób ocenę

GET {endpoint}/openai/v1/evals/{eval_id}

Uzyskaj ocenę Pobierz ocenę według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny do odzyskania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Eval

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — eval aktualizacji

POST {endpoint}/openai/v1/evals/{eval_id}

Zaktualizuj ocenę Zaktualizuj niektóre właściwości oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny do zaktualizowania.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg		Nie.
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Eval

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — uruchomienia listy

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Pobierz listę przebiegów oceny Pobierz listę przebiegów do oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny, dla której mają zostać pobrane przebiegi.
Po	kwerenda	Nie.	ciąg	Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba przebiegów do pobrania.
porządek	kwerenda	Nie.	ciąg Możliwe wartości: `asc`, `desc`	Kolejność sortowania przebiegów według znacznika czasu. Użyj `asc` dla kolejności rosnącej lub `desc` dla kolejności malejącej. Wartość domyślna to `asc`.
stan	kwerenda	Nie.	ciąg Możliwe wartości: `queued`, , `in_progresscompleted`, `canceled`, `failed` . Filtruj uruchomienia według stanu. Jeden z `queued`, , `in_progressfailed`, `completed`, `canceled`.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — tworzenie przebiegu oceny

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Tworzenie przebiegu oceny

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny potrzebny do utworzenia przebiegu.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
źródło danych	OpenAI.CreateEvalJsonlRunDataSource lub OpenAI.CreateEvalCompletionsRunDataSource lub OpenAI.CreateEvalResponsesRunDataSource lub EvalRunDataSource	Szczegółowe informacje o źródle danych przebiegu.	Yes
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Nazwa przebiegu.	Nie.
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvalRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — usuwanie przebiegu oceny

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Usuń przebieg oceny Usuń przebieg oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny, z której ma zostać usunięty przebieg.
run_id	ścieżka	Yes	ciąg	Identyfikator przebiegu do usunięcia.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DeleteEvalRunResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals - get eval run (Pobieranie przebiegu oceny)

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Pobierz przebieg oceny Pobierz ocenę uruchamianą według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny, dla której mają zostać pobrane przebiegi.
run_id	ścieżka	Yes	ciąg	Identyfikator przebiegu do pobrania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvalRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — anulowanie przebiegu oceny

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Anuluj przebieg oceny Anuluj trwający przebieg oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator ewaluacji, której wykonanie chcesz anulować.
run_id	ścieżka	Yes	ciąg	Identyfikator uruchomienia do anulowania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvalRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — pobieranie elementów wyjściowych przebiegu eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Pobierz elementy wyjściowe przebiegu oceny Pobierz listę elementów wyjściowych dla przebiegu oceny.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg
run_id	ścieżka	Yes	ciąg	Identyfikator przebiegu w celu pobrania elementów wyjściowych.
Po	kwerenda	Nie.	ciąg	Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba przebiegów do pobrania.
porządek	kwerenda	Nie.	ciąg Możliwe wartości: `asc`, `desc`	Kolejność sortowania przebiegów według znacznika czasu. Użyj `asc` dla kolejności rosnącej lub `desc` dla kolejności malejącej. Wartość domyślna to `asc`.
stan	kwerenda	Nie.	ciąg Możliwe wartości: `fail`, `pass`	Filtruj elementy wyjściowe według stanu. Użyj `failed` polecenia , aby filtrować według nieudanych danych wyjściowych elementy lub `pass` filtrowanie według przekazanych elementów wyjściowych.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Evals — pobieranie elementu wyjściowego przebiegu eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Pobierz element wyjściowy przebiegu oceny Pobierz element wyjściowy przebiegu oceny według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	ścieżka	Yes	ciąg	Identyfikator oceny, dla której mają zostać pobrane przebiegi.
run_id	ścieżka	Yes	ciąg	Identyfikator przebiegu do pobrania.
Identyfikator_elementu_wyjściowego (output_item_id)	ścieżka	Yes	ciąg	Identyfikator elementu wyjściowego do pobrania.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	EvalRunOutputItem

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Fine-Tuning

Tworzenie zadania dostrajania

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

Tworzy zadanie dostrajania, które rozpoczyna proces tworzenia nowego modelu na podstawie danego zestawu danych.

Odpowiedź zawiera szczegóły zadania w kolejce, w tym stan zadania, jak również nazwę dopasowanych modeli po zakończeniu.

Dowiedz się więcej o dostrajaniu

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
hiperparametry	OpenAI.CreateFineTuningJobRequestHyperparameters		Nie.
└batch_size	string lub OpenAI.integer		Nie.	samochód
└ learning_rate_multiplier	string lub OpenAI.numeric		Nie.
└n_epochs	string lub OpenAI.integer		Nie.	samochód
Integracje	tablica obiektów OpenAI.CreateFineTuningJobRequestIntegrations	Lista integracji umożliwiających dostrajanie zadania.	Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
metoda	OpenAI.FineTuneMethod	Metoda używana do dostrajania.	Nie.
model	ciąg (zobacz prawidłowe modele poniżej)	Nazwa modelu do dostosowania. Możesz wybrać jedną z opcji obsługiwane modele.	Yes
seed	OpenAI.integer (dopuszczający wartość null)		Nie.
Sufiks	ciąg (dopuszczany do wartości null)	Ciąg składający się z maksymalnie 64 znaków, które zostaną dodane do nazwy dostrojonego modelu. Na przykład wartość `suffix` "custom-model-name" spowoduje wygenerowanie nazwy modelu, takiej jak `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Ograniczenia: minLength: 1, maxLength: 64	Nie.
plik szkoleniowy	ciąg	Identyfikator przekazanego pliku zawierającego dane szkoleniowe. Zobacz przekazywanie pliku , aby dowiedzieć się, jak przekazać plik. Zestaw danych musi być sformatowany jako plik JSONL. Ponadto należy wgrać swój plik w celu `fine-tune`. Zawartość pliku powinna się różnić w zależności od tego, czy model używa formatu czatu, uzupełniania lub czy metoda dostrajania dokładnego używa formatu preferencji . Aby uzyskać więcej informacji, zobacz przewodnik dostosowywania .	Yes
plik walidacji	ciąg (dopuszczany do wartości null)	Identyfikator przekazanego pliku zawierającego dane walidacji. Jeśli podasz ten plik, dane są używane do generowania walidacji Metryki są oceniane okresowo podczas dostrajania. Metryki można wyświetlić w plik wyników fine-tuningu. Te same dane nie powinny być obecne zarówno w plikach trenowania, jak i walidacji. Zestaw danych musi być sformatowany jako plik JSONL. Musisz przekazać plik z celem `fine-tune`. Aby uzyskać więcej informacji, zobacz przewodnik dostosowywania .	Nie.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyświetlanie listy zadań dostrajania podzielonego na strony

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Wymień zadania dostrajania swojej organizacji

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Po	kwerenda	Nie.	ciąg	Identyfikator ostatniego zadania z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba zadań dostrajania do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Pobieranie zadania dostrajania

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1

Uzyskaj informacje o zadaniu dostrajania.

Dowiedz się więcej o dostrajaniu

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
identyfikator_zadania_dostrajania	ścieżka	Yes	ciąg	Identyfikator zadania dostrajania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Anulowanie zadania dostrajania

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1

Natychmiast anuluj zadanie dostrajania.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
identyfikator_zadania_dostrajania	ścieżka	Yes	ciąg	Identyfikator zadania dostrajania do anulowania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyświetlanie listy punktów kontrolnych zadań dostrajania

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1

Wyświetlanie listy punktów kontrolnych dla zadania dostrajania.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
identyfikator_zadania_dostrajania	ścieżka	Yes	ciąg	Identyfikator zadania dostrajania w celu pobrania punktów kontrolnych.
Po	kwerenda	Nie.	ciąg	Identyfikator punktu kontrolnego z ostatniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba punktów kontrolnych do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyświetlanie listy zdarzeń zadania dostrajania

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1

Uzyskaj szczegółowe aktualizacje stanu dla zadania dostrajania.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
identyfikator_zadania_dostrajania	ścieżka	Yes	ciąg	Identyfikator zadania dostrajania w celu pobrania zdarzeń.
Po	kwerenda	Nie.	ciąg	Identyfikator ostatniego zdarzenia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba zdarzeń do pobrania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wstrzymaj zadanie dostrajania

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1

Wstrzymaj uruchomione zadanie dostrajania.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
identyfikator_zadania_dostrajania	ścieżka	Yes	ciąg	Identyfikator wstrzymywanego zadania dostrajania.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wznawianie zadania dostrajania

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1

Wznów wstrzymane zadanie precyzyjnego dostrajania.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
identyfikator_zadania_dostrajania	ścieżka	Yes	ciąg	Identyfikator zadania finetuningu do wznowienia.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Responses

Tworzenie odpowiedzi — tworzenie strumienia odpowiedzi

POST {endpoint}/openai/v1/responses

Tworzy odpowiedź modelu. Tworzy odpowiedź modelu (odpowiedź strumieniowa).

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
konwersacja	OpenAI.ConversationParam (dopuszczana wartość null)	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.	Nie.
Obejmują	tablica openAI.IncludeEnum		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 obrazu - Dane wejściowe pliku - Stan konwersacji - Wywoływanie funkcji	Nie.
instructions	ciąg (dopuszczany do wartości null)		Nie.
max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
maks_liczba_wywołań_narzędzi	OpenAI.integer (dopuszczający wartość null)		Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	Nie.
wywołania_narzędzia_równoległe	Wartość logiczna (dopuszczana do wartości null)		Nie.	True
previous_response_id	ciąg (dopuszczany do wartości null)		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
reasoning	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└─ wysiłek	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.
└─ generuj_podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
└─ Podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
poziom usługi	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	Nie.
przechowywać	Wartość logiczna (dopuszczana do wartości null)		Nie.	True
odtwarzać strumieniowo	Wartość logiczna (dopuszczana do wartości null)		Nie.
stream_options	OpenAI.ResponseStreamOptions (dopuszczana wartość null)	Opcje przesyłania strumieniowego odpowiedzi. Ustaw tę wartość tylko po ustawieniu `stream: true`.	Nie.
└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.
structured_inputs	obiekt	Ustrukturyzowane dane wejściowe odpowiedzi, które mogą uczestniczyć w podstawieniu szablonu monitu lub powiązaniach argumentów narzędzia.	Nie.
temperatura	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
truncation	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Wyświetlanie listy odpowiedzi

GET {endpoint}/openai/v1/responses

Zwraca listę wszystkich odpowiedzi.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.
agent_name	kwerenda	Nie.	ciąg	Filtruj według nazwy agenta. Jeśli zostanie podana, zostaną zwrócone tylko elementy skojarzone z określonym agentem.
Agent_id	kwerenda	Nie.	ciąg	Filtruj według identyfikatora agenta w formacie `name:version`. Jeśli zostanie podana, zostaną zwrócone tylko elementy skojarzone z określonym identyfikatorem agenta.
conversation_id	kwerenda	Nie.	ciąg	Filtruj według identyfikatora konwersacji. Jeśli zostanie podana, zostaną zwrócone tylko odpowiedzi skojarzone z określoną konwersacją.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Kompaktowanie konwersacji odpowiedzi

POST {endpoint}/openai/v1/responses/compact

Tworzy kompaktowanie konwersacji odpowiedzi.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
dane wejściowe	ciąg lub tablica elementu OpenAI.InputItem		Nie.
instructions	ciąg (dopuszczany do wartości null)		Nie.
model	OpenAI.ModelIdsCompaction	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-5` lub `o3`. Platforma OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, charakterystykami wydajności i punktami cenowymi. Zapoznaj się z przewodnikiem po modelu , aby przeglądać i porównywać dostępne modele.	Yes
previous_response_id	ciąg (dopuszczany do wartości null)		Nie.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Uzyskiwanie odpowiedzi — pobieranie strumienia odpowiedzi

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

Pobiera odpowiedź modelu z danym identyfikatorem. Pobiera odpowiedź modelu z danym identyfikatorem (odpowiedź strumieniowa).

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	ścieżka	Yes	ciąg
include[]	kwerenda	Nie.	macierz
odtwarzać strumieniowo	kwerenda	Nie.	boolean
starting_after	kwerenda	Nie.	liczba całkowita

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
akceptuj	Nieprawda	ciąg Możliwe wartości: `text/event-stream`

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Usuń odpowiedź

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

Usuwa odpowiedź modelu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	ścieżka	Yes	ciąg	Identyfikator odpowiedzi do usunięcia.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	DeleteResponseResult

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Anuluj odpowiedź

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

Anuluje odpowiedź modelu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	ścieżka	Yes	ciąg	Identyfikator odpowiedzi na anulowanie.

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

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	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	ścieżka	Yes	ciąg
limit	kwerenda	Nie.	liczba całkowita	Limit liczby zwracanych obiektów. Limit może mieścić się w zakresie od 1 do 100, a wartość domyślna to 20.
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.
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.
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.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	obiekt	Dane odpowiedzi dla żądanej listy elementów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Redteams

Redteams - lista

GET {endpoint}/redTeams/runs?api-version=v1

Wyświetl listę redteam według nazwy.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `RedTeams=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedRedTeam

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Redteams – zdobądź

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Uzyskaj czerwoną drużynę według nazwy.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Yes	ciąg	Identyfikator czerwonego przebiegu zespołu.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `RedTeams=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	RedTeam

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Redteams — tworzenie

POST {endpoint}/redTeams/runs:run?api-version=v1

Tworzy uruchomienie redteam.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `RedTeams=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy	Wartość domyślna
applicationScenario	ciąg	Scenariusz aplikacji dla czerwonej operacji zespołu w celu wygenerowania konkretnych ataków scenariusza.	Nie.
attackStrategies	tablica strategii ataków	Lista strategii ataku lub zagnieżdżonych list strategii ataku.	Nie.
displayName	ciąg	Nazwa uruchomienia czerwonego zespołu.	Nie.
id	ciąg (tylko do odczytu)	Identyfikator czerwonego przebiegu zespołu.	Yes
liczbawywracania	liczba całkowita	Liczba rund symulacji.	Nie.
properties	obiekt	Właściwości zespołu czerwonego. W przeciwieństwie do tagów właściwości są tylko do dodawania. Po dodaniu nie można usunąć właściwości.	Nie.
riskCategories	tablica kategorii ryzyka	Lista kategorii ryzyka do generowania celów ataku.	Nie.
symulacjaOnly	boolean	Tylko symulacja lub Symulacja i ocena. Wartość domyślna false, jeśli wartość true skanowania generuje wynik konwersacji, która nie jest wynikiem oceny.	Nie.	Nieprawda
stan	ciąg (tylko do odczytu)	Stan czerwonego zespołu. Jest on ustawiany przez usługę i jest tylko do odczytu.	Nie.
tags	obiekt	Tagi czerwonego zespołu. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
miejsce docelowe	TargetConfig	Klasa abstrakcyjna dla konfiguracji docelowej.	Yes
└typ	ciąg	Typ konfiguracji modelu.	Yes

Responses

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	RedTeam

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Rozkłady

Harmonogramy — lista

GET {endpoint}/schedules?api-version=v1

Wyświetl listę wszystkich harmonogramów.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ	kwerenda	Nie.	ciąg Możliwe wartości: `Evaluation`, `Insight`	Filtruj według typu harmonogramu.
enabled	kwerenda	Nie.	boolean	Filtruj według stanu włączonego.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Schedules=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedSchedule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Harmonogramy — usuwanie

DELETE {endpoint}/schedules/{id}?api-version=v1

Usuń harmonogram.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Identyfikator harmonogramu.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Schedules=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 204

Opis: Nie ma zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Harmonogramy — pobierz

GET {endpoint}/schedules/{id}?api-version=v1

Pobierz harmonogram według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Identyfikator harmonogramu.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Schedules=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Schedule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Harmonogramy — tworzenie lub aktualizowanie

PUT {endpoint}/schedules/{id}?api-version=v1

Tworzenie lub aktualizowanie szablonu operacji.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Identyfikator harmonogramu.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Schedules=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis harmonogramu.	Nie.
displayName	ciąg	Nazwa harmonogramu.	Nie.
enabled	boolean	Włączony stan harmonogramu.	Yes
id	ciąg (tylko do odczytu)	Identyfikator harmonogramu.	Yes
properties	obiekt	Właściwości harmonogramu. W przeciwieństwie do tagów właściwości są tylko do dodawania. Po dodaniu nie można usunąć właściwości.	Nie.
provisioningStatus (stan aprowizacji)	ScheduleProvisioningStatus (tylko do odczytu)	Zaplanuj stan apryfikacji.	Nie.
daneSystemowe	obiekt (tylko do odczytu)	Metadane systemu dla zasobu.	Yes
tags	obiekt	Tagi harmonogramu. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
zadanie	ScheduleTask	Zaplanuj model zadań.	Yes
Konfiguracja └*	obiekt	Konfiguracja zadania.	Nie.
└typ	ScheduleTaskType	Typ zadania.	Yes
wyzwalacz	Trigger	Model podstawowy dla wyzwalacza harmonogramu.	Yes
└typ	Typ wyzwalacza	Typ wyzwalacza.	Yes

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	Schedule

Kod stanu: 201

Opis: Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Typ zawartości	Type	Opis
application/json	Schedule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Harmonogramy — uruchomienia listy

GET {endpoint}/schedules/{id}/runs?api-version=v1

Wyświetl listę wszystkich przebiegów harmonogramu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.
id	ścieżka	Yes	ciąg	Identyfikator harmonogramu.
typ	kwerenda	Nie.	ciąg Możliwe wartości: `Evaluation`, `Insight`	Filtruj według typu harmonogramu.
enabled	kwerenda	Nie.	boolean	Filtruj według stanu włączonego.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Schedules=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	PagedScheduleRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	Azure. Core.Foundations.ErrorResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
x-ms-error-code	ciąg	Kod błędu ciągu wskazujący, co poszło nie tak.

Harmonogramy — pobieranie przebiegu

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Pobierz harmonogram przebiegu według identyfikatora.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	ścieżka	Yes	ciąg	Punkt końcowy Project foundry w formularzu "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nazwa projektu}". Jeśli masz tylko jedną Project w usłudze Foundry Hub lub docelową domyślną Project w centrum użyj formularza "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Schedule_id	ścieżka	Yes	ciąg	Unikatowy identyfikator harmonogramu.
run_id	ścieżka	Yes	ciąg	Unikatowy identyfikator przebiegu harmonogramu.
wersja API	kwerenda	Yes	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Obowiązkowy	Typ	Description
Foundry-Features	True	ciąg Możliwe wartości: `Schedules=V1Preview`	Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

Responses

Kod stanu: 200

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

Typ zawartości	Type	Opis
application/json	ScheduleRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	ApiErrorResponse

Components

A2APreviewTool

Agent implementujący protokół A2A.

Name	Typ	Description	Obowiązkowy
agent_card_path	ciąg	Ścieżka do karty agenta względem .`base_url` Jeśli nie zostanie podany, wartość domyślna to `/.well-known/agent-card.json`	Nie.
base_url	ciąg	Podstawowy adres URL agenta.	Nie.
project_connection_id	ciąg	Identyfikator połączenia w project dla serwera A2A. W połączeniu przechowywane są dane uwierzytelniające i inne szczegóły połączenia potrzebne do nawiązania połączenia z serwerem A2A.	Nie.
typ	wyliczenie	Typ narzędzia. Zawsze `"a2a_preview`. Możliwe wartości: `a2a_preview`	Yes

AISearchIndexResource

Zasób AI Search Index.

Name	Typ	Description	Obowiązkowy
filtr	ciąg	ciąg filtru dla zasobu wyszukiwania. Więcej informacji można znaleźć tutaj.	Nie.
index_asset_id	ciąg	Identyfikator zasobu indeksu dla zasobu wyszukiwania.	Nie.
nazwa_indeksu	ciąg	Nazwa indeksu w indeksieResource dołączonym do tego agenta.	Nie.
project_connection_id	ciąg	Identyfikator połączenia indeksu w pliku IndexResource dołączony do tego agenta.	Nie.
typ zapytania	AzureAISearchQueryType	Dostępne typy zapytań dla narzędzia Wyszukiwanie AI platformy Azure.	Nie.
top_k	liczba całkowita	Liczba dokumentów do pobrania z wyszukiwania i prezentowania do modelu.	Nie.

AgentClusterInsightRequest

Wgląd w zestaw wyników oceny agenta

Name	Typ	Description	Obowiązkowy
agentName	ciąg	Identyfikator agenta.	Yes
modelKonfiguracja	InsightModelConfiguration	Konfiguracja modelu używanego w generowaniu wniosków.	Nie.
└* modelDeploymentName	ciąg	Wdrożenie modelu do oceny. Akceptuje nazwę wdrożenia samodzielnie lub z nazwą połączenia jako `{connectionName}/<modelDeploymentName>`.	Yes
typ	wyliczenie	Typ żądania. Możliwe wartości: `AgentClusterInsight`	Yes

AgentClusterInsightResult

Szczegółowe informacje z analizy skupień agentów.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
clusterInsight	ClusterInsightResult	Wnioski z analizy skupień.	Yes
typ	wyliczenie	Typ wyniku szczegółowych informacji. Możliwe wartości: `AgentClusterInsight`	Yes

AgentContainerObject

Szczegóły kontenera określonej wersji agenta.

Name	Typ	Description	Obowiązkowy
kontener	ContainerDetails (tylko do odczytu)	Szczegółowe informacje o kontenerze.	Nie.
└health_state	ciąg	Stan kondycji kontenera.	Yes
└provisioning_error	ciąg	Błąd aprowizacji kontenera, jeśli istnieje.	Nie.
└provisioning_state	ciąg	Stan aprowizacji kontenera.	Yes
Repliki └*	tablica konteneraReplica	Lista replik w kontenerze.	Yes
Stan └*	ciąg	Stan kontenera.	Yes
└updated_on	ciąg	Czas ostatniej aktualizacji kontenera.	Yes
utworzono_o	ciąg	Czas tworzenia kontenera.	Yes
Error_message	ciąg (tylko do odczytu)	Komunikat o błędzie, jeśli kontener nie może działać, jeśli istnieje.	Nie.
id	ciąg (tylko do odczytu)	Identyfikator kontenera.	Nie.
max_replicas	liczba całkowita	Maksymalna liczba replik dla kontenera. Wartość domyślna to 1.	Nie.
min_replicas	liczba całkowita	Minimalna liczba replik dla kontenera. Wartość domyślna to 1.	Nie.
obiekt	wyliczenie	Typ obiektu, który jest zawsze "agent.container". Możliwe wartości: `agent.container`	Yes
stan	AgentContainerStatus (tylko do odczytu)	Stan kontenera określonej wersji agenta.	Yes
updated_at	ciąg	Czas ostatniej aktualizacji kontenera.	Yes

AgentContainerOperationError

Szczegóły błędu operacji kontenera, jeśli istnieją.

Name	Typ	Description	Obowiązkowy
kod	ciąg	Kod błędu operacji kontenera, jeśli istnieje.	Yes
komunikat	ciąg	Komunikat o błędzie operacji kontenera, jeśli istnieje.	Yes
typ	ciąg	Typ błędu operacji kontenera, jeśli istnieje.	Yes

AgentContainerOperationObject

Operacja kontenera dla określonej wersji agenta.

Name	Typ	Description	Obowiązkowy
Agent_id	ciąg	Identyfikator agenta.	Yes
agent_version_id	ciąg	Identyfikator wersji agenta.	Yes
kontener	AgentContainerObject	Szczegóły kontenera określonej wersji agenta.	Nie.
Kontener └*	ContainerDetails (tylko do odczytu)	Szczegółowe informacje o kontenerze.	Nie.
└─ utworzono_o	ciąg (tylko do odczytu)	Czas tworzenia kontenera.	Yes
└error_message	ciąg (tylko do odczytu)	Komunikat o błędzie, jeśli kontener nie może działać, jeśli istnieje.	Nie.
└─ ID	ciąg (tylko do odczytu)	Identyfikator kontenera.	Nie.
└max_replicas	liczba całkowita	Maksymalna liczba replik dla kontenera. Wartość domyślna to 1.	Nie.
└min_replicas	liczba całkowita	Minimalna liczba replik dla kontenera. Wartość domyślna to 1.	Nie.
└─ obiekt	wyliczenie	Typ obiektu, który jest zawsze "agent.container". Możliwe wartości: `agent.container`	Yes
└─ Status	AgentContainerStatus (tylko do odczytu)	Stan kontenera określonej wersji agenta.	Yes
└updated_at	ciąg (tylko do odczytu)	Czas ostatniej aktualizacji kontenera.	Yes
błąd	AgentContainerOperationError	Szczegóły błędu operacji kontenera, jeśli istnieją.	Nie.
└─ kod	ciąg	Kod błędu operacji kontenera, jeśli istnieje.	Yes
└─ Komunikat	ciąg	Komunikat o błędzie operacji kontenera, jeśli istnieje.	Yes
└typ	ciąg	Typ błędu operacji kontenera, jeśli istnieje.	Yes
id	ciąg	Identyfikator operacji kontenera. Ten identyfikator jest unikatowym identyfikatorem w systemie.	Yes
stan	AgentContainerOperationStatus	Stan operacji kontenera dla określonej wersji agenta.	Yes

AgentContainerOperationStatus

Stan operacji kontenera dla określonej wersji agenta.

Property	Value
Type	ciąg
Wartości	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

Stan kontenera określonej wersji agenta.

Property	Value
Type	ciąg
Wartości	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

Dyskryminujące dla agentaDefinition

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

Typ wartości	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

Name	Typ	Description	Obowiązkowy
rodzaj	AgentKind		Yes
rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
└rai_policy_name	ciąg	Nazwa zasad RAI do zastosowania.	Yes

AgentKind

Property	Value
Type	ciąg
Wartości	`prompt` `hosted` `container_app` `workflow`

AgentObject

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator agenta.	Yes
nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 63	Yes
obiekt	wyliczenie	Typ obiektu, który jest zawsze "agentem". Możliwe wartości: `agent`	Yes
versions	obiekt	Najnowsza wersja agenta.	Yes
└* najnowsze	AgentVersionObject		Yes

AgentProtocol

Property	Value
Type	ciąg
Wartości	`activity_protocol` `responses`

AgentReference

Name	Typ	Description	Obowiązkowy
nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
wersja	ciąg	Identyfikator wersji agenta.	Nie.

AgentTaxonomyInput

Konfiguracja danych wejściowych dla taksonomii oceny, gdy typ danych wejściowych to agent.

Name	Typ	Description	Obowiązkowy
riskCategories	tablica kategorii ryzyka	Lista kategorii ryzyka do oceny.	Yes
miejsce docelowe	Obiekt docelowy	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Yes
└typ	ciąg	Typ obiektu docelowego.	Yes
typ	wyliczenie	Typ danych wejściowych taksonomii oceny. Możliwe wartości: `agent`	Yes

AgentTaxonomyInputUpdate

Konfiguracja danych wejściowych dla taksonomii oceny, gdy typ danych wejściowych to agent.

Name	Typ	Description	Obowiązkowy
riskCategories	tablica kategorii ryzyka	Lista kategorii ryzyka do oceny.	Nie.
miejsce docelowe	TargetUpdate	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Nie.
└typ	ciąg	Typ obiektu docelowego.	Yes
typ	wyliczenie	Typ danych wejściowych taksonomii oceny. Możliwe wartości: `agent`	Yes

AgentVersionObject

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) w momencie utworzenia agenta.	Yes
definicja	AgentDefinition		Yes
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
id	ciąg	Unikatowy identyfikator wersji agenta.	Yes
metadane	object (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Yes
nazwa	ciąg	Nazwa agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. Ograniczenia: maxLength: 256	Yes
obiekt	wyliczenie	Typ obiektu, którym zawsze jest "agent.version". Możliwe wartości: `agent.version`	Yes
wersja	ciąg	Identyfikator wersji agenta. Agenci są niezmienni, a każda aktualizacja tworzy nową wersję, zachowując tę samą nazwę.	Yes

AgenticIdentityPreviewCredentials

Definicja poświadczeń tożsamości agenta

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

ApiErrorResponse

Odpowiedź na błąd w przypadku awarii interfejsu API.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
błąd	OpenAI.Error		Yes

ApiKeyCredentials

Definicja poświadczeń klucza interfejsu API

Name	Typ	Description	Obowiązkowy	Wartość domyślna
klucz	ciąg (tylko do odczytu)	Klucz API	Nie.
typ	wyliczenie	Typ poświadczeń Możliwe wartości: `ApiKey`	Yes

AssetCredentialResponse

Reprezentuje odwołanie do obiektu blob do użycia

Name	Typ	Description	Obowiązkowy
BlobReference	BlobReference	Szczegóły odwołania do obiektu blob.	Yes
└* identyfikator blobUri	ciąg	Ścieżka identyfikatora URI obiektu blob dla klienta w celu przekazania danych. Przykład: `https://blob.windows.core.net/Container/Path`	Yes
Poświadczenie └*	SasCredential	Informacje o poświadczeniach umożliwiające uzyskanie dostępu do konta magazynu.	Yes
└* storageAccountArmId	ciąg	Identyfikator arm konta magazynu do użycia.	Yes

Identyfikator zasobu

Identyfikator zapisanego zasobu.

Typ: ciąg

AttackStrategy

Strategie ataków.

Property	Value
Opis	Strategie ataków.
Type	ciąg
Wartości	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure. Core.Foundations.Error

Obiekt błędu.

Name	Typ	Description	Obowiązkowy
kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Yes
details	tablica Azure. Core.Foundations.Error	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.	Nie.
innererror	Azure. Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Nie.
└─ kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Nie.
└* wewnętrzny błąd	Azure. Core.Foundations.InnerError	Błąd wewnętrzny.	Nie.
komunikat	ciąg	Czytelna dla człowieka reprezentacja błędu.	Yes
miejsce docelowe	ciąg	Obiekt docelowy błędu.	Nie.

Azure. Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Name	Typ	Description	Obowiązkowy
błąd	Azure. Core.Foundations.Error	Obiekt błędu.	Yes
└─ kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Yes
└szczegóły	tablica Azure. Core.Foundations.Error	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.	Nie.
└* wewnętrzny błąd	Azure. Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.	Nie.
└─ Komunikat	ciąg	Czytelna dla człowieka reprezentacja błędu.	Yes
└* docelowy	ciąg	Obiekt docelowy błędu.	Nie.

Azure. Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description	Obowiązkowy
kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Nie.
innererror	Azure. Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Nie.
└─ kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Nie.
└* wewnętrzny błąd	Azure. Core.Foundations.InnerError	Błąd wewnętrzny.	Nie.

Azure. Core.Foundations.OperationState

Wyliczenie opisujące dozwolone stany operacji.

Property	Value
Opis	Wyliczenie opisujące dozwolone stany operacji.
Type	ciąg
Wartości	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure. Core.uuid

Unikatowy identyfikator uniwersalny

Typ: ciąg

Format: uuid

AzureAIAgentTarget

Reprezentuje cel określający agenta Azure AI.

Name	Typ	Description	Obowiązkowy
nazwa	ciąg	Unikatowy identyfikator agenta Azure AI.	Yes
tool_descriptions	tablica elementu ToolDescription	Parametry używane do kontrolowania zachowania próbkowania agenta podczas generowania tekstu.	Nie.
typ	wyliczenie	Typ celu, zawsze `azure_ai_agent`. Możliwe wartości: `azure_ai_agent`	Yes
wersja	ciąg	Wersja agenta Azure AI.	Nie.

AzureAIAgentTargetUpdate

Reprezentuje cel określający agenta Azure AI.

Name	Typ	Description	Obowiązkowy
nazwa	ciąg	Unikatowy identyfikator agenta Azure AI.	Nie.
tool_descriptions	tablica elementu ToolDescription	Parametry używane do kontrolowania zachowania próbkowania agenta podczas generowania tekstu.	Nie.
typ	wyliczenie	Typ celu, zawsze `azure_ai_agent`. Możliwe wartości: `azure_ai_agent`	Yes
wersja	ciąg	Wersja agenta Azure AI.	Nie.

AzureAIDataSourceConfig

Name	Typ	Description	Obowiązkowy
scenariusz	wyliczenie	Scenariusz schematu danych. Możliwe wartości: `red_team`, , `responses`, `traces_previewsynthetic_data_gen_preview`	Yes
schemat	obiekt	Ogólny schemat JSON obiektu dla elementów źródła danych uruchamiania.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `azure_ai_source`. Możliwe wartości: `azure_ai_source`	Yes

AzureAIModelTarget

Reprezentuje cel określający model AI Azure dla operacji wymagających wyboru modelu.

Name	Typ	Description	Obowiązkowy
model	ciąg	Unikatowy identyfikator modelu sztucznej inteligencji Azure.	Nie.
parametry_próbowania	ModelSamplingParams	Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.	Nie.
└─ maksymalna_ilość_znaków_do_zakończenia	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Yes
└─ nasion	liczba całkowita	Losowe inicjatory do odtworzenia.	Yes
└* temperatura	number	Parametr temperatury do próbkowania.	Yes
└─top_p	number	Parametr top-p próbkowania jądra.	Yes
typ	wyliczenie	Typ celu, zawsze `azure_ai_model`. Możliwe wartości: `azure_ai_model`	Yes

AzureAIModelTargetUpdate

Reprezentuje cel określający model AI Azure dla operacji wymagających wyboru modelu.

Name	Typ	Description	Obowiązkowy
model	ciąg	Unikatowy identyfikator modelu sztucznej inteligencji Azure.	Nie.
parametry_próbowania	ModelSamplingParamsUpdate	Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.	Nie.
└─ maksymalna_ilość_znaków_do_zakończenia	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Nie.
└─ nasion	liczba całkowita	Losowe inicjatory do odtworzenia.	Nie.
└* temperatura	number	Parametr temperatury do próbkowania.	Nie.
└─top_p	number	Parametr top-p próbkowania jądra.	Nie.
typ	wyliczenie	Typ celu, zawsze `azure_ai_model`. Możliwe wartości: `azure_ai_model`	Yes

AzureAIResponsesEvalRunDataSource

Reprezentuje źródło danych dla przebiegów oceny, które są specyficzne dla scenariuszy ciągłej oceny.

Name	Typ	Description	Obowiązkowy
event_configuration_id	ciąg	Nazwa konfiguracji zdarzenia skojarzona z tym przebiegiem oceny.	Yes
item_generation_params	ResponseRetrievalItemGenerationParams	Reprezentuje parametry generowania elementu pobierania odpowiedzi.	Yes
└data_mapping	obiekt	Mapowanie z pól źródłowych na pole response_id wymagane do pobierania historii czatu.	Yes
└max_num_turns	liczba całkowita	Maksymalna liczba zakrętów historii czatów do oceny.	Yes
└— źródło	OpenAI.EvalJsonlFileContentSource lub OpenAI.EvalJsonlFileIdSource	Źródło, z którego jest odczytywana zawartość JSONL.	Yes
└typ	wyliczenie	Typ parametrów generowania elementów, zawsze `response_retrieval`. Możliwe wartości: `response_retrieval`	Yes
max_runs_hourly	liczba całkowita	Maksymalna dozwolona liczba przebiegów oceny na godzinę.	Yes
typ	wyliczenie	Typ źródła danych, zawsze `azure_ai_responses`. Możliwe wartości: `azure_ai_responses`	Yes

Indeks wyszukiwania Azure AI

definicja indeksu Wyszukiwanie AI platformy Azure

Name	Typ	Description	Obowiązkowy
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	wyliczenie	Typ indeksu Możliwe wartości: `AzureSearch`	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

AzureAISearchIndexUpdate

definicja indeksu Wyszukiwanie AI platformy Azure

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	wyliczenie	Typ indeksu Możliwe wartości: `AzureSearch`	Yes

AzureAISearchQueryType

Dostępne typy zapytań dla narzędzia Wyszukiwanie AI platformy Azure.

Property	Value
Opis	Dostępne typy zapytań dla narzędzia Wyszukiwanie AI platformy Azure.
Type	ciąg
Wartości	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

Informacje o definicji wejściowych dla narzędzia wyszukiwania Azure AI, używane do konfiguracji agenta.

Name	Typ	Description	Obowiązkowy
azure_ai_search	AzureAISearchToolResource	Zestaw zasobów indeksu używanych przez narzędzie `azure_ai_search`.	Yes
Indeksy └*	tablica AISearchIndexResource	Indeksy dołączone do tego agenta. Może istnieć maksymalnie 1 indeks zasób dołączony do agenta. Ograniczenia: maxItems: 1	Yes
typ	wyliczenie	Typ obiektu, którym zawsze jest 'azure_ai_search'. Możliwe wartości: `azure_ai_search`	Yes

AzureAISearchToolResource

Zestaw zasobów indeksu używanych przez narzędzie azure_ai_search.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Indeksy	tablica AISearchIndexResource	Indeksy dołączone do tego agenta. Może istnieć maksymalnie 1 indeks zasób dołączony do agenta.	Yes

AzureFunctionBinding

Struktura przechowywania storage nazwa kolejki i identyfikator URI.

Name	Typ	Description	Obowiązkowy
storage_queue	AzureFunctionStorageQueue	Struktura przechowywania storage nazwa kolejki i identyfikator URI.	Yes
└queue_name	ciąg	Nazwa kolejki magazynu funkcji Azure.	Yes
└queue_service_endpoint	ciąg	Identyfikator URI do usługi kolejki Azure Storage umożliwia manipulowanie kolejką.	Yes
typ	wyliczenie	Typ powiązania, który jest zawsze "storage_queue". Możliwe wartości: `storage_queue`	Yes

AzureFunctionDefinition

Definicja funkcji Azure.

Name	Typ	Description	Obowiązkowy
funkcja	obiekt	Definicja funkcji platformy Azure i jej parametrów.	Yes
Opis └*	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
Parametry	obiekt	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.	Yes
input_binding	AzureFunctionBinding	Struktura przechowywania storage nazwa kolejki i identyfikator URI.	Yes
└storage_queue	AzureFunctionStorageQueue	Kolejka magazynu.	Yes
└typ	wyliczenie	Typ powiązania, który jest zawsze "storage_queue". Możliwe wartości: `storage_queue`	Yes
output_binding	AzureFunctionBinding	Struktura przechowywania storage nazwa kolejki i identyfikator URI.	Yes
└storage_queue	AzureFunctionStorageQueue	Kolejka magazynu.	Yes
└typ	wyliczenie	Typ powiązania, który jest zawsze "storage_queue". Możliwe wartości: `storage_queue`	Yes

AzureFunctionStorageQueue

Struktura przechowywania storage nazwa kolejki i identyfikator URI.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
queue_name	ciąg	Nazwa kolejki magazynu funkcji Azure.	Yes
queue_service_endpoint	ciąg	Identyfikator URI do usługi kolejki Azure Storage umożliwia manipulowanie kolejką.	Yes

AzureFunctionTool

Informacje o definicji wejściowych dla narzędzia Azure Function Tool, używane do konfiguracji agenta.

Name	Typ	Description	Obowiązkowy
azure_function	AzureFunctionDefinition	Definicja funkcji Azure.	Yes
└* , funkcja	obiekt	Definicja funkcji platformy Azure i jej parametrów.	Yes
Opis └*	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
Parametry	obiekt	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.	Yes
└input_binding	AzureFunctionBinding	Kolejka magazynu wejściowego. Wyzwalacz magazynu kolejek uruchamia funkcję w miarę dodawania do niej komunikatów.	Yes
└output_binding	AzureFunctionBinding	Kolejka magazynu wyjściowego. Funkcja zapisuje dane wyjściowe w tej kolejce po przetworzeniu elementów wejściowych.	Yes
typ	wyliczenie	Typ obiektu, którym zawsze jest "browser_automation". Możliwe wartości: `azure_function`	Yes

AzureOpenAIModelConfiguration

Azure konfiguracji modelu OpenAI. Wersja interfejsu API zostanie wybrana przez usługę do wykonywania zapytań dotyczących modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
modelDeploymentName	ciąg	Nazwa wdrożenia modelu AOAI. Przykład: gpt-4o, jeśli w usłudze AIServices lub na podstawie `connection_name/deployment_name` połączenia (np. `my-aoai-connection/gpt-4o`).	Yes
typ	wyliczenie	Możliwe wartości: `AzureOpenAIModel`	Yes

BaseCredentials

Klasa bazowa dla poświadczeń połączenia

Dyskryminujące dla obiektów BaseCredential

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

Typ wartości	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	Customcredential
`SAS`	Sygnatury dostępu współdzielonego
`None`	NoAuthenticationCredentials
`AgenticIdentityToken_Preview`	AgenticIdentityPreviewCredentials

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	CredentialType (tylko do odczytu)	Typ poświadczeń używany przez połączenie	Yes

BingCustomSearchConfiguration

Konfiguracja wyszukiwania niestandardowego bing.

Name	Typ	Description	Obowiązkowy
count	liczba całkowita	Liczba wyników wyszukiwania, które mają być zwracane w odpowiedzi interfejsu API Bing	Nie.
freshness	ciąg	Filtruj wyniki wyszukiwania według określonego zakresu czasu. Zobacz akceptowane wartości tutaj.	Nie.
instance_name	ciąg	Nazwa wystąpienia konfiguracji niestandardowej podane do konfiguracji.	Yes
Rynku	ciąg	Rynek, z którego pochodzą wyniki.	Nie.
project_connection_id	ciąg	Project identyfikator połączenia dla uziemienia za pomocą wyszukiwania bing	Yes
set_lang	ciąg	Język używany do obsługi ciągów interfejsu użytkownika podczas wywoływania interfejsu API Bing.	Nie.

BingCustomSearchPreviewTool

Informacje o definicji danych wejściowych dla narzędzia wyszukiwania niestandardowego Bing używane do konfigurowania agenta.

Name	Typ	Description	Obowiązkowy
bing_custom_search_preview	BingCustomSearchToolParameters	Parametry niestandardowego narzędzia wyszukiwania bing.	Yes
└search_configurations	tablica obiektów BingCustomSearchConfiguration	Połączenia project dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia. Ograniczenia: maxItems: 1	Yes
typ	wyliczenie	Typ obiektu, który zawsze jest "bing_custom_search_preview". Możliwe wartości: `bing_custom_search_preview`	Yes

BingCustomSearchToolParameters

Parametry niestandardowego narzędzia wyszukiwania bing.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
search_configurations	tablica obiektów BingCustomSearchConfiguration	Połączenia project dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Yes

BingGroundingSearchConfiguration

Wyszukaj konfigurację Bing Grounding

Name	Typ	Description	Obowiązkowy
count	liczba całkowita	Liczba wyników wyszukiwania, które mają być zwracane w odpowiedzi interfejsu API Bing	Nie.
freshness	ciąg	Filtruj wyniki wyszukiwania według określonego zakresu czasu. Zobacz akceptowane wartości tutaj.	Nie.
Rynku	ciąg	Rynek, z którego pochodzą wyniki.	Nie.
project_connection_id	ciąg	Project identyfikator połączenia dla uziemienia za pomocą wyszukiwania bing	Yes
set_lang	ciąg	Język używany do obsługi ciągów interfejsu użytkownika podczas wywoływania interfejsu API Bing.	Nie.

BingGroundingSearchToolParameters

Parametry narzędzia wyszukiwania bing uziemienia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
search_configurations	tablica obiektów BingGroundingSearchConfiguration	Konfiguracje wyszukiwania dołączone do tego narzędzia. Może istnieć maksymalnie 1 zasób konfiguracji wyszukiwania dołączony do narzędzia.	Yes

BingGroundingTool

Informacje o definicji danych wejściowych dla narzędzia wyszukiwania uziemieniowego bing używane do konfigurowania agenta.

Name	Typ	Description	Obowiązkowy
bing_grounding	BingGroundingSearchToolParameters	Parametry narzędzia wyszukiwania bing uziemienia.	Yes
└search_configurations	tablica obiektów BingGroundingSearchConfiguration	Konfiguracje wyszukiwania dołączone do tego narzędzia. Może istnieć maksymalnie 1 zasób konfiguracji wyszukiwania dołączony do narzędzia. Ograniczenia: maxItems: 1	Yes
typ	wyliczenie	Typ obiektu, którym zawsze jest 'bing_grounding'. Możliwe wartości: `bing_grounding`	Yes

BlobReference

Szczegóły odwołania do obiektu blob.

Name	Typ	Description	Obowiązkowy
Identyfikator blobUri	ciąg	Ścieżka identyfikatora URI obiektu blob dla klienta w celu przekazania danych. Przykład: `https://blob.windows.core.net/Container/Path`	Yes
poświadczenie	SasCredential	Definicja poświadczeń sygnatury dostępu współdzielonego	Yes
└* sasUri	ciąg (tylko do odczytu)	Identyfikator URI sygnatury dostępu współdzielonego	Yes
└typ	wyliczenie	Typ poświadczeń Możliwe wartości: `SAS`	Yes
storageAccountArmId	ciąg	Identyfikator arm konta magazynu do użycia.	Yes

BrowserAutomationPreviewTool

Informacje o definicji danych wejściowych dla narzędzia Browser Automation Tool, które służy do konfigurowania agenta.

Name	Typ	Description	Obowiązkowy
browser_automation_preview	BrowserAutomationToolParameters	Definicja parametrów wejściowych dla narzędzia Browser Automation Tool.	Yes
Połączenie └*	BrowserAutomationToolConnectionParameters	Parametry połączenia projektu skojarzone z narzędziem automatyzacji przeglądarki.	Yes
typ	wyliczenie	Typ obiektu, który zawsze jest "browser_automation_preview". Możliwe wartości: `browser_automation_preview`	Yes

BrowserAutomationToolConnectionParameters

Definicja parametrów wejściowych dla połączenia używanego przez narzędzie Browser Automation Tool.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
project_connection_id	ciąg	Identyfikator połączenia projektu z zasobem Azure Playwright.	Yes

BrowserAutomationToolParameters

Definicja parametrów wejściowych dla narzędzia Browser Automation Tool.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
połączenie	BrowserAutomationToolConnectionParameters	Definicja parametrów wejściowych dla połączenia używanego przez narzędzie Browser Automation Tool.	Yes
└project_connection_id	ciąg	Identyfikator połączenia projektu z zasobem Azure Playwright.	Yes

CaptureStructuredOutputsTool

Narzędzie do przechwytywania ustrukturyzowanych danych wyjściowych

Name	Typ	Description	Obowiązkowy
outputs	StructuredOutputDefinition	Ustrukturyzowane dane wyjściowe, które mogą być generowane przez agenta.	Yes
Opis └*	ciąg	Opis danych wyjściowych do emisji. Używany przez model do określania, kiedy emitować dane wyjściowe.	Yes
└─ nazwa	ciąg	Nazwa danych wyjściowych ze strukturą.	Yes
Schemat └*	obiekt	Schemat JSON dla danych wyjściowych ze strukturą.	Yes
└* ścisłe	Wartość logiczna (dopuszczana do wartości null)	Czy wymuszać ścisłą walidację. Wartość domyślna `true`.	Yes
typ	wyliczenie	Typ narzędzia. Zawsze `capture_structured_outputs`. Możliwe wartości: `capture_structured_outputs`	Yes

Wykres współrzędny

Współrzędne wykresu analizy.

Name	Typ	Description	Obowiązkowy
size	liczba całkowita	Rozmiar elementu wykresu.	Yes
x	liczba całkowita	Współrzędna osi X.	Yes
y	liczba całkowita	Współrzędna osi Y.	Yes

ChatSummaryMemoryItem

Element pamięci zawierający podsumowanie wyodrębnione z konwersacji.

Name	Typ	Description	Obowiązkowy
zawartość	ciąg	Zawartość pamięci.	Yes
rodzaj	wyliczenie	Rodzaj elementu pamięci. Możliwe wartości: `chat_summary`	Yes
memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Yes
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes
updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Yes

ClusterInsightResult

Wnioski z analizy skupień.

Name	Typ	Description	Obowiązkowy
clusters	tablica tablicy insightCluster	Lista klastrów zidentyfikowanych w szczegółowych danych.	Yes
współrzędne	obiekt	Opcjonalne mapowanie identyfikatorów na współrzędne 2D używane przez interfejs użytkownika do wizualizacji. Klucze mapy są identyfikatorami ciągów (na przykład identyfikatorem klastra lub przykładowym identyfikatorem) wartości to współrzędne i rozmiar wizualizacji renderowania na wykresie 2D. Ta właściwość zostanie pominięta, chyba że klient żąda współrzędnych (na przykład przekazując `includeCoordinates=true` jako parametr zapytania). Przykład: `<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>` Współrzędne są przeznaczone tylko dla wizualizacji po stronie klienta i nie zmodyfikuj wyniki szczegółowych informacji kanonicznych.	Nie.
podsumowanie	InsightSummary	Podsumowanie analizy skupień błędów.	Yes
└* metoda	ciąg	Metoda używana do klastrowania.	Yes
└* sampleCount	liczba całkowita	Łączna liczba analizowanych próbek.	Yes
└* uniqueClusterCount	liczba całkowita	Łączna liczba unikatowych klastrów.	Yes
└(*) uniqueSubclusterCount	liczba całkowita	Całkowita liczba unikatowych etykiet podklasy.	Yes
└─ użycie	ClusterTokenUsage	Użycie tokenu podczas przeprowadzania analizy klastrowania	Yes

ClusterTokenUsage

Użycie tokenu do analizy skupień

Name	Typ	Description	Obowiązkowy
inputTokenUsage	liczba całkowita	użycie tokenu wejściowego	Yes
outputTokenUsage	liczba całkowita	użycie tokenu wyjściowego	Yes
totalTokenUsage	liczba całkowita	łączne użycie tokenu	Yes

CodeBasedEvaluatorDefinition

Definicja ewaluatora opartego na kodzie przy użyciu kodu w języku Python

Name	Typ	Description	Obowiązkowy
code_text	ciąg	Wbudowany tekst kodu dla ewaluatora	Yes
data_schema	obiekt	Schemat JSON (wersja robocza 2020-12) dla danych wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
init_parameters	obiekt	Schemat JSON (wersja robocza 2020-12) dla parametrów wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
metryki	obiekt	Lista wskaźników wyjściowych opracowanych przez tego ewaluatora	Nie.
typ	wyliczenie	Możliwe wartości: `code`	Yes

CompletionMessageToolCallChunk

Szczegóły wywołania narzędzia w wiadomości.

Name	Typ	Description	Obowiązkowy
funkcja	FunctionToolCall	Szczegóły wywołania narzędzia funkcji.	Nie.
└─ Argumenty	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON.	Yes
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
id	ciąg	Identyfikator wywołania narzędzia.	Yes
typ	wyliczenie	Typ wywołania narzędzia, który jest zawsze "funkcją". Możliwe wartości: `function`	Yes

Połączenie

Operacje odpowiedzi z listy i pobierania połączeń

Name	Typ	Description	Obowiązkowy
dane logowania	BaseCredentials (tylko do odczytu)	Klasa bazowa dla poświadczeń połączenia	Yes
└typ	CredentialType (tylko do odczytu)	Typ poświadczeń używany przez połączenie	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator połączenia wygenerowany przez usługę	Yes
isDefault	Wartość logiczna (tylko do odczytu)	Czy połączenie jest oznaczone jako domyślne połączenie typu	Yes
metadane	obiekt (tylko do odczytu)	Metadane połączenia	Yes
nazwa	ciąg (tylko do odczytu)	Przyjazna nazwa połączenia podana przez użytkownika.	Yes
miejsce docelowe	ciąg (tylko do odczytu)	Adres URL połączenia, który ma być używany dla tej usługi	Yes
typ	ConnectionType (tylko do odczytu)	Typ (lub kategoria) połączenia	Yes

ConnectionType

Typ (lub kategoria) połączenia

Property	Value
Opis	Typ (lub kategoria) połączenia
Type	ciąg
Wartości	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

Definicja agenta aplikacji kontenera.

Name	Typ	Description	Obowiązkowy
container_app_resource_id	ciąg	Identyfikator zasobu aplikacji kontenera Azure hostujący tego agenta. Nie można modyfikować między wersjami.	Yes
container_protocol_versions	tablica wartości ProtocolVersionRecord	Protokoły obsługiwane przez agenta na potrzeby komunikacji przychodzącej kontenerów.	Yes
ingress_subdomain_suffix	ciąg	Sufiks do zastosowania do poddomeny aplikacji podczas wysyłania ruchu przychodzącego do agenta. Może to być etykieta (np. "---current"), określona poprawka (np. "--0000001") lub pusta, aby użyć domyślnego punktu końcowego dla aplikacji kontenera.	Yes
rodzaj	wyliczenie	Możliwe wartości: `container_app`	Yes
rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
└rai_policy_name	ciąg	Nazwa zasad RAI do zastosowania.	Yes

ContainerDetails

Szczegółowe informacje o kontenerze.

Name	Typ	Description	Obowiązkowy
health_state	ciąg	Stan kondycji kontenera.	Yes
provisioning_error	ciąg	Błąd aprowizacji kontenera, jeśli istnieje.	Nie.
provisioning_state	ciąg	Stan aprowizacji kontenera.	Yes
replicas	tablica konteneraReplica	Lista replik w kontenerze.	Yes
stan	ciąg	Stan kontenera.	Yes
updated_on	ciąg	Czas ostatniej aktualizacji kontenera.	Yes

ContainerLogKind

Typ dzienników do przesyłania strumieniowego z kontenera.

Property	Value
Type	ciąg
Wartości	`console` `system`

ContainerReplica

Informacje o repliki kontenera.

Name	Typ	Description	Obowiązkowy
container_state	ciąg	Stan kontenera repliki.	Yes
nazwa	ciąg	Nazwa repliki.	Yes
stan	ciąg	Stan repliki.	Yes

ContinuousEvaluationRuleAction

Akcja reguły oceny dla ciągłej oceny.

Name	Typ	Description	Obowiązkowy
evalId	ciąg	Identyfikator oceny w celu dodania przebiegów oceny ciągłej do.	Yes
maxHourlyRuns	liczba całkowita	Maksymalna dozwolona liczba przebiegów oceny na godzinę.	Nie.
typ	wyliczenie	Możliwe wartości: `continuousEvaluation`	Yes

Indeks CosmosDB

Definicja indeksu magazynu wektorów usługi CosmosDB

Name	Typ	Description	Obowiązkowy
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	wyliczenie	Typ indeksu Możliwe wartości: `CosmosDBNoSqlVectorStore`	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

CosmosDBIndexUpdate

Definicja indeksu magazynu wektorów usługi CosmosDB

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	wyliczenie	Typ indeksu Możliwe wartości: `CosmosDBNoSqlVectorStore`	Yes

CreateAgentFromManifestRequest

Name	Typ	Description	Obowiązkowy
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Yes
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Unikatowa nazwa identyfikująca agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. - Musi rozpoczynać się i kończyć znakiem alfanumerycznym, - Może zawierać łączniki w środku - Nie może przekraczać 63 znaków. Ograniczenia: maxLength: 63	Yes
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Yes

CreateAgentRequest

Name	Typ	Description	Obowiązkowy
definicja	AgentDefinition		Yes
Rodzaj └*	AgentKind		Yes
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Unikatowa nazwa identyfikująca agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta. - Musi rozpoczynać się i kończyć znakiem alfanumerycznym, - Może zawierać łączniki w środku - Nie może przekraczać 63 znaków. Ograniczenia: maxLength: 63	Yes

CreateAgentVersionFromManifestRequest

Name	Typ	Description	Obowiązkowy
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Yes
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Yes

CreateAgentVersionRequest

Name	Typ	Description	Obowiązkowy
definicja	AgentDefinition		Yes
Rodzaj └*	AgentKind		Yes
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.

UtwórzŻądanieOceny

Name	Typ	Description	Obowiązkowy
konfiguracja źródła danych	OpenAI.CreateEvalCustomDataSourceConfig lub OpenAI.CreateEvalLogsDataSourceConfig lub OpenAI.CreateEvalStoredCompletionsDataSourceConfig lub AzureAIDataSourceConfig	Konfiguracja źródła danych używanego do uruchamiania oceny. Określa schemat danych używanych w ocenie.	Yes
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Nazwa oceny.	Nie.
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.
kryteria_testowe	tablica elementów OpenAI.EvalGraderLabelModel lub OpenAI.EvalGraderStringCheck lub OpenAI.EvalGraderTextSimilarity lub OpenAI.EvalGraderPython lub OpenAI.EvalGraderScoreModel lub EvalGraderAzureAIEvaluator	Lista osób oceniających dla wszystkich przebiegów oceny w tej grupie. Klasyfikatory mogą odwoływać się do zmiennych w źródle danych przy użyciu notacji podwójnych nawiasów klamrowych, takich jak `{{item.variable_name}}`. Aby odwołać się do danych wyjściowych modelu, użyj `sample` przestrzeni nazw (tj. `{{sample.output_text}}`).	Yes

CreateEvalRunRequest

Name	Typ	Description	Obowiązkowy
źródło danych	OpenAI.CreateEvalJsonlRunDataSource lub OpenAI.CreateEvalCompletionsRunDataSource lub OpenAI.CreateEvalResponsesRunDataSource lub EvalRunDataSource	Szczegółowe informacje o źródle danych przebiegu.	Yes
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg	Nazwa przebiegu.	Nie.
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.

Typ poświadczeń

Typ poświadczeń używany przez połączenie

Property	Value
Opis	Typ poświadczeń używany przez połączenie
Type	ciąg
Wartości	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

Wyzwalacz oparty na Cronie.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
endTime	ciąg	Czas zakończenia harmonogramu cron w formacie ISO 8601.	Nie.
wyrażenie	ciąg	Wyrażenie Crona, które definiuje częstotliwość harmonogramu.	Yes
startTime	ciąg	Godzina rozpoczęcia harmonogramu cron w formacie ISO 8601.	Nie.
timeZone	ciąg	Strefa czasowa dla harmonogramu cron.	Nie.	UTC
typ	wyliczenie	Możliwe wartości: `Cron`	Yes

Customcredential

Niestandardowa definicja poświadczeń

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

Ten obiekt akceptuje również dodatkowe właściwości typu: string

DailyRecurrenceSchedule

Harmonogram codziennych cykli.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
hours	tablica liczb całkowitych	Godziny harmonogramu cyklu.	Yes
typ	wyliczenie	Typ cyklu dziennego. Możliwe wartości: `Daily`	Yes

DataSourceConfig

Klasa podstawowa do uruchamiania źródeł danych z obsługą dyskryminującą.

Dyskryminujące dla elementu DataSourceConfig

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

Typ wartości	Schema

Name	Typ	Description	Obowiązkowy	Wartość domyślna
schemat	obiekt	Ogólny schemat JSON obiektu dla elementów źródła danych uruchamiania.	Yes
typ	ciąg	Dyskryminujący typ źródła danych.	Yes

Typ zestawu danych

Wyliczenie w celu określenia typu danych.

Property	Value
Opis	Wyliczenie w celu określenia typu danych.
Type	ciąg
Wartości	`uri_file` `uri_folder`

DatasetVersion

Definicja wersji zestawu danych DatasetVersion

Dyskryminujący dla elementu DatasetVersion

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

Typ wartości	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Name	Typ	Description	Obowiązkowy
Connectionname	ciąg	Nazwa połączenia konta Azure Storage. Wymagane, jeśli parametr startPendingUploadVersion nie został wywołany przed utworzeniem zestawu danych	Nie.
dataUri	ciąg	Identyfikator URI danych (przykład) Ograniczenia: minLength: 1, wzorzec: `[a-zA-Z0-9_]`	Yes
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
Isreference	Wartość logiczna (tylko do odczytu)	Wskazuje, czy zestaw danych zawiera odwołanie do magazynu, czy zestaw danych zarządza samym magazynem. Jeśli to prawda, dane bazowe nie zostaną usunięte po usunięciu wersji zestawu danych	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	Typ zestawu danych	Wyliczenie w celu określenia typu danych.	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

DatasetVersionUpdate

Definicja wersji zestawu danych DatasetVersion

Dyskryminujące dla elementu DatasetVersionUpdate

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

Typ wartości	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	Typ zestawu danych	Wyliczenie w celu określenia typu danych.	Yes

DzieńTygodnia

Dni tygodnia dla harmonogramu cyklu.

Property	Value
Opis	Dni tygodnia dla harmonogramu cyklu.
Type	ciąg
Wartości	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Usunięty obiekt agenta

Name	Typ	Description	Obowiązkowy
usunięta	boolean	Czy agent został pomyślnie usunięty.	Yes
nazwa	ciąg	Nazwa agenta.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "agent.deleted". Możliwe wartości: `agent.deleted`	Yes

DeleteAgentVersionResponse

Usunięta wersja agenta Object

Name	Typ	Description	Obowiązkowy
usunięta	boolean	Czy agent został pomyślnie usunięty.	Yes
nazwa	ciąg	Nazwa agenta.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "agent.version.deleted". Możliwe wartości: `agent.version.deleted`	Yes
wersja	ciąg	Identyfikator wersji agenta.	Yes

DeleteEvalResponse

Usunięty obiekt oceny

Name	Typ	Description	Obowiązkowy
usunięta	boolean	Czy eval został pomyślnie usunięty.	Yes
eval_id	ciąg	identyfikator ewalu.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.deleted". Możliwe wartości: `eval.deleted`	Yes

DeleteEvalRunResponse

Usunięty obiekt przebiegu oceny.

Name	Typ	Description	Obowiązkowy
usunięta	boolean	Czy eval został pomyślnie usunięty.	Nie.
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.deleted". Możliwe wartości: `eval.deleted`	Nie.
run_id	ciąg	identyfikator ewalu.	Nie.

DeleteMemoryStoreResponse

Name	Typ	Description	Obowiązkowy
usunięta	boolean	Czy magazyn pamięci został pomyślnie usunięty.	Yes
nazwa	ciąg	Nazwa magazynu pamięci.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "memory_store.deleted". Możliwe wartości: `memory_store.deleted`	Yes

DeleteResponseResult

Wynik operacji usuwania odpowiedzi.

Name	Typ	Description	Obowiązkowy
usunięta	wyliczenie	Zawsze zwracaj wartość true Możliwe wartości: `True`	Yes
id	ciąg	Identyfikator operacji.	Yes
obiekt	wyliczenie	Zawsze zwracaj wartość "response". Możliwe wartości: `response`	Yes

Deployment

Definicja wdrożenia modelu

Dyskryminujące wdrożenie

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

Typ wartości	Schema
`ModelDeployment`	ModelDeployment

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nazwa	ciąg (tylko do odczytu)	Nazwa wdrożenia	Yes
typ	Deploymenttype		Yes

Deploymenttype

Property	Value
Type	ciąg
Wartości	`ModelDeployment`

EntraIDCredentials

Definicja poświadczenia Entra ID

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

Ewaluacja

Obiekt Eval z konfiguracją źródła danych i kryteriami testowania. Eval reprezentuje zadanie, które należy wykonać na potrzeby Twojej integracji z LLM. Lubię to:

Poprawianie jakości mojego czatbota
Zobacz, jak dobrze mój czatbot obsługuje obsługę klienta
Sprawdź, czy o4-mini jest lepiej w moim przypadku użycia niż gpt-4o

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) wskazująca moment utworzenia oceny.	Yes
utworzone_przez	ciąg	imię i nazwisko osoby, która utworzyła przebieg.	Nie.
konfiguracja źródła danych	OpenAI.CreateEvalCustomDataSourceConfig lub OpenAI.CreateEvalLogsDataSourceConfig lub OpenAI.CreateEvalStoredCompletionsDataSourceConfig lub AzureAIDataSourceConfig	Konfiguracja źródeł danych używanych w przebiegach oceny.	Yes
id	ciąg	Unikatowy identyfikator oceny.	Yes
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Yes
modified_at	liczba całkowita		Nie.
nazwa	ciąg	Nazwa oceny.	Yes
obiekt	wyliczenie	Typ obiektu. Możliwe wartości: `eval`	Yes
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.
kryteria_testowe	tablica elementów OpenAI.EvalGraderLabelModel lub OpenAI.EvalGraderStringCheck lub OpenAI.EvalGraderTextSimilarity lub OpenAI.EvalGraderPython lub OpenAI.EvalGraderScoreModel lub EvalGraderAzureAIEvaluator	Lista kryteriów testowania.	Yes

EvalCsvFileIdSource

Reprezentuje odwołanie do przekazanego pliku CSV używanego jako źródło danych ewaluacyjnych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
id	ciąg	Identyfikator przekazanego pliku CSV.	Yes
typ	wyliczenie	Typ źródła, zawsze `file_id`. Możliwe wartości: `file_id`	Yes

EvalCsvRunDataSource

Reprezentuje źródło danych CSV na potrzeby przebiegów oceny.

Name	Typ	Description	Obowiązkowy
przesłać źródło	EvalCsvFileIdSource	Reprezentuje odwołanie do przekazanego pliku CSV używanego jako źródło danych ewaluacyjnych.	Yes
└─ ID	ciąg	Identyfikator przekazanego pliku CSV.	Yes
└typ	wyliczenie	Typ źródła, zawsze `file_id`. Możliwe wartości: `file_id`	Yes
typ	wyliczenie	Typ źródła danych, zawsze `csv`. Możliwe wartości: `csv`	Yes

EvalGraderAzureAIEvaluator

Name	Typ	Description	Obowiązkowy
mapowanie danych	obiekt	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Nie.
evaluator_name	ciąg	Nazwa ewaluatora.	Yes
evaluator_version	ciąg	Wersja ewaluatora. Najnowsza wersja, jeśli nie zostanie określona.	Nie.
initialization_parameters	obiekt	Parametry inicjowania oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Nie.
nazwa	ciąg	Nazwa oceniającego.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `azure_ai_evaluator`. Możliwe wartości: `azure_ai_evaluator`	Yes

EvalResult

Wynik oceny.

Name	Typ	Description	Obowiązkowy
nazwa	ciąg	nazwa sprawdzania	Yes
Przekazywane	boolean	wskazuje, czy sprawdzanie zakończyło się powodzeniem lub niepowodzeniem	Yes
wynik	number	wynik	Yes
typ	ciąg	typ sprawdzania	Yes

EvalRun

Schemat reprezentujący przebieg oceny.

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia przebiegu oceny.	Yes
utworzone_przez	ciąg	imię i nazwisko osoby, która utworzyła przebieg.	Nie.
źródło danych	OpenAI.CreateEvalJsonlRunDataSource lub OpenAI.CreateEvalCompletionsRunDataSource lub OpenAI.CreateEvalResponsesRunDataSource lub EvalRunDataSource	Informacje o źródle danych przebiegu.	Yes
błąd	OpenAI.EvalApiError	Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.	Yes
eval_id	ciąg	Identyfikator skojarzonej oceny.	Yes
id	ciąg	Unikatowy identyfikator przebiegu oceny.	Yes
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Yes
model	ciąg	Model, który jest oceniany, jeśli ma zastosowanie.	Yes
modified_at	liczba całkowita		Nie.
nazwa	ciąg	Nazwa przebiegu oceny.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.run". Możliwe wartości: `eval.run`	Yes
użycie na model	tablica elementów OpenAI.EvalRunPerModelUsage	Statystyki użycia dla każdego modelu podczas przebiegu oceny.	Yes
wyniki_wg_kryteriów_testowych	tablica obiektów OpenAI.EvalRunPerTestingCriteriaResults	Wyniki na kryteria testowania stosowane podczas przebiegu oceny.	Yes
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.
report_url	ciąg	Adres URL wyświetlonego raportu przebiegu oceny na pulpicie interfejsu użytkownika.	Yes
wyniki_liczby	OpenAI.EvalRunResultCounts		Yes
└─ Wystąpił błąd	OpenAI.integer		Yes
└* nie powiodło się	OpenAI.integer		Yes
└* zaliczone	OpenAI.integer		Yes
└─ suma	OpenAI.integer		Yes
stan	ciąg	Stan przebiegu oceny.	Yes

EvalRunDataSource

Klasa podstawowa do uruchamiania źródeł danych z obsługą dyskryminującą.

Dyskryminujące dla elementu EvalRunDataSource

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

Typ wartości	Schema
`azure_ai_traces_preview`	TracesPreviewEvalRunDataSource
`azure_ai_synthetic_data_gen_preview`	SyntheticDataGenerationPreviewEvalRunDataSource
`azure_ai_responses`	AzureAIResponsesEvalRunDataSource
`azure_ai_target_completions`	TargetCompletionEvalRunDataSource
`csv`	EvalCsvRunDataSource
`azure_ai_red_team`	RedTeamEvalRunDataSource

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	ciąg	Dyskryminujący typ źródła danych.	Yes

EvalRunOutputItem

Schemat reprezentujący element wyjściowy przebiegu oceny.

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia przebiegu oceny.	Yes
element źródła danych	obiekt	Szczegóły elementu wejściowego źródła danych.	Yes
"identyfikator_elementu_źródła_danych (datasource_item_id)"	OpenAI.integer		Yes
eval_id	ciąg	Identyfikator grupy ewaluacyjnej.	Yes
id	ciąg	Unikatowy identyfikator elementu wyjściowego procesu oceny.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.run.output_item". Możliwe wartości: `eval.run.output_item`	Yes
results	tablica EvalRunOutputItemResult	Lista wyników klasyzatora dla tego elementu wyjściowego.	Yes
run_id	ciąg	Identyfikator przebiegu oceny skojarzonego z tym elementem wyjściowym.	Yes
próbka	OpenAI.EvalRunOutputItemSample		Yes
└─ błąd	OpenAI.EvalApiError	Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.	Yes
└ finish_reason	ciąg		Yes
└─ Wejście	tablica EvalRunOutputItemSampleInput		Yes
└─ maksymalna_ilość_znaków_do_zakończenia	OpenAI.integer		Yes
└─ Model	ciąg		Yes
└─ Dane wyjściowe	tablica EvalRunOutputItemSampleOutput		Yes
└─ nasion	OpenAI.integer		Yes
└* temperatura	OpenAI.numeric		Yes
└─top_p	OpenAI.numeric		Yes
└─ użycie	OpenAI.EvalRunOutputItemSampleUsage		Yes
stan	ciąg	Stan przebiegu oceny.	Yes

EvalRunOutputItemResult

Pojedynczy wynik klasykatora dla elementu wyjściowego przebiegu oceny.

Name	Typ	Description	Obowiązkowy
etykieta	ciąg	Etykieta skojarzona z metryką kryteriów testu (np. "pass", "fail", "good", "bad").	Nie.
metryka	ciąg	Nazwa metryki (np. "fluency", "f1_score").	Nie.
nazwa	ciąg	Nazwa oceniającego.	Yes
Przekazywane	boolean	Czy klasyk uznał dane wyjściowe za przekazywanie.	Yes
properties	obiekt	Dodatkowe szczegóły dotyczące metryki kryteriów testu.	Nie.
powód	ciąg	Przyczyna metryki kryteriów testu.	Nie.
próbka	object (dopuszczana wartość null)	Opcjonalne próbki lub dane pośrednie generowane przez klasykator.	Nie.
wynik	OpenAI.numeric		Yes
próg	number	Próg używany do określania przebiegu/niepowodzenia dla tych kryteriów testu, jeśli jest to wartość liczbowa.	Nie.
typ	ciąg	Typ klasyra (na przykład "string-check-grader").	Nie.

Ten obiekt akceptuje również dodatkowe właściwości.

EvalRunOutputItemSampleInput

Komunikat w przebiegu oceny.

Name	Typ	Description	Obowiązkowy
zawartość	ciąg		Yes
rola	ciąg		Yes
tool_calls	tablica elementu CompletionMessageToolCallChunk	Wywołania narzędzi wykonane w wiadomości, jeśli istnieją.	Yes

EvalRunOutputItemSampleOutput

Komunikat w przebiegu oceny.

Name	Typ	Description	Obowiązkowy
zawartość	ciąg		Nie.
rola	ciąg		Nie.
tool_calls	tablica elementu CompletionMessageToolCallChunk	Wywołania narzędzi wykonane w wiadomości, jeśli istnieją.	Yes

EvalRunResultCompareItem

Porównanie wskaźników leczenia w stosunku do wartości wyjściowej.

Name	Typ	Description	Obowiązkowy
deltaEstimate	number	Szacowana różnica między leczeniem a punktem odniesienia.	Yes
pValue	number	Wartość P dla efektu leczenia.	Yes
leczenieEffect	TreatmentEffectType	Rodzaj efektu zabiegu.	Yes
leczenieRunId	ciąg	Identyfikator przebiegu leczenia.	Yes
leczenieRunSummary	EvalRunResultSummary	Statystyki podsumowujące metrykę w przebiegu oceny.	Yes
└* średnia	number	Średnia wartość metryki w przebiegu oceny.	Yes
└* runId	ciąg	Identyfikator przebiegu oceny.	Yes
└* sampleCount	liczba całkowita	Liczba próbek w przebiegu oceny.	Yes
└* standardowaDeviation	number	Odchylenie standardowe metryki w przebiegu oceny.	Yes

EvalRunResultComparison

Wyniki porównania dla leczenia są sprzeczne z wartością wyjściową.

Name	Typ	Description	Obowiązkowy
baselineRunSummary	EvalRunResultSummary	Statystyki podsumowujące metrykę w przebiegu oceny.	Yes
└* średnia	number	Średnia wartość metryki w przebiegu oceny.	Yes
└* runId	ciąg	Identyfikator przebiegu oceny.	Yes
└* sampleCount	liczba całkowita	Liczba próbek w przebiegu oceny.	Yes
└* standardowaDeviation	number	Odchylenie standardowe metryki w przebiegu oceny.	Yes
compareItems	tablica EvalRunResultCompareItem	Lista wyników porównania dla każdego przebiegu leczenia.	Yes
Oceniającego	ciąg	Nazwa ewaluatora dla tych kryteriów testowania.	Yes
metryka	ciąg	Obliczana metryka.	Yes
testingCriteria	ciąg	Nazwa kryteriów testowania.	Yes

EvalRunResultSummary

Statystyki podsumowujące metrykę w przebiegu oceny.

Name	Typ	Description	Obowiązkowy
średnia	number	Średnia wartość metryki w przebiegu oceny.	Yes
identyfikator uruchomienia	ciąg	Identyfikator przebiegu oceny.	Yes
sampleCount	liczba całkowita	Liczba próbek w przebiegu oceny.	Yes
StandardowaDeviation	number	Odchylenie standardowe metryki w przebiegu oceny.	Yes

EvaluationComparisonInsightRequest

Prośba o porównanie oceny

Name	Typ	Description	Obowiązkowy
baselineRunId	ciąg	Identyfikator przebiegu punktu odniesienia dla porównania.	Yes
evalId	ciąg	Identyfikator oceny.	Yes
leczenieRunIds	tablica ciągów	Lista identyfikatorów przebiegów leczenia do porównania.	Yes
typ	wyliczenie	Typ żądania. Możliwe wartości: `EvaluationComparison`	Yes

EvaluationComparisonInsightResult

Wnioski z porównania ewaluacji.

Name	Typ	Description	Obowiązkowy
Porównania	tablica EvalRunResultComparison	Wyniki porównania dla każdego przebiegu leczenia względem punktu odniesienia.	Yes
metoda	ciąg	Metoda statystyczna użyta do porównania.	Yes
typ	wyliczenie	Typ wyniku szczegółowych informacji. Możliwe wartości: `EvaluationComparison`	Yes

EvaluationResultSample

Próbka z wyniku oceny.

Name	Typ	Description	Obowiązkowy
correlationInfo	obiekt	Informacje o korelacji dla próbki analizy.	Yes
evaluationResult	EvalResult	Wynik oceny.	Yes
└─ nazwa	ciąg	nazwa sprawdzania	Yes
└* zaliczone	boolean	wskazuje, czy sprawdzanie zakończyło się powodzeniem lub niepowodzeniem	Yes
└* wynik	number	wynik	Yes
└typ	ciąg	typ sprawdzania	Yes
features	obiekt	Funkcje ułatwiające dodatkowe filtrowanie danych w środowisku użytkownika.	Yes
id	ciąg	Unikatowy identyfikator próbki analizy.	Yes
typ	wyliczenie	Typ przykładu wyniku oceny Możliwe wartości: `EvaluationResultSample`	Yes

Reguła oceny

Model reguły oceny.

Name	Typ	Description	Obowiązkowy
akcja	EvaluationRuleAction	Model działania ewaluacyjnego.	Yes
└typ	EvaluationRuleActionType	Rodzaj działania w ramach oceny.	Yes
opis	ciąg	Opis reguły oceny.	Nie.
displayName	ciąg	Nazwa wyświetlana reguły oceny.	Nie.
enabled	boolean	Wskazuje, czy reguła oceny jest włączona. Wartość domyślna to true.	Yes
eventType	EvaluationRuleEventType	Typ zdarzenia reguły oceny.	Yes
filtr	EvaluationRuleFilter	Model filtru oceny.	Nie.
└} agentName	ciąg	Filtruj według nazwy agenta.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator reguły oceny.	Yes
daneSystemowe	obiekt (tylko do odczytu)	Metadane systemu dla reguły oceny.	Yes

EvaluationRuleAction

Model działania ewaluacyjnego.

Dyskryminowanie ocenyRuleAction

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

Typ wartości	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	EvaluationRuleActionType	Rodzaj działania w ramach oceny.	Yes

EvaluationRuleActionType

Rodzaj działania w ramach oceny.

Property	Value
Opis	Rodzaj działania w ramach oceny.
Type	ciąg
Wartości	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

Typ zdarzenia reguły oceny.

Property	Value
Opis	Typ zdarzenia reguły oceny.
Type	ciąg
Wartości	`responseCompleted` `manual`

EvaluationRuleFilter

Model filtru oceny.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
agentName	ciąg	Filtruj według nazwy agenta.	Yes

EvaluationRunClusterInsightRequest

Wgląd w zestaw wyników ewaluacji

Name	Typ	Description	Obowiązkowy
evalId	ciąg	Identyfikator oceny dla szczegółowych informacji.	Yes
modelKonfiguracja	InsightModelConfiguration	Konfiguracja modelu używanego w generowaniu wniosków.	Nie.
└* modelDeploymentName	ciąg	Wdrożenie modelu do oceny. Akceptuje nazwę wdrożenia samodzielnie lub z nazwą połączenia jako `{connectionName}/<modelDeploymentName>`.	Yes
identyfikatory runId	tablica ciągów	Lista identyfikatorów przebiegów oceny dla szczegółowych informacji.	Yes
typ	wyliczenie	Typ żądania szczegółowych informacji. Możliwe wartości: `EvaluationRunClusterInsight`	Yes

EvaluationRunClusterInsightResult

Szczegółowe informacje z oceny uruchamiają analizę skupień.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
clusterInsight	ClusterInsightResult	Wnioski z analizy skupień.	Yes
typ	wyliczenie	Typ wyniku szczegółowych informacji. Możliwe wartości: `EvaluationRunClusterInsight`	Yes

EvaluationScheduleTask

Zadanie oceny harmonogramu.

Name	Typ	Description	Obowiązkowy
konfiguracja	obiekt	Konfiguracja zadania.	Nie.
evalId	ciąg	Identyfikator grupy ewaluacyjnej.	Yes
evalRun	obiekt	Ładunek przebiegu oceny.	Yes
typ	wyliczenie	Możliwe wartości: `Evaluation`	Yes

EvaluationTaxonomy

Definicja taksonomii oceny

Name	Typ	Description	Obowiązkowy
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
properties	obiekt	Dodatkowe właściwości taksonomii oceny.	Nie.
taksonomiaKategorie	tablica taksonomiiKategory	Lista kategorii taksonomii.	Nie.
taksonomiaInput	EvaluationTaxonomyInput	Konfiguracja danych wejściowych dla taksonomii oceny.	Yes
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

EvaluationTaxonomyCreateOrUpdate

Definicja taksonomii oceny

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
properties	obiekt	Dodatkowe właściwości taksonomii oceny.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
taksonomiaKategorie	tablica taksonomiiKategory	Lista kategorii taksonomii.	Nie.
taksonomiaInput	EvaluationTaxonomyInput	Konfiguracja danych wejściowych dla taksonomii oceny.	Yes
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Yes

EvaluationTaxonomyInput

Konfiguracja danych wejściowych dla taksonomii oceny.

Dyskryminowanie wartości EvaluationTaxonomyInput

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

Typ wartości	Schema
`agent`	AgentTaxonomyInput

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	EvaluationTaxonomyInputType	Rodzaj danych wejściowych oceny taksonomii.	Yes

EvaluationTaxonomyInputType

Rodzaj danych wejściowych oceny taksonomii.

Property	Value
Opis	Rodzaj danych wejściowych oceny taksonomii.
Type	ciąg
Wartości	`agent` `policy`

EvaluationTaxonomyInputUpdate

Konfiguracja danych wejściowych dla taksonomii oceny.

Dyskryminator ocenyTaxonomyInputUpdate

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

Typ wartości	Schema
`agent`	AgentTaxonomyInputUpdate

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	EvaluationTaxonomyInputType	Rodzaj danych wejściowych oceny taksonomii.	Yes

EvaluationTaxonomyUpdate

Definicja taksonomii oceny

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
properties	obiekt	Dodatkowe właściwości taksonomii oceny.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
taksonomiaKategorie	tablica taksonomiiKategory	Lista kategorii taksonomii.	Nie.
taksonomiaInput	EvaluationTaxonomyInputUpdate	Konfiguracja danych wejściowych dla taksonomii oceny.	Nie.
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Yes

EwaluatorCategory

Kategoria osoby oceniającej

Property	Value
Opis	Kategoria osoby oceniającej
Type	ciąg
Wartości	`quality` `safety` `agents`

EwaluatorDefinition

Podstawowa konfiguracja ewaluatora z dyskryminatorem

Dyskryminowanie ewaluatoraDefinition

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

Typ wartości	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

Name	Typ	Description	Obowiązkowy
data_schema	obiekt	Schemat JSON (wersja robocza 2020-12) dla danych wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
init_parameters	obiekt	Schemat JSON (wersja robocza 2020-12) dla parametrów wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
metryki	obiekt	Lista wskaźników wyjściowych opracowanych przez tego ewaluatora	Nie.
typ	EwaluatorDefinitionType	Definicja rodzaju osoby ewaluującej	Yes

EwaluatorDefinitionType

Definicja rodzaju osoby ewaluującej

Property	Value
Opis	Definicja rodzaju osoby ewaluującej
Type	ciąg
Wartości	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EwaluatorMetric

Metryka ewaluatora

Name	Typ	Description	Obowiązkowy
desirable_direction	EwaluatorMetricDirection	Kierunek metryki wskazujący, czy wyższa wartość jest lepsza, niższa wartość jest lepsza, czy neutralna	Nie.
is_primary	boolean	Wskazuje, czy ta metryka jest podstawowa, gdy istnieje wiele metryk.	Nie.
max_value	number	Maksymalna wartość metryki. Jeśli nie zostanie określony, przyjmuje się, że jest on niezwiązany.	Nie.
min_value	number	Minimalna wartość metryki	Nie.
typ	EwaluatorMetricType	Rodzaj osoby oceniającej	Nie.

EwaluatorMetricDirection

Kierunek metryki wskazujący, czy wyższa wartość jest lepsza, niższa wartość jest lepsza, czy neutralna

Property	Value
Opis	Kierunek metryki wskazujący, czy wyższa wartość jest lepsza, niższa wartość jest lepsza, czy neutralna
Type	ciąg
Wartości	`increase` `decrease` `neutral`

EwaluatorMetricType

Rodzaj osoby oceniającej

Property	Value
Opis	Rodzaj osoby oceniającej
Type	ciąg
Wartości	`ordinal` `continuous` `boolean`

Typ ewaluatora

Rodzaj osoby oceniającej

Property	Value
Opis	Rodzaj osoby oceniającej
Type	ciąg
Wartości	`builtin` `custom`

EvaluatorVersion

Definicja ewaluatora

Name	Typ	Description	Obowiązkowy
categories	tablica EwaluatorCategory	Kategorie osoby oceniającej	Yes
utworzono_o	ciąg (tylko do odczytu)	Data/godzina utworzenia osoby oceniającej	Yes
utworzone_przez	ciąg (tylko do odczytu)	Twórca ewaluatora	Yes
definicja	EwaluatorDefinition	Podstawowa konfiguracja ewaluatora z dyskryminatorem	Yes
└data_schema	obiekt	Schemat JSON (wersja robocza 2020-12) dla danych wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
└init_parameters	obiekt	Schemat JSON (wersja robocza 2020-12) dla parametrów wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
Metryki └*	obiekt	Lista wskaźników wyjściowych opracowanych przez tego ewaluatora	Nie.
└typ	EwaluatorDefinitionType	Definicja rodzaju osoby ewaluującej	Yes
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Łatwiej jest znaleźć ewaluatora w AI Foundry. Nie musi być unikalny.	Nie.
evaluator_type	Typ ewaluatora	Rodzaj osoby oceniającej	Yes
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
metadane	obiekt	Metadane dotyczące osoby oceniającej	Nie.
modified_at	ciąg (tylko do odczytu)	Data/godzina ostatniej modyfikacji osoby oceniającej	Yes
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

EvaluatorVersionTworzenie

Definicja ewaluatora

Name	Typ	Description	Obowiązkowy
categories	tablica EwaluatorCategory	Kategorie osoby oceniającej	Yes
definicja	EwaluatorDefinition	Podstawowa konfiguracja ewaluatora z dyskryminatorem	Yes
└data_schema	obiekt	Schemat JSON (wersja robocza 2020-12) dla danych wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
└init_parameters	obiekt	Schemat JSON (wersja robocza 2020-12) dla parametrów wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
Metryki └*	obiekt	Lista wskaźników wyjściowych opracowanych przez tego ewaluatora	Nie.
└typ	EwaluatorDefinitionType	Definicja rodzaju osoby ewaluującej	Yes
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Łatwiej jest znaleźć ewaluatora w AI Foundry. Nie musi być unikalny.	Nie.
evaluator_type	Typ ewaluatora	Rodzaj osoby oceniającej	Yes
metadane	obiekt	Metadane dotyczące osoby oceniającej	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.

EvaluatorVersionUpdate

Definicja ewaluatora

Name	Typ	Description	Obowiązkowy
categories	tablica EwaluatorCategory	Kategorie osoby oceniającej	Nie.
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Łatwiej jest znaleźć ewaluatora w AI Foundry. Nie musi być unikalny.	Nie.
metadane	obiekt	Metadane dotyczące osoby oceniającej	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.

FabricDataAgentToolParameters

Parametry narzędzia agenta danych sieci szkieletowej.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
project_connections	tablica toolProjectConnection	Połączenia project dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Nie.

FileDatasetVersion

Definicja wersji pliku FileDatasetVersion

Name	Typ	Description	Obowiązkowy
Connectionname	ciąg	Nazwa połączenia konta Azure Storage. Wymagane, jeśli parametr startPendingUploadVersion nie został wywołany przed utworzeniem zestawu danych	Nie.
dataUri	ciąg	Identyfikator URI danych (przykład) Ograniczenia: minLength: 1, wzorzec: `[a-zA-Z0-9_]`	Yes
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
Isreference	Wartość logiczna (tylko do odczytu)	Wskazuje, czy zestaw danych zawiera odwołanie do magazynu, czy zestaw danych zarządza samym magazynem. Jeśli to prawda, dane bazowe nie zostaną usunięte po usunięciu wersji zestawu danych	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	wyliczenie	Typ zestawu danych Możliwe wartości: `uri_file`	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

FileDatasetVersionUpdate

Definicja wersji pliku FileDatasetVersion

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	wyliczenie	Typ zestawu danych Możliwe wartości: `uri_file`	Yes

FolderDatasetVersion

Definicja wersji pliku FileDatasetVersion

Name	Typ	Description	Obowiązkowy
Connectionname	ciąg	Nazwa połączenia konta Azure Storage. Wymagane, jeśli parametr startPendingUploadVersion nie został wywołany przed utworzeniem zestawu danych	Nie.
dataUri	ciąg	Identyfikator URI danych (przykład) Ograniczenia: minLength: 1, wzorzec: `[a-zA-Z0-9_]`	Yes
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
Isreference	Wartość logiczna (tylko do odczytu)	Wskazuje, czy zestaw danych zawiera odwołanie do magazynu, czy zestaw danych zarządza samym magazynem. Jeśli to prawda, dane bazowe nie zostaną usunięte po usunięciu wersji zestawu danych	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	wyliczenie	Typ zestawu danych Możliwe wartości: `uri_folder`	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

FolderDatasetVersionUpdate

Definicja wersji pliku FileDatasetVersion

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	wyliczenie	Typ zestawu danych Możliwe wartości: `uri_folder`	Yes

FunctionToolCall

Szczegóły wywołania narzędzia funkcji.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Argumenty	ciąg	Argumenty do wywołania funkcji za pomocą , wygenerowane przez model w formacie JSON.	Yes
nazwa	ciąg	Nazwa funkcji do wywołania.	Yes

HostedAgentDefinition

Definicja hostowanego agenta.

Name	Typ	Description	Obowiązkowy
container_protocol_versions	tablica wartości ProtocolVersionRecord	Protokoły obsługiwane przez agenta na potrzeby komunikacji przychodzącej kontenerów.	Yes
cpu	ciąg	Konfiguracja procesora CPU dla hostowanego agenta.	Yes
environment_variables	obiekt	Zmienne środowiskowe do ustawienia w kontenerze hostowanego agenta.	Nie.
obraz	ciąg	Identyfikator obrazu agenta, który ma zastosowanie do agentów hostowanych na podstawie obrazów.	Nie.
rodzaj	wyliczenie	Możliwe wartości: `hosted`	Yes
pamięć	ciąg	Konfiguracja pamięci hostowanego agenta.	Yes
rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
└rai_policy_name	ciąg	Nazwa zasad RAI do zastosowania.	Yes
Narzędzia	tablica narzędzi OpenAI.Tool	Szereg narzędzi, które model hostowanego agenta 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` .	Nie.

HourlyRecurrenceSchedule

Godzinowy harmonogram cykli.

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

HumanEvaluationPreviewRuleAction

Akcja reguły oceny dla oceny przez człowieka.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
templateId	Identyfikator zasobu	Identyfikator zapisanego zasobu.	Yes
typ	wyliczenie	Możliwe wartości: `humanEvaluationPreview`	Yes

Index

Definicja zasobu indeksu

Dyskryminujący indeks

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

Typ wartości	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Name	Typ	Description	Obowiązkowy
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	Typ indeksu		Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

Typ indeksu

Property	Value
Type	ciąg
Wartości	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

Definicja zasobu indeksu

Dyskryminujący dla indeksuAktualizuj

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

Typ wartości	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	Typ indeksu		Yes

Wgląd

Treść odpowiedzi dla szczegółowych informacji o klastrze.

Name	Typ	Description	Obowiązkowy
displayName	ciąg	Przyjazna dla użytkownika nazwa wyświetlana szczegółowych informacji.	Yes
id	ciąg (tylko do odczytu)	Unikatowy identyfikator raportu szczegółowych informacji.	Yes
metadane	InsightsMetadata (tylko do odczytu)	Metadane dotyczące szczegółowych informacji.	Yes
└* completedAt	ciąg	Sygnatura czasowa ukończenia szczegółowych informacji.	Nie.
└} createdAt	ciąg	Sygnatura czasowa utworzenia szczegółowych informacji.	Yes
żądanie	InsightRequest	Żądanie raportu szczegółowych informacji.	Yes
└typ	InsightType	Typ żądania.	Yes
result	InsightResult (tylko do odczytu)	Wynik spostrzeżeń.	Nie.
└typ	InsightType	Typ wyniku szczegółowych informacji.	Yes
stan	Azure. Core.Foundations.OperationState (tylko do odczytu)	Wyliczenie opisujące dozwolone stany operacji.	Yes

InsightCluster

Klaster próbek analitycznych.

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis klastra analizy.	Yes
id	ciąg	Identyfikator klastra analizy.	Yes
etykieta	ciąg	Etykieta dla klastra	Yes
Próbki	tablica insightSample	Lista przykładów należących do tego klastra. Puste, jeśli próbki są częścią podciągów.	Nie.
subClusters	tablica tablicy insightCluster	Lista podrzędnych elementów podrzędnych w tym klastrze. Pusty, jeśli nie istnieją żadne podrzędne elementy podrzędne.	Nie.
Sugestia	ciąg	Sugestia dotycząca klastra	Yes
suggestionTitle	ciąg	Tytuł sugestii dla klastra	Yes
weight	liczba całkowita	Waga klastra analizy. Wskazuje to liczbę próbek w klastrze.	Yes

InsightModelConfiguration

Konfiguracja modelu używanego w generowaniu wniosków.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
modelDeploymentName	ciąg	Wdrożenie modelu do oceny. Akceptuje nazwę wdrożenia samodzielnie lub z nazwą połączenia jako `{connectionName}/<modelDeploymentName>`.	Yes

InsightRequest

Żądanie raportu szczegółowych informacji.

Dyskryminująca analizaRequest

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

Typ wartości	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	InsightType	Prośba o wglądy.	Yes

Szczegółowe informacje

Wynik spostrzeżeń.

Dyskryminująca analizaResult

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

Typ wartości	Schema
`EvaluationComparison`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	InsightType	Prośba o wglądy.	Yes

InsightSample

Próbka z analizy.

Dyskryminowanie szczegółowych informacjiPrzykład

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

Typ wartości	Schema
`EvaluationResultSample`	EvaluationResultSample

Name	Typ	Description	Obowiązkowy
correlationInfo	obiekt	Informacje o korelacji dla próbki analizy.	Yes
features	obiekt	Funkcje ułatwiające dodatkowe filtrowanie danych w środowisku użytkownika.	Yes
id	ciąg	Unikatowy identyfikator próbki analizy.	Yes
typ	SampleType	Rodzaj próbki użytej w analizie.	Yes

InsightScheduleTask

Zadanie Wgląd dla harmonogramu.

Name	Typ	Description	Obowiązkowy
konfiguracja	obiekt	Konfiguracja zadania.	Nie.
analiza	Wgląd	Treść odpowiedzi dla szczegółowych informacji o klastrze.	Yes
└} displayName	ciąg	Przyjazna dla użytkownika nazwa wyświetlana szczegółowych informacji.	Yes
└─ ID	ciąg (tylko do odczytu)	Unikatowy identyfikator raportu szczegółowych informacji.	Yes
Metadane └*	InsightsMetadata (tylko do odczytu)	Metadane dotyczące raportu szczegółowych informacji.	Yes
└* żądanie	InsightRequest	Żądanie analizy szczegółowych informacji.	Yes
Wynik └*	InsightResult (tylko do odczytu)	Wynik raportu szczegółowych informacji.	Nie.
Stan └*	Azure. Core.Foundations.OperationState (tylko do odczytu)	Bieżący stan szczegółowych informacji.	Yes
typ	wyliczenie	Możliwe wartości: `Insight`	Yes

InsightSummary

Podsumowanie analizy skupień błędów.

Name	Typ	Description	Obowiązkowy
metoda	ciąg	Metoda używana do klastrowania.	Yes
sampleCount	liczba całkowita	Łączna liczba analizowanych próbek.	Yes
uniqueClusterCount	liczba całkowita	Łączna liczba unikatowych klastrów.	Yes
uniqueSubclusterCount	liczba całkowita	Całkowita liczba unikatowych etykiet podklasy.	Yes
użycie	ClusterTokenUsage	Użycie tokenu do analizy skupień	Yes
└* inputTokenUsage	liczba całkowita	użycie tokenu wejściowego	Yes
└} outputTokenUsage	liczba całkowita	użycie tokenu wyjściowego	Yes
└* totalTokenUsage	liczba całkowita	łączne użycie tokenu	Yes

InsightType

Prośba o wglądy.

Property	Value
Opis	Prośba o wglądy.
Type	ciąg
Wartości	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Metadane dotyczące szczegółowych informacji.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
completedAt	ciąg	Sygnatura czasowa ukończenia szczegółowych informacji.	Nie.
createdAt	ciąg	Sygnatura czasowa utworzenia szczegółowych informacji.	Yes

ItemGenerationParams

Reprezentuje zestaw parametrów używanych do sterowania operacjami generowania elementów.

Dyskryminujący element ItemGenerationParams

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

Typ wartości	Schema
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	ItemGenerationParamsType	Typy parametrów generowania elementów zespołu czerwonego.	Yes

ItemGenerationParamsType

Typy parametrów generowania elementów zespołu czerwonego.

Property	Value
Opis	Typy parametrów generowania elementów zespołu czerwonego.
Type	ciąg
Wartości	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Definicja indeksu zarządzanego Wyszukiwanie AI platformy Azure

Name	Typ	Description	Obowiązkowy
id	ciąg (tylko do odczytu)	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg (tylko do odczytu)	Nazwa zasobu	Yes
typ	wyliczenie	Typ indeksu Możliwe wartości: `ManagedAzureSearch`	Yes
wersja	ciąg (tylko do odczytu)	Wersja zasobu	Yes

ManagedAzureAISearchIndexUpdate

Definicja indeksu zarządzanego Wyszukiwanie AI platformy Azure

Name	Typ	Description	Obowiązkowy
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	wyliczenie	Typ indeksu Możliwe wartości: `ManagedAzureSearch`	Yes

MemoryItem

Pojedynczy element pamięci przechowywany w magazynie pamięci, zawierający zawartość i metadane.

Dyskryminujące dla elementu MemoryItem

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

Typ wartości	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

Name	Typ	Description	Obowiązkowy
zawartość	ciąg	Zawartość pamięci.	Yes
rodzaj	MemoryItemKind	Rodzaj elementu pamięci.	Yes
memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Yes
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes
updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Yes

MemoryItemKind

Rodzaj elementu pamięci.

Property	Value
Opis	Rodzaj elementu pamięci.
Type	ciąg
Wartości	`user_profile` `chat_summary`

MemoryOperation

Reprezentuje pojedynczą operację pamięci (tworzenie, aktualizowanie lub usuwanie) wykonywaną na elemencie pamięci.

Name	Typ	Description	Obowiązkowy
rodzaj	MemoryOperationKind	Rodzaj operacji pamięci.	Yes
memory_item	MemoryItem	Pojedynczy element pamięci przechowywany w magazynie pamięci, zawierający zawartość i metadane.	Yes
└─ zawartość	ciąg	Zawartość pamięci.	Yes
Rodzaj └*	MemoryItemKind	Rodzaj elementu pamięci.	Yes
└memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Yes
Zakres └*	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes
└updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Yes

MemoryOperationKind

Rodzaj operacji pamięci.

Property	Value
Opis	Rodzaj operacji pamięci.
Type	ciąg
Wartości	`create` `update` `delete`

MemorySearchItem

Pobrany element pamięci z wyszukiwania w pamięci.

Name	Typ	Description	Obowiązkowy
memory_item	MemoryItem	Pojedynczy element pamięci przechowywany w magazynie pamięci, zawierający zawartość i metadane.	Yes
└─ zawartość	ciąg	Zawartość pamięci.	Yes
Rodzaj └*	MemoryItemKind	Rodzaj elementu pamięci.	Yes
└memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Yes
Zakres └*	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes
└updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Yes

MemorySearchOptions

Opcje wyszukiwania w pamięci.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
max_memories	liczba całkowita	Maksymalna liczba elementów pamięci do zwrócenia.	Nie.

MemorySearchPreviewTool

Narzędzie do integracji wspomnień z agentem.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
memory_store_name	ciąg	Nazwa magazynu pamięci, który ma być używany.	Yes
zakres	ciąg	Przestrzeń nazw używana do grupowania i izolowania wspomnień, takich jak identyfikator użytkownika. Ogranicza liczbę wspomnień, które można odzyskać lub zaktualizować. Użyj specjalnej zmiennej `{{$userId}}` , aby określić zakres pamięci do bieżącego zalogowanego użytkownika.	Yes
search_options	MemorySearchOptions	Opcje wyszukiwania w pamięci.	Nie.
└max_memories	liczba całkowita	Maksymalna liczba elementów pamięci do zwrócenia.	Nie.
typ	wyliczenie	Typ narzędzia. Zawsze `memory_search_preview`. Możliwe wartości: `memory_search_preview`	Yes
update_delay	liczba całkowita	Czas oczekiwania przed aktualizacją wspomnień po braku aktywności (w sekundach). Domyślnie 300.	Nie.	300

MemorySearchToolCallItemParam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
results	tablica elementu MemorySearchItem	Wyniki zwrócone z wyszukiwania pamięci.	Nie.
typ	wyliczenie	Możliwe wartości: `memory_search_call`	Yes

MemorySearchToolCallItemResource

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
results	tablica elementu MemorySearchItem	Wyniki zwrócone z wyszukiwania pamięci.	Nie.
stan	wyliczenie	Stan wywołania narzędzia wyszukiwania pamięci. Jeden z `in_progress` `searching`, `completed`lub `incompletefailed`, Możliwe wartości: `in_progress`, , `searchingcompleted`, , `incompletefailed`	Yes
typ	wyliczenie	Możliwe wartości: `memory_search_call`	Yes

MemoryStoreDefaultDefinition

Domyślna implementacja magazynu pamięci.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
chat_model	ciąg	Nazwa lub identyfikator wdrożenia modelu uzupełniania czatu używany do przetwarzania pamięci.	Yes
embedding_model	ciąg	Nazwa lub identyfikator wdrożenia modelu osadzania używanego do przetwarzania pamięci.	Yes
rodzaj	wyliczenie	Rodzaj magazynu pamięci. Możliwe wartości: `default`	Yes
options	MemoryStoreDefaultOptions	Domyślne konfiguracje magazynu pamięci.	Nie.
└chat_summary_enabled	boolean	Czy włączyć wyodrębnianie podsumowania czatu i storage. Wartość domyślna to true.	Yes	True
└user_profile_details	ciąg	Określone kategorie lub typy informacji o profilu użytkownika do wyodrębnienia i przechowywania.	Nie.
└user_profile_enabled	boolean	Czy włączyć wyodrębnianie i storage profilu użytkownika. Wartość domyślna to true.	Yes	True

MemoryStoreDefaultOptions

Domyślne konfiguracje magazynu pamięci.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
chat_summary_enabled	boolean	Czy włączyć wyodrębnianie podsumowania czatu i storage. Wartość domyślna to true.	Yes	True
user_profile_details	ciąg	Określone kategorie lub typy informacji o profilu użytkownika do wyodrębnienia i przechowywania.	Nie.
user_profile_enabled	boolean	Czy włączyć wyodrębnianie i storage profilu użytkownika. Wartość domyślna to true.	Yes	True

MemoryStoreDefinition

Podstawowa definicja konfiguracji magazynu pamięci.

Dyskryminowanie dla klasy MemoryStoreDefinition

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

Typ wartości	Schema
`default`	MemoryStoreDefaultDefinition

Name	Typ	Description	Obowiązkowy	Wartość domyślna
rodzaj	MemoryStoreKind	Typ implementacji magazynu pamięci, który ma być używany.	Yes

MemoryStoreDeleteScopeResponse

Odpowiedź na usunięcie wspomnień z zakresu.

Name	Typ	Description	Obowiązkowy
usunięta	boolean	Czy operacja usuwania zakończyła się pomyślnie.	Yes
nazwa	ciąg	Nazwa magazynu pamięci.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze "memory_store.scope.deleted". Możliwe wartości: `memory_store.scope.deleted`	Yes
zakres	ciąg	Zakres, z którego usunięto wspomnienia.	Yes

MemoryStoreKind

Typ implementacji magazynu pamięci, który ma być używany.

Property	Value
Opis	Typ implementacji magazynu pamięci, który ma być używany.
Type	ciąg
Wartości	`default`

MemoryStoreObject

Magazyn pamięci, który może przechowywać i pobierać wspomnienia użytkownika.

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia magazynu pamięci.	Yes
definicja	MemoryStoreDefinition	Podstawowa definicja konfiguracji magazynu pamięci.	Yes
Rodzaj └*	MemoryStoreKind	Rodzaj magazynu pamięci.	Yes
opis	ciąg	Czytelny dla człowieka opis magazynu pamięci. Ograniczenia: maxLength: 512	Nie.
id	ciąg	Unikatowy identyfikator magazynu pamięci.	Yes
metadane	obiekt	Dowolne metadane klucz-wartość do skojarzenia z magazynem pamięci.	Nie.
nazwa	ciąg	Nazwa magazynu pamięci. Ograniczenia: maxLength: 256	Yes
obiekt	wyliczenie	Typ obiektu, który jest zawsze "memory_store". Możliwe wartości: `memory_store`	Yes
updated_at	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach), kiedy magazyn pamięci został ostatnio zaktualizowany.	Yes

MemoryStoreOperationUsage

Statystyki użycia operacji składnicy pamięci.

Name	Typ	Description	Obowiązkowy
embedding_tokens	liczba całkowita	Liczba tokenów osadzania.	Yes
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└cached_tokens	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ tokeny_rozumowania	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

MemoryStoreSearchResponse

Odpowiedź na wyszukiwanie w pamięci.

Name	Typ	Description	Obowiązkowy
Wspomnienia	tablica elementu MemorySearchItem	Powiązane elementy pamięci znalezione podczas operacji wyszukiwania.	Yes
search_id	ciąg	Unikatowy identyfikator tego żądania wyszukiwania. Użyj tej wartości jako previous_search_id w kolejnych żądaniach, aby wykonywać wyszukiwania przyrostowe.	Yes
użycie	MemoryStoreOperationUsage	Statystyki użycia operacji składnicy pamięci.	Yes
└embedding_tokens	liczba całkowita	Liczba tokenów osadzania.	Yes
└input_tokens	OpenAI.integer	Liczba tokenów wejściowych.	Yes
└input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Szczegółowy podział tokenów wejściowych.	Yes
└─ tokeny_wyjściowe	OpenAI.integer	Liczba tokenów wyjściowych.	Yes
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Szczegółowy podział tokenów wyjściowych.	Yes
└total_tokens	OpenAI.integer	Całkowita liczba użytych tokenów.	Yes

MemoryStoreUpdateCompletedResult

Wynik aktualizacji pamięci.

Name	Typ	Description	Obowiązkowy
memory_operations	tablica operacji MemoryOperation	Lista poszczególnych operacji pamięci, które zostały wykonane podczas aktualizacji.	Yes
użycie	MemoryStoreOperationUsage	Statystyki użycia operacji składnicy pamięci.	Yes
└embedding_tokens	liczba całkowita	Liczba tokenów osadzania.	Yes
└input_tokens	OpenAI.integer	Liczba tokenów wejściowych.	Yes
└input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Szczegółowy podział tokenów wejściowych.	Yes
└─ tokeny_wyjściowe	OpenAI.integer	Liczba tokenów wyjściowych.	Yes
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Szczegółowy podział tokenów wyjściowych.	Yes
└total_tokens	OpenAI.integer	Całkowita liczba użytych tokenów.	Yes

MemoryStoreUpdateResponse

Określa stan operacji aktualizacji magazynu pamięci.

Name	Typ	Description	Obowiązkowy
błąd	OpenAI.Error		Nie.
└* additionalInfo	obiekt		Nie.
└─ kod	ciąg (dopuszczany do wartości null)		Yes
└* debugInfo	obiekt		Nie.
└szczegóły	tablica openAI.Error		Nie.
└─ Komunikat	ciąg		Yes
└* param	ciąg (dopuszczany do wartości null)		Nie.
└typ	ciąg		Nie.
result	MemoryStoreUpdateCompletedResult	Wynik aktualizacji pamięci.	Nie.
└memory_operations	tablica operacji MemoryOperation	Lista poszczególnych operacji pamięci, które zostały wykonane podczas aktualizacji.	Yes
└─ użycie	MemoryStoreOperationUsage	Statystyki użycia skojarzone z operacją aktualizacji pamięci.	Yes
stan	MemoryStoreUpdateStatus	Stan operacji aktualizacji magazynu pamięci.	Yes
superseded_by	ciąg	Update_id operacja została zastąpiona przez stan "zastąpiony".	Nie.
update_id	ciąg	Unikatowy identyfikator tego żądania aktualizacji. Użyj tej wartości jako previous_update_id w kolejnych żądaniach w celu wykonania aktualizacji przyrostowych.	Yes

MemoryStoreUpdateStatus

Stan operacji aktualizacji magazynu pamięci.

Property	Value
Type	ciąg
Wartości	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

Informacje o definicji wejściowych dla narzędzia Microsoft Fabric używane do konfiguracji agenta.

Name	Typ	Description	Obowiązkowy
fabric_dataagent_preview	FabricDataAgentToolParameters	Parametry narzędzia agenta danych sieci szkieletowej.	Yes
└project_connections	tablica toolProjectConnection	Połączenia project dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia. Ograniczenia: maxItems: 1	Nie.
typ	wyliczenie	Typ obiektu, który zawsze jest "fabric_dataagent_preview". Możliwe wartości: `fabric_dataagent_preview`	Yes

Implementacja modelu

Definicja wdrożenia modelu

Name	Typ	Description	Obowiązkowy
capabilities	obiekt (tylko do odczytu)	Możliwości wdrożonego modelu	Yes
Connectionname	ciąg (tylko do odczytu)	Nazwa połączenia, z poziomu których pochodzi wdrożenie	Nie.
modelName	ciąg (tylko do odczytu)	Publisher nazwa wdrożonego modelu	Yes
modelPublisher	ciąg (tylko do odczytu)	Nazwa wydawcy wdrożonego modelu	Yes
wersja modelu	ciąg (tylko do odczytu)	Publisher wersji wdrożonego modelu	Yes
nazwa	ciąg (tylko do odczytu)	Nazwa wdrożenia	Yes
sku	Jednostka SKU (tylko do odczytu)	Informacje o jednostce SKU	Yes
Pojemność └*	liczba całkowita	Pojemność jednostki SKU	Yes
Rodzina └*	ciąg	Rodzina jednostek SKU	Yes
└─ nazwa	ciąg	Nazwa jednostki SKU	Yes
└* rozmiar	ciąg	Rozmiar jednostki SKU	Yes
Warstwa └*	ciąg	Warstwa jednostki SKU	Yes
typ	wyliczenie	Typ wdrożenia Możliwe wartości: `ModelDeployment`	Yes

ModelSamplingParams

Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.

Name	Typ	Description	Obowiązkowy
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Yes
seed	liczba całkowita	Losowe inicjatory do odtworzenia.	Yes
temperatura	number	Parametr temperatury do próbkowania.	Yes
top_p	number	Parametr top-p próbkowania jądra.	Yes

ModelSamplingParamsUpdate

Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.

Name	Typ	Description	Obowiązkowy
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Nie.
seed	liczba całkowita	Losowe inicjatory do odtworzenia.	Nie.
temperatura	number	Parametr temperatury do próbkowania.	Nie.
top_p	number	Parametr top-p próbkowania jądra.	Nie.

MonthlyRecurrenceSchedule

Miesięczny harmonogram cykli.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
daysOfMonth	tablica liczb całkowitych	Dni miesiąca dla harmonogramu cyklu.	Yes
typ	wyliczenie	Typ cyklu miesięcznego. Możliwe wartości: `Monthly`	Yes

NoAuthenticationCredentials

Poświadczenia, które nie wymagają uwierzytelniania

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

OAuthConsentRequestOutputItem

Żądanie od usługi, aby użytkownik wykonał zgodę OAuth.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
consent_link	ciąg	Link, za pomocą których użytkownik może wykonać zgodę OAuth.	Yes
id	ciąg		Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
etykieta_serwera	ciąg	Etykieta serwera dla żądania zgody OAuth.	Yes
typ	wyliczenie	Możliwe wartości: `oauth_consent_request`	Yes

OneTimeTrigger

Jednorazowy spust.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
timeZone	ciąg	Strefa czasowa dla wyzwalacza jednorazowego.	Nie.	UTC
triggerAt	ciąg	Data i godzina jednorazowego wyzwolenia w formacie ISO 8601.	Yes
typ	wyliczenie	Możliwe wartości: `OneTime`	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

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

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

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

OpenAI.ApplyPatchCreateFileOperation

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

Name	Typ	Description	Obowiązkowy
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

OpenAI.ApplyPatchCreateFileOperationParam

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

Name	Typ	Description	Obowiązkowy
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

OpenAI.ApplyPatchDeleteFileOperation

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

OpenAI.ApplyPatchDeleteFileOperationParam

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

OpenAI.ApplyPatchFileOperation

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

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

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

OpenAI.ApplyPatchUpdateFileOperation

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

Name	Typ	Description	Obowiązkowy
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

OpenAI.ApplyPatchUpdateFileOperationParam

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

Name	Typ	Description	Obowiązkowy
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

OpenAI.PrzybliżonaLokalizacja

Name	Typ	Description	Obowiązkowy
Miasta	ciąg (dopuszczany do wartości null)		Nie.
kraj	ciąg (dopuszczany do wartości null)		Nie.
region	ciąg (dopuszczany do wartości null)		Nie.
timezone	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ przybliżenia lokalizacji. Zawsze `approximate`. Możliwe wartości: `approximate`	Yes

OpenAI.ChatCompletionTool

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

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

OpenAI.ChatModel

Property Value

Type ciąg

Wartości gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat-latest
gpt-5.2-pro
gpt-5.2-pro-2025-12-11
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-codex
gpt-5.1-mini
gpt-5.1-chat-latest
gpt-5
gpt-5-mini
gpt-5-nano
gpt-5-2025-08-07
gpt-5-mini-2025-08-07
gpt-5-nano-2025-08-07
gpt-5-chat-latest
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4.1-2025-04-14
gpt-4.1-mini-2025-04-14
gpt-4.1-nano-2025-04-14
o4-mini
o4-mini-2025-04-16
o3
o3-2025-04-16
o3-mini
o3-mini-2025-01-31
o1
o1-2024-12-17
o1-preview
o1-preview-2024-09-12
o1-mini
o1-mini-2024-09-12
gpt-4o
gpt-4o-2024-11-20
gpt-4o-2024-08-06
gpt-4o-2024-05-13
gpt-4o-audio-preview
gpt-4o-audio-preview-2024-10-01
gpt-4o-audio-preview-2024-12-17
gpt-4o-audio-preview-2025-06-03
gpt-4o-mini-audio-preview
gpt-4o-mini-audio-preview-2024-12-17
gpt-4o-search-preview
gpt-4o-mini-search-preview
gpt-4o-search-preview-2025-03-11
gpt-4o-mini-search-preview-2025-03-11
chatgpt-4o-latest
codex-mini-latest
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4-turbo
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-turbo-preview
gpt-4-1106-preview
gpt-4-vision-preview
gpt-4
gpt-4-0314
gpt-4-0613
gpt-4-32k
gpt-4-32k-0314
gpt-4-32k-0613
gpt-3.5-turbo
gpt-3.5-turbo-16k
gpt-3.5-turbo-0301
gpt-3.5-turbo-0613
gpt-3.5-turbo-1106
gpt-3.5-turbo-0125
gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

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

OpenAI.ClickParam

Akcja kliknięcia.

Name	Typ	Description	Obowiązkowy
przycisk	OpenAI.ClickButtonType		Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji kliknięcia ta właściwość jest zawsze `click`. Możliwe wartości: `click`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.CodeInterpreterContainerAuto

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

Name	Typ	Description	Obowiązkowy
identyfikatory_plików	tablica ciągów	Opcjonalna lista przesłanych plików, które mają być dostępne w Twoim kodzie.	Nie.
limit_pamięci	OpenAI.ContainerMemoryLimit (dopuszczana do wartości null)		Nie.
typ	wyliczenie	Zawsze `auto`. Możliwe wartości: `auto`	Yes

OpenAI.CodeInterpreterOutputImage

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
url	ciąg	Adres URL wyjścia obrazu z interpretera kodu.	Yes

OpenAI.CodeInterpreterOutputLogs

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

OpenAI.CodeInterpreterTool

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.CodeInterpreterContainerAuto	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. Jeśli nie zostanie podana, usługa zakłada automatyczne użycie.	Nie.
typ	wyliczenie	Typ narzędzia interpretera kodu. Zawsze `code_interpreter`. Możliwe wartości: `code_interpreter`	Yes

OpenAI.CompactResource

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia skompaktowanej konwersacji.	Yes
id	ciąg	Unikatowy identyfikator skompaktowanej odpowiedzi.	Yes
obiekt	wyliczenie	Typ obiektu. Zawsze `response.compaction`. Możliwe wartości: `response.compaction`	Yes
We/Wy	tablica openAI.OutputItem	Kompaktowana lista elementów wyjściowych. Jest to lista wszystkich komunikatów użytkownika, po których następuje pojedynczy element kompaktowania.	Yes
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.	Yes
└input_tokens	OpenAI.integer	Liczba tokenów wejściowych.	Yes
└input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Szczegółowy podział tokenów wejściowych.	Yes
└─ tokeny_wyjściowe	OpenAI.integer	Liczba tokenów wyjściowych.	Yes
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Szczegółowy podział tokenów wyjściowych.	Yes
└total_tokens	OpenAI.integer	Całkowita liczba użytych tokenów.	Yes

OpenAI.CompactResponseMethodPublicBody

Name	Typ	Description	Obowiązkowy
dane wejściowe	ciąg lub tablica elementu OpenAI.InputItem		Nie.
instructions	ciąg (dopuszczany do wartości null)		Nie.
model	OpenAI.ModelIdsCompaction	Identyfikator modelu używany do generowania odpowiedzi, na przykład `gpt-5` lub `o3`. Platforma OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, charakterystykami wydajności i punktami cenowymi. Zapoznaj się z przewodnikiem po modelu , aby przeglądać i porównywać dostępne modele.	Yes
previous_response_id	ciąg (dopuszczany do wartości null)		Nie.

OpenAI.ComparisonFilter

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
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`, `gte`, , `ltlte`	Yes
value	ciąg lub openAI.numeric lub wartość logiczna lub tablica openAI.ComparisonFilterValueItems	Wartość do porównania z kluczem atrybutu; obsługuje typy ciągów, liczb lub wartości logicznych.	Yes

OpenAI.ComparisonFilterValueItems

Typ: ciąg lub OpenAI.numeric

OpenAI.CompoundFilter

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.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Zrzut ekranu
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

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

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 (dopuszczany do wartości null)		Nie.
id	ciąg	Identyfikator oczekującego sprawdzenia bezpieczeństwa.	Yes
komunikat	ciąg (dopuszczany do wartości null)		Nie.

OpenAI.ComputerŚrodowisko

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

OpenAI.ComputerScreenshotContent

Zrzut ekranu przedstawiający komputer.

Name	Typ	Description	Obowiązkowy
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Yes
image_url	ciąg		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

OpenAI.ComputerScreenshotImage

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

Name	Typ	Description	Obowiązkowy
identyfikator_pliku	ciąg	Identyfikator przekazanego pliku zawierającego zrzut ekranu.	Nie.
image_url	ciąg	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

OpenAI.NarzędziePodgląduUżytkowaniaKomputera

Narzędzie kontrolujące komputer wirtualny.

Name	Typ	Description	Obowiązkowy
wysokość ekranu	OpenAI.integer		Yes
szerokość_wyświetlacza	OpenAI.integer		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

OpenAI.ContainerFileCitationBody

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

Name	Typ	Description	Obowiązkowy
container_id	ciąg	Identyfikator pliku kontenera.	Yes
end_index	OpenAI.integer		Yes
identyfikator_pliku	ciąg	Identyfikator pliku.	Yes
filename	ciąg	Nazwa pliku kontenera przytoczony.	Yes
start_index	OpenAI.integer		Yes
typ	wyliczenie	Typ cytatu pliku kontenera. Zawsze `container_file_citation`. Możliwe wartości: `container_file_citation`	Yes

OpenAI.ContainerMemoryLimit

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

OpenAI.ConversationItem

Pojedynczy element w konwersacji. Zestaw możliwych typów jest taki sam jak output typ obiektu Response.

Dyskryminujące dla openAI.ConversationItem

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

Typ wartości	Schema
`message`	OpenAI.ConversationItemMessage
`function_call`	OpenAI.ConversationItemFunctionToolCallResource
`function_call_output`	OpenAI.ConversationItemFunctionToolCallOutputResource
`file_search_call`	OpenAI.ConversationItemFileSearchToolCall
`web_search_call`	OpenAI.ConversationItemWebSearchToolCall
`image_generation_call`	OpenAI.ConversationItemImageGenToolCall
`computer_call`	OpenAI.ConversationItemComputerToolCall
`computer_call_output`	OpenAI.ConversationItemComputerToolCallOutputResource
`reasoning`	OpenAI.ConversationItemReasoningItem
`code_interpreter_call`	OpenAI.ConversationItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ConversationItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ConversationItemLocalShellToolCallOutput
`shell_call`	OpenAI.ConversationItemFunctionShellCall
`shell_call_output`	OpenAI.ConversationItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.ConversationItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ConversationItemApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ConversationItemMcpListTools
`mcp_approval_request`	OpenAI.ConversationItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ConversationItemMcpApprovalResponseResource
`mcp_call`	OpenAI.ConversationItemMcpToolCall
`custom_tool_call`	OpenAI.ConversationItemCustomToolCall
`custom_tool_call_output`	OpenAI.ConversationItemCustomToolCallOutput

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

OpenAI.ConversationItemApplyPatchToolCall

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

Name	Typ	Description	Obowiązkowy
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

OpenAI.ConversationItemApplyPatchToolCallOutput

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

Name	Typ	Description	Obowiązkowy
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 (dopuszczany do wartości null)		Nie.
stan	OpenAI.ApplyPatchCallOutputStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call_output`. Możliwe wartości: `apply_patch_call_output`	Yes

OpenAI.ConversationItemCodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy
kod	ciąg (dopuszczany do wartości 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		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

OpenAI.ConversationItemComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera. Aby uzyskać więcej informacji, zobacz przewodnik dotyczący korzystania z komputera .

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.ComputerAction		Yes
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

OpenAI.ConversationItemComputerToolCallOutputResource

Name	Typ	Description	Obowiązkowy
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	Identyfikator wyniku wywołania komputerowego narzędzia.	Nie.
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

OpenAI.ConversationItemCustomToolCall

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
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.ConversationItemCustomToolCallOutput

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.ConversationItemFileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików. Aby uzyskać więcej informacji, zobacz przewodnik 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 obiektów OpenAI.FileSearchToolCallResults		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.ConversationItemFunctionShellCall

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

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.FunctionShellAction	Wykonaj polecenie powłoki.	Yes
Polecenia └*	tablica ciągów		Yes
└max_output_length	OpenAI.integer (dopuszczający wartość null)		Yes
└timeout_ms	OpenAI.integer (dopuszczający wartość 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.
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.LocalShellCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes

OpenAI.ConversationItemFunctionShellCallOutput

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

Name	Typ	Description	Obowiązkowy
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	OpenAI.integer (dopuszczający wartość null)		Yes
We/Wy	tablica elementów OpenAI.FunctionShellCallOutputContent	Tablica zawartości danych wyjściowych wywołań powłoki	Yes
typ	wyliczenie	Typ danych wyjściowych wywołania powłoki. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania narzędzia funkcji. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Nie.
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.ConversationItemFunctionToolCallResource

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	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Nie.
nazwa	ciąg	Nazwa funkcji do uruchomienia.	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 wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.ConversationItemImageGenToolCall

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg (dopuszczany do wartości 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.ConversationItemList

Lista elementów konwersacji.

Name	Typ	Description	Obowiązkowy
dane	tablica openAI.ConversationItem	Lista elementów konwersacji.	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.ConversationItemLocalShellToolCall

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.ConversationItemLocalShellToolCallOutput

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	wyliczenie	Możliwe wartości: `in_progress`, , `completedincomplete`	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.ConversationItemMcpApprovalRequest

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.ConversationItemMcpApprovalResponseResource

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 (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.ConversationItemMcpListTools

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	ciąg (dopuszczany do wartości null)		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.ConversationItemMcpToolCall

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg (dopuszczany do wartości null)		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg (dopuszczany do wartości 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.ConversationItemMessage

Komunikat do lub z modelu.

Name	Typ	Description	Obowiązkowy
zawartość	tablica elementów OpenAI.MessageContent	Zawartość wiadomości	Yes
id	ciąg	Unikatowy identyfikator wiadomości.	Yes
rola	OpenAI.MessageRole		Yes
stan	OpenAI.MessageStatus		Yes
typ	wyliczenie	Typ komunikatu. Zawsze ustaw na `message`. Możliwe wartości: `message`	Yes

OpenAI.ConversationItemReasoningItem

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

Name	Typ	Description	Obowiązkowy
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg (dopuszczany do wartości 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	tablica interfejsu OpenAI.Summary	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

OpenAI.ConversationItemType

Property Value

Type ciąg

Wartości message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
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
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Wyniki wywołania narzędzia wyszukiwania w Internecie. Aby uzyskać więcej informacji, zobacz przewodnik 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ółowe informacje na temat sposobu użycia modelu w Internecie (wyszukiwanie, open_page, znajdowanie).	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.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.

Typ: ciąg lub OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

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, 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.ConversationResource

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Czas, w którym konwersacja została utworzona, mierzona w sekundach od epoki systemu Unix.	Yes
id	ciąg	Unikatowy identyfikator konwersacji.	Yes
metadane	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Yes
obiekt	wyliczenie	Typ obiektu, który jest zawsze `conversation`. Możliwe wartości: `conversation`	Yes

OpenAI.CreateChatCompletionRequestResponseFormat

Obiekt określający format, który musi zostać wygenerowany przez model. Ustawienie w celu { "type": "json_schema", "json_schema": {...} } włączenia danych wyjściowych ze strukturą, co gwarantuje, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku dotyczącym Strukturalnych danych wyjściowych. Włączenie trybu { "type": "json_object" } aktywuje starszy tryb JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.

Dyskryminujący format OpenAI.CreateChatCompletionRequestResponseFormat

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

Typ wartości	Schema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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.CreateChatCompletionRequestResponseFormatResponseFormatText

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.CreateChatCompletionRequestResponseFormatType

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

OpenAI.CreateConversationBody

Name	Typ	Description	Obowiązkowy	Wartość domyślna
items	tablica openAI.InputItem		Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.

OpenAI.CreateEvalCompletionsRunDataSource

Obiekt CompletionsRunDataSource opisujący konfigurację próbkowania modelu.

Name	Typ	Description	Obowiązkowy
wiadomości wejściowe	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate lub OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Używane podczas próbkowania z modelu. Określa strukturę komunikatów przekazywanych do modelu. Może być odwołaniem do wstępnie utworzonej trajektorii (tj `item.input_trajectory`. ) lub szablonu ze zmiennymi odwołaniami do `item` przestrzeni nazw.	Nie.
model	ciąg	Nazwa modelu, który ma być użyty do generowania uzupełnień (np. "o3-mini").	Nie.
parametry_próbowania	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Nie.
przesłać źródło	OpenAI.EvalJsonlFileContentSource lub OpenAI.EvalJsonlFileIdSource lub OpenAI.EvalStoredCompletionsSource	Określa, co wypełnia `item` przestrzeń nazw w źródle danych tego przebiegu.	Yes
typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze `completions`. Możliwe wartości: `completions`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Typ	Description	Obowiązkowy	Wartość domyślna
szablon	tablica openAI.EasyInputMessage lub OpenAI.EvalItem		Yes
typ	wyliczenie	Możliwe wartości: `template`	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Typ	Description	Obowiązkowy	Wartość domyślna
max_completion_tokens	OpenAI.integer		Nie.
wysiłek rozumowania	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.
format_odpowiedzi	OpenAI.ResponseFormatText lub OpenAI.ResponseFormatJsonSchema lub OpenAI.ResponseFormatJsonObject		Nie.
seed	OpenAI.integer		Nie.	42
temperatura	OpenAI.numeric		Nie.	1
Narzędzia	tablica narzędzi OpenAI.ChatCompletionTool		Nie.
top_p	OpenAI.numeric		Nie.	1

OpenAI.CreateEvalCustomDataSourceConfig

Obiekt CustomDataSourceConfig, który definiuje schemat źródła danych używanego do przeprowadzania serii ocen. Ten schemat służy do definiowania kształtu danych, które będą następujące:

Służy do definiowania kryteriów testowania i
Jakie dane są wymagane podczas tworzenia przebiegu

Name	Typ	Description	Obowiązkowy
uwzględnij_przykładowy_schemat	boolean	Czy podczas oceny należy oczekiwać wypełnienia przykładowej przestrzeni nazw (tj. przez generowanie odpowiedzi ze źródła danych)	Nie.
item_schema	obiekt	Schemat JSON dla każdego wiersza w źródle danych.	Yes
typ	wyliczenie	Typ źródła danych. Zawsze `custom`. Możliwe wartości: `custom`	Yes

OpenAI.CreateEvalJsonlRunDataSource

Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
przesłać źródło	OpenAI.EvalJsonlFileContentSource lub OpenAI.EvalJsonlFileIdSource	Określa, co wypełnia `item` przestrzeń nazw w źródle danych.	Yes
typ	wyliczenie	Typ źródła danych. Zawsze `jsonl`. Możliwe wartości: `jsonl`	Yes

OpenAI.CreateEvalLogsDataSourceConfig

Konfiguracja źródła danych określająca właściwość metadanych zapytania dotyczącego dzienników. Zazwyczaj są to metadane, takie jak usecase=chatbot lub prompt-version=v2, itp.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
metadane	obiekt	Filtry metadanych dla źródła danych dzienników.	Nie.
typ	wyliczenie	Typ źródła danych. Zawsze `logs`. Możliwe wartości: `logs`	Yes

OpenAI.CreateEvalResponsesRunDataSource

Obiekt ResponsesRunDataSource opisujący konfigurację próbkowania modelu.

Name	Typ	Description	Obowiązkowy
wiadomości wejściowe	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate lub OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Używane podczas próbkowania z modelu. Określa strukturę komunikatów przekazywanych do modelu. Może być odwołaniem do wstępnie utworzonej trajektorii (tj `item.input_trajectory`. ) lub szablonu ze zmiennymi odwołaniami do `item` przestrzeni nazw.	Nie.
model	ciąg	Nazwa modelu, który ma być użyty do generowania uzupełnień (np. "o3-mini").	Nie.
parametry_próbowania	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Nie.
przesłać źródło	OpenAI.EvalJsonlFileContentSource lub OpenAI.EvalJsonlFileIdSource lub OpenAI.EvalResponsesSource	Określa, co wypełnia `item` przestrzeń nazw w źródle danych tego przebiegu.	Yes
typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze `responses`. Możliwe wartości: `responses`	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Typ	Description	Obowiązkowy	Wartość domyślna
szablon	tablica obiektów lub OpenAI.EvalItem		Yes
typ	wyliczenie	Możliwe wartości: `template`	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Typ	Description	Obowiązkowy	Wartość domyślna
max_completion_tokens	OpenAI.integer		Nie.
wysiłek rozumowania	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.
seed	OpenAI.integer		Nie.	42
temperatura	OpenAI.numeric		Nie.	1
SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Nie.
Narzędzia	tablica narzędzi OpenAI.Tool		Nie.
top_p	OpenAI.numeric		Nie.	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

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.

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Zdezaktualizowane na rzecz LogsDataSourceConfig.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
metadane	obiekt	Filtry metadanych dla przechowywanego źródła danych uzupełniania.	Nie.
typ	wyliczenie	Typ źródła danych. Zawsze `stored_completions`. Możliwe wartości: `stored_completions`	Yes

OpenAI.CreateFineTuningJobRequest

Prawidłowe modele:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Typ	Description	Obowiązkowy	Wartość domyślna
hiperparametry	OpenAI.CreateFineTuningJobRequestHyperparameters		Nie.
└batch_size	string lub OpenAI.integer		Nie.	samochód
└ learning_rate_multiplier	string lub OpenAI.numeric		Nie.
└n_epochs	string lub OpenAI.integer		Nie.	samochód
Integracje	tablica obiektów OpenAI.CreateFineTuningJobRequestIntegrations	Lista integracji umożliwiających dostrajanie zadania.	Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
metoda	OpenAI.FineTuneMethod	Metoda używana do dostrajania.	Nie.
model	ciąg (zobacz prawidłowe modele poniżej)	Nazwa modelu do dostosowania. Możesz wybrać jedną z opcji obsługiwane modele.	Yes
seed	OpenAI.integer (dopuszczający wartość null)		Nie.
Sufiks	ciąg (dopuszczany do wartości null)	Ciąg składający się z maksymalnie 64 znaków, które zostaną dodane do nazwy dostrojonego modelu. Na przykład wartość `suffix` "custom-model-name" spowoduje wygenerowanie nazwy modelu, takiej jak `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Ograniczenia: minLength: 1, maxLength: 64	Nie.
plik szkoleniowy	ciąg	Identyfikator przekazanego pliku zawierającego dane szkoleniowe. Zobacz przekazywanie pliku , aby dowiedzieć się, jak przekazać plik. Zestaw danych musi być sformatowany jako plik JSONL. Ponadto należy wgrać swój plik w celu `fine-tune`. Zawartość pliku powinna się różnić w zależności od tego, czy model używa formatu czatu, uzupełniania lub czy metoda dostrajania dokładnego używa formatu preferencji . Aby uzyskać więcej informacji, zobacz przewodnik dostosowywania .	Yes
plik walidacji	ciąg (dopuszczany do wartości null)	Identyfikator przekazanego pliku zawierającego dane walidacji. Jeśli podasz ten plik, dane są używane do generowania walidacji Metryki są oceniane okresowo podczas dostrajania. Metryki można wyświetlić w plik wyników fine-tuningu. Te same dane nie powinny być obecne zarówno w plikach trenowania, jak i walidacji. Zestaw danych musi być sformatowany jako plik JSONL. Musisz przekazać plik z celem `fine-tune`. Aby uzyskać więcej informacji, zobacz przewodnik dostosowywania .	Nie.

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Typ	Obowiązkowy
rozmiar partii	string lub OpenAI.integer	Nie.
mnożnik szybkości uczenia	string lub OpenAI.numeric	Nie.
n_epochs (liczba epok)	string lub OpenAI.integer	Nie.

OpenAI.CreateFineTuningJobRequestIntegrations

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

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Typ	Obowiązkowy
jednostka	ciąg (dopuszczany do wartości null)	Nie.
nazwa	ciąg (dopuszczany do wartości null)	Nie.
projekt	ciąg	Yes
tags	tablica ciągów	Nie.

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

Gramatyka zdefiniowana przez użytkownika.

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

OpenAI.CustomTextFormatParam

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

OpenAI.CustomToolParam

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

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.DeletedConversationResource

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

OpenAI.DetailEnum

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

OpenAI.DoubleClickAction

Dwukrotne kliknięcie myszy.

Name	Typ	Description	Obowiązkowy
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
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.Drag

Czynność przeciągania.

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

OpenAI.DragPoint

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

Name	Typ	Description	Obowiązkowy	Wartość domyślna
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.EasyInputMessage

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
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.Error

Name	Typ	Obowiązkowy
dodatkoweInformacje	obiekt	Nie.
kod	ciąg (dopuszczany do wartości null)	Yes
debugInfo	obiekt	Nie.
details	tablica openAI.Error	Nie.
komunikat	ciąg	Yes
param	ciąg (dopuszczany do wartości null)	Nie.
typ	ciąg	Nie.

OpenAI.EvalApiError

Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg	Kod błędu.	Yes
komunikat	ciąg	Komunikat o błędzie.	Yes

OpenAI.EvalGraderLabelModel

Name	Typ	Description	Obowiązkowy
dane wejściowe	tablica openAI.EvalItem		Yes
labels	tablica ciągów	Etykiety do przypisania do każdego elementu w ocenie.	Yes
model	ciąg	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
przechodzące_etykiety	tablica ciągów	Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `label_model`. Możliwe wartości: `label_model`	Yes

OpenAI.EvalGraderPython

Name	Typ	Description	Obowiązkowy
znacznik_obrazu	ciąg	Tag obrazu do użycia dla skryptu języka Python.	Nie.
nazwa	ciąg	Nazwa oceniającego.	Yes
próg zaliczenia	OpenAI.numeric		Nie.
przesłać źródło	ciąg	Kod źródłowy skryptu języka Python.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `python`. Możliwe wartości: `python`	Yes

OpenAI.EvalGraderScoreModel

Name	Typ	Description	Obowiązkowy	Wartość domyślna
dane wejściowe	tablica openAI.EvalItem	Komunikaty wejściowe oceniane przez klasykator. Obsługuje tekst, tekst wyjściowy, obraz wejściowy i wejściowe bloki zawartości audio i mogą zawierać ciągi szablonu.	Yes
model	ciąg	Model do użycia do oceny.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
próg zaliczenia	OpenAI.numeric		Nie.
zakres	tablica openAI.numeric	Zakres wyniku Wartość domyślna to `[0, 1]`.	Nie.
parametry_próbowania	OpenAI.EvalGraderScoreModelSamplingParams		Nie.
└max_completions_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└─ wysiłek rozumowania	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.
└─ nasion	OpenAI.integer (dopuszczający wartość null)		Nie.
└* temperatura	OpenAI.numeric (dopuszczana do wartości null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
typ	wyliczenie	Typ obiektu, który jest zawsze `score_model`. Możliwe wartości: `score_model`	Yes

OpenAI.EvalGraderScoreModelSamplingParams

Name	Typ	Description	Obowiązkowy	Wartość domyślna
max_completions_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
wysiłek rozumowania	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.
seed	OpenAI.integer (dopuszczający wartość null)		Nie.
temperatura	OpenAI.numeric (dopuszczana do wartości null)		Nie.
top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1

OpenAI.EvalGraderStringCheck

Name	Typ	Description	Obowiązkowy
dane wejściowe	ciąg	Tekst wejściowy. Może to obejmować ciągi szablonu.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
operacja	wyliczenie	Operacja sprawdzania ciągów, którą należy wykonać. `eq`Jeden z , `ne`, `like`lub `ilike`. Możliwe wartości: `eq`, , `ne`, `likeilike`	Yes
odwołanie	ciąg	Tekst odwołania. Może to obejmować ciągi szablonu.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `string_check`. Możliwe wartości: `string_check`	Yes

OpenAI.EvalGraderTextSimilarity

Name	Typ	Description	Obowiązkowy
miara oceny	wyliczenie	Metryka oceny do użycia. Jeden z `cosine`, , `fuzzy_match`, , `bleu` `gleu`, `meteor`, , `rouge_1`, `rouge_2rouge_3`, , `rouge_4`, , `rouge_5` lub `rouge_l`. Możliwe wartości: `cosine`, `fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l`	Yes
dane wejściowe	ciąg	Tekst jest oceniany.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
próg zaliczenia	OpenAI.numeric		Yes
odwołanie	ciąg	Tekst oceniany względem.	Yes
typ	wyliczenie	Typ klasyra. Możliwe wartości: `text_similarity`	Yes

OpenAI.EvalItem

Name	Typ	Description	Obowiązkowy
zawartość	OpenAI.EvalItemContent	Dane wejściowe modelu — mogą zawierać ciągi szablonu. Obsługuje tekst, tekst wyjściowy, obrazy wejściowe i dźwięk wejściowy jako pojedynczy element lub tablicę elementów.	Yes
rola	wyliczenie	Rola wejścia komunikatu. `user`Jeden z, `assistant`, `system` lub `developer`. Możliwe wartości: `user`, , `assistant`, `systemdeveloper`	Yes
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze `message`. Możliwe wartości: `message`	Nie.

OpenAI.EvalItemContent

Dane wejściowe modelu — mogą zawierać ciągi szablonu. Obsługuje tekst, tekst wyjściowy, obrazy wejściowe i dźwięk wejściowy jako pojedynczy element lub tablicę elementów.

Typ: OpenAI.EvalItemContentItem lub OpenAI.EvalItemContentArray

Dane wejściowe modelu — mogą zawierać ciągi szablonu. Obsługuje tekst, tekst wyjściowy, obrazy wejściowe i dźwięk wejściowy jako pojedynczy element lub tablicę elementów.

OpenAI.EvalItemContentArray

Lista danych wejściowych, z których każda może być tekstem wejściowym, tekstem wyjściowym, obrazem wejściowym lub wejściowym obiektem audio.

Tablica: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItemItem

Pojedynczy element zawartości: tekst wejściowy, tekst wyjściowy, obraz wejściowy lub dźwięk wejściowy.

Typ: OpenAI.EvalItemContentText lub OpenAI.EvalItemContentItemObject

Pojedynczy element zawartości: tekst wejściowy, tekst wyjściowy, obraz wejściowy lub dźwięk wejściowy.

OpenAI.EvalItemContentItemObject

Pojedynczy element zawartości: tekst wejściowy, tekst wyjściowy, obraz wejściowy lub dźwięk wejściowy.

Dyskryminujące dla obiektu OpenAI.EvalItemContentItemObject

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

Typ wartości	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

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

OpenAI.EvalItemContentItemObjectInputTextContent

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

OpenAI.EvalItemContentItemObjectType

Property	Value
Type	ciąg
Wartości	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
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

OpenAI.EvalItemContentText

Wprowadzanie tekstu do modelu.

Typ: ciąg

OpenAI.EvalItemInputImage

Blok wejściowy obrazu używany w tablicach zawartości EvalItem.

Name	Typ	Description	Obowiązkowy
detail	ciąg	Poziom szczegółowości obrazu, który ma zostać wysłany do modelu. `high`Jeden z , `low`lub `auto`. Wartość domyślna to `auto`.	Nie.
image_url	ciąg	Adres URL danych wejściowych obrazu.	Yes
typ	wyliczenie	Typ danych wejściowych obrazu. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes

OpenAI.EvalJsonlFileContentSource

Name	Typ	Description	Obowiązkowy	Wartość domyślna
zawartość	tablica obiektów OpenAI.EvalJsonlFileContentSourceContent	Zawartość pliku jsonl.	Yes
typ	wyliczenie	Typ źródła jsonl. Zawsze `file_content`. Możliwe wartości: `file_content`	Yes

OpenAI.EvalJsonlFileContentSourceContent

Name	Typ	Description	Obowiązkowy	Wartość domyślna
element	obiekt		Yes
próbka	obiekt		Nie.

OpenAI.EvalJsonlFileIdSource

Name	Typ	Description	Obowiązkowy	Wartość domyślna
id	ciąg	Identyfikator pliku.	Yes
typ	wyliczenie	Typ źródła jsonl. Zawsze `file_id`. Możliwe wartości: `file_id`	Yes

OpenAI.EvalResponsesSource

Obiekt EvalResponsesSource opisujący konfigurację uruchamiania źródła danych.

Name	Typ	Description	Obowiązkowy
stworzone_po	OpenAI.integer (dopuszczający wartość null)		Nie.
utworzone_przed	OpenAI.integer (dopuszczający wartość null)		Nie.
wyszukiwanie_instrukcji	ciąg (dopuszczany do wartości null)		Nie.
metadane	object (dopuszczana wartość null)		Nie.
model	ciąg (dopuszczany do wartości null)		Nie.
wysiłek rozumowania	OpenAI.ReasoningEffort (dopuszczający wartość null)	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.
temperatura	OpenAI.numeric (dopuszczana do wartości null)		Nie.
Narzędzia	tablica ciągów		Nie.
top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.
typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze `responses`. Możliwe wartości: `responses`	Yes
users	tablica ciągów		Nie.

OpenAI.EvalRunOutputItemSample

Name	Typ	Description	Obowiązkowy
błąd	OpenAI.EvalApiError	Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.	Yes
powód zakończenia	ciąg		Yes
dane wejściowe	tablica EvalRunOutputItemSampleInput		Yes
max_completion_tokens	OpenAI.integer		Yes
model	ciąg		Yes
We/Wy	tablica EvalRunOutputItemSampleOutput		Yes
seed	OpenAI.integer		Yes
temperatura	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
użycie	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleUsage

Name	Typ	Obowiązkowy
cached_tokens	OpenAI.integer	Yes
completion_tokens	OpenAI.integer	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerModelUsage

Name	Typ	Obowiązkowy
cached_tokens	OpenAI.integer	Yes
completion_tokens	OpenAI.integer	Yes
invocation_count	OpenAI.integer	Yes
model_name	ciąg	Yes
prompt_tokens	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.EvalRunPerTestingCriteriaResults

Name	Typ	Obowiązkowy
niepowodzenie	OpenAI.integer	Yes
Przekazywane	OpenAI.integer	Yes
kryteria_testowe	ciąg	Yes

OpenAI.EvalRunResultCounts

Name	Typ	Obowiązkowy
błąd	OpenAI.integer	Yes
niepowodzenie	OpenAI.integer	Yes
Przekazywane	OpenAI.integer	Yes
Łącznych	OpenAI.integer	Yes

OpenAI.EvalStoredCompletionsSource

Konfiguracja StoredCompletionsRunDataSource opisująca zestaw filtrów

Name	Typ	Description	Obowiązkowy
stworzone_po	OpenAI.integer (dopuszczający wartość null)		Nie.
utworzone_przed	OpenAI.integer (dopuszczający wartość null)		Nie.
limit	OpenAI.integer (dopuszczający wartość null)		Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
model	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ źródła. Zawsze `stored_completions`. Możliwe wartości: `stored_completions`	Yes

OpenAI.FileCitationBody

Cytat do pliku.

Name	Typ	Description	Obowiązkowy
identyfikator_pliku	ciąg	Identyfikator pliku.	Yes
filename	ciąg	Nazwa pliku cytowanego.	Yes
indeks	OpenAI.integer		Yes
typ	wyliczenie	Typ cytowania pliku. Zawsze `file_citation`. Możliwe wartości: `file_citation`	Yes

OpenAI.FilePath

Ścieżka do pliku.

Name	Typ	Description	Obowiązkowy
identyfikator_pliku	ciąg	Identyfikator pliku.	Yes
indeks	OpenAI.integer		Yes
typ	wyliczenie	Typ ścieżki pliku. Zawsze `file_path`. Możliwe wartości: `file_path`	Yes

OpenAI.FileSearchTool

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

Name	Typ	Description	Obowiązkowy
filters	OpenAI.Filters (dopuszczana wartość null)		Nie.
maks_liczba_wyników	OpenAI.integer		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	OpenAI.numeric	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
identyfikatory_sklepu_wektorów	tablica ciągów	Identyfikatory wektorów są przechowywane do wyszukiwania.	Yes

OpenAI.FileSearchToolCallResults

Name	Typ	Description	Obowiązkowy
attributes	OpenAI.VectorStoreFileAttributes (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze są ciągami znaków o maksymalnej długości 64 znaków. Wartości to ciągi z maksymalną wartością długość 512 znaków, wartość logiczna lub liczba.	Nie.
identyfikator_pliku	ciąg		Nie.
filename	ciąg		Nie.
wynik	number		Nie.
SMS	ciąg		Nie.

OpenAI.Filters

Typ: OpenAI.ComparisonFilter lub OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Hiperparametry używane do zadania dostrajania parametrów DPO.

Name	Typ	Description	Obowiązkowy
rozmiar partii	string lub OpenAI.integer	Liczba przykładów w każdej partii. Większy rozmiar partii oznacza, że parametry modelu są aktualizowane rzadziej, ale z niższą wariancją.	Nie.
wersja beta	string lub OpenAI.numeric	Wartość beta metody obiektu DPO. Wyższa wartość beta zwiększy wagę kary między zasadami a modelem referencyjnym.	Nie.
mnożnik szybkości uczenia	string lub OpenAI.numeric	Współczynnik skalowania dla szybkości nauki. Mniejsze tempo nauki może być przydatne, aby uniknąć przeuczenia.	Nie.
n_epochs (liczba epok)	string lub OpenAI.integer	Liczba epok, przez które trenowany jest model. Epoka oznacza jeden pełny cykl przez zbiór danych treningowych.	Nie.

OpenAI.FineTuneDPOMethod

Konfiguracja metody dostrajania DPO.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
hiperparametry	OpenAI.FineTuneDPOHyperparameters	Hiperparametry używane do zadania dostrajania parametrów DPO.	Nie.

OpenAI.FineTuneMethod

Metoda używana do dostrajania.

Name	Typ	Description	Obowiązkowy
dpo	OpenAI.FineTuneDPOMethod	Konfiguracja metody dostrajania DPO.	Nie.
wzmocnienie	OpenAI.FineTuneReinforcementMethod	Konfiguracja metody dostrajania wzmocnienia.	Nie.
Nadzorowany	OpenAI.FineTuneSupervisedMethod	Konfiguracja nadzorowanej metody dostrajania.	Nie.
typ	wyliczenie	Typ metody. Ma wartość `supervised`, `dpo`lub `reinforcement`. Możliwe wartości: `supervised`, , `dporeinforcement`	Yes

OpenAI.FineTuneReinforcementHyperparameters

Hiperparametry używane do zadania dostrajania wzmocnienia.

Name	Typ	Description	Obowiązkowy
rozmiar partii	string lub OpenAI.integer	Liczba przykładów w każdej partii. Większy rozmiar partii oznacza, że parametry modelu są aktualizowane rzadziej, ale z niższą wariancją.	Nie.
compute_multiplier	string lub OpenAI.numeric	Mnożnik ilości zasobów obliczeniowych używanych do eksplorowania przestrzeni wyszukiwania podczas trenowania.	Nie.
interwał oceny	string lub OpenAI.integer	Liczba kroków szkoleniowych między przebiegami oceny.	Nie.
próbki_ewaluacyjne	string lub OpenAI.integer	Liczba próbek oceny do wygenerowania na krok trenowania.	Nie.
mnożnik szybkości uczenia	string lub OpenAI.numeric	Współczynnik skalowania dla szybkości nauki. Mniejsze tempo nauki może być przydatne, aby uniknąć przeuczenia.	Nie.
n_epochs (liczba epok)	string lub OpenAI.integer	Liczba epok, przez które trenowany jest model. Epoka oznacza jeden pełny cykl przez zbiór danych treningowych.	Nie.
wysiłek rozumowania	wyliczenie	Poziom wysiłku rozumowania. Możliwe wartości: `default`, , `low`, `mediumhigh`	Nie.

OpenAI.FineTuneReinforcementMethod

Konfiguracja metody dostrajania wzmocnienia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Równiarka	OpenAI.GraderStringCheck lub OpenAI.GraderTextSimilarity lub OpenAI.GraderPython lub OpenAI.GraderScoreModel lub OpenAI.GraderMulti	Klasykator używany do zadania dostrajania.	Yes
hiperparametry	OpenAI.FineTuneReinforcementHyperparameters	Hiperparametry używane do zadania dostrajania wzmocnienia.	Nie.

OpenAI.FineTuneSupervisedHyperparameters

Hiperparametry używane do procesu dostrajania modelu.

Name	Typ	Description	Obowiązkowy
rozmiar partii	string lub OpenAI.integer	Liczba przykładów w każdej partii. Większy rozmiar partii oznacza, że parametry modelu są aktualizowane rzadziej, ale z niższą wariancją.	Nie.
mnożnik szybkości uczenia	string lub OpenAI.numeric	Współczynnik skalowania dla szybkości nauki. Mniejsze tempo nauki może być przydatne, aby uniknąć przeuczenia.	Nie.
n_epochs (liczba epok)	string lub OpenAI.integer	Liczba epok, przez które trenowany jest model. Epoka oznacza jeden pełny cykl przez zbiór danych treningowych.	Nie.

OpenAI.FineTuneSupervisedMethod

Konfiguracja nadzorowanej metody dostrajania.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
hiperparametry	OpenAI.FineTuneSupervisedHyperparameters	Hiperparametry używane do procesu dostrajania modelu.	Nie.

OpenAI.FineTuningIntegration

Name	Typ	Description	Obowiązkowy
typ	wyliczenie	Typ włączonej integracji dla zadania dostrajania Możliwe wartości: `wandb`	Yes
wandb	OpenAI.FineTuningIntegrationWandb		Yes
Jednostka	ciąg (dopuszczany do wartości null)		Nie.
└─ nazwa	ciąg (dopuszczany do wartości null)		Nie.
└* projekt	ciąg		Yes
└─ Tagi	tablica ciągów		Nie.

OpenAI.FineTuningIntegrationWandb

Name	Typ	Obowiązkowy
jednostka	ciąg (dopuszczany do wartości null)	Nie.
nazwa	ciąg (dopuszczany do wartości null)	Nie.
projekt	ciąg	Yes
tags	tablica ciągów	Nie.

OpenAI.FineTuningJob

Obiekt fine_tuning.job reprezentuje zadanie dostrajania, które zostało utworzone za pośrednictwem interfejsu API.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia zadania dostrajania.	Yes
błąd	OpenAI.FineTuningJobError (dopuszczający wartość null)		Yes
└─ kod	ciąg		Yes
└─ Komunikat	ciąg		Yes
└* param	ciąg (dopuszczany do wartości null)		Yes
szacowany czas zakończenia	liczba całkowita		Nie.
fine_tuned_model	ciąg (dopuszczany do wartości null)		Yes
zakończono_o	liczba całkowita		Yes
hiperparametry	OpenAI.FineTuningJobHyperparameters		Yes
└batch_size	string lub OpenAI.integer		Nie.	samochód
└ learning_rate_multiplier	string lub OpenAI.numeric		Nie.
└n_epochs	string lub OpenAI.integer		Nie.	samochód
id	ciąg	Identyfikator obiektu, do którego można odwoływać się w punktach końcowych interfejsu API.	Yes
Integracje	tablica openAI.FineTuningIntegration		Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
metoda	OpenAI.FineTuneMethod	Metoda używana do dostrajania.	Nie.
model	ciąg	Model podstawowy, który zostaje precyzyjnie dostrojony.	Yes
obiekt	wyliczenie	Typ obiektu, który jest zawsze "fine_tuning.job". Możliwe wartości: `fine_tuning.job`	Yes
id_organizacji	ciąg	Organizacja, która jest właścicielem zadania dostrajania.	Yes
pliki_wynikowe	tablica ciągów	Skompilowane identyfikatory plików wyników dla zadania dostrajania. Wyniki można pobrać za pomocą interfejsu API plików.	Yes
seed	OpenAI.integer		Yes
stan	wyliczenie	Bieżący stan zadania dostrajania, który może być jednym z następujących: `validating_files`, `queued`, `running`, `succeeded`, `failed` lub `cancelled`. Możliwe wartości: `validating_files`, , `queuedrunning`, `succeeded`, , `failedcancelled`	Yes
tokeny szkoleniowe	OpenAI.integer (dopuszczający wartość null)		Yes
plik szkoleniowy	ciąg	Identyfikator pliku używany do trenowania. Dane szkoleniowe można pobrać za pomocą interfejsu API plików.	Yes
plik walidacji	ciąg (dopuszczany do wartości null)		Yes

OpenAI.FineTuningJobCheckpoint

Obiekt fine_tuning.job.checkpoint reprezentuje punkt kontrolny modelu dla zadania dostrajania, które jest gotowe do użycia.

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia punktu kontrolnego.	Yes
punkt kontrolny modelu dostrojonego	ciąg	Nazwa utworzonego, dopracowanego modelu punktów kontrolnych.	Yes
identyfikator_zadania_dostrajania	ciąg	Nazwa zadania dostrajania, na podstawie którego utworzono ten punkt kontrolny.	Yes
id	ciąg	Identyfikator punktu kontrolnego, do którego można odwoływać się w punktach końcowych interfejsu API.	Yes
metryki	OpenAI.FineTuningJobCheckpointMetrics		Yes
└─full_valid_loss	OpenAI.numeric		Nie.
└ pełna_weryfikowalna_średnia_dokładność_tokenu (full_valid_mean_token_accuracy)	OpenAI.numeric		Nie.
└─ Krok	OpenAI.numeric		Nie.
└─ train_loss	OpenAI.numeric		Nie.
└- dokładność_średniego_tokena_treningowego	OpenAI.numeric		Nie.
└ valid_loss	OpenAI.numeric		Nie.
└─ poprawna_średnia_dokładność_tokena	OpenAI.numeric		Nie.
obiekt	wyliczenie	Typ obiektu, który zawsze jest "fine_tuning.job.checkpoint". Możliwe wartości: `fine_tuning.job.checkpoint`	Yes
numer_kroku	OpenAI.integer		Yes

OpenAI.FineTuningJobCheckpointMetrics

Name	Typ	Obowiązkowy
full_valid_loss	OpenAI.numeric	Nie.
full_valid_mean_token_accuracy	OpenAI.numeric	Nie.
krok	OpenAI.numeric	Nie.
train_loss	OpenAI.numeric	Nie.
train_mean_token_accuracy	OpenAI.numeric	Nie.
valid_loss	OpenAI.numeric	Nie.
valid_mean_token_accuracy	OpenAI.numeric	Nie.

OpenAI.FineTuningJobError

Name	Typ	Obowiązkowy
kod	ciąg	Yes
komunikat	ciąg	Yes
param	ciąg (dopuszczany do wartości null)	Yes

OpenAI.FineTuningJobEvent

Obiekt zdarzenia procesu dostrajania

Name	Typ	Description	Obowiązkowy
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia zadania dostrajania.	Yes
dane	OpenAI.FineTuningJobEventData		Nie.
id	ciąg	Identyfikator obiektu.	Yes
poziom	wyliczenie	Poziom rejestrowania zdarzenia. Możliwe wartości: `info`, , `warnerror`	Yes
komunikat	ciąg	Komunikat zdarzenia.	Yes
obiekt	wyliczenie	Typ obiektu, który zawsze jest "fine_tuning.job.event". Możliwe wartości: `fine_tuning.job.event`	Yes
typ	wyliczenie	Typ zdarzenia. Możliwe wartości: `message`, `metrics`	Nie.

OpenAI.FineTuningJobEventData

Typ: obiekt

OpenAI.FineTuningJobHyperparameters

Name	Typ	Obowiązkowy
rozmiar partii	string lub OpenAI.integer	Nie.
mnożnik szybkości uczenia	string lub OpenAI.numeric	Nie.
n_epochs (liczba epok)	string lub OpenAI.integer	Nie.

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 do modelu.

Name	Typ	Description	Obowiązkowy
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
file_url	ciąg	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

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazów.

Name	Typ	Description	Obowiązkowy
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
image_url	ciąg		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

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

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.FunctionObject

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania. Musi składać się z a-z, A-Z, 0-9 lub zawierać podkreślniki i kreski, z maksymalną długością 64 znaków.	Yes
parameters	OpenAI.FunctionParameters	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu. Pominięcie `parameters` definiuje funkcję z pustą listą parametrów.	Nie.
surowy	Wartość logiczna (dopuszczana do wartości null)		Nie.

OpenAI.FunctionParameters

Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON. Zapoznaj się z przewodnikiem , aby zapoznać się z przykładami i dokumentacją dotyczącą schematu JSON , aby uzyskać dokumentację dotyczącą formatu. Pominięcie parameters definiuje funkcję z pustą listą parametrów.

Typ: obiekt

OpenAI.FunctionShellAction

Wykonaj polecenie powłoki.

Name	Typ	Obowiązkowy
commands	tablica ciągów	Yes
max_output_length	OpenAI.integer (dopuszczający wartość null)	Yes
limit_czasu_ms	OpenAI.integer (dopuszczający wartość null)	Yes

OpenAI.FunctionShellActionParam

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	OpenAI.integer (dopuszczający wartość null)		Nie.
limit_czasu_ms	OpenAI.integer (dopuszczający wartość null)		Nie.

OpenAI.FunctionShellCallItemStatus

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ść 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

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

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	OpenAI.integer		Yes
typ	wyliczenie	Typ wyniku. Zawsze `exit`. Możliwe wartości: `exit`	Yes

OpenAI.FunctionShellCallOutputExitOutcomeParam

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	OpenAI.integer		Yes
typ	wyliczenie	Typ wyniku. Zawsze `exit`. Możliwe wartości: `exit`	Yes

OpenAI.FunctionShellCallOutputOutcome

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 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.FunctionShellCallOutputTimeoutOutcome

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

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

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

OpenAI.FunctionShellToolParam

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

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

OpenAI.FunctionTool

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

Name	Typ	Description	Obowiązkowy
opis	ciąg (dopuszczany do wartości null)		Nie.
nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
parameters	object (dopuszczana wartość null)		Yes
surowy	Wartość logiczna (dopuszczana do wartości null)		Yes
typ	wyliczenie	Typ narzędzia funkcji. Zawsze `function`. Możliwe wartości: `function`	Yes

OpenAI.GraderLabelModel

Obiekt LabelModelGrader, który używa modelu do przypisywania etykiet do każdego elementu w ocenie.

Name	Typ	Description	Obowiązkowy
dane wejściowe	tablica openAI.EvalItem		Yes
labels	tablica ciągów	Etykiety do przypisania do każdego elementu w ocenie.	Yes
model	ciąg	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
przechodzące_etykiety	tablica ciągów	Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `label_model`. Możliwe wartości: `label_model`	Yes

OpenAI.GraderMulti

Obiekt MultiGrader łączy dane wyjściowe wielu ocenianek w celu utworzenia pojedynczego wyniku.

Name	Typ	Description	Obowiązkowy
oblicz_wynik	ciąg	Formuła do obliczenia wyniku na podstawie wyników oceniającego.	Yes
Równiarki	OpenAI.GraderStringCheck lub OpenAI.GraderTextSimilarity lub OpenAI.GraderPython lub OpenAI.GraderScoreModel lub OpenAI.GraderLabelModel		Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `multi`. Możliwe wartości: `multi`	Yes

OpenAI.GraderPython

Obiekt PythonGrader, który uruchamia skrypt języka Python na danych wejściowych.

Name	Typ	Description	Obowiązkowy
znacznik_obrazu	ciąg	Tag obrazu do użycia dla skryptu języka Python.	Nie.
nazwa	ciąg	Nazwa oceniającego.	Yes
przesłać źródło	ciąg	Kod źródłowy skryptu języka Python.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `python`. Możliwe wartości: `python`	Yes

OpenAI.GraderScoreModel

Obiekt ScoreModelGrader, który używa modelu do przypisania wyniku do danych wejściowych.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
dane wejściowe	tablica openAI.EvalItem	Komunikaty wejściowe oceniane przez klasykator. Obsługuje tekst, tekst wyjściowy, obraz wejściowy i wejściowe bloki zawartości audio i mogą zawierać ciągi szablonu.	Yes
model	ciąg	Model do użycia do oceny.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
zakres	tablica openAI.numeric	Zakres wyniku Wartość domyślna to `[0, 1]`.	Nie.
parametry_próbowania	OpenAI.EvalGraderScoreModelSamplingParams		Nie.
└max_completions_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└─ wysiłek rozumowania	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.
└─ nasion	OpenAI.integer (dopuszczający wartość null)		Nie.
└* temperatura	OpenAI.numeric (dopuszczana do wartości null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
typ	wyliczenie	Typ obiektu, który jest zawsze `score_model`. Możliwe wartości: `score_model`	Yes

OpenAI.GraderStringCheck

Obiekt StringCheckGrader, który wykonuje porównanie ciągów między danymi wejściowymi i odwołaniami przy użyciu określonej operacji.

Name	Typ	Description	Obowiązkowy
dane wejściowe	ciąg	Tekst wejściowy. Może to obejmować ciągi szablonu.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
operacja	wyliczenie	Operacja sprawdzania ciągów, którą należy wykonać. `eq`Jeden z , `ne`, `like`lub `ilike`. Możliwe wartości: `eq`, , `ne`, `likeilike`	Yes
odwołanie	ciąg	Tekst odwołania. Może to obejmować ciągi szablonu.	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze `string_check`. Możliwe wartości: `string_check`	Yes

OpenAI.GraderTextSimilarity

Obiekt TextSimilarityGrader, który klasyfikuje tekst na podstawie metryk podobieństwa.

Name	Typ	Description	Obowiązkowy
miara oceny	wyliczenie	Metryka oceny do użycia. Jeden z `cosine`, , `fuzzy_match`, , `bleu` `gleu`, `meteor`, , `rouge_1`, `rouge_2rouge_3`, , `rouge_4`, , `rouge_5` lub `rouge_l`. Możliwe wartości: `cosine`, `fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l`	Yes
dane wejściowe	ciąg	Tekst jest oceniany.	Yes
nazwa	ciąg	Nazwa oceniającego.	Yes
odwołanie	ciąg	Tekst oceniany względem.	Yes
typ	wyliczenie	Typ klasyra. Możliwe wartości: `text_similarity`	Yes

OpenAI.GrammarSyntax1

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

OpenAI.HybridSearchOptions

Name	Typ	Description	Obowiązkowy	Wartość domyślna
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageDetail

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

OpenAI.ImageGenTool

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

Prawidłowe modele:

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

Name	Typ	Description	Obowiązkowy	Wartość domyślna
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.
input_fidelity	OpenAI.InputFidelity (dopuszczana wartość null)	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 programu `gpt-image-1`. Nieobsługiwane dla elementu `gpt-image-1-mini`. Obsługuje i `highlow`. Wartość domyślna to `low`.	Nie.
maska_wprowadzania_obrazu	OpenAI.ImageGenToolInputImageMask		Nie.
└ file_id	ciąg		Nie.
└─ image_url	ciąg		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.
kompresja wyjściowa	OpenAI.integer		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.
częściowe_obrazy	OpenAI.integer		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.
size	wyliczenie	Rozmiar wygenerowanego obrazu. `1024x1024`Jeden z , , `1024x1536` `1536x1024`lub `auto`. Wartość domyślna: `auto`. Możliwe wartości: `1024x1024`, , `1024x1536`, `1536x1024auto`	Nie.
typ	wyliczenie	Typ narzędzia do generowania obrazów. Zawsze `image_generation`. Możliwe wartości: `image_generation`	Yes

OpenAI.ImageGenToolInputImageMask

Name	Typ	Description	Obowiązkowy	Wartość domyślna
identyfikator_pliku	ciąg		Nie.
image_url	ciąg		Nie.

OpenAI.IncludeEnum

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

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.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). | | Typ | 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
memory_search_call.results |

OpenAI.InputAudio

Dane audio jako wejście do modelu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
input_audio	OpenAI.InputAudioInputAudio		Yes
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_audio`. Możliwe wartości: `input_audio`	Yes

OpenAI.InputAudioInputAudio

Name	Typ	Description	Obowiązkowy	Wartość domyślna
dane	ciąg		Yes
format	wyliczenie	Możliwe wartości: `mp3`, `wav`	Yes

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 do modelu.

Name	Typ	Description	Obowiązkowy
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
file_url	ciąg	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

OpenAI.InputContentInputImageContent

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazów.

Name	Typ	Description	Obowiązkowy
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
image_url	ciąg		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes

OpenAI.InputContentInputTextContent

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

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 programu gpt-image-1. Nieobsługiwane dla elementu 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 do modelu.

Name	Typ	Description	Obowiązkowy
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
file_url	ciąg	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

OpenAI.InputFileContentParam

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy
file_data	ciąg (dopuszczany do wartości null)		Nie.
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
file_url	ciąg		Nie.
filename	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_file`. Możliwe wartości: `input_file`	Yes

OpenAI.InputImageContent

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazów.

Name	Typ	Description	Obowiązkowy
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
image_url	ciąg		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes

OpenAI.InputImageContentParamAutoParam

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazów

Name	Typ	Description	Obowiązkowy
detail	OpenAI.DetailEnum (dopuszczana wartość null)		Nie.
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
image_url	ciąg		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes

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
`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

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

OpenAI.InputItemApplyPatchToolCallItemParam

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

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości 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

OpenAI.InputItemApplyPatchToolCallOutputItemParam

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

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
We/Wy	ciąg (dopuszczany do wartości 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

OpenAI.InputItemCodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy
kod	ciąg (dopuszczany do wartości 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		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

OpenAI.InputItemCompactionSummaryItemParam

Element kompaktowania generowany przez v1/responses/compact interfejs API.

Name	Typ	Description	Obowiązkowy
encrypted_content	ciąg	Zaszyfrowana zawartość podsumowania kompaktowania. Ograniczenia: maxLength: 10485760	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu. Zawsze `compaction`. Możliwe wartości: `compaction`	Yes

OpenAI.InputItemComputerCallOutputItemParam

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

Name	Typ	Description	Obowiązkowy
acknowledged_safety_checks	tablica openAI.ComputerCallSafetyCheckParam		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 (dopuszczany do wartości null)		Nie.
We/Wy	OpenAI.ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.	Yes
stan	OpenAI.FunctionCallItemStatus (dopuszczana wartość 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

OpenAI.InputItemComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera. Aby uzyskać więcej informacji, zobacz przewodnik dotyczący korzystania z komputera .

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.ComputerAction		Yes
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

OpenAI.InputItemCustomToolCall

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
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.InputItemCustomToolCallOutput

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

Wyniki wywołania narzędzia wyszukiwania plików. Aby uzyskać więcej informacji, zobacz przewodnik 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 obiektów OpenAI.FileSearchToolCallResults		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

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. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości 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 (dopuszczana wartość 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

OpenAI.InputItemFunctionShellCallItemParam

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

Name	Typ	Description	Obowiązkowy
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	OpenAI.integer (dopuszczający wartość null)		Nie.
└timeout_ms	OpenAI.integer (dopuszczający wartość null)		Nie.
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
stan	OpenAI.FunctionShellCallItemStatus (dopuszczana wartość null)	Wartości stanu zgłaszane dla wywołań narzędzi powłoki.	Nie.
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes

OpenAI.InputItemFunctionShellCallOutputItemParam

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

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
max_output_length	OpenAI.integer (dopuszczający wartość null)		Nie.
We/Wy	tablica openAI.FunctionShellCallOutputContentParam	Przechwycone fragmenty danych wyjściowych stdout i stderr wraz ze skojarzonymi wynikami.	Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes

OpenAI.InputItemFunctionToolCall

Wywołanie narzędzia w celu uruchomienia funkcji. Aby uzyskać więcej informacji, zobacz przewodnik wywoływania 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	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Nie.
nazwa	ciąg	Nazwa funkcji do uruchomienia.	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 wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.InputItemImageGenToolCall

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg (dopuszczany do wartości 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

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

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	wyliczenie	Możliwe wartości: `in_progress`, , `completedincomplete`	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

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 żą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 (dopuszczany do wartości null)		Nie.
powód	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.InputItemMcpListTools

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	ciąg (dopuszczany do wartości null)		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ędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg (dopuszczany do wartości null)		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg (dopuszczany do wartości 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 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
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

Name	Typ	Description	Obowiązkowy
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg (dopuszczany do wartości 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	tablica interfejsu OpenAI.Summary	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

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

OpenAI.InputItemWebSearchToolCall

Wyniki wywołania narzędzia wyszukiwania w Internecie. Aby uzyskać więcej informacji, zobacz przewodnik 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ółowe informacje na temat sposobu użycia modelu w Internecie (wyszukiwanie, open_page, znajdowanie).	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.InputMessage

Name	Typ	Description	Obowiązkowy
zawartość	OpenAI.InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość types.	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

OpenAI.InputMessageContentList

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

Tablica: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Typ	Description	Obowiązkowy
zawartość	OpenAI.InputMessageContentList	Lista jednego lub wielu elementów wejściowych do modelu zawierająca inną zawartość types.	Yes
id	ciąg	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

OpenAI.InputParam

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

Typ: ciąg lub tablica openAI.InputItem

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

OpenAI.InputTextContent

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

OpenAI.InputTextContentParam

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

OpenAI.Item

Element zawartości używany do generowania odpowiedzi.

Dyskryminujący element OpenAI.Item

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

Typ wartości	Schema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

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

OpenAI.ItemApplyPatchToolCallItemParam

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

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości 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

OpenAI.ItemApplyPatchToolCallOutputItemParam

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

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia stosowania poprawek wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
We/Wy	ciąg (dopuszczany do wartości 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

OpenAI.ItemCodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy
kod	ciąg (dopuszczany do wartości 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		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

OpenAI.ItemCompactionSummaryItemParam

Element kompaktowania generowany przez v1/responses/compact interfejs API.

Name	Typ	Description	Obowiązkowy
encrypted_content	ciąg	Zaszyfrowana zawartość podsumowania kompaktowania. Ograniczenia: maxLength: 10485760	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu. Zawsze `compaction`. Możliwe wartości: `compaction`	Yes

OpenAI.ItemComputerCallOutputItemParam

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

Name	Typ	Description	Obowiązkowy
acknowledged_safety_checks	tablica openAI.ComputerCallSafetyCheckParam		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 (dopuszczany do wartości null)		Nie.
We/Wy	OpenAI.ComputerScreenshotImage	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.	Yes
stan	OpenAI.FunctionCallItemStatus (dopuszczana wartość 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

OpenAI.ItemComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera. Aby uzyskać więcej informacji, zobacz przewodnik dotyczący korzystania z komputera .

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.ComputerAction		Yes
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

OpenAI.ItemCustomToolCall

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
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.ItemCustomToolCallOutput

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.ItemFileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików. Aby uzyskać więcej informacji, zobacz przewodnik 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 obiektów OpenAI.FileSearchToolCallResults		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.ItemFunctionCallOutputItemParam

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. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości 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 (dopuszczana wartość 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

OpenAI.ItemFunctionShellCallItemParam

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

Name	Typ	Description	Obowiązkowy
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	OpenAI.integer (dopuszczający wartość null)		Nie.
└timeout_ms	OpenAI.integer (dopuszczający wartość null)		Nie.
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
stan	OpenAI.FunctionShellCallItemStatus (dopuszczana wartość null)	Wartości stanu zgłaszane dla wywołań narzędzi powłoki.	Nie.
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes

OpenAI.ItemFunctionShellCallOutputItemParam

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

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki wygenerowany przez model. Ograniczenia: minLength: 1, maxLength: 64	Yes
id	ciąg (dopuszczany do wartości null)		Nie.
max_output_length	OpenAI.integer (dopuszczający wartość null)		Nie.
We/Wy	tablica openAI.FunctionShellCallOutputContentParam	Przechwycone fragmenty danych wyjściowych stdout i stderr wraz ze skojarzonymi wynikami.	Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes

OpenAI.ItemFunctionToolCall

Wywołanie narzędzia w celu uruchomienia funkcji. Aby uzyskać więcej informacji, zobacz przewodnik wywoływania 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	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Nie.
nazwa	ciąg	Nazwa funkcji do uruchomienia.	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 wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.ItemImageGenToolCall

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg (dopuszczany do wartości 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.ItemLocalShellToolCall

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.ItemLocalShellToolCallOutput

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	wyliczenie	Możliwe wartości: `in_progress`, , `completedincomplete`	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.ItemMcpApprovalRequest

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.ItemMcpApprovalResponse

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 (dopuszczany do wartości null)		Nie.
powód	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.ItemMcpListTools

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	ciąg (dopuszczany do wartości null)		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.ItemMcpToolCall

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg (dopuszczany do wartości null)		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg (dopuszczany do wartości 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.ItemOutputMessage

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
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.ItemReasoningItem

Name	Typ	Description	Obowiązkowy
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg (dopuszczany do wartości 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	tablica interfejsu OpenAI.Summary	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

OpenAI.ItemReferenceParam

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

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.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`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

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

OpenAI.ItemResourceApplyPatchToolCall

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

Name	Typ	Description	Obowiązkowy
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

OpenAI.ItemResourceApplyPatchToolCallOutput

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

Name	Typ	Description	Obowiązkowy
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 (dopuszczany do wartości null)		Nie.
stan	OpenAI.ApplyPatchCallOutputStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call_output`. Możliwe wartości: `apply_patch_call_output`	Yes

OpenAI.ItemResourceCodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy
kod	ciąg (dopuszczany do wartości 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		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

OpenAI.ItemResourceComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera. Aby uzyskać więcej informacji, zobacz przewodnik dotyczący korzystania z komputera .

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.ComputerAction		Yes
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

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Typ	Description	Obowiązkowy
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	Identyfikator wyniku wywołania komputerowego narzędzia.	Nie.
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

OpenAI.ItemResourceFileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików. Aby uzyskać więcej informacji, zobacz przewodnik 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 obiektów OpenAI.FileSearchToolCallResults		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

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

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.FunctionShellAction	Wykonaj polecenie powłoki.	Yes
Polecenia └*	tablica ciągów		Yes
└max_output_length	OpenAI.integer (dopuszczający wartość null)		Yes
└timeout_ms	OpenAI.integer (dopuszczający wartość 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.
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.LocalShellCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes

OpenAI.ItemResourceFunctionShellCallOutput

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

Name	Typ	Description	Obowiązkowy
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	OpenAI.integer (dopuszczający wartość null)		Yes
We/Wy	tablica elementów OpenAI.FunctionShellCallOutputContent	Tablica zawartości danych wyjściowych wywołań powłoki	Yes
typ	wyliczenie	Typ danych wyjściowych wywołania powłoki. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Typ	Description	Obowiązkowy
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Yes
id	ciąg	Unikatowy identyfikator danych wyjściowych wywołania narzędzia funkcji. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Nie.
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.ItemResourceFunctionToolCallResource

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	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Nie.
nazwa	ciąg	Nazwa funkcji do uruchomienia.	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 wywołania funkcji narzędziowej. Zawsze `function_call`. Możliwe wartości: `function_call`	Yes

OpenAI.ItemResourceImageGenToolCall

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
result	ciąg (dopuszczany do wartości 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.ItemResourceLocalShellToolCall

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

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	wyliczenie	Możliwe wartości: `in_progress`, , `completedincomplete`	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

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 żą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 (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ elementu. Zawsze `mcp_approval_response`. Możliwe wartości: `mcp_approval_response`	Yes

OpenAI.ItemResourceMcpListTools

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
błąd	ciąg (dopuszczany do wartości null)		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ędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
approval_request_id	ciąg (dopuszczany do wartości null)		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg (dopuszczany do wartości 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 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
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.ItemResourceType

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
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
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Wyniki wywołania narzędzia wyszukiwania w Internecie. Aby uzyskać więcej informacji, zobacz przewodnik 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ółowe informacje na temat sposobu użycia modelu w Internecie (wyszukiwanie, open_page, znajdowanie).	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.ItemType

Property Value

Type ciąg

OpenAI.ItemWebSearchToolCall

Wyniki wywołania narzędzia wyszukiwania w Internecie. Aby uzyskać więcej informacji, zobacz przewodnik 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ółowe informacje na temat sposobu użycia modelu w Internecie (wyszukiwanie, open_page, znajdowanie).	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

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

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Typ	Description	Obowiązkowy
dane	tablica openAI.FineTuningJobCheckpoint		Yes
first_id	ciąg (dopuszczany do wartości null)		Nie.
zawiera_więcej	boolean		Yes
last_id	ciąg (dopuszczany do wartości null)		Nie.
obiekt	wyliczenie	Możliwe wartości: `list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Name	Typ	Description	Obowiązkowy
dane	tablica obiektów OpenAI.FineTuningJobEvent		Yes
zawiera_więcej	boolean		Yes
obiekt	wyliczenie	Możliwe wartości: `list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Typ	Description	Obowiązkowy
dane	tablica obiektów OpenAI.FineTuningJob		Yes
zawiera_więcej	boolean		Yes
obiekt	wyliczenie	Możliwe wartości: `list`	Yes

OpenAI.LocalShellCallStatus

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

OpenAI.LocalShellExecAction

Wykonaj polecenie powłoki na serwerze.

Name	Typ	Description	Obowiązkowy
polecenie	tablica ciągów	Polecenie do uruchomienia.	Yes
środowisko	obiekt	Zmienne środowiskowe, które należy ustawić dla polecenia.	Yes
limit_czasu_ms	OpenAI.integer (dopuszczający wartość null)		Nie.
typ	wyliczenie	Typ akcji lokalnego interfejsu powłoki. Zawsze `exec`. Możliwe wartości: `exec`	Yes
użytkownik	ciąg (dopuszczany do wartości null)		Nie.
katalog roboczy	ciąg (dopuszczany do wartości null)		Nie.

OpenAI.LocalShellToolParam

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

OpenAI.LogProb

Prawdopodobieństwo logarytmiczne tokenu.

Name	Typ	Obowiązkowy
bytes	tablica wartości OpenAI.integer	Yes
logprob	OpenAI.numeric	Yes
kod przedpłaty	ciąg	Yes
top_logprobs	tablica biblioteki OpenAI.TopLogProb	Yes

OpenAI.MCPListToolsTool

Narzędzie dostępne na serwerze MCP.

Name	Typ	Description	Obowiązkowy
annotations	OpenAI.MCPListToolsToolsAnnotations (dopuszczana wartość null)		Nie.
opis	ciąg (dopuszczany do wartości null)		Nie.
input_schema	OpenAI.MCPListToolsToolsToolInputSchema		Yes
nazwa	ciąg	Nazwa narzędzia.	Yes

OpenAI.MCPListToolsToolsAnnotations

Typ: obiekt

OpenAI.MCPListToolsToolsToolInputSchema

Typ: obiekt

OpenAI.MCPTool

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

Name	Typ	Description	Obowiązkowy
dozwolone_narzędzia	tablica ciągów lub OpenAI.MCPToolFilter		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 łączniki tutaj. 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.
headers	object (dopuszczana wartość null)		Nie.
project_connection_id	ciąg	Identyfikator połączenia w project dla serwera MCP. W połączeniu przechowywane są dane uwierzytelniające i inne szczegóły połączenia potrzebne do nawiązania połączenia z serwerem MCP.	Nie.
wymaga_akceptacji	object (zobacz prawidłowe modele poniżej)		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	ciąg	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

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
`summary_text`	OpenAI.SummaryTextContent
`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

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

OpenAI.MessageContentInputFileContent

Plik wejściowy do modelu.

Name	Typ	Description	Obowiązkowy
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
file_url	ciąg	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

OpenAI.MessageContentInputImageContent

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazów.

Name	Typ	Description	Obowiązkowy
detail	OpenAI.ImageDetail		Yes
identyfikator_pliku	ciąg (dopuszczany do wartości null)		Nie.
image_url	ciąg		Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze `input_image`. Możliwe wartości: `input_image`	Yes

OpenAI.MessageContentInputTextContent

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

OpenAI.MessageContentOutputTextContent

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy
annotations	tablica adnotacji OpenAI.Annotation	Adnotacje tekstu wyjściowego.	Yes
logprobs	tablica biblioteki OpenAI.LogProb		Nie.
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

OpenAI.MessageContentReasoningTextContent

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

OpenAI.MessageContentRefusalContent

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

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.MessageRole

Property	Value
Type	ciąg
Wartości	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

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

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.ModelIdsCompaction

Identyfikator modelu używany do generowania odpowiedzi, na przykład gpt-5 lub o3. Platforma OpenAI oferuje szeroką gamę modeli z różnymi możliwościami, charakterystykami wydajności i punktami cenowymi. Zapoznaj się z przewodnikiem po modelu , aby przeglądać i porównywać dostępne modele.

Typ: OpenAI.ModelIdsResponses lub ciąg

OpenAI.ModelIdsResponses

Property	Value
Type	ciąg
Wartości	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

Typ: ciąg lub OpenAI.ChatModel

OpenAI.Move

Akcja ruchu myszy.

Name	Typ	Description	Obowiązkowy
typ	wyliczenie	Określa typ zdarzenia. W przypadku ruchu, ta właściwość to zawsze ustawiony na `move`. Możliwe wartości: `move`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

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

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy
annotations	tablica adnotacji OpenAI.Annotation	Adnotacje tekstu wyjściowego.	Yes
logprobs	tablica biblioteki OpenAI.LogProb		Nie.
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

OpenAI.OutputContentReasoningTextContent

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

OpenAI.OutputContentRefusalContent

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

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
`structured_outputs`	StructuredOutputsOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`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
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
typ	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

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

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
stan	OpenAI.ApplyPatchCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call`. Możliwe wartości: `apply_patch_call`	Yes

OpenAI.OutputItemApplyPatchToolCallOutput

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

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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 (dopuszczany do wartości null)		Nie.
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
stan	OpenAI.ApplyPatchCallOutputStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `apply_patch_call_output`. Możliwe wartości: `apply_patch_call_output`	Yes

OpenAI.OutputItemCodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
kod	ciąg (dopuszczany do wartości 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		Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
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

OpenAI.OutputItemCompactionBody

Element kompaktowania generowany przez v1/responses/compact interfejs API.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
typ	wyliczenie	Typ elementu. Zawsze `compaction`. Możliwe wartości: `compaction`	Yes

OpenAI.OutputItemComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera. Aby uzyskać więcej informacji, zobacz przewodnik dotyczący korzystania z komputera .

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.ComputerAction		Yes
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	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`	Yes
typ	wyliczenie	Typ wywołania komputera. Zawsze `computer_call`. Możliwe wartości: `computer_call`	Yes

OpenAI.OutputItemCustomToolCall

Wywołanie niestandardowego narzędzia utworzonego przez model.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
typ	wyliczenie	Typ niestandardowego wywołania narzędzia. Zawsze `custom_tool_call`. Możliwe wartości: `custom_tool_call`	Yes

OpenAI.OutputItemFileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików. Aby uzyskać więcej informacji, zobacz przewodnik wyszukiwania plików .

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
results	tablica obiektów OpenAI.FileSearchToolCallResults		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

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

Name	Typ	Description	Obowiązkowy
akcja	OpenAI.FunctionShellAction	Wykonaj polecenie powłoki.	Yes
Polecenia └*	tablica ciągów		Yes
└max_output_length	OpenAI.integer (dopuszczający wartość null)		Yes
└timeout_ms	OpenAI.integer (dopuszczający wartość null)		Yes
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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.
id	ciąg	Unikatowy identyfikator wywołania narzędzia powłoki. Wypełniane, gdy ten element jest zwracany za pośrednictwem interfejsu API.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
stan	OpenAI.LocalShellCallStatus		Yes
typ	wyliczenie	Typ elementu. Zawsze `shell_call`. Możliwe wartości: `shell_call`	Yes

OpenAI.OutputItemFunctionShellCallOutput

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

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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	OpenAI.integer (dopuszczający wartość null)		Yes
We/Wy	tablica elementów OpenAI.FunctionShellCallOutputContent	Tablica zawartości danych wyjściowych wywołań powłoki	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
typ	wyliczenie	Typ danych wyjściowych wywołania powłoki. Zawsze `shell_call_output`. Możliwe wartości: `shell_call_output`	Yes

OpenAI.OutputItemFunctionToolCall

Wywołanie narzędzia w celu uruchomienia funkcji. Aby uzyskać więcej informacji, zobacz przewodnik wywoływania funkcji .

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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	Unikatowy identyfikator wywołania narzędzia funkcjonalnego.	Nie.
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	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.OutputItemImageGenToolCall

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
id	ciąg	Unikatowy identyfikator wywołania generowania obrazu.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
result	ciąg (dopuszczany do wartości 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

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
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
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.OutputItemMcpApprovalRequest

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

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
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
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
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.OutputItemMcpListTools

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
błąd	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator listy.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
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ędzia na serwerze MCP.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
approval_request_id	ciąg (dopuszczany do wartości null)		Nie.
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Yes
błąd	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia.	Yes
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Yes
We/Wy	ciąg (dopuszczany do wartości null)		Nie.
response_id	ciąg	Odpowiedź, na której jest tworzony element.	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 z modelu.

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
zawartość	tablica elementów OpenAI.OutputMessageContent	Zawartość komunikatu wyjściowego.	Yes
id	ciąg	Unikatowy identyfikator komunikatu wyjściowego.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	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

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
zawartość	tablica obiektu OpenAI.ReasoningTextContent	Wnioskowanie zawartości tekstowej.	Nie.
encrypted_content	ciąg (dopuszczany do wartości null)		Nie.
id	ciąg	Unikatowy identyfikator zawartości rozumowania.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	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.
podsumowanie	tablica interfejsu OpenAI.Summary	Rozumowanie zawartości podsumowania.	Yes
typ	wyliczenie	Typ obiektu. Zawsze `reasoning`. Możliwe wartości: `reasoning`	Yes

OpenAI.OutputItemType

Property Value

Type ciąg

Wartości output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Wyniki wywołania narzędzia wyszukiwania w Internecie. Aby uzyskać więcej informacji, zobacz przewodnik 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ółowe informacje na temat sposobu użycia modelu w Internecie (wyszukiwanie, open_page, znajdowanie).	Yes
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
id	ciąg	Unikatowy identyfikator wywołania narzędzia wyszukiwania w Internecie.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
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

Dane wyjściowe tekstowe z modelu.

Name	Typ	Description	Obowiązkowy
annotations	tablica adnotacji OpenAI.Annotation	Adnotacje tekstu wyjściowego.	Yes
logprobs	tablica biblioteki OpenAI.LogProb		Nie.
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

OpenAI.OutputMessageContentRefusalContent

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

OpenAI.OutputMessageContentType

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

OpenAI.Prompt

Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.

Name	Typ	Description	Obowiązkowy
id	ciąg	Unikatowy identyfikator szablonu monitu do użycia.	Yes
variables	OpenAI.ResponsePromptVariables (dopuszczana wartość null)	Opcjonalna mapa wartości, które mają być zastępowane zmiennymi w prompt. Wartości podstawienia mogą być ciągami znaków lub innymi wartościami. Typy danych wejściowych odpowiedzi, takie jak obrazy lub pliki.	Nie.
wersja	ciąg (dopuszczany do wartości 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	OpenAI.numeric	Waga osadzania w wzajemnym połączeniu rankingowym.	Yes
└text_weight	OpenAI.numeric	Waga tekstu w wzajemnym połączeniu klasyfikacji.	Yes
klasyfikator	OpenAI.RankerVersionType		Nie.
próg punktowy	OpenAI.numeric		Nie.

OpenAI.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	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	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
Type	ciąg
Nullable	Yes
Wartości	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

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

OpenAI.Response

Name	Typ	Description	Obowiązkowy	Wartość domyślna
agent_reference	AgentReference (dopuszczana wartość null)		Yes
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
zakończono_o	liczba całkowita		Nie.
konwersacja	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ ID	ciąg	Unikatowy identyfikator konwersacji, z którą została skojarzona ta odpowiedź.	Yes
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ kod	OpenAI.ResponseErrorCode	Kod błędu odpowiedzi.	Yes
└─ Komunikat	ciąg	Czytelny dla człowieka opis błędu.	Yes
id	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└* przyczyna	wyliczenie	Możliwe wartości: `max_output_tokens`, `content_filter`	Nie.
instructions	ciąg lub tablica elementu OpenAI.InputItem		Yes
max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
maks_liczba_wywołań_narzędzi	OpenAI.integer (dopuszczający wartość null)		Nie.
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
reasoning	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└─ wysiłek	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.
└─ generuj_podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
└─ Podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
poziom usługi	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
truncation	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	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.	Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		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	OpenAI.integer		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	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference (dopuszczana wartość null)	Agent używany na potrzeby tej odpowiedzi	Yes
└* tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
└completed_at	Liczba całkowita (dopuszczana do wartości null)		Nie.
Konwersacja └*	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└─ instrukcje	ciąg lub tablica elementu OpenAI.InputItem (dopuszczana do wartości null)		Yes
└─ max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└max_tool_calls	OpenAI.integer (dopuszczający wartość null)		Nie.
Metadane └*	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
└─ Model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
└prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
└* rozumowanie	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
└service_tier	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości 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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
└* skrócenie	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Yes
output_index	OpenAI.integer		Yes
część	OpenAI.OutputContent		Yes
└typ	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Yes
output_index	OpenAI.integer		Yes
część	OpenAI.OutputContent		Yes
└typ	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference (dopuszczana wartość null)	Agent używany na potrzeby tej odpowiedzi	Yes
└* tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
└completed_at	Liczba całkowita (dopuszczana do wartości null)		Nie.
Konwersacja └*	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└─ instrukcje	ciąg lub tablica elementu OpenAI.InputItem (dopuszczana do wartości null)		Yes
└─ max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└max_tool_calls	OpenAI.integer (dopuszczający wartość null)		Nie.
Metadane └*	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
└─ Model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
└prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
└* rozumowanie	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
└service_tier	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości 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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
└* skrócenie	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.created`. Możliwe wartości: `response.created`	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Identyfikator typu zdarzenia. Możliwe wartości: `response.custom_tool_call_input.delta`	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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 (dopuszczany do wartości null)		Yes
komunikat	ciąg	Komunikat o błędzie.	Yes
param	ciąg (dopuszczany do wartości null)		Yes
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference (dopuszczana wartość null)	Agent używany na potrzeby tej odpowiedzi	Yes
└* tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
└completed_at	Liczba całkowita (dopuszczana do wartości null)		Nie.
Konwersacja └*	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└─ instrukcje	ciąg lub tablica elementu OpenAI.InputItem (dopuszczana do wartości null)		Yes
└─ max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└max_tool_calls	OpenAI.integer (dopuszczający wartość null)		Nie.
Metadane └*	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
└─ Model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
└prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
└* rozumowanie	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
└service_tier	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości 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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
└* skrócenie	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.file_search_call.searching`. Możliwe wartości: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormatJsonObject

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.ResponseFormatJsonSchema

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

Name	Typ	Description	Obowiązkowy
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema		Yes
Opis └*	ciąg		Nie.
└─ nazwa	ciąg		Yes
Schemat └*	OpenAI.ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON. Dowiedz się, jak tworzyć schematy JSON tutaj.	Nie.
└* ścisłe	Wartość logiczna (dopuszczana do wartości null)		Nie.
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze `json_schema`. Możliwe wartości: `json_schema`	Yes

OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema

Name	Typ	Description	Obowiązkowy
opis	ciąg		Nie.
nazwa	ciąg		Yes
schemat	OpenAI.ResponseFormatJsonSchemaSchema	Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON. Dowiedz się, jak tworzyć schematy JSON tutaj.	Nie.
surowy	Wartość logiczna (dopuszczana do wartości null)		Nie.

OpenAI.ResponseFormatJsonSchemaSchema

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

Typ: obiekt

OpenAI.ResponseFormatText

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.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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Możliwe wartości: `response.function_call_arguments.done`	Yes

OpenAI.ResponseImageGenCallCompletedEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.completed". Możliwe wartości: `response.image_generation_call.completed`	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.generating". Możliwe wartości: `response.image_generation_call.generating`	Yes

OpenAI.ResponseImageGenCallInProgressEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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

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	OpenAI.integer		Yes
partial_image_b64	ciąg	Dane częściowe obrazu zakodowane w formacie Base64, odpowiednie do renderowania jako obrazu.	Yes
partial_image_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference (dopuszczana wartość null)	Agent używany na potrzeby tej odpowiedzi	Yes
└* tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
└completed_at	Liczba całkowita (dopuszczana do wartości null)		Nie.
Konwersacja └*	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└─ instrukcje	ciąg lub tablica elementu OpenAI.InputItem (dopuszczana do wartości null)		Yes
└─ max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└max_tool_calls	OpenAI.integer (dopuszczający wartość null)		Nie.
Metadane └*	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
└─ Model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
└prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
└* rozumowanie	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
└service_tier	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości 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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
└* skrócenie	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference (dopuszczana wartość null)	Agent używany na potrzeby tej odpowiedzi	Yes
└* tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
└completed_at	Liczba całkowita (dopuszczana do wartości null)		Nie.
Konwersacja └*	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└─ instrukcje	ciąg lub tablica elementu OpenAI.InputItem (dopuszczana do wartości null)		Yes
└─ max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└max_tool_calls	OpenAI.integer (dopuszczający wartość null)		Nie.
Metadane └*	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
└─ Model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
└prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
└* rozumowanie	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
└service_tier	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości 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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
└* skrócenie	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.incomplete`. Możliwe wartości: `response.incomplete`	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	OpenAI.numeric		Yes
kod przedpłaty	ciąg	Możliwy token tekstowy.	Yes
top_logprobs	tablica openAI.ResponseLogProbTopLogprobs	Prawdopodobieństwo dziennika pierwszych 20 najbardziej prawdopodobnych tokenów.	Nie.

OpenAI.ResponseLogProbTopLogprobs

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

OpenAI.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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call_arguments.delta". Możliwe wartości: `response.mcp_call_arguments.delta`	Yes

OpenAI.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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call_arguments.done". Możliwe wartości: `response.mcp_call_arguments.done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.completed". Możliwe wartości: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.failed". Możliwe wartości: `response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.in_progress". Możliwe wartości: `response.mcp_call.in_progress`	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze „response.mcp_list_tools.completed”. Możliwe wartości: `response.mcp_list_tools.completed`	Yes

OpenAI.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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_list_tools.failed". Możliwe wartości: `response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference	Agent, który utworzył element.	Nie.
└response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
└typ	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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
└agent_reference	AgentReference	Agent, który utworzył element.	Nie.
└response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
└typ	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.output_item.done`. Możliwe wartości: `response.output_item.done`	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

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	OpenAI.integer		Yes
content_index	OpenAI.integer		Yes
item_id	ciąg	Unikatowy identyfikator elementu, do którego jest dodawana adnotacja.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze "response.output_text.adnotacja.added". Możliwe wartości: `response.output_text.annotation.added`	Yes

OpenAI.ResponsePromptVariables

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

Emitowane, gdy odpowiedź czeka w kolejce na przetworzenie.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
response	OpenAI.Response		Yes
└agent_reference	AgentReference (dopuszczana wartość null)	Agent używany na potrzeby tej odpowiedzi	Yes
└* tło	Wartość logiczna (dopuszczana do wartości null)		Nie.
└completed_at	Liczba całkowita (dopuszczana do wartości null)		Nie.
Konwersacja └*	OpenAI.ConversationReference (dopuszczana wartość null)	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.	Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Yes
└─ błąd	OpenAI.ResponseError (dopuszczana wartość null)	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Yes
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Yes
└niekompletne_szczegóły	OpenAI.ResponseIncompleteDetails (dopuszczana wartość null)		Yes
└─ instrukcje	ciąg lub tablica elementu OpenAI.InputItem (dopuszczana do wartości null)		Yes
└─ max_output_tokens	OpenAI.integer (dopuszczający wartość null)		Nie.
└max_tool_calls	OpenAI.integer (dopuszczający wartość null)		Nie.
Metadane └*	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
└─ Model	ciąg	Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi.	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 (dopuszczany do wartości 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 (dopuszczany do wartości null)		Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	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. Dowiedz się więcej.	Nie.
└prompt_cache_retention	wyliczenie	Możliwe wartości: `in-memory`, `24h`	Nie.
└* rozumowanie	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└safety_identifier	ciąg	Stabilny identyfikator używany do wykrywania użytkowników aplikacji, którzy mogą naruszać zasady użycia interfejsu OpenAI. Identyfikatory powinny być ciągiem, który jednoznacznie identyfikuje każdego użytkownika. Zalecamy wyznaczanie wartości skrótu nazwy użytkownika lub adresu e-mail, aby uniknąć wysyłania nam wszelkich informacji identyfikacyjnych. Dowiedz się więcej.	Nie.
└service_tier	OpenAI.ServiceTier	Określa typ przetwarzania używany do obsługi żądania. — Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej. — Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu. — Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone z odpowiednią warstwą usługi. — Jeśli nie jest ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru `service_tier` treść odpowiedzi będzie zawierać `service_tier` wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .	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	OpenAI.numeric (dopuszczana do wartości 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 - Dane wyjściowe ze strukturą	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 w Internecie lub 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 wywoływanie funkcji. Możesz również użyć niestandardowe narzędzia do wywoływania własnego kodu.	Nie.
└ top_logprobs	OpenAI.integer (dopuszczający wartość null)		Nie.
└─top_p	OpenAI.numeric (dopuszczana do wartości null)		Nie.	1
└* skrócenie	wyliczenie	Możliwe wartości: `auto`, `disabled`	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. Dowiedz się więcej.	Nie.
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
część	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└* tekst	ciąg		Yes
└typ	wyliczenie	Możliwe wartości: `summary_text`	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		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	OpenAI.integer		Yes
część	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└* tekst	ciąg		Yes
└typ	wyliczenie	Możliwe wartości: `summary_text`	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		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	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
item_id	ciąg	Identyfikator elementu, z tym tekstem rozumowania jest skojarzony.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		Yes
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego tekst odmowy jest finalizowany.	Yes
output_index	OpenAI.integer		Yes
refusal	ciąg	Tekst odmowy, który jest sfinalizowany.	Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.refusal.done`. Możliwe wartości: `response.refusal.done`	Yes

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	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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	OpenAI.integer		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	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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:

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	Obowiązkowy
input_tokens	OpenAI.integer	Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Yes
└cached_tokens	OpenAI.integer	Yes
output_tokens	OpenAI.integer	Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Yes
└─ tokeny_rozumowania	OpenAI.integer	Yes
total_tokens	OpenAI.integer	Yes

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Obowiązkowy	Wartość domyślna
cached_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Obowiązkowy	Wartość domyślna
tokeny_rozumowania	OpenAI.integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Emitowane po zakończeniu wywołania wyszukiwania w Internecie.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.web_search_call.completed`. Możliwe wartości: `response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Emitowane po zainicjowaniu wywołania wyszukiwania w Sieci Web.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		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

Emitowane podczas wykonywania wywołania wyszukiwania w Internecie.

Name	Typ	Description	Obowiązkowy
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
typ	wyliczenie	Typ zdarzenia. Zawsze `response.web_search_call.searching`. Możliwe wartości: `response.web_search_call.searching`	Yes

OpenAI.Zrzut ekranu

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ść to zawsze ustawiony na `screenshot`. Możliwe wartości: `screenshot`	Yes

OpenAI.Scroll

Akcja przewijania.

Name	Typ	Description	Obowiązkowy
scroll_x	OpenAI.integer		Yes
scroll_y	OpenAI.integer		Yes
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przewijania właściwość ta to zawsze ustawiony na `scroll`. Możliwe wartości: `scroll`	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.SearchContextSize

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

OpenAI.ServiceTier

Określa typ przetwarzania używany do obsługi żądania.

Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone z warstwą usługi skonfigurowaną w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej.
Jeśli zostanie ustawiona wartość "domyślna", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu.
Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone przy użyciu odpowiedniej warstwy usługi.
Jeśli nie zostanie ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru service_tier treść odpowiedzi będzie zawierać service_tier wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .

Property	Value
Type	ciąg
Nullable	Yes
Wartości	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

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

OpenAI.SpecificFunctionShellParam

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

OpenAI.Summary

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

OpenAI.SummaryTextContent

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

OpenAI.TextContent

Zawartość tekstowa.

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

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. Niezalecane w przypadku modeli gpt-4o i nowszych:* Ustawienie { "type": "json_object" } umożliwia korzystanie ze starszego trybu JSON, co gwarantuje, że komunikat generowany przez model jest prawidłowym kodem 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

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

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

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

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 (dopuszczana do wartości 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
`bing_grounding`	BingGroundingTool
`fabric_dataagent_preview`	MicrosoftFabricPreviewTool
`sharepoint_grounding_preview`	SharepointPreviewTool
`azure_ai_search`	AzureAISearchTool
`openapi`	OpenApiTool
`bing_custom_search_preview`	BingCustomSearchPreviewTool
`browser_automation_preview`	BrowserAutomationPreviewTool
`azure_function`	AzureFunctionTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2APreviewTool
`memory_search_preview`	MemorySearchPreviewTool
`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

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

OpenAI.ToolChoiceAllowed

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> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<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.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

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

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

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

Name	Typ	Description	Obowiązkowy
nazwa	ciąg (dopuszczany do wartości 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

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
`function`	OpenAI.ToolChoiceFunction
`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

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`

OpenAI.ToolChoiceWebSearchPreview

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`	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.ToolType

Property Value

Type ciąg

Wartości function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

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 usługę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. 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ższy logarytm prawdopodobieństwa tokenu.

Name	Typ	Obowiązkowy
bytes	tablica wartości OpenAI.integer	Yes
logprob	OpenAI.numeric	Yes
kod przedpłaty	ciąg	Yes

OpenAI.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. W przypadku akcji typu ta właściwość to zawsze ustawiony na `type`. Możliwe wartości: `type`	Yes

OpenAI.UpdateConversationBody

Name	Typ	Description	Obowiązkowy	Wartość domyślna
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Yes

OpenAI.UrlCitationBody

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

Name	Typ	Description	Obowiązkowy
end_index	OpenAI.integer		Yes
start_index	OpenAI.integer		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	ciąg	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
Type	ciąg
Nullable	Yes
Wartości	`low` `medium` `high`

OpenAI.Wait

Akcja oczekiwania.

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

OpenAI.WebSearchActionFind

Typ akcji "find": wyszukuje wzorzec 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	ciąg	Adres URL strony, na której wyszukiwano wzorzec.	Yes

OpenAI.WebSearchActionOpenPage

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	Adres URL otwarty przez model.	Yes

OpenAI.WebSearchActionSearch

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	ciąg		Yes

OpenAI.WebSearchApproximateLocation

Przybliżona lokalizacja użytkownika.

Name	Typ	Description	Obowiązkowy
Miasta	ciąg (dopuszczany do wartości null)		Nie.
kraj	ciąg (dopuszczany do wartości null)		Nie.
region	ciąg (dopuszczany do wartości null)		Nie.
timezone	ciąg (dopuszczany do wartości null)		Nie.
typ	wyliczenie	Typ przybliżenia lokalizacji. Zawsze `approximate`. Możliwe wartości: `approximate`	Nie.

OpenAI.WebSearchPreviewTool

To narzędzie przeszukuje internet w poszukiwaniu odpowiednich wyników do wykorzystania w odpowiedzi. Dowiedz się więcej o narzędziu wyszukiwania web.

Name	Typ	Description	Obowiązkowy
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
lokalizacja_użytkownika	OpenAI.ApproximateLocation (dopuszczana wartość null)		Nie.
└* miasto	ciąg (dopuszczany do wartości null)		Nie.
└* kraj	ciąg (dopuszczany do wartości null)		Nie.
└region	ciąg (dopuszczany do wartości null)		Nie.
└* strefa czasowa	ciąg (dopuszczany do wartości null)		Nie.
└typ	wyliczenie	Typ przybliżenia lokalizacji. Zawsze `approximate`. Możliwe wartości: `approximate`	Yes

OpenAI.WebSearchTool

Przeszukaj Internet w poszukiwaniu źródeł związanych z tym tematem. Dowiedz się więcej o narzędziu wyszukiwania web.

Name	Typ	Description	Obowiązkowy
custom_search_configuration	WebSearchConfiguration	Konfiguracja wyszukiwania w Internecie dla wyszukiwania niestandardowego bing	Nie.
└instance_name	ciąg	Nazwa wystąpienia konfiguracji niestandardowej podane do konfiguracji.	Yes
└project_connection_id	ciąg	Project identyfikator połączenia dla uziemienia za pomocą wyszukiwania niestandardowego bing	Yes
filters	OpenAI.WebSearchToolFilters (dopuszczający wartość null)		Nie.
└allowed_domains	tablica ciągu (dopuszczana do wartości 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.
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
lokalizacja_użytkownika	OpenAI.WebSearchApproximateLocation (dopuszczana wartość null)	Przybliżona lokalizacja użytkownika.	Nie.
└* miasto	ciąg (dopuszczany do wartości null)		Nie.
└* kraj	ciąg (dopuszczany do wartości null)		Nie.
└region	ciąg (dopuszczany do wartości null)		Nie.
└* strefa czasowa	ciąg (dopuszczany do wartości null)		Nie.
└typ	wyliczenie	Typ przybliżenia lokalizacji. Zawsze `approximate`. Możliwe wartości: `approximate`	Nie.

OpenAI.WebSearchToolFilters

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

OpenAI.integer

Typ: liczba całkowita

Format: int64

OpenAI.numeric

Typ: liczba

Format: podwójne

OpenApiAnonymousAuthDetails

Szczegóły zabezpieczeń uwierzytelniania anonimowego openApi

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	wyliczenie	Typ obiektu, który jest zawsze "anonimowy". Możliwe wartości: `anonymous`	Yes

OpenApiAuthDetails

szczegóły uwierzytelniania dla elementu OpenApiFunctionDefinition

Dyskryminujące dla openApiAuthDetails

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

Typ wartości	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	OpenApiAuthType	Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to: — Anonimowe (bez wymaganego uwierzytelniania) — połączenie Project (wymaga project_connection_id do punktu końcowego, zgodnie z konfiguracją w narzędziu AI Foundry) - Managed_Identity (wymaga odbiorców uwierzytelniania opartego na tożsamościach)	Yes

OpenApiAuthType

Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to:

Anonimowy (uwierzytelnianie nie jest wymagane)
Project Connection (wymaga project_connection_id do punktu końcowego, jak ustawione w AI Foundry)
Managed_Identity (wymaga odbiorców do uwierzytelniania opartego na tożsamości)

Property	Value
Opis	Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to: — Anonimowe (bez wymaganego uwierzytelniania) — połączenie Project (wymaga project_connection_id do punktu końcowego, zgodnie z konfiguracją w narzędziu AI Foundry) - Managed_Identity (wymaga odbiorców uwierzytelniania opartego na tożsamościach)
Type	ciąg
Wartości	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Informacje o definicji danych wejściowych dla funkcji openapi.

Name	Typ	Description	Obowiązkowy
auth	OpenApiAuthDetails	szczegóły uwierzytelniania dla elementu OpenApiFunctionDefinition	Yes
└typ	OpenApiAuthType	Typ uwierzytelniania musi być anonimowy/project_connection/managed_identity	Yes
default_params	tablica ciągów	Lista parametrów specyfikacji interfejsu OpenAPI, które będą używać domyślnych ustawień udostępnionych przez użytkownika	Nie.
opis	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
functions	tablica obiektu	Lista definicji funkcji używanych przez narzędzie OpenApi	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
spec	obiekt	Kształt funkcji openapi opisany jako obiekt schematu JSON.	Yes

OpenApiManagedAuthDetails

Szczegóły zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Name	Typ	Description	Obowiązkowy
security_scheme	OpenApiManagedSecurityScheme	Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity	Yes
└odbiorców	ciąg	Zakres uwierzytelniania dla typu uwierzytelniania managed_identity	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze "managed_identity". Możliwe wartości: `managed_identity`	Yes

OpenApiManagedSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Name	Typ	Description	Obowiązkowy	Wartość domyślna
audience	ciąg	Zakres uwierzytelniania dla typu uwierzytelniania managed_identity	Yes

OpenApiProjectConnectionAuthDetails

Szczegóły zabezpieczeń uwierzytelniania połączeń interfejsu OpenApi project

Name	Typ	Description	Obowiązkowy
security_scheme	OpenApiProjectConnectionSecurityScheme	Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity	Yes
└project_connection_id	ciąg	identyfikator połączenia Project dla typu uwierzytelniania połączenia Project	Yes
typ	wyliczenie	Typ obiektu, który jest zawsze "project_connection". Możliwe wartości: `project_connection`	Yes

OpenApiProjectConnectionSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Name	Typ	Description	Obowiązkowy	Wartość domyślna
project_connection_id	ciąg	identyfikator połączenia Project dla typu uwierzytelniania połączenia Project	Yes

OpenApiTool

Informacje o definicji danych wejściowych narzędzia OpenAPI używane do konfigurowania agenta.

Name	Typ	Description	Obowiązkowy
openapi	OpenApiFunctionDefinition	Informacje o definicji danych wejściowych dla funkcji openapi.	Yes
└* uwierzytelnianie	OpenApiAuthDetails	Szczegóły uwierzytelniania interfejsu API	Yes
└default_params	tablica ciągów	Lista parametrów specyfikacji interfejsu OpenAPI, które będą używać domyślnych ustawień udostępnionych przez użytkownika	Nie.
Opis └*	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
Funkcje └*	tablica obiektów (tylko do odczytu)	Lista definicji funkcji używanych przez narzędzie OpenApi	Nie.
Opis └*	ciąg	Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
Parametry	obiekt	Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.	Yes
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Yes
└* specyfikacja	obiekt	Kształt funkcji openapi opisany jako obiekt schematu JSON.	Yes
typ	wyliczenie	Typ obiektu, którym zawsze jest 'openapi'. Możliwe wartości: `openapi`	Yes

PageOrder

Property	Value
Type	ciąg
Wartości	`asc` `desc`

PagedConnection

Stronicowana kolekcja elementów połączenia

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica połączeń	Elementy połączenia na tej stronie	Yes

PagedDatasetVersion

Stronicowana kolekcja elementów DatasetVersion

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica elementu DatasetVersion	Elementy DatasetVersion na tej stronie	Yes

PagedDeployment

Stronicowana kolekcja elementów wdrożenia

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica wdrożenia	Elementy wdrożenia na tej stronie	Yes

PagedEvaluationRule

Stronicowana kolekcja elementów EvaluationRule

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica wartości EvaluationRule	Elementy EvaluationRule na tej stronie	Yes

PagedEvaluationTaxonomy

Stronicowana kolekcja elementów EvaluationTaxonomy

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica wartości EvaluationTaxonomy	Elementy EvaluationTaxonomy na tej stronie	Yes

PagedEvaluatorVersion

Stronicowana kolekcja elementów EvaluatorVersion

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica EwaluatorVersion	Elementy EvaluatorVersion na tej stronie	Yes

PagedIndex

Stronicowana kolekcja elementów indeksu

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica indeksu	Elementy indeksu na tej stronie	Yes

PagedInsight

Stronicowana kolekcja elementów szczegółowych informacji

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica szczegółowych informacji	Elementy szczegółowych informacji na tej stronie	Yes

PagedRedTeam

Stronicowana kolekcja elementów RedTeam

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica redteam	Elementy RedTeam na tej stronie	Yes

PagedSchedule

Stronicowana kolekcja elementów harmonogramu

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica harmonogramu	Elementy harmonogramu na tej stronie	Yes

PagedScheduleRun

Stronicowana kolekcja elementów ScheduleRun

Name	Typ	Description	Obowiązkowy	Wartość domyślna
nextLink	ciąg	Link do następnej strony elementów	Nie.
value	tablica funkcji ScheduleRun	Elementy ScheduleRun na tej stronie	Yes

PendingUploadRequest

Reprezentuje prośbę o oczekujące przesłanie.

Name	Typ	Description	Obowiązkowy
Connectionname	ciąg	Nazwa połączenia konta usługi Azure Storage do użycia do generowania tymczasowego tokenu SAS	Nie.
pendingUploadId	ciąg	Jeśli PendingUploadId nie zostanie podany, zostanie użyty losowy identyfikator GUID.	Nie.
pendingUploadType	wyliczenie	Funkcja BlobReference jest jedynym obsługiwanym typem. Możliwe wartości: `BlobReference`	Yes

PendingUploadResponse

Reprezentuje odpowiedź na oczekujące żądanie przesłania

Name	Typ	Description	Obowiązkowy
BlobReference	BlobReference	Szczegóły odwołania do obiektu blob.	Yes
└* identyfikator blobUri	ciąg	Ścieżka identyfikatora URI obiektu blob dla klienta w celu przekazania danych. Przykład: `https://blob.windows.core.net/Container/Path`	Yes
Poświadczenie └*	SasCredential	Informacje o poświadczeniach umożliwiające uzyskanie dostępu do konta magazynu.	Yes
└* storageAccountArmId	ciąg	Identyfikator arm konta magazynu do użycia.	Yes
pendingUploadId	ciąg	Identyfikator tego żądania przesłania.	Yes
pendingUploadType	wyliczenie	BlobReference jest jedynym obsługiwanym typem Możliwe wartości: `BlobReference`	Yes
wersja	ciąg	Wersja zasobu, która ma zostać utworzona, jeśli użytkownik nie określił wersji podczas początkowego tworzenia przesyłania	Nie.

PromptAgentDefinition

Definicja agenta monitu

Name	Typ	Description	Obowiązkowy	Wartość domyślna
instructions	ciąg (dopuszczany do wartości null)	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu.	Nie.
rodzaj	wyliczenie	Możliwe wartości: `prompt`	Yes
model	ciąg	Wdrożenie modelu do użycia dla tego agenta.	Yes
rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
└rai_policy_name	ciąg	Nazwa zasad RAI do zastosowania.	Yes
reasoning	OpenAI.Reasoning (dopuszczające wartość null)	Tylko modele gpt-5 i serii o Opcje konfiguracji dla modele rozumowania.	Nie.
└─ wysiłek	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.
└─ generuj_podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
└─ Podsumowanie	wyliczenie	Możliwe wartości: `auto`, , `concisedetailed`	Nie.
structured_inputs	obiekt	Zestaw ustrukturyzowanych danych wejściowych, które mogą uczestniczyć w zastępowaniu szablonów monitów lub powiązaniach argumentów narzędzia.	Nie.
temperatura	number	Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będą bardziej skoncentrowane i deterministyczne. Ogólnie zalecamy zmienić to lub `top_p`, ale nie obu jednocześnie.	Nie.	1
SMS	PromptAgentDefinitionTextOptions	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą.	Nie.
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.
tool_choice	string lub 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.	Nie.
Narzędzia	tablica narzędzi OpenAI.Tool	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` .	Nie.
top_p	number	Alternatywa dla próbkowania z temperaturą, nazywana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów o prawdopodobieństwie "top_p" masa. Tak więc 0,1 oznacza tylko tokeny składające się z 10 pierwszych% masy prawdopodobieństwa są brane pod uwagę. Ogólnie zalecamy zmienić to lub `temperature`, ale nie obu jednocześnie.	Nie.	1

PromptAgentDefinitionTextOptions

Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON 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.

PromptBasedEvaluatorDefinition

Ewaluator oparty na podpowiedziach

Name	Typ	Description	Obowiązkowy
data_schema	obiekt	Schemat JSON (wersja robocza 2020-12) dla danych wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
init_parameters	obiekt	Schemat JSON (wersja robocza 2020-12) dla parametrów wejściowych ewaluatora. Obejmuje to parametry, takie jak typ, właściwości, wymagane.	Nie.
metryki	obiekt	Lista wskaźników wyjściowych opracowanych przez tego ewaluatora	Nie.
prompt_text	ciąg	Tekst monitu używany do oceny	Yes
typ	wyliczenie	Możliwe wartości: `prompt`	Yes

ProtocolVersionRecord

Mapowanie rekordu dla pojedynczego protokołu i jego wersji.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
protokół	AgentProtocol		Yes
wersja	ciąg	Ciąg wersji protokołu, np. "v0.1.1".	Yes

RaiConfig

Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).

Name	Typ	Description	Obowiązkowy	Wartość domyślna
rai_policy_name	ciąg	Nazwa zasad RAI do zastosowania.	Yes

RecurrenceSchedule

Model harmonogramu cykli.

Dyskryminujący dla cykluSchedule

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

Typ wartości	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

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

RecurrenceTrigger

Wyzwalacz oparty na cyklu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
endTime	ciąg	Godzina zakończenia harmonogramu cyklu w formacie ISO 8601.	Nie.
interwał	liczba całkowita	Interwał harmonogramu cyklu.	Yes
schedule	RecurrenceSchedule	Model harmonogramu cykli.	Yes
└typ	Typ cyklu	Typ cyklu dla harmonogramu cyklu.	Yes
startTime	ciąg	Godzina rozpoczęcia harmonogramu cyklu w formacie ISO 8601.	Nie.
timeZone	ciąg	Strefa czasowa dla harmonogramu cyklu.	Nie.	UTC
typ	wyliczenie	Typ wyzwalacza. Możliwe wartości: `Recurrence`	Yes

Typ cyklu

Typ cyklu.

Property	Value
Opis	Typ cyklu.
Type	ciąg
Wartości	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Szczegóły czerwonej drużyny.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
applicationScenario	ciąg	Scenariusz aplikacji dla czerwonej operacji zespołu w celu wygenerowania konkretnych ataków scenariusza.	Nie.
attackStrategies	tablica strategii ataków	Lista strategii ataku lub zagnieżdżonych list strategii ataku.	Nie.
displayName	ciąg	Nazwa uruchomienia czerwonego zespołu.	Nie.
id	ciąg (tylko do odczytu)	Identyfikator czerwonego przebiegu zespołu.	Yes
liczbawywracania	liczba całkowita	Liczba rund symulacji.	Nie.
properties	obiekt	Właściwości zespołu czerwonego. W przeciwieństwie do tagów właściwości są tylko do dodawania. Po dodaniu nie można usunąć właściwości.	Nie.
riskCategories	tablica kategorii ryzyka	Lista kategorii ryzyka do generowania celów ataku.	Nie.
symulacjaOnly	boolean	Tylko symulacja lub Symulacja i ocena. Wartość domyślna false, jeśli wartość true skanowania generuje wynik konwersacji, która nie jest wynikiem oceny.	Nie.	Nieprawda
stan	ciąg (tylko do odczytu)	Stan czerwonego zespołu. Jest on ustawiany przez usługę i jest tylko do odczytu.	Nie.
tags	obiekt	Tagi czerwonego zespołu. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
miejsce docelowe	TargetConfig	Klasa abstrakcyjna dla konfiguracji docelowej.	Yes
└typ	ciąg	Typ konfiguracji modelu.	Yes

RedTeamEvalRunDataSource

Name	Typ	Description	Obowiązkowy
item_generation_params	ItemGenerationParams	Reprezentuje zestaw parametrów używanych do sterowania operacjami generowania elementów.	Yes
└typ	ItemGenerationParamsType	Typ parametrów generowania elementu do użycia.	Yes
miejsce docelowe	Obiekt docelowy	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Yes
└typ	ciąg	Typ obiektu docelowego.	Yes
typ	wyliczenie	Typ źródła danych. Zawsze `azure_ai_red_team`. Możliwe wartości: `azure_ai_red_team`	Yes

RedTeamItemGenerationParams

Name	Typ	Description	Obowiązkowy	Wartość domyślna
attack_strategies	tablica strategii ataków	Kolekcja strategii ataków, które mają być używane.	Yes
num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Yes	20
typ	wyliczenie	Typ parametrów generowania elementu. Możliwe wartości: `red_team`	Yes

RedTeamSeedPromptsItemGenerationParams

Reprezentuje parametry generowania elementu z czerwonym inicjatorem zespołu.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
attack_strategies	tablica strategii ataków	Kolekcja strategii ataków, które mają być używane.	Yes
num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Yes	20
przesłać źródło	OpenAI.EvalJsonlFileContentSource		Yes
└─ zawartość	tablica obiektów OpenAI.EvalJsonlFileContentSourceContent	Zawartość pliku jsonl.	Yes
└typ	wyliczenie	Typ źródła jsonl. Zawsze `file_content`. Możliwe wartości: `file_content`	Yes
typ	wyliczenie	Typ parametrów generowania elementów, zawsze `red_team_seed_prompts`. Możliwe wartości: `red_team_seed_prompts`	Yes

RedTeamTaxonomyItemGenerationParams

Reprezentuje parametry generowania elementów taksonomii zespołu czerwonego.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
attack_strategies	tablica strategii ataków	Kolekcja strategii ataków, które mają być używane.	Yes
num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Yes	20
przesłać źródło	OpenAI.EvalJsonlFileContentSource		Yes
└─ zawartość	tablica obiektów OpenAI.EvalJsonlFileContentSourceContent	Zawartość pliku jsonl.	Yes
└typ	wyliczenie	Typ źródła jsonl. Zawsze `file_content`. Możliwe wartości: `file_content`	Yes
typ	wyliczenie	Typ parametrów generowania elementów, zawsze `red_team_taxonomy`. Możliwe wartości: `red_team_taxonomy`	Yes

ResponseRetrievalItemGenerationParams

Reprezentuje parametry generowania elementu pobierania odpowiedzi.

Name	Typ	Description	Obowiązkowy
mapowanie danych	obiekt	Mapowanie z pól źródłowych na pole response_id wymagane do pobierania historii czatu.	Yes
max_num_turns	liczba całkowita	Maksymalna liczba zakrętów historii czatów do oceny.	Yes
przesłać źródło	OpenAI.EvalJsonlFileContentSource lub OpenAI.EvalJsonlFileIdSource	Źródło, z którego jest odczytywana zawartość JSONL.	Yes
typ	wyliczenie	Typ parametrów generowania elementów, zawsze `response_retrieval`. Możliwe wartości: `response_retrieval`	Yes

Kategoria ryzyka

Kategoria ryzyka dla celu ataku.

Property	Value
Opis	Kategoria ryzyka dla celu ataku.
Type	ciąg
Wartości	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

Sygnatury dostępu współdzielonego

Definicja poświadczeń sygnatury dostępu współdzielonego (SAS)

Name	Typ	Description	Obowiązkowy	Wartość domyślna
SAS	ciąg (tylko do odczytu)	token SAS	Nie.
typ	wyliczenie	Typ poświadczeń Możliwe wartości: `SAS`	Yes

SampleType

Rodzaj próbki użytej w analizie.

Property	Value
Opis	Rodzaj próbki użytej w analizie.
Type	ciąg
Wartości	`EvaluationResultSample`

SasCredential

Definicja poświadczeń sygnatury dostępu współdzielonego

Name	Typ	Description	Obowiązkowy	Wartość domyślna
sasUri	ciąg (tylko do odczytu)	Identyfikator URI sygnatury dostępu współdzielonego	Yes
typ	wyliczenie	Typ poświadczeń Możliwe wartości: `SAS`	Yes

Schedule

Model harmonogramu.

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis harmonogramu.	Nie.
displayName	ciąg	Nazwa harmonogramu.	Nie.
enabled	boolean	Włączony stan harmonogramu.	Yes
id	ciąg (tylko do odczytu)	Identyfikator harmonogramu.	Yes
properties	obiekt	Właściwości harmonogramu. W przeciwieństwie do tagów właściwości są tylko do dodawania. Po dodaniu nie można usunąć właściwości.	Nie.
provisioningStatus (stan aprowizacji)	ScheduleProvisioningStatus (tylko do odczytu)	Zaplanuj stan apryfikacji.	Nie.
daneSystemowe	obiekt (tylko do odczytu)	Metadane systemu dla zasobu.	Yes
tags	obiekt	Tagi harmonogramu. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
zadanie	ScheduleTask	Zaplanuj model zadań.	Yes
Konfiguracja └*	obiekt	Konfiguracja zadania.	Nie.
└typ	ScheduleTaskType	Typ zadania.	Yes
wyzwalacz	Trigger	Model podstawowy dla wyzwalacza harmonogramu.	Yes
└typ	Typ wyzwalacza	Typ wyzwalacza.	Yes

ScheduleProvisioningStatus

Zaplanuj stan apryfikacji.

Property	Value
Opis	Zaplanuj stan apryfikacji.
Type	ciąg
Wartości	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Zaplanuj model uruchamiania.

Name	Typ	Description	Obowiązkowy
błąd	ciąg (tylko do odczytu)	Informacje o błędzie dotyczące przebiegu harmonogramu.	Nie.
id	ciąg (tylko do odczytu)	Identyfikator przebiegu harmonogramu.	Yes
properties	obiekt (tylko do odczytu)	Właściwości przebiegu harmonogramu.	Yes
identyfikator harmonogramu	ciąg	Identyfikator harmonogramu.	Yes
success	Wartość logiczna (tylko do odczytu)	Stan powodzenia wyzwalacza przebiegu harmonogramu.	Yes
triggerTime	ciąg	Czas wyzwalania przebiegu harmonogramu.	Nie.

ZaplanowaneZadanie

Zaplanuj model zadań.

Dyskryminujący dla harmonogramuTask

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

Typ wartości	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

Name	Typ	Description	Obowiązkowy	Wartość domyślna
konfiguracja	obiekt	Konfiguracja zadania.	Nie.
typ	ScheduleTaskType	Typ zadania.	Yes

ScheduleTaskType

Typ zadania.

Property	Value
Opis	Typ zadania.
Type	ciąg
Wartości	`Evaluation` `Insight`

SharepointGroundingToolParameters

Parametry narzędzia do uziemiania programu sharepoint.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
project_connections	tablica toolProjectConnection	Połączenia project dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Nie.

SharepointPreviewTool

Informacje o definicji danych wejściowych narzędzia sharepoint używane do konfigurowania agenta.

Name	Typ	Description	Obowiązkowy
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parametry narzędzia do uziemiania programu sharepoint.	Yes
└project_connections	tablica toolProjectConnection	Połączenia project dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia. Ograniczenia: maxItems: 1	Nie.
typ	wyliczenie	Typ obiektu, który zawsze jest "sharepoint_grounding_preview". Możliwe wartości: `sharepoint_grounding_preview`	Yes

Sku

Informacje o jednostce SKU

Name	Typ	Description	Obowiązkowy
dyspozycyjność	liczba całkowita	Pojemność jednostki SKU	Yes
family	ciąg	Rodzina jednostek SKU	Yes
nazwa	ciąg	Nazwa jednostki SKU	Yes
size	ciąg	Rozmiar jednostki SKU	Yes
warstwa	ciąg	Warstwa jednostki SKU	Yes

StructuredInputDefinition

Ustrukturyzowane dane wejściowe, które mogą uczestniczyć w monitujących podstawieniach szablonów i wiązaniu argumentów narzędzia.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
default_value		Wartość domyślna danych wejściowych, jeśli nie podano wartości czasu wykonywania.	Nie.
opis	ciąg	Czytelny dla człowieka opis danych wejściowych.	Nie.
required	boolean	Określa, czy właściwość wejściowa jest wymagana, gdy agent jest wywoływany.	Nie.	Nieprawda
schemat	obiekt	Schemat JSON dla danych wejściowych ze strukturą (opcjonalnie).	Nie.

StructuredOutputDefinition

Ustrukturyzowane dane wyjściowe, które mogą być generowane przez agenta.

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis danych wyjściowych do emisji. Używany przez model do określania, kiedy emitować dane wyjściowe.	Yes
nazwa	ciąg	Nazwa danych wyjściowych ze strukturą.	Yes
schemat	obiekt	Schemat JSON dla danych wyjściowych ze strukturą.	Yes
surowy	Wartość logiczna (dopuszczana do wartości null)	Czy wymuszać ścisłą walidację. Wartość domyślna `true`.	Yes

StructuredOutputsOutputsOutputItem

Name	Typ	Description	Obowiązkowy
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
We/Wy		Dane wyjściowe ze strukturą przechwycone podczas odpowiedzi.	Yes
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
typ	wyliczenie	Możliwe wartości: `structured_outputs`	Yes

SyntheticDataGenerationPreviewEvalRunDataSource

Reprezentuje źródło danych dla przebiegów oceny, które ocenia na podstawie wygenerowanych syntetycznych danych na potrzeby testowania.

Name	Typ	Description	Obowiązkowy
wiadomości wejściowe	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Nie.
└─ szablon	tablica obiektów lub OpenAI.EvalItem		Yes
└typ	wyliczenie	Możliwe wartości: `template`	Yes
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Yes
└model_deployment_name	ciąg	Nazwa wdrożenia modelu do użycia do generowania danych syntetycznych.	Yes
└output_dataset_id	ciąg (tylko do odczytu)	Identyfikator wyjściowego zestawu danych, w którym są przechowywane wygenerowane dane syntetyczne. Wygenerowane dane to plik jsonl z identyfikatorem kolumn, zapytaniem i test_description.	Nie.
└output_dataset_name	ciąg	Nazwa wyjściowego zestawu danych, w którym będą przechowywane wygenerowane syntetyczne dane. Jeśli nie zostanie podana, usługa automatycznie generuje nazwę zestawu danych.	Nie.
Zachęta └*	ciąg	Monit używany do generowania danych syntetycznych. Jest to opcja, jeśli element docelowy ma typ "azure_ai_agent" z instrukcjami skonfigurowanymi w agencie.	Nie.
└samples_count	liczba całkowita	Maksymalna liczba próbek danych do wygenerowania.	Yes
Źródła └*	tablica pliku OpenAI.EvalJsonlFileIdSource	Opcjonalne pliki źródłowe zawartości danych inicjuj na potrzeby generowania danych.	Yes
└typ	wyliczenie	Typ parametrów generowania elementu. Możliwe wartości: `synthetic_data_gen_preview`	Yes
miejsce docelowe	Obiekt docelowy	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Yes
└typ	ciąg	Typ obiektu docelowego.	Yes
typ	wyliczenie	Typ źródła danych, zawsze `azure_ai_synthetic_data_gen_preview`. Możliwe wartości: `azure_ai_synthetic_data_gen_preview`	Yes

SyntheticDataGenerationPreviewItemGenerationParams

Name	Typ	Description	Obowiązkowy
nazwa_wdrożenia_modelu	ciąg	Nazwa wdrożenia modelu do użycia do generowania danych syntetycznych.	Yes
output_dataset_id	ciąg (tylko do odczytu)	Identyfikator wyjściowego zestawu danych, w którym są przechowywane wygenerowane dane syntetyczne. Wygenerowane dane to plik jsonl z identyfikatorem kolumn, zapytaniem i test_description.	Nie.
output_dataset_name	ciąg	Nazwa wyjściowego zestawu danych, w którym będą przechowywane wygenerowane syntetyczne dane. Jeśli nie zostanie podana, usługa automatycznie generuje nazwę zestawu danych.	Nie.
monit	ciąg	Monit używany do generowania danych syntetycznych. Jest to opcja, jeśli element docelowy ma typ "azure_ai_agent" z instrukcjami skonfigurowanymi w agencie.	Nie.
samples_count	liczba całkowita	Maksymalna liczba próbek danych do wygenerowania.	Yes
Źródeł	tablica pliku OpenAI.EvalJsonlFileIdSource	Opcjonalne pliki źródłowe zawartości danych inicjuj na potrzeby generowania danych.	Yes
typ	wyliczenie	Typ parametrów generowania elementu. Możliwe wartości: `synthetic_data_gen_preview`	Yes

Target

Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.

Dyskryminujący cel

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

Typ wartości	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	ciąg	Typ obiektu docelowego.	Yes

TargetCompletionEvalRunDataSource

Reprezentuje źródło danych dla docelowej konfiguracji oceny ukończenia.

Name	Typ	Description	Obowiązkowy
wiadomości wejściowe	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Nie.
└item_reference	ciąg		Yes
└typ	wyliczenie	Możliwe wartości: `item_reference`	Yes
przesłać źródło	OpenAI.EvalJsonlFileContentSource lub OpenAI.EvalJsonlFileIdSource	Konfiguracja źródła dla danych wbudowanych lub plików.	Yes
miejsce docelowe	Obiekt docelowy	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Yes
└typ	ciąg	Typ obiektu docelowego.	Yes
typ	wyliczenie	Typ źródła danych, zawsze `azure_ai_target_completions`. Możliwe wartości: `azure_ai_target_completions`	Yes

TargetConfig

Klasa abstrakcyjna dla konfiguracji docelowej.

Dyskryminujące dla elementu TargetConfig

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

Typ wartości	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	ciąg	Typ konfiguracji modelu.	Yes

TargetUpdate

Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.

Dyskryminujący dla elementu TargetUpdate

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

Typ wartości	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_agent`	AzureAIAgentTargetUpdate

Name	Typ	Description	Obowiązkowy	Wartość domyślna
typ	ciąg	Typ obiektu docelowego.	Yes

TaksonomiaCategory

Definicja kategorii taksonomii.

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis kategorii taksonomii.	Nie.
id	ciąg	Unikatowy identyfikator kategorii taksonomii.	Yes
nazwa	ciąg	Nazwa kategorii taksonomii.	Yes
properties	obiekt	Dodatkowe właściwości kategorii taksonomii.	Nie.
riskCategory	Kategoria ryzyka	Kategoria ryzyka dla celu ataku.	Yes
Podkategorie	tablica taksonomiiSubCategory	Lista podkategorii taksonomii.	Yes

TaksonomiaSubCategory

Definicja podkategorii taksonomii.

Name	Typ	Description	Obowiązkowy
opis	ciąg	Opis podkategoii taksonomii.	Nie.
enabled	boolean	Lista elementów taksonomii w tej podkategoii.	Yes
id	ciąg	Unikatowy identyfikator podkategoii taksonomii.	Yes
nazwa	ciąg	Nazwa podkategoii taksonomii.	Yes
properties	obiekt	Dodatkowe właściwości podkategoii taksonomii.	Nie.

ToolDescription

Opis narzędzia, które może być używane przez agenta.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
opis	ciąg	Krótki opis przeznaczenia narzędzia.	Nie.
nazwa	ciąg	Nazwa narzędzia.	Nie.

ToolProjectConnection

Zasób połączenia project.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
project_connection_id	ciąg	Połączenie projektu w narzędziu ToolProjectConnectionList dołączone do tego narzędzia.	Yes

TracesPreviewEvalRunDataSource

Reprezentuje źródło danych na potrzeby przebiegów oceny, które działają na podstawie śladów agenta przechowywanych w usłudze Application Insights.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Agent_id	ciąg	Identyfikator agenta używany do filtrowania śladów na potrzeby oceny.	Nie.
agent_name	ciąg	Nazwa agenta używana do filtrowania śladów na potrzeby oceny.	Nie.
czas zakończenia	liczba całkowita	Znacznik czasu systemu Unix (w sekundach) oznaczający koniec okna zapytania śledzenia. Domyślnie ustawiony jest aktualny czas.	Nie.
ingestion_delay_seconds	liczba całkowita	Opóźnienie, które ma dotyczyć pozyskiwania podczas wykonywania zapytań dotyczących śladów.	Nie.	300
lookback_hours	liczba całkowita	Okno wyszukiwania (w godzinach) stosowane podczas pobierania śladów z usługi Application Insights. W przypadku zaplanowanych ocen jest to wnioskowane z interwału cyklu.	Nie.	168
max_traces	liczba całkowita	Limit próbkowania zastosowany do śladów pobranych do oceny.	Nie.	1000
trace_ids	tablica ciągów	Kolekcja identyfikatorów śledzenia agenta, które powinny być oceniane.	Nie.
typ	wyliczenie	Typ źródła danych, zawsze `azure_ai_traces_preview`. Możliwe wartości: `azure_ai_traces_preview`	Yes

TreatmentEffectType

Rodzaj efektu zabiegu.

Property	Value
Opis	Rodzaj efektu zabiegu.
Type	ciąg
Wartości	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

Model podstawowy dla wyzwalacza harmonogramu.

Dyskryminujący wyzwalacz

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

Typ wartości	Schema
`Cron`	CronTrigger (Wyzwalacz Crona)
`Recurrence`	Wyzwalacz cyklu
`OneTime`	OneTimeTrigger

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

Typ wyzwalacza

Typ wyzwalacza.

Property	Value
Opis	Typ wyzwalacza.
Type	ciąg
Wartości	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Name	Typ	Description	Obowiązkowy
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Yes
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Yes

UpdateAgentRequest

Name	Typ	Description	Obowiązkowy
definicja	AgentDefinition		Yes
Rodzaj └*	AgentKind		Yes
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta. Ograniczenia: maxLength: 512	Nie.
metadane	obiekt	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.

UpdateEvalParametersBody

Name	Typ	Description	Obowiązkowy
metadane	OpenAI.Metadata (dopuszczana wartość null)	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 ustrukturyzowanej strukturze formatowanie i wykonywanie 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 z maksymalną długością 512 znaków.	Nie.
nazwa	ciąg		Nie.
properties	obiekt	Zestaw niezmiennych par klucz-wartość 16, które można dołączyć do obiektu w celu przechowywania dodatkowych informacji. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków.	Nie.

UserProfileMemoryItem

Element pamięci zawierający informacje o profilu użytkownika wyodrębnione z konwersacji, takie jak preferencje, zainteresowania i dane osobowe.

Name	Typ	Description	Obowiązkowy
zawartość	ciąg	Zawartość pamięci.	Yes
rodzaj	wyliczenie	Rodzaj elementu pamięci. Możliwe wartości: `user_profile`	Yes
memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Yes
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Yes
updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Yes

WebSearchConfiguration

Konfiguracja wyszukiwania w Internecie dla wyszukiwania niestandardowego bing

Name	Typ	Description	Obowiązkowy	Wartość domyślna
instance_name	ciąg	Nazwa wystąpienia konfiguracji niestandardowej podane do konfiguracji.	Yes
project_connection_id	ciąg	Project identyfikator połączenia dla uziemienia za pomocą wyszukiwania niestandardowego bing	Yes

WeeklyRecurrenceSchedule

Tygodniowy harmonogram nawrotów.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
Dni tygodnia	tablica DayOfWeek	Dni tygodnia dla harmonogramu cyklu.	Yes
typ	wyliczenie	Typ cyklu tygodniowego. Możliwe wartości: `Weekly`	Yes

WorkflowActionOutputItem

Name	Typ	Description	Obowiązkowy
action_id	ciąg	Unikatowy identyfikator akcji.	Yes
agent_reference	AgentReference		Nie.
└─ nazwa	ciąg	Nazwa agenta. Ograniczenia: maxLength: 256	Yes
└typ	wyliczenie	Możliwe wartości: `agent_reference`	Yes
└─ wersja	ciąg	Identyfikator wersji agenta.	Nie.
rodzaj	ciąg	Rodzaj akcji CSDL (np. "SetVariable", "InvokeAzureAgent").	Yes
parent_action_id	ciąg	Identyfikator akcji nadrzędnej, jeśli jest to akcja zagnieżdżona.	Nie.
previous_action_id	ciąg	Identyfikator poprzedniej akcji, jeśli ta akcja jest zgodna z inną akcją.	Nie.
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
stan	wyliczenie	Stan akcji (np. "in_progress", "completed", "failed", "cancelled". Możliwe wartości: `completed`, , `failed`, `in_progresscancelled`	Yes
typ	wyliczenie	Możliwe wartości: `workflow_action`	Yes

WorkflowAgentDefinition

Definicja agenta przepływu pracy.

Name	Typ	Description	Obowiązkowy
rodzaj	wyliczenie	Możliwe wartości: `workflow`	Yes
rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
└rai_policy_name	ciąg	Nazwa zasad RAI do zastosowania.	Yes
przepływ pracy	ciąg	Definicja YAML CSDL przepływu pracy.	Nie.

liczba całkowita

Typ: liczba całkowita

Format: int64

Last updated on 2026-06-12