Dokumentacja REST projektu Microsoft Foundry

Wersja interfejsu API: 2025-11-15-preview

Agenci — tworzenie agenta

POST {endpoint}/agents?api-version=2025-11-15-preview

Tworzy agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
definicja	obiekt		Tak
Rodzaj └*	AgentKind		Nie.
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — lista agentów

GET {endpoint}/agents?api-version=2025-11-15-preview

Zwraca listę wszystkich agentów.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
rodzaj	kwerenda	Nie.		Filtruj agentów według rodzaju. Jeśli nie zostanie podany, zostaną zwrócone wszystkie agenty.
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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — uzyskiwanie agenta

GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Pobiera agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — aktualizowanie agenta

POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

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	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
definicja	obiekt		Tak
Rodzaj └*	AgentKind		Nie.
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Typ	Opis
aplikacja/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — usuwanie agenta

DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview

Usuwa agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DeleteAgentResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — aktualizowanie agenta z manifestu

POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview

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	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta do zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — wyświetlanie listy operacji kontenera agenta

GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview

Wyświetlanie listy operacji kontenera dla agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — pobieranie operacji kontenera agenta

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview

Uzyskaj stan operacji kontenera dla agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
operation_id	ścieżka	Tak	ciąg	Identyfikator operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentContainerOperationObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse lub ApiErrorResponse

Agenci — tworzenie wersji agenta

POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

Utwórz nową wersję agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
definicja	obiekt		Tak
Rodzaj └*	AgentKind		Nie.
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Typ	Opis
aplikacja/json	AgentVersionObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — wyświetlanie listy wersji agentów

GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview

Zwraca listę wersji agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — uzyskiwanie wersji agenta

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

Pobiera określoną wersję agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta do pobrania.
agent_version	ścieżka	Tak	ciąg	Wersja agenta do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentVersionObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — usuwanie wersji agenta

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview

Usuwa określoną wersję agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta do usunięcia.
agent_version	ścieżka	Tak	ciąg	Wersja agenta do usunięcia

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DeleteAgentVersionResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — pobieranie kontenera agenta

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview

Pobierz kontener dla określonej wersji agenta.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
agent_version	ścieżka	Tak	ciąg	Wersja agenta.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentContainerObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — wyświetlanie listy operacji kontenera wersji agenta

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
agent_version	ścieżka	Tak	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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — usuwanie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
agent_version	ścieżka	Tak	ciąg	Wersja agenta.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 202

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentContainerOperationObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — uruchamianie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
agent_version	ścieżka	Tak	ciąg	Wersja agenta.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
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	Typ	Opis
aplikacja/json	AgentContainerOperationObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — zatrzymywanie kontenera agentów

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
agent_version	ścieżka	Tak	ciąg	Wersja agenta.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 202

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentContainerOperationObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse lub ApiErrorResponse

Agenci — aktualizowanie kontenera agenta

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	ciąg	Nazwa agenta.
agent_version	ścieżka	Tak	ciąg	Wersja agenta.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
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	Typ	Opis
aplikacja/json	AgentContainerOperationObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — tworzenie wersji agenta na podstawie manifestu

POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
agent_name	ścieżka	Tak	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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentVersionObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Agenci — tworzenie agenta na podstawie manifestu

POST {endpoint}/agents:import?api-version=2025-11-15-preview

Tworzy agenta na podstawie manifestu.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AgentObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Połączenia — lista

GET {endpoint}/connections?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ połączenia	kwerenda	Nie.		Wyświetlanie listy połączeń tego konkretnego typu
defaultConnection	kwerenda	Nie.	typ logiczny (boolowski)	Wyświetlanie listy połączeń, które są połączeniami domyślnymi
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedConnection

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Połączenia — pobierz

GET {endpoint}/connections/{name}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Przyjazna nazwa połączenia podana przez użytkownika.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Połączenie

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

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

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview

Pobieranie połączenia według nazwy z jego poświadczeniami połączenia

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Przyjazna nazwa połączenia podana przez użytkownika.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Połączenie

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — lista najnowszych

GET {endpoint}/datasets?api-version=2025-11-15-preview

Wyświetlanie listy najnowszych wersji każdego elementu DatasetVersion

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedDatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — wersje listy

GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview

Wyświetlanie listy wszystkich wersji danego elementu DatasetVersion

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedDatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — pobieranie wersji

GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Określony identyfikator wersji elementu DatasetVersion do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — usuwanie wersji

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Wersja elementu DatasetVersion do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 204

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — tworzenie lub aktualizowanie wersji

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview

Utwórz nowy lub zaktualizuj istniejący element DatasetVersion przy użyciu podanego identyfikatora wersji

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Konkretny identyfikator wersji elementu DatasetVersion do utworzenia lub zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

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

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

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DatasetVersion

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	DatasetVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — uzyskiwanie poświadczeń

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Konkretny identyfikator wersji elementu DatasetVersion, na którym ma być wykonywana operacja.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	AssetCredentialResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Zestawy danych — rozpoczynanie oczekiwania na przekazanie wersji

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview

Rozpocznij nowy lub pobierz istniejące oczekujące przekazanie zestawu danych dla określonej wersji.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Konkretny identyfikator wersji elementu DatasetVersion, na którym ma być wykonywana operacja.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
connectionName (nazwa_połączenia)	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	BlobReference jest jedynym obsługiwanym typem. Możliwe wartości: BlobReference	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PendingUploadResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Wdrożenia — lista

GET {endpoint}/deployments?api-version=2025-11-15-preview

Wyświetlanie listy wszystkich wdrożonych modeli w projekcie

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
modelPublisher	kwerenda	Nie.	ciąg	Wydawca modeli, według którego można filtrować modele
modelName	kwerenda	Nie.	ciąg	Nazwa modelu (nazwa specyficzna dla wydawcy), według której można filtrować modele
deploymentType	kwerenda	Nie.		Typ wdrożenia do filtrowania listy według
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedDeployment

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Wdrożenia — pobieranie

GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview

Pobierz wdrożony model.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa wdrożenia
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Wdrożenie

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Reguły oceny — lista

GET {endpoint}/evaluationrules?api-version=2025-11-15-preview

Wyświetl listę wszystkich reguł oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
actionType	kwerenda	Nie.		Filtruj według typu reguły oceny.
agentName	kwerenda	Nie.	ciąg	Filtruj według nazwy agenta.
włączony	kwerenda	Nie.	typ logiczny (boolowski)	Filtruj według stanu włączenia.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedEvaluationRule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Reguły oceny — pobieranie

GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Pobierz regułę oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Niepowtarzalny identyfikator reguły oceny.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationRule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Reguły oceny — usuwanie

DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Usuwanie reguły oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Niepowtarzalny identyfikator reguły oceny.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 204

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Reguły oceny — tworzenie lub aktualizowanie

PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview

Tworzenie lub aktualizowanie reguły oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Niepowtarzalny identyfikator reguły oceny.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
akcja	obiekt	Model działania ewaluacyjnego.	Tak
└typ	EvaluationRuleActionType	Rodzaj działania w ramach oceny.	Nie.
opis	ciąg	Opis reguły oceny.	Nie.
displayName	ciąg	Nazwa wyświetlana reguły oceny.	Nie.
włączony	typ logiczny (boolowski)	Wskazuje, czy reguła oceny jest włączona. Wartość domyślna to true.	Tak
eventType	obiekt	Typ zdarzenia reguły oceny.	Tak
filtr	obiekt	Model filtru oceny.	Nie.
└} agentName	ciąg	Filtruj według nazwy agenta.	Nie.
identyfikator	ciąg	Niepowtarzalny identyfikator reguły oceny.	Tak
daneSystemowe	obiekt	Metadane systemowe dla reguły oceny.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationRule

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationRule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Taksonomie oceny — lista

GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview

Lista taksonomii oceny

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
inputName	kwerenda	Nie.	ciąg	Filtruj według nazwy danych wejściowych oceny.
inputType	kwerenda	Nie.	ciąg	Filtrowanie według typu danych wejściowych taksonomii.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedEvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Taksonomie oceny — pobierz

GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Pobierz ocenę uruchomioną według nazwy.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Taksonomie oceny — usuwanie

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Usuń taksonomię oceny według nazwy.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 204

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Taksonomie oceny — tworzenie

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Utwórz taksonomię oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa taksonomii oceny.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
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	macierz	Lista kategorii taksonomii.	Nie.
taksonomiaInput	obiekt	Konfiguracja danych wejściowych dla taksonomii oceny.	Tak
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationTaxonomy

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Taksonomie oceny — aktualizacja

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview

Aktualizowanie taksonomii oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa taksonomii oceny.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
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	macierz	Lista kategorii taksonomii.	Nie.
taksonomiaInput	obiekt	Konfiguracja danych wejściowych dla taksonomii oceny.	Nie.
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluationTaxonomy

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Ewaluatory — lista najnowszych wersji

GET {endpoint}/evaluators?api-version=2025-11-15-preview

Lista najnowszych wersji każdego ewaluatora

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ	kwerenda	Nie.		Filtruj oceniających 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	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedEvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Ewaluatory — wersje listy

GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

Lista wszystkich wersji danego ewaluatora

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
typ	kwerenda	Nie.		Filtruj oceniających 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	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedEvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Ewaluatory — tworzenie wersji

POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
categories	macierz	Kategorie osoby oceniającej	Tak
definicja	obiekt	Podstawowa konfiguracja ewaluatora z dyskryminatorem	Tak
└data_schema		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		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	Nie.
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Pomaga łatwo znaleźć ewaluatora w Foundry. Nie musi być unikalny.	Nie.
evaluator_type	obiekt	Rodzaj osoby oceniającej	Tak
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	Typ	Opis
aplikacja/json	EvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Ewaluatory — pobieranie wersji

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Określony identyfikator wersji ewaluatorVersion do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Ewaluatory — usuwanie wersji

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Wersja ewaluatorVersion do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 204

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Ewaluatorzy — wersja aktualizacji

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Wersja ewaluatorVersion do aktualizacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
categories	macierz	Kategorie osoby oceniającej	Nie.
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Pomaga łatwo znaleźć ewaluatora w 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	Typ	Opis
aplikacja/json	EvaluatorVersion

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Indeksy — najnowsza lista

GET {endpoint}/indexes?api-version=2025-11-15-preview

Wyświetlanie listy najnowszych wersji każdego indeksu

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedIndex

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Indeksy — wersje listy

GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview

Wyświetla listę wszystkich wersji danego indeksu

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedIndex

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Indeksy — pobieranie wersji

GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Konkretny identyfikator wersji indeksu do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Indeks

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Indeksy — usuwanie wersji

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Wersja indeksu do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 204

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Indeksy — tworzenie lub aktualizowanie wersji

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview

Utwórz nowy lub zaktualizuj istniejący indeks o podanym identyfikatorze wersji

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa zasobu
wersja	ścieżka	Tak	ciąg	Konkretny identyfikator wersji indeksu do utworzenia lub zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

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

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	obiekt		Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Indeks

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	Indeks

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Szczegółowe informacje — generowanie

POST {endpoint}/insights?api-version=2025-11-15-preview

Generowanie szczegółowych informacji

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
Powtarzalność —Request-ID	nagłówek	Nie.	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	nagłówek	Nie.	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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
displayName	ciąg	Przyjazna dla użytkownika nazwa wyświetlana dla szczegółowych informacji.	Tak
identyfikator	ciąg	Unikatowy identyfikator raportu ze statystykami.	Tak
metadane	obiekt	Metadane dotyczące szczegółowych informacji.	Tak
└* completedAt	ciąg	Sygnatura czasowa, kiedy szczegółowe informacje zostały ukończone.	Nie.
└} createdAt	ciąg	Sygnatura czasowa utworzenia szczegółowych informacji.	Nie.
żądanie	obiekt	Żądanie raportu szczegółowych informacji.	Tak
└typ	InsightType	Typ żądania.	Nie.
wynik	obiekt	Wynik spostrzeżeń.	Nie.
└typ	InsightType	Typ wyniku szczegółowych informacji.	Nie.
stan	obiekt	Wyliczenie opisujące dozwolone stany operacji.	Tak

Responses

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	Wgląd

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Szczegółowe informacje — lista

GET {endpoint}/insights?api-version=2025-11-15-preview

Wyświetl listę wszystkich szczegółowych informacji w odwrotnej kolejności chronologicznej (od najnowszych).

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
typ	kwerenda	Nie.		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.	typ logiczny (boolowski)	Określa, czy w odpowiedzi mają być uwzględniane współrzędne wizualizacji. Wartość domyślna to fałsz.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedInsight

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Szczegółowe informacje — uzyskiwanie

GET {endpoint}/insights/{id}?api-version=2025-11-15-preview

Uzyskaj szczegółowe informacje na podstawie identyfikatora.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Unikatowy identyfikator raportu ze statystykami.
includeCoordinates	kwerenda	Nie.	typ logiczny (boolowski)	Określa, czy w odpowiedzi mają być uwzględniane współrzędne wizualizacji. Wartość domyślna to fałsz.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Wgląd

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Tworzenie magazynu pamięci

POST {endpoint}/memory_stores?api-version=2025-11-15-preview

Utwórz magazyn pamięci.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
definicja	obiekt	Podstawowa definicja konfiguracji magazynu pamięci.	Tak
Rodzaj └*	MemoryStoreKind	Rodzaj magazynu pamięci.	Nie.
opis	ciąg	Czytelny dla człowieka opis magazynu pamięci.	Nie.
metadane	obiekt	Dowolne metadane klucz-wartość do skojarzenia z magazynem pamięci.	Nie.
nazwa	ciąg	Nazwa magazynu pamięci.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	MemoryStoreObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Lista magazynów pamięci

GET {endpoint}/memory_stores?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Aktualizowanie magazynu pamięci

POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Aktualizowanie magazynu pamięci.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci do zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis magazynu pamięci.	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	Typ	Opis
aplikacja/json	MemoryStoreObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Pobieranie magazynu pamięci

GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Pobieranie magazynu pamięci.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	MemoryStoreObject

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Usuwanie magazynu pamięci

DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview

Usuń magazyn pamięci.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DeleteMemoryStoreResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Pobieranie wyniku aktualizacji

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview

Pobierz wynik aktualizacji magazynu pamięci.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci.
update_id	ścieżka	Tak	ciąg	Identyfikator operacji aktualizacji pamięci.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	MemoryStoreUpdateResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Usuwanie wspomnień zakresu

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje pamięci do usunięcia, na przykład identyfikator użytkownika.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	MemoryStoreDeleteScopeResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyszukiwanie wspomnień

POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci do wyszukania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
items	macierz	Przedmioty, dla których należy wyszukać odpowiednie wspomnienia.	Nie.
options	obiekt	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 w pamięci od miejsca, w którym zakończono ostatnią operację.	Nie.
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	MemoryStoreSearchResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Aktualizowanie pamięci

POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Nazwa magazynu pamięci do zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
items	macierz	Elementy konwersacji, z których można wyodrębnić wspomnienia.	Nie.
previous_update_id	ciąg	Unikatowy identyfikator poprzedniego żądania aktualizacji, umożliwiający przyrostowe aktualizacje pamięci od miejsca, w którym została przerwana ostatnia operacja.	Nie.
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Tak
update_delay	liczba całkowita	Limit czasu przed przetworzeniem aktualizacji pamięci w sekundach. Jeśli w tym okresie zostanie odebrane nowe żądanie aktualizacji, zostanie anulowane bieżące żądanie i zresetowany 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	Typ	Opis
aplikacja/json	MemoryStoreUpdateResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Tworzenie konwersacji

POST {endpoint}/openai/conversations?api-version=2025-11-15-preview

Utwórz konwersację.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
items	macierz	Początkowe elementy do uwzględnienia kontekstu konwersacji. Jednocześnie możesz dodać maksymalnie 20 elementów.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Typ	Opis
aplikacja/json	OpenAI.ConversationResource

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy konwersacji

GET {endpoint}/openai/conversations?api-version=2025-11-15-preview

Zwraca listę wszystkich konwersacji.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Aktualizowanie konwersacji

POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Aktualizowanie konwersacji.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	ciąg	Identyfikator konwersacji do zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Typ	Opis
aplikacja/json	OpenAI.ConversationResource

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Uzyskiwanie konwersacji

GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Pobiera konwersację.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	ciąg	Identyfikator konwersacji do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ConversationResource

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Usuwanie konwersacji

DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview

Usuwa konwersację.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	ciąg	Identyfikator konwersacji do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.DeletedConversationResource

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Tworzenie elementów konwersacji

POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

Utwórz elementy w konwersacji z danym identyfikatorem.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	ciąg	Identyfikator konwersacji, na której należy utworzyć element.
include	kwerenda	Nie.	macierz	Dodatkowe pola do uwzględnienia w odpowiedzi. include Aby uzyskać więcej informacji, zobacz parametr zawierający listę elementów konwersacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
items	macierz	Elementy do dodania do konwersacji. Jednocześnie możesz dodać maksymalnie 20 elementów.	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ConversationItemList

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy elementów konwersacji

GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.		Filtruj według typu elementu. Jeśli zostanie podana, zostaną zwrócone tylko elementy określonego typu.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Pobieranie elementu konwersacji

GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

Pobierz pojedynczy element z konwersacji z podanymi identyfikatorami.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	ciąg	Identyfikator konwersacji zawierającej element.
item_id	ścieżka	Tak	ciąg	Identyfikator elementu konwersacji do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ItemResource

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Usuwanie elementu konwersacji

DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview

Usuń element z konwersacji z podanymi identyfikatorami.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
conversation_id	ścieżka	Tak	ciąg	Identyfikator konwersacji, z której należy usunąć element.
item_id	ścieżka	Tak	ciąg	Identyfikator elementu konwersacji do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ConversationResource

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — evals list

GET {endpoint}/openai/evals?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
after	kwerenda	Nie.	ciąg	Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.		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.
sortuj_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 czas utworzenia lub updated_at czas ostatniej aktualizacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — tworzenie eval

POST {endpoint}/openai/evals?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
konfiguracja źródła danych	obiekt	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	Tak
└ dołącz_przykładowy_schemat	typ logiczny (boolowski)	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.	Nie.
Metadane └*	obiekt	Filtry metadanych dla przechowywanego źródła danych uzupełniania.	Nie.
Scenariusz └*	wyliczenie	Scenariusz schematu danych. Możliwe wartości: red_team, , responsestraces	Nie.
└typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: azure_ai_source	Nie.
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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	macierz	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}}).	Tak

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Eval

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — usuwanie eval

DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Usuń ocenę Usuń ocenę.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DeleteEvalResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — uzyskiwanie oceny

GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

Uzyskaj ocenę Pobierz ocenę według identyfikatora.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny do odzyskania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Eval

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — eval aktualizacji

POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny do zaktualizowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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	Typ	Opis
aplikacja/json	Eval

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — uruchomienia listy

GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny, dla której mają zostać pobrane przebiegi.
after	kwerenda	Nie.	ciąg	Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.		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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — tworzenie przebiegu oceny

POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview

Tworzenie przebiegu oceny

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny potrzebny do utworzenia przebiegu.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
źródło danych	obiekt	Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji.	Tak
└input_messages	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.
└item_generation_params	RedTeamItemGenerationParams	Parametry generowania elementów.	Nie.
Model └*	ciąg	Nazwa modelu do użycia do generowania uzupełniania (np. "o3-mini").	Nie.
└parametry_próbkowania	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Nie.
└— ź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.	Nie.
└* docelowy	Obiekt docelowy	Konfiguracja docelowa oceny.	Nie.
└typ	ciąg	Dyskryminujący typ źródła danych.	Nie.
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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	Typ	Opis
aplikacja/json	EvalRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — usuwanie przebiegu oceny

DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

Usuń przebieg oceny Usuń przebieg oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny, z której ma zostać usunięty przebieg.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DeleteEvalRunResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — uzyskiwanie przebiegu oceny

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny, dla której mają zostać pobrane przebiegi.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvalRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — anulowanie przebiegu oceny

POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview

Anuluj przebieg oceny Anuluj trwający przebieg oceny.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator ewaluacji, której wykonanie chcesz anulować.
run_id	ścieżka	Tak	ciąg	Identyfikator uruchomienia do anulowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvalRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — uzyskiwanie elementów wyjściowych przebiegu oceny

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu w celu pobrania elementów wyjściowych.
after	kwerenda	Nie.	ciąg	Identyfikator ostatniego uruchomienia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.		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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Evals OpenAI — uzyskiwanie elementu wyjściowego przebiegu oceny

GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
eval_id	ścieżka	Tak	ciąg	Identyfikator oceny, dla której mają zostać pobrane przebiegi.
run_id	ścieżka	Tak	ciąg	Identyfikator przebiegu do pobrania.
output_item_id	ścieżka	Tak	ciąg	Identyfikator elementu wyjściowego do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	EvalRunOutputItem

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Tworzenie zadania dostrajania

POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

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 i nazwę dostosowanych modeli po zakończeniu.

Dowiedz się więcej o dostrajaniu

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
hiperparametry	obiekt	Hiperparametry używane do zadania dostrajania. Ta wartość jest teraz przestarzała na rzecz parametru methodi powinna zostać przekazana w parametrze method .	Nie.
└batch_size	wyliczenie	Możliwe wartości: auto	Nie.
└learning_rate_multiplier	wyliczenie	Możliwe wartości: auto	Nie.
└n_epochs	wyliczenie	Możliwe wartości: auto	Nie.
Integracje	macierz	Lista integracji umożliwiających dostrajanie zadania.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
seed	liczba całkowita	Nasiono kontroluje reproduktywność procesu. Przekazywanie tych samych parametrów nasion i zadania powinno generować te same wyniki, ale mogą się różnić w rzadkich przypadkach. Jeśli ziarno nie zostanie określone, zostanie wygenerowane dla Ciebie.	Nie.
przyrostek	ciąg	Ciąg zawierający maksymalnie 64 znaki, które zostaną dodane do precyzyjnej nazwy modelu. Na przykład wartość suffix "custom-model-name" spowoduje wygenerowanie nazwy modelu, takiej jak ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Nie.	Żaden
plik szkoleniowy	ciąg	Identyfikator przekazanego pliku zawierającego dane szkoleniowe. Zestaw danych musi być sformatowany jako plik JSONL. Ponadto należy przekazać 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 .	Tak
plik walidacji	ciąg	Identyfikator przekazanego pliku zawierającego dane walidacji. Jeśli podasz ten plik, dane są używane do generowania walidacji metryki okresowo podczas dostrajania. Te metryki można wyświetlić w programie plik wyników dostrajania. Te same dane nie powinny być obecne zarówno w plikach trenowania, jak i sprawdzania poprawności. 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	Typ	Opis
aplikacja/json	OpenAI.FineTuningJob

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy zadań dostrajania podzielonego na strony

GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview

Wyświetlanie listy zadań dostrajania organizacji

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
after	kwerenda	Nie.	ciąg	Identyfikator ostatniego zadania z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba zadań dostrajania do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ListPaginatedFineTuningJobsResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Pobieranie zadania dostrajania

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview

Uzyskaj informacje o zadaniu dostrajania.

Dowiedz się więcej o dostrajaniu

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator_zadania_dostrajania	ścieżka	Tak	ciąg	Identyfikator zadania dostrajania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.FineTuningJob

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Anulowanie zadania dostrajania

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview

Natychmiast anuluj zadanie dostrajania.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator_zadania_dostrajania	ścieżka	Tak	ciąg	Identyfikator zadania dostrajania do anulowania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.FineTuningJob

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy punktów kontrolnych zadań dostrajania

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator_zadania_dostrajania	ścieżka	Tak	ciąg	Identyfikator zadania dostrajania w celu pobrania punktów kontrolnych.
after	kwerenda	Nie.	ciąg	Identyfikator ostatniego identyfikatora punktu kontrolnego z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba punktów kontrolnych do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ListFineTuningJobCheckpointsResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy zdarzeń zadania dostrajania

GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview

Uzyskaj szczegółowe aktualizacje stanu dla zadania dostrajania.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator_zadania_dostrajania	ścieżka	Tak	ciąg	Identyfikator zadania dostrajania w celu pobrania zdarzeń.
after	kwerenda	Nie.	ciąg	Identyfikator ostatniego zdarzenia z poprzedniego żądania stronicowania.
limit	kwerenda	Nie.	liczba całkowita	Liczba zdarzeń do pobrania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.ListFineTuningJobEventsResponse

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wstrzymaj zadanie dostrajania

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview

Wstrzymaj uruchomione zadanie dostrajania.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator_zadania_dostrajania	ścieżka	Tak	ciąg	Identyfikator zadania dostrajania do wstrzymania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.FineTuningJob

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wznawianie zadania dostrajania

POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview

Wznów wstrzymane zadanie dostrajania.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator_zadania_dostrajania	ścieżka	Tak	ciąg	Identyfikator zadania dostrajania do wznowienia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.FineTuningJob

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Tworzenie odpowiedzi — tworzenie strumienia odpowiedzi

POST {endpoint}/openai/responses?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Nie.	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
agent	AgentReference	Agent do użycia do generowania odpowiedzi.	Nie.
tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
konwersacja	ciąg lub obiekt		Nie.
include	macierz	Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to: - code_interpreter_call.outputs: zawiera dane wyjściowe wykonywania kodu w języku Python w elementy wywołania narzędzia interpretera kodu. - computer_call_output.output.image_url: dołącz adresy URL obrazów z wyników procesu komputerowego. - file_search_call.results: uwzględnij wyniki wyszukiwania wywołanie narzędzia wyszukiwania plików. - message.input_image.image_url: dołącz adresy URL obrazów z komunikatu wejściowego. - message.output_text.logprobs: dołączanie logprobs z komunikatami asystenta. - reasoning.encrypted_content: zawiera zaszyfrowaną wersję rozumowania tokeny w danych wyjściowych elementu rozumowania. Dzięki temu elementy rozumowania mogą być używane w programie konwersacje wieloetapowe przy bezstanowym korzystaniu z interfejsu API Odpowiedzi (na przykład gdy store parametr jest ustawiony na false lub gdy organizacja jest zapisane w programie nieprzechowywania żadnych danych).	Nie.
dane wejściowe	ciąg lub tablica	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 - Zarządzanie stanem konwersacji - Wywoływanie funkcji	Nie.
instructions	ciąg	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
monit	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
reasoning	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
poziom usługi	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
przechowywać	typ logiczny (boolowski)	Czy zapisać wygenerowaną odpowiedź modelu do późniejszego pobrania? API.	Nie.	Prawda
odtwarzać strumieniowo	typ logiczny (boolowski)	W przypadku ustawienia wartości true dane odpowiedzi modelu będą przesyłane strumieniowo do klienta generowane przy użyciu zdarzeń wysyłanych przez serwer. aby uzyskać więcej informacji.	Nie.	Nieprawda
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	Liczba	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	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
tool_choice	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie plików. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu.	Nie.
top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
top_p	Liczba	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
truncation	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. Możliwe wartości: auto, disabled	Nie.
użytkownik	ciąg	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.Response
text/event-stream	OpenAI.ResponseStreamEvent

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy odpowiedzi

GET {endpoint}/openai/responses?api-version=2025-11-15-preview

Zwraca listę wszystkich odpowiedzi.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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ą.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Uzyskiwanie odpowiedzi — pobieranie strumienia odpowiedzi

GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Nie.	ciąg	Wersja interfejsu API do użycia dla tej operacji.
response_id	ścieżka	Tak	ciąg
include[]	kwerenda	Nie.	macierz
odtwarzać strumieniowo	kwerenda	Nie.	typ logiczny (boolowski)
starting_after	kwerenda	Nie.	liczba całkowita
akceptuj	nagłówek	Nie.	ciąg Możliwe wartości: text/event-stream

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.Response
text/event-stream	OpenAI.ResponseStreamEvent

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Usuń odpowiedź

DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview

Usuwa odpowiedź modelu.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
response_id	ścieżka	Tak	ciąg	Identyfikator odpowiedzi do usunięcia.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	DeleteResponseResult

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Anuluj odpowiedź

POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview

Anuluje odpowiedź modelu.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
response_id	ścieżka	Tak	ciąg	Identyfikator odpowiedzi na anulowanie.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	OpenAI.Response

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Wyświetlanie listy elementów wejściowych

GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview

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

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
response_id	ścieżka	Tak	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 idesc dla kolejności malejącej.
after	kwerenda	Nie.	ciąg	Kursor do użycia 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 użycia 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.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Typ	Opis
aplikacja/json	ApiErrorResponse

Redteams - lista

GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview

Wymień czerwoną drużynę według nazwy.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedRedTeam

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Redteams – zdobądź

GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview

Zdobądź redteam według nazwy.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
nazwa	ścieżka	Tak	ciąg	Identyfikator biegu drużyny czerwonej.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	RedTeam

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Redteams — tworzenie

POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview

Tworzy przebieg redteam.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
applicationScenario	ciąg	Scenariusz aplikacji dla operacji red team, w celu wygenerowania ataków specyficznych dla scenariusza.	Nie.
attackStrategies	macierz	Lista strategii ataku lub zagnieżdżone listy strategii ataku.	Nie.
displayName	ciąg	Nazwa biegu czerwonej drużyny.	Nie.
identyfikator	ciąg	Identyfikator biegu drużyny czerwonej.	Tak
liczbawywracania	liczba całkowita	Liczba rund symulacji.	Nie.
properties	obiekt	Właściwości czerwonej drużyny. 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	macierz	Lista kategorii ryzyka, dla których mają być generowane cele ataku.	Nie.
symulacjaOnly	typ logiczny (boolowski)	Tylko symulacja lub Symulacja + ocena. Wartość domyślna false, jeśli true skanowanie generuje wynik konwersacji, a nie wynik oceny.	Nie.	Nieprawda
stan	ciąg	Status czerwonej drużyny. Jest on ustawiany przez usługę i jest tylko do odczytu.	Nie.
tags	obiekt	Tagi czerwonej drużyny. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
miejsce docelowe	obiekt	Klasa abstrakcyjna dla konfiguracji docelowej.	Tak
└typ	ciąg	Typ konfiguracji modelu.	Nie.

Responses

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	RedTeam

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Harmonogramy — lista

GET {endpoint}/schedules?api-version=2025-11-15-preview

Wyświetl listę wszystkich harmonogramów.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedSchedule

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Harmonogramy — usuwanie

DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Usuń harmonogram.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Identyfikator harmonogramu.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 204

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

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Harmonogramy — pobierz

GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Uzyskaj harmonogram według identyfikatora.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Identyfikator harmonogramu.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Harmonogram

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Harmonogramy — tworzenie lub aktualizowanie

PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview

Tworzenie lub aktualizowanie harmonogramu według identyfikatora.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Identyfikator harmonogramu.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Treść żądania

Typ zawartości: aplikacja/json

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis harmonogramu.	Nie.
displayName	ciąg	Nazwa harmonogramu.	Nie.
włączony	typ logiczny (boolowski)	Włączony stan harmonogramu.	Tak
identyfikator	ciąg	Identyfikator harmonogramu.	Tak
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)	obiekt	Zaplanuj stan apryfikacji.	Nie.
daneSystemowe	obiekt	Metadane systemowe zasobu.	Tak
tags	obiekt	Tagi harmonogramu. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
zadanie	obiekt	Zaplanuj model zadań.	Tak
Konfiguracja └*	obiekt	Konfiguracja dla zadania.	Nie.
└typ	ScheduleTaskType	Typ zadania.	Nie.
wyzwalacz	obiekt	Model podstawowy dla wyzwalacza harmonogramu.	Tak
└typ	Typ wyzwalacza	Typ wyzwalacza.	Nie.

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	Harmonogram

Kod stanu: 201

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

Typ zawartości	Typ	Opis
aplikacja/json	Harmonogram

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Harmonogramy — uruchomienia listy

GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview

Wyświetl listę wszystkich przebiegów harmonogramu.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator	ścieżka	Tak	ciąg	Identyfikator harmonogramu.
x-ms-client-request-id	nagłówek	Nie.		Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	PagedScheduleRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Harmonogramy — pobieranie przebiegu

GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview

Pobierz harmonogram uruchamiany przez identyfikator.

Parametry identyfikatora URI

Name	In	Wymagane	Typ	Opis
punkt końcowy	ścieżka	Tak	ciąg Adres URL	Punkt końcowy programu Foundry Project w postaci https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Jeśli masz tylko jeden projekt w usłudze Foundry Hub lub w celu kierowania domyślnego projektu w centrum, użyj formularza https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
wersja API	kwerenda	Tak	ciąg	Wersja interfejsu API do użycia dla tej operacji.
identyfikator harmonogramu	ścieżka	Tak	ciąg	Identyfikator harmonogramu.
identyfikator uruchomienia	ścieżka	Tak	ciąg	Identyfikator przebiegu harmonogramu.

Nagłówek żądania

Name	Wymagane	Typ	Opis
Autoryzacja	Prawda	ciąg	Przykład:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Aby wygenerować token uwierzytelniania przy użyciu interfejsu wiersza polecenia platformy Azure: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize zakres: https://ai.azure.com/.default

Responses

Kod stanu: 200

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

Typ zawartości	Typ	Opis
aplikacja/json	ScheduleRun

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

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

Components

A2ATool

Agent implementujący protokół A2A.

Name	Typ	Opis	Wymagane	Default
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 projekcie 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. Możliwe wartości: a2a_preview	Tak

AISearchIndexResource

Zasób AI Search Index.

Name	Typ	Opis	Wymagane	Default
filtr	ciąg	Filtruj ciąg 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 elemencie IndexResource dołączonym do tego agenta.	Nie.
typ_zapytania	obiekt	Dostępne typy zapytań dla narzędzia Azure AI Search.	Nie.
top_k	liczba całkowita	Liczba dokumentów do pobrania z wyszukiwania i prezentowania do modelu.	Nie.

AgentClusterInsightResult

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

Name	Typ	Opis	Wymagane	Default
clusterInsight	ClusterInsightResult	Wnioski z analizy skupień.	Tak
typ	wyliczenie	Typ wyniku szczegółowych informacji. Możliwe wartości: AgentClusterInsight	Tak

AgentClusterInsightsRequest

Wgląd w zestaw wyników oceny agenta

Name	Typ	Opis	Wymagane	Default
agentName	ciąg	Identyfikator agenta.	Tak
modelKonfiguracja	obiekt	Konfiguracja modelu używanego w generowaniu wniosków.	Nie.
└* modelDeploymentName	ciąg	Wdrożenie modelu, które ma zostać ocenione. Akceptuje nazwę wdrożenia samodzielnie lub z nazwą połączenia jako {connectionName}/<modelDeploymentName>.	Nie.
typ	wyliczenie	Typ żądania. Możliwe wartości: AgentClusterInsight	Tak

AgentContainerObject

Szczegóły kontenera określonej wersji agenta.

Name	Typ	Opis	Wymagane	Default
utworzono_o	ciąg	Czas tworzenia kontenera.	Tak
error_message	ciąg	Komunikat o błędzie, jeśli kontener nie może działać, jeśli istnieje.	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	Tak
stan	obiekt	Stan kontenera określonej wersji agenta.	Tak
updated_at	ciąg	Czas ostatniej aktualizacji kontenera.	Tak

AgentContainerOperationError

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

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Kod błędu operacji kontenera, jeśli istnieje.	Tak
komunikat	ciąg	Komunikat o błędzie operacji kontenera, jeśli istnieje.	Tak
typ	ciąg	Typ błędu operacji kontenera, jeśli istnieje.	Tak

AgentContainerOperationObject

Operacja kontenera dla określonej wersji agenta.

Name	Typ	Opis	Wymagane	Default
agent_id	ciąg	Identyfikator agenta.	Tak
agent_version_id	ciąg	Identyfikator wersji agenta.	Tak
kontener	obiekt	Szczegóły kontenera określonej wersji agenta.	Nie.
└─ utworzono_o	ciąg	Czas tworzenia kontenera.	Nie.
└error_message	ciąg	Komunikat o błędzie, jeśli kontener nie może działać, jeśli istnieje.	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	Nie.
Stan └*	AgentContainerStatus	Stan kontenera określonej wersji agenta.	Nie.
└updated_at	ciąg	Czas ostatniej aktualizacji kontenera.	Nie.
błąd	obiekt	Szczegóły błędu operacji kontenera, jeśli istnieją.	Nie.
└─ kod	ciąg	Kod błędu operacji kontenera, jeśli istnieje.	Nie.
└─ Komunikat	ciąg	Komunikat o błędzie operacji kontenera, jeśli istnieje.	Nie.
└typ	ciąg	Typ błędu operacji kontenera, jeśli istnieje.	Nie.
identyfikator	ciąg	Identyfikator operacji kontenera. Ten identyfikator jest unikatowym identyfikatorem w systemie.	Tak
stan	obiekt	Stan operacji kontenera dla określonej wersji agenta.	Tak

AgentContainerOperationStatus

Stan operacji kontenera dla określonej wersji agenta.

Majątek	Wartość
Opis	Stan operacji kontenera dla określonej wersji agenta.
Typ	ciąg
Wartości	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Stan kontenera określonej wersji agenta.

Majątek	Wartość
Opis	Stan kontenera określonej wersji agenta.
Typ	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:

Wartość typu	Schema
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition
prompt	PromptAgentDefinition

Name	Typ	Opis	Wymagane	Default
rodzaj	AgentKind		Tak
rai_config	obiekt	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
└rai_policy_name	ciąg	Nazwa zasady RAI, która ma zostać zastosowana.	Nie.

Identyfikator agenta

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Nazwa agenta.	Tak
typ	wyliczenie	Możliwe wartości: agent_id	Tak
wersja	ciąg	Identyfikator wersji agenta.	Tak

AgentKind

Majątek	Wartość
Typ	ciąg
Wartości	prompt hosted container_app workflow

AgentObject

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Niepowtarzalny identyfikator agenta.	Tak
nazwa	ciąg	Nazwa agenta.	Tak
obiekt	wyliczenie	Typ obiektu, którym zawsze jest "agent". Możliwe wartości: agent	Tak
versions	obiekt	Najnowsza wersja agenta.	Tak
└* najnowsze	AgentVersionObject		Nie.

AgentProtocol

Majątek	Wartość
Typ	ciąg
Wartości	activity_protocol responses

Odniesienie do agenta

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Nazwa agenta.	Tak
typ	wyliczenie	Możliwe wartości: agent_reference	Tak
wersja	ciąg	Identyfikator wersji agenta.	Nie.

AgentTaxonomyInput

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

Name	Typ	Opis	Wymagane	Default
riskCategories	macierz	Lista kategorii ryzyka, w odniesieniu do których należy dokonać oceny.	Tak
miejsce docelowe	obiekt	Reprezentuje element docelowy określający agenta sztucznej inteligencji platformy Azure.	Tak
└─ nazwa	ciąg	Unikatowy identyfikator agenta sztucznej inteligencji platformy Azure.	Nie.
└tool_descriptions	macierz	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	Nie.
└* wersja	ciąg	Wersja agenta sztucznej inteligencji platformy Azure.	Nie.
typ	wyliczenie	Typ danych wejściowych taksonomii oceny. Możliwe wartości: agent	Tak

AgentTaxonomyInputUpdate

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

Name	Typ	Opis	Wymagane	Default
riskCategories	macierz	Lista kategorii ryzyka, w odniesieniu do których należy dokonać oceny.	Nie.
miejsce docelowe	obiekt	Reprezentuje element docelowy określający agenta sztucznej inteligencji platformy Azure.	Nie.
└─ nazwa	ciąg	Unikatowy identyfikator agenta sztucznej inteligencji platformy Azure.	Nie.
└tool_descriptions	macierz	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	Nie.
└* wersja	ciąg	Wersja agenta sztucznej inteligencji platformy Azure.	Nie.
typ	wyliczenie	Typ danych wejściowych taksonomii oceny. Możliwe wartości: agent	Nie.

AgentVersionObject

Name	Typ	Opis	Wymagane	Default
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) w momencie utworzenia agenta.	Tak
definicja	AgentDefinition		Tak
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
identyfikator	ciąg	Unikatowy identyfikator wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
nazwa	ciąg	Nazwa agenta. Nazwa może służyć do pobierania/aktualizowania/usuwania agenta.	Tak
obiekt	wyliczenie	Typ obiektu, którym zawsze jest "agent.version". Możliwe wartości: agent.version	Tak
wersja	ciąg	Identyfikator wersji agenta. Agenci są niezmienni, a każda aktualizacja tworzy nową wersję, zachowując tę samą nazwę.	Tak

AgenticIdentityCredentials

Definicja poświadczeń tożsamości agenta

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ poświadczeń Możliwe wartości: AgenticIdentityToken	Tak

ApiErrorResponse

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

Name	Typ	Opis	Wymagane	Default
błąd	OpenAI.Error		Tak

ApiKeyCredentials

Definicja poświadczeń klucza interfejsu API

Name	Typ	Opis	Wymagane	Default
klucz	ciąg	Klucz interfejsu API	Nie.
typ	wyliczenie	Typ poświadczeń Możliwe wartości: ApiKey	Tak

AssetCredentialResponse

Reprezentuje odwołanie do obiektu blob do użycia

Name	Typ	Opis	Wymagane	Default
BlobReference	obiekt	Szczegóły odwołania do obiektu blob.	Tak
└* 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	Nie.
Poświadczenie └*	SasCredential	Informacje o poświadczeniach w celu uzyskania dostępu do konta magazynu.	Nie.
└* storageAccountArmId	ciąg	Identyfikator usługi ARM konta magazynu do użycia.	Nie.

Identyfikator zasobu

Identyfikator zapisanego zasobu.

Typ: ciąg

AttackStrategy

Strategie ataków.

Majątek	Wartość
Opis	Strategie ataków.
Typ	ciąg
Wartości	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansii_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	Opis	Wymagane	Default
kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Tak
details	macierz	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.	Nie.
innererror	obiekt	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — 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.	Tak
miejsce docelowe	ciąg	Element docelowy błędu.	Nie.

Azure.Core.Foundations.ErrorResponse

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

Name	Typ	Opis	Wymagane	Default
błąd	obiekt	Obiekt błędu.	Tak
└─ kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Nie.
└szczegóły	macierz	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.	Nie.
└* docelowy	ciąg	Element docelowy błędu.	Nie.

Azure.Core.Foundations.InnerError

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

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.	Nie.
innererror	obiekt	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — 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.

Majątek	Wartość
Typ	ciąg
Wartości	NotStarted Running Succeeded Failed Canceled

Azure.Core.uuid

Unikatowy identyfikator uniwersalny

Typ: ciąg

Format: uuid

AzureAIAgentTarget

Reprezentuje element docelowy określający agenta sztucznej inteligencji platformy Azure.

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Unikatowy identyfikator agenta sztucznej inteligencji platformy Azure.	Tak
tool_descriptions	macierz	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	Tak
wersja	ciąg	Wersja agenta sztucznej inteligencji platformy Azure.	Nie.

AzureAIAgentTargetUpdate

Reprezentuje element docelowy określający agenta sztucznej inteligencji platformy Azure.

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Unikatowy identyfikator agenta sztucznej inteligencji platformy Azure.	Nie.
tool_descriptions	macierz	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	Nie.
wersja	ciąg	Wersja agenta sztucznej inteligencji platformy Azure.	Nie.

AzureAIAssistantTarget

Reprezentuje element docelowy określający punkt końcowy asystenta sztucznej inteligencji platformy Azure (agenta w wersji 1), w tym jego identyfikator.

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Unikatowy identyfikator asystenta sztucznej inteligencji platformy Azure.	Nie.
tool_descriptions	macierz	Opisy narzędzi dostępnych dla asystenta.	Tak
typ	wyliczenie	Typ celu, zawsze azure_ai_assistant. Możliwe wartości: azure_ai_assistant	Tak

AzureAIAssistantTargetUpdate

Reprezentuje element docelowy określający punkt końcowy asystenta sztucznej inteligencji platformy Azure (agenta w wersji 1), w tym jego identyfikator.

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Unikatowy identyfikator asystenta sztucznej inteligencji platformy Azure.	Nie.
tool_descriptions	macierz	Opisy narzędzi dostępnych dla asystenta.	Nie.
typ	wyliczenie	Typ celu, zawsze azure_ai_assistant. Możliwe wartości: azure_ai_assistant	Nie.

AzureAIEvaluator

Definicja ewaluatora sztucznej inteligencji platformy Azure dla ewaluatorów znalezionych.

Name	Typ	Opis	Wymagane	Default
mapowanie danych	obiekt	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Nie.
evaluator_name	ciąg	Nazwa ewaluatora.	Tak
evaluator_version	ciąg	Wersja ewaluatora.	Nie.
initialization_parameters	obiekt	Parametry inicjowania oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Nie.
nazwa	ciąg	Nazwa oceniającego.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: azure_ai_evaluator	Tak

AzureAIModelTarget

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

Name	Typ	Opis	Wymagane	Default
model	ciąg	Unikatowy identyfikator modelu AI platformy Azure.	Nie.
parametry_próbowania	obiekt	Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.	Nie.
└max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Nie.
└─ nasion	liczba całkowita	Losowe inicjatory do odtworzenia.	Nie.
└* temperatura	Liczba	Parametr temperatury do próbkowania.	Nie.
└─top_p	Liczba	Parametr top-p próbkowania jądra.	Nie.
typ	wyliczenie	Typ celu, zawsze azure_ai_model. Możliwe wartości: azure_ai_model	Tak

AzureAIModelTargetUpdate

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

Name	Typ	Opis	Wymagane	Default
model	ciąg	Unikatowy identyfikator modelu AI platformy Azure.	Nie.
parametry_próbowania	obiekt	Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.	Nie.
└max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Nie.
└─ nasion	liczba całkowita	Losowe inicjatory do odtworzenia.	Nie.
└* temperatura	Liczba	Parametr temperatury do próbkowania.	Nie.
└─top_p	Liczba	Parametr top-p próbkowania jądra.	Nie.
typ	wyliczenie	Typ celu, zawsze azure_ai_model. Możliwe wartości: azure_ai_model	Nie.

AzureAIRedTeam

Name	Typ	Opis	Wymagane	Default
item_generation_params	obiekt	Reprezentuje parametry generowania elementów zespołu czerwonego.	Tak
└attack_strategies	macierz	Kolekcja strategii ataków, które mają być używane.	Nie.
└num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Nie.
└typ	wyliczenie	Typ parametrów generowania elementów, zawsze red_team. Możliwe wartości: red_team	Nie.
miejsce docelowe	obiekt	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Tak
└typ	ciąg	Typ obiektu docelowego.	Nie.
typ	wyliczenie	Typ źródła danych. Zawsze azure_ai_red_team. Możliwe wartości: azure_ai_red_team	Tak

AzureAIResponses

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

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

AzureAISearchAgentTool

Informacje o definicji danych wejściowych narzędzia wyszukiwania sztucznej inteligencji platformy Azure używane do konfigurowania agenta.

Name	Typ	Opis	Wymagane	Default
azure_ai_search	obiekt	Zestaw zasobów indeksu używanych przez narzędzie azure_ai_search.	Tak
Indeksy └*	macierz	Indeksy dołączone do tego agenta. Może istnieć maksymalnie 1 indeks zasób dołączony do agenta.	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest 'azure_ai_search'. Możliwe wartości: azure_ai_search	Tak

Indeks wyszukiwania Azure AI

Definicja indeksu wyszukiwania w usłudze Azure AI

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Rodzaj indeksu Możliwe wartości: AzureSearch	Tak

AzureAISearchIndexUpdate

Definicja indeksu wyszukiwania w usłudze Azure AI

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Rodzaj indeksu Możliwe wartości: AzureSearch	Tak

AzureAISearchQueryType

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

Majątek	Wartość
Opis	Dostępne typy zapytań dla narzędzia Azure AI Search.
Typ	ciąg
Wartości	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchToolResource

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

Name	Typ	Opis	Wymagane	Default
Indeksy	macierz	Indeksy dołączone do tego agenta. Może istnieć maksymalnie 1 indeks zasób dołączony do agenta.	Tak

AzureAISource

Name	Typ	Opis	Wymagane	Default
scenariusz	wyliczenie	Scenariusz schematu danych. Możliwe wartości: red_team, , responsestraces	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: azure_ai_source	Tak

AzureFunctionAgentTool

Informacje o definicji danych wejściowych dla narzędzia funkcji platformy Azure używane do konfigurowania agenta.

Name	Typ	Opis	Wymagane	Default
azure_function	obiekt	Definicja funkcji platformy Azure.	Tak
└* , funkcja	obiekt	Definicja funkcji platformy Azure i jej parametrów.	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.	Nie.
Parametry		Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.	Nie.
└input_binding	AzureFunctionBinding	Kolejka magazynu wejściowego. Wyzwalacz magazynu kolejek uruchamia funkcję w miarę dodawania do niej komunikatów.	Nie.
└output_binding	AzureFunctionBinding	Kolejka magazynu wyjściowego. Funkcja zapisuje dane wyjściowe w tej kolejce po przetworzeniu elementów wejściowych.	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest "browser_automation". Możliwe wartości: azure_function	Tak

AzureFunctionBinding

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.

Name	Typ	Opis	Wymagane	Default
storage_queue	obiekt	Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.	Tak
└queue_name	ciąg	Nazwa kolejki usługi Azure Function Storage.	Nie.
└queue_service_endpoint	ciąg	Identyfikator URI usługi Azure Storage Queue Service umożliwiający manipulowanie kolejką.	Nie.
typ	wyliczenie	Typ powiązania, który jest zawsze "storage_queue". Możliwe wartości: storage_queue	Tak

AzureFunctionDefinition

Definicja funkcji platformy Azure.

Name	Typ	Opis	Wymagane	Default
funkcja	obiekt	Definicja funkcji platformy Azure i jej parametrów.	Tak
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.	Nie.
Parametry		Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.	Nie.
input_binding	obiekt	Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.	Tak
└storage_queue	AzureFunctionStorageQueue	Kolejka magazynu.	Nie.
└typ	wyliczenie	Typ powiązania, który jest zawsze "storage_queue". Możliwe wartości: storage_queue	Nie.
output_binding	obiekt	Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.	Tak
└storage_queue	AzureFunctionStorageQueue	Kolejka magazynu.	Nie.
└typ	wyliczenie	Typ powiązania, który jest zawsze "storage_queue". Możliwe wartości: storage_queue	Nie.

AzureFunctionStorageQueue

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.

Name	Typ	Opis	Wymagane	Default
queue_name	ciąg	Nazwa kolejki usługi Azure Function Storage.	Tak
queue_service_endpoint	ciąg	Identyfikator URI usługi Azure Storage Queue Service umożliwiający manipulowanie kolejką.	Tak

AzureOpenAIModelConfiguration

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

Name	Typ	Opis	Wymagane	Default
modelDeploymentName	ciąg	Nazwa wdrożenia dla modelu AOAI. Przykład: gpt-4o, jeśli w AISservicess lub oparty na connection_name/deployment_name połączeniu (np. my-aoai-connection/gpt-4o).	Tak
typ	wyliczenie	Możliwe wartości: AzureOpenAIModel	Tak

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:

Wartość typu	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	Sygnatury dostępu współdzielonego
None	NoAuthenticationCredentials
AgenticIdentityToken	AgenticIdentityCredentials

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Typ poświadczeń używany przez połączenie	Tak

BingCustomSearchAgentTool

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

Name	Typ	Opis	Wymagane	Default
bing_custom_search_preview	obiekt	Parametry narzędzia wyszukiwania niestandardowego Bing.	Tak
└search_configurations	macierz	Połączenia projektu dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest 'bing_custom_search'. Możliwe wartości: bing_custom_search_preview	Tak

BingCustomSearchConfiguration

Konfiguracja wyszukiwania niestandardowego Bing.

Name	Typ	Opis	Wymagane	Default
count	liczba całkowita	Liczba wyników wyszukiwania do zwrócenia 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.	Tak
rynek	ciąg	Rynek, z którego pochodzą wyniki.	Nie.
project_connection_id	ciąg	Identyfikator połączenia projektu dla uziemienia za pomocą wyszukiwania Bing	Tak
set_lang	ciąg	Język, który ma być używany dla ciągów interfejsu użytkownika podczas wywoływania interfejsu API Bing.	Nie.

BingCustomSearchToolParameters

Parametry narzędzia wyszukiwania niestandardowego Bing.

Name	Typ	Opis	Wymagane	Default
search_configurations	macierz	Połączenia projektu dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Tak

BingGroundingAgentTool

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

Name	Typ	Opis	Wymagane	Default
bing_grounding	obiekt	Parametry narzędzia wyszukiwania uziemienia Bing.	Tak
└search_configurations	macierz	Konfiguracje wyszukiwania dołączone do tego narzędzia. Może istnieć maksymalnie 1 zasób konfiguracji wyszukiwania dołączony do narzędzia.	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest 'bing_grounding'. Możliwe wartości: bing_grounding	Tak

BingGroundingSearchConfiguration

Wyszukaj konfigurację dla Bing Grounding

Name	Typ	Opis	Wymagane	Default
count	liczba całkowita	Liczba wyników wyszukiwania do zwrócenia w odpowiedzi interfejsu API Bing	Nie.
freshness	ciąg	Filtruj wyniki wyszukiwania według określonego zakresu czasu. Zobacz akceptowane wartości tutaj.	Nie.
rynek	ciąg	Rynek, z którego pochodzą wyniki.	Nie.
project_connection_id	ciąg	Identyfikator połączenia projektu dla uziemienia za pomocą wyszukiwania Bing	Tak
set_lang	ciąg	Język, który ma być używany dla ciągów interfejsu użytkownika podczas wywoływania interfejsu API Bing.	Nie.

BingGroundingSearchToolParameters

Parametry narzędzia wyszukiwania uziemienia Bing.

Name	Typ	Opis	Wymagane	Default
search_configurations	macierz	Konfiguracje wyszukiwania dołączone do tego narzędzia. Może istnieć maksymalnie 1 zasób konfiguracji wyszukiwania dołączony do narzędzia.	Tak

BlobReference

Szczegóły odwołania do obiektu blob.

Name	Typ	Opis	Wymagane	Default
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	Tak
poświadczenie	obiekt	Definicja poświadczeń sygnatury dostępu współdzielonego	Tak
└* sasUri	ciąg	Identyfikator URI sygnatury dostępu współdzielonego	Nie.
└typ	wyliczenie	Rodzaj poświadczenia Możliwe wartości: SAS	Nie.
storageAccountArmId	ciąg	Identyfikator usługi ARM konta magazynu do użycia.	Tak

BrowserAutomationAgentTool

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

Name	Typ	Opis	Wymagane	Default
browser_automation_preview	obiekt	Definicja parametrów wejściowych dla narzędzia Browser Automation Tool.	Tak
Połączenie └*	BrowserAutomationToolConnectionParameters	Parametry połączenia projektu skojarzone z narzędziem Browser Automation Tool.	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest "browser_automation". Możliwe wartości: browser_automation_preview	Tak

BrowserAutomationToolConnectionParameters

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

Name	Typ	Opis	Wymagane	Default
project_connection_id	ciąg	Identyfikator połączenia projektu z zasobem usługi Azure Playwright.	Tak

BrowserAutomationToolParameters

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

Name	Typ	Opis	Wymagane	Default
połączenie	obiekt	Definicja parametrów wejściowych dla połączenia używanego przez narzędzie Browser Automation Tool.	Tak
└project_connection_id	ciąg	Identyfikator połączenia projektu z zasobem usługi Azure Playwright.	Nie.

CaptureStructuredOutputsTool

Narzędzie do przechwytywania ustrukturyzowanych danych wyjściowych

Name	Typ	Opis	Wymagane	Default
Wyniki	obiekt	Ustrukturyzowane dane wyjściowe, które mogą być generowane przez agenta.	Tak
Opis └*	ciąg	Opis danych wyjściowych, które mają zostać wyemitowane. Używany przez model do określania, kiedy należy wyemitować dane wyjściowe.	Nie.
└─ nazwa	ciąg	Nazwa ustrukturyzowanych danych wyjściowych.	Nie.
Schemat └*		Schemat JSON dla ustrukturyzowanych danych wyjściowych.	Nie.
└* ścisłe	typ logiczny (boolowski)	Określa, czy wymuszać ścisłą walidację. Wartość domyślna true.	Nie.
typ	wyliczenie	Typ narzędzia. Zawsze capture_structured_outputs. Możliwe wartości: capture_structured_outputs	Tak

Wykres współrzędny

Współrzędne wykresu analizy.

Name	Typ	Opis	Wymagane	Default
rozmiar	liczba całkowita	Rozmiar elementu wykresu.	Tak
x	liczba całkowita	Współrzędna osi X.	Tak
y	liczba całkowita	Współrzędna osi Y.	Tak

ChatSummaryMemoryItem

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

Name	Typ	Opis	Wymagane	Default
rodzaj	wyliczenie	Rodzaj elementu pamięci. Możliwe wartości: chat_summary	Tak

ClusterInsightResult

Wnioski z analizy skupień.

Name	Typ	Opis	Wymagane	Default
clusters	macierz	Lista klastrów zidentyfikowanych w szczegółowych informacjach.	Tak
współrzędne	obiekt	Opcjonalne mapowanie identyfikatorów na współrzędne 2D używane przez środowisko 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	obiekt	Podsumowanie analizy skupień błędów.	Tak
└* metoda	ciąg	Metoda stosowana do grupowania.	Nie.
└* sampleCount	liczba całkowita	Łączna liczba przeanalizowanych próbek.	Nie.
└* uniqueClusterCount	liczba całkowita	Łączna liczba unikatowych klastrów.	Nie.
└(*) uniqueSubclusterCount	liczba całkowita	Łączna liczba unikatowych etykiet podklastrów.	Nie.
└─ użycie	ClusterTokenUsage	Użycie tokenów podczas wykonywania analizy klastrowania	Nie.

ClusterTokenUsage

Użycie tokenu do analizy skupień

Name	Typ	Opis	Wymagane	Default
inputTokenUsage	liczba całkowita	Użycie tokenu wejściowego	Tak
outputTokenUsage	liczba całkowita	Użycie tokenu wyjściowego	Tak
totalTokenUsage	liczba całkowita	Całkowite użycie tokenów	Tak

CodeBasedEvaluatorDefinition

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

Name	Typ	Opis	Wymagane	Default
code_text	ciąg	Tekst kodu wbudowanego dla osoby oceniającej	Tak
typ	wyliczenie	Możliwe wartości: code	Tak

Połączenie

Operacje odpowiedzi z listy i pobierania połączeń

Name	Typ	Opis	Wymagane	Default
dane logowania	obiekt	Klasa bazowa dla poświadczeń połączenia	Tak
└typ	Typ poświadczeń	Typ poświadczenia używanego przez połączenie	Nie.
identyfikator	ciąg	Unikatowy identyfikator połączenia generowany przez usługę	Tak
isDefault	typ logiczny (boolowski)	Czy połączenie jest oznaczone jako połączenie domyślne danego typu	Tak
metadane	obiekt	Metadane połączenia	Tak
nazwa	ciąg	Przyjazna nazwa połączenia podana przez użytkownika.	Tak
miejsce docelowe	ciąg	Adres URL połączenia, który ma być używany dla tej usługi	Tak
typ	obiekt	Typ (lub kategoria) połączenia	Tak

Typ Połączenia

Typ (lub kategoria) połączenia

Majątek	Wartość
Opis	Typ (lub kategoria) połączenia
Typ	ciąg
Wartości	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool

ContainerAppAgentDefinition

Definicja agenta aplikacji kontenera.

Name	Typ	Opis	Wymagane	Default
container_app_resource_id	ciąg	Identyfikator zasobu aplikacji kontenera platformy Azure, która hostuje tego agenta. Nie można modyfikować między wersjami.	Tak
container_protocol_versions	macierz	Protokoły obsługiwane przez agenta na potrzeby komunikacji przychodzącej kontenerów.	Tak
ingress_subdomain_suffix	ciąg	Sufiks, który ma być stosowany do poddomeny aplikacji podczas wysyłania ruchu przychodzącego do agenta. Może to być etykieta (np. "---bieżąca"), określona poprawka (np. "--0000001") lub pusta, aby użyć domyślnego punktu końcowego dla aplikacji kontenera.	Tak
rodzaj	wyliczenie	Możliwe wartości: container_app	Tak

ContinuousEvalItemGenerationParams

Reprezentuje parametry generowania elementu ciągłej oceny.

Name	Typ	Opis	Wymagane	Default
mapowanie danych	obiekt	Mapowanie z pól źródłowych na pole response_id wymagane do pobierania historii czatu.	Tak
max_num_turns	liczba całkowita	Maksymalna liczba zakrętów historii czatów do oceny.	Tak
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└typ	wyliczenie	Typ źródła jsonl. Zawsze file_id. Możliwe wartości: file_id	Nie.
typ	wyliczenie	Typ parametrów generowania elementów, zawsze ResponseRetrieval. Możliwe wartości: response_retrieval	Tak

ContinuousEvaluationRuleAction

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

Name	Typ	Opis	Wymagane	Default
evalId	ciąg	Identyfikator ewaluacji, do którego mają zostać dodane ciągłe przebiegi oceny.	Tak
maxHourlyRuns	liczba całkowita	Maksymalna dozwolona liczba przebiegów oceny na godzinę.	Nie.
typ	wyliczenie	Możliwe wartości: continuousEvaluation	Tak

Indeks CosmosDB

Definicja indeksu magazynu wektorów usługi CosmosDB

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Rodzaj indeksu Możliwe wartości: CosmosDBNoSqlVectorStore	Tak

CosmosDBIndexUpdate

Definicja indeksu magazynu wektorów usługi CosmosDB

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Rodzaj indeksu Możliwe wartości: CosmosDBNoSqlVectorStore	Tak

CreateAgentFromManifestRequest

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
parameter_values	obiekt	Dane wejściowe manifestu, które spowodują w pełni zmaterializowany agent.	Tak

CreateAgentRequest

Name	Typ	Opis	Wymagane	Default
definicja	obiekt		Tak
Rodzaj └*	AgentKind		Nie.
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak

CreateAgentVersionFromManifestRequest

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak

CreateAgentVersionRequest

Name	Typ	Opis	Wymagane	Default
definicja	obiekt		Tak
Rodzaj └*	AgentKind		Nie.
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Opis	Wymagane	Default
konfiguracja źródła danych	obiekt	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	Tak
└ dołącz_przykładowy_schemat	typ logiczny (boolowski)	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.	Nie.
Metadane └*	obiekt	Filtry metadanych dla przechowywanego źródła danych uzupełniania.	Nie.
Scenariusz └*	wyliczenie	Scenariusz schematu danych. Możliwe wartości: red_team, , responsestraces	Nie.
└typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: azure_ai_source	Nie.
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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	macierz	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}}).	Tak

CreateEvalRunRequest

Name	Typ	Opis	Wymagane	Default
źródło danych	obiekt	Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji.	Tak
└input_messages	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.
└item_generation_params	RedTeamItemGenerationParams	Parametry generowania elementów.	Nie.
Model └*	ciąg	Nazwa modelu do użycia do generowania uzupełniania (np. "o3-mini").	Nie.
└parametry_próbkowania	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Nie.
└— ź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.	Nie.
└* docelowy	Obiekt docelowy	Konfiguracja docelowa oceny.	Nie.
└typ	ciąg	Dyskryminujący typ źródła danych.	Nie.
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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.

Utworzone przez

Name	Typ	Opis	Wymagane	Default
agent	obiekt		Nie.
└─ nazwa	ciąg	Nazwa agenta.	Nie.
└typ	wyliczenie	Możliwe wartości: agent_id	Nie.
└* wersja	ciąg	Identyfikator wersji agenta.	Nie.
response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.

Typ poświadczeń

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

Majątek	Wartość
Opis	Typ poświadczeń używany przez połączenie
Typ	ciąg
Wartości	ApiKey AAD SAS CustomKeys None AgenticIdentityToken

CronTrigger

Wyzwalacz oparty na Cronie.

Name	Typ	Opis	Wymagane	Default
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.	Tak
startTime	ciąg	Godzina rozpoczęcia harmonogramu cron w formacie ISO 8601.	Nie.
strefa czasowa	ciąg	Strefa czasowa dla harmonogramu cron.	Nie.	UTC
typ	wyliczenie	Możliwe wartości: Cron	Tak

CustomCredential

Niestandardowa definicja poświadczeń

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ poświadczeń Możliwe wartości: CustomKeys	Tak

DailyRecurrenceSchedule

Harmonogram codziennych cykli.

Name	Typ	Opis	Wymagane	Default
Godzin	macierz	Godziny dla harmonogramu cyklu.	Tak
typ	wyliczenie	Typ nawrotu dziennego. Możliwe wartości: Daily	Tak

Typ zestawu danych

Wyliczenie w celu określenia typu danych.

Majątek	Wartość
Opis	Wyliczenie w celu określenia typu danych.
Typ	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:

Wartość typu	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Typ	Opis	Wymagane	Default
connectionName (nazwa_połączenia)	ciąg	Nazwa połączenia konta usługi Azure Storage. Wymagane, jeśli startPendingUploadVersion nie została wywołana przed utworzeniem zestawu danych	Nie.
dataUri	ciąg	Identyfikator URI danych (przykład)	Tak
identyfikator	ciąg	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
isReference	typ logiczny (boolowski)	Wskazuje, czy zestaw danych zawiera odwołanie do magazynu, czy też zestaw danych sam zarządza magazynem. Jeśli to prawda, dane źródłowe nie zostaną usunięte po usunięciu wersji zestawu danych	Nie.
nazwa	ciąg	Nazwa zasobu	Tak
typ	obiekt	Wyliczenie w celu określenia typu danych.	Tak
wersja	ciąg	Wersja zasobu	Tak

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:

Wartość typu	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

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

DzieńTygodnia

Dni tygodnia dla harmonogramu cyklu.

Majątek	Wartość
Opis	Dni tygodnia dla harmonogramu cyklu.
Typ	ciąg
Wartości	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Usunięty obiekt agenta

Name	Typ	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)	Określa, czy agent został pomyślnie usunięty.	Tak
nazwa	ciąg	Nazwa agenta.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "agent.deleted". Możliwe wartości: agent.deleted	Tak

DeleteAgentVersionResponse

Usunięta wersja agenta Object

Name	Typ	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)	Określa, czy agent został pomyślnie usunięty.	Tak
nazwa	ciąg	Nazwa agenta.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "agent.deleted". Możliwe wartości: agent.version.deleted	Tak
wersja	ciąg	Identyfikator wersji agenta.	Tak

DeleteEvalResponse

Usunięty obiekt oceny

Name	Typ	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)	Czy eval został pomyślnie usunięty.	Tak
eval_id	ciąg	identyfikator ewalu.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.deleted". Możliwe wartości: eval.deleted	Tak

DeleteEvalRunResponse

Usunięty obiekt przebiegu oceny.

Name	Typ	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)	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	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)	Określa, czy magazyn pamięci został pomyślnie usunięty.	Tak
nazwa	ciąg	Nazwa magazynu pamięci.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "memory_store.usunięte". Możliwe wartości: memory_store.deleted	Tak

DeleteResponseResult

Wynik operacji usuwania odpowiedzi.

Name	Typ	Opis	Wymagane	Default
usunięta	wyliczenie	Zawsze zwracaj wartość true Możliwe wartości: True	Tak
identyfikator	ciąg	Identyfikator operacji.	Tak
obiekt	wyliczenie	Zawsze zwracaj wartość "response". Możliwe wartości: response	Tak

Wdrożenie

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:

Wartość typu	Schema
ModelDeployment	ModelDeployment

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Nazwa wdrożenia	Tak
typ	obiekt		Tak

Deploymenttype

Majątek	Wartość
Typ	ciąg
Wartości	ModelDeployment

EntraIDCredentials

Definicja poświadczeń identyfikatora Entra

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ poświadczeń Możliwe wartości: AAD	Tak

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ć:

• 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	Opis	Wymagane	Default
utworzono_o	obiekt		Tak
utworzone_przez	ciąg	imię i nazwisko osoby, która utworzyła przebieg.	Nie.
konfiguracja źródła danych	obiekt	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	Tak
└ dołącz_przykładowy_schemat	typ logiczny (boolowski)	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.	Nie.
Metadane └*	obiekt	Filtry metadanych dla przechowywanego źródła danych uzupełniania.	Nie.
Scenariusz └*	wyliczenie	Scenariusz schematu danych. Możliwe wartości: red_team, , responsestraces	Nie.
└typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: azure_ai_source	Nie.
identyfikator	ciąg	Unikatowy identyfikator oceny.	Tak
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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.	Tak
modified_at	obiekt		Nie.
nazwa	ciąg	Nazwa oceny.	Tak
obiekt	wyliczenie	Typ obiektu. Możliwe wartości: eval	Tak
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	macierz	Lista kryteriów testowania.	Tak

EvalCompareReport

Wnioski z porównania ewaluacji.

Name	Typ	Opis	Wymagane	Default
Porównania	macierz	Wyniki porównania dla każdego leczenia są sprzeczne z wartością wyjściową.	Tak
metoda	ciąg	Metoda statystyczna zastosowana do porównania.	Tak
typ	wyliczenie	Typ wyniku szczegółowych informacji. Możliwe wartości: EvaluationComparison	Tak

EvalResult

Wynik oceny.

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Nazwa czeku	Tak
Przekazywane	typ logiczny (boolowski)	Wskazuje, czy test zakończył się powodzeniem, czy niepowodzeniem	Tak
wynik	Liczba	wynik	Tak
typ	ciąg	Rodzaj kontroli	Tak

EvalRun

Schemat reprezentujący przebieg oceny.

Name	Typ	Opis	Wymagane	Default
utworzono_o	obiekt		Tak
utworzone_przez	ciąg	imię i nazwisko osoby, która utworzyła przebieg.	Nie.
źródło danych	obiekt	Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji.	Tak
└input_messages	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.
└item_generation_params	RedTeamItemGenerationParams	Parametry generowania elementów.	Nie.
Model └*	ciąg	Nazwa modelu do użycia do generowania uzupełniania (np. "o3-mini").	Nie.
└parametry_próbkowania	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Nie.
└— ź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.	Nie.
└* docelowy	Obiekt docelowy	Konfiguracja docelowa oceny.	Nie.
└typ	ciąg	Dyskryminujący typ źródła danych.	Nie.
błąd	OpenAI.EvalApiError	Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.	Tak
eval_id	ciąg	Identyfikator skojarzonej oceny.	Tak
identyfikator	ciąg	Unikatowy identyfikator przebiegu oceny.	Tak
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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.	Tak
model	ciąg	Model, który jest oceniany, jeśli ma zastosowanie.	Tak
modified_at	obiekt		Nie.
nazwa	ciąg	Nazwa przebiegu oceny.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.run". Możliwe wartości: eval.run	Tak
użycie na model	macierz	Statystyki użycia dla każdego modelu podczas przebiegu oceny.	Tak
wyniki_wg_kryteriów_testowych	macierz	Wyniki na kryteria testowania stosowane podczas przebiegu oceny.	Tak
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.	Tak
wyniki_liczby	obiekt		Tak
└─ Wystąpił błąd	OpenAI.integer		Nie.
└* nie powiodło się	OpenAI.integer		Nie.
└* zaliczone	OpenAI.integer		Nie.
└─ suma	OpenAI.integer		Nie.
stan	ciąg	Stan przebiegu oceny.	Tak

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:

Wartość typu	Schema
azure_ai_traces	TracesEvalRunDataSource
azure_ai_responses	AzureAIResponses
azure_ai_target_completions	TargetCompletions

Name	Typ	Opis	Wymagane	Default
typ	ciąg	Dyskryminujący typ źródła danych.	Tak

EvalRunOutputItem

Schemat reprezentujący element wyjściowy przebiegu oceny.

Name	Typ	Opis	Wymagane	Default
utworzono_o	obiekt		Tak
element źródła danych	obiekt	Szczegóły elementu wejściowego źródła danych.	Tak
"identyfikator_elementu_źródła_danych (datasource_item_id)"	obiekt		Tak
eval_id	ciąg	Identyfikator grupy ewaluacyjnej.	Tak
identyfikator	ciąg	Unikatowy identyfikator elementu wyjściowego procesu oceny.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "eval.run.output_item". Możliwe wartości: eval.run.output_item	Tak
results	macierz	Lista wyników klasyzatora dla tego elementu wyjściowego.	Tak
run_id	ciąg	Identyfikator przebiegu oceny skojarzonego z tym elementem wyjściowym.	Tak
próbka	obiekt		Tak
└─ błąd	OpenAI.EvalApiError	Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.	Nie.
└ finish_reason	ciąg		Nie.
└─ Wejście	macierz		Nie.
└max_completion_tokens	OpenAI.integer		Nie.
Model └*	ciąg		Nie.
└─ Dane wyjściowe	macierz		Nie.
└─ nasion	OpenAI.integer		Nie.
└* temperatura	OpenAI.numeric		Nie.
└─top_p	OpenAI.numeric		Nie.
└─ użycie	OpenAI.EvalRunOutputItemSampleUsage		Nie.
stan	ciąg	Stan przebiegu oceny.	Tak

EvalRunOutputItemResult

Pojedynczy wynik klasykatora dla elementu wyjściowego przebiegu oceny.

Name	Typ	Opis	Wymagane	Default
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.	Tak
Przekazywane	typ logiczny (boolowski)	Czy klasyk uznał dane wyjściowe za przekazywanie.	Tak
properties	obiekt	Dodatkowe szczegóły dotyczące metryki kryteriów testu.	Nie.
powód	ciąg	Przyczyna metryki kryteriów testu.	Nie.
próbka	obiekt	Opcjonalne próbki lub dane pośrednie generowane przez klasykator.	Nie.
wynik	obiekt		Tak
próg	Liczba	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.

EvalRunResultCompareItem

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

Name	Typ	Opis	Wymagane	Default
deltaEstimate	Liczba	Szacowana różnica między leczeniem a wartością wyjściową.	Tak
pValue	Liczba	Wartość P dla efektu leczenia.	Tak
leczenieEffect	obiekt	Rodzaj efektu zabiegu.	Tak
leczenieRunId	ciąg	Przebieg leczenia ID.	Tak
leczenieRunSummary	obiekt	Statystyki podsumowujące metrykę w przebiegu oceny.	Tak
└* średnia	Liczba	Średnia wartość metryki w przebiegu oceny.	Nie.
└* runId	ciąg	Identyfikator przebiegu oceny.	Nie.
└* sampleCount	liczba całkowita	Liczba próbek w przebiegu oceny.	Nie.
└* standardowaDeviation	Liczba	Odchylenie standardowe metryki w przebiegu oceny.	Nie.

EvalRunResultComparison

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

Name	Typ	Opis	Wymagane	Default
baselineRunSummary	obiekt	Statystyki podsumowujące metrykę w przebiegu oceny.	Tak
└* średnia	Liczba	Średnia wartość metryki w przebiegu oceny.	Nie.
└* runId	ciąg	Identyfikator przebiegu oceny.	Nie.
└* sampleCount	liczba całkowita	Liczba próbek w przebiegu oceny.	Nie.
└* standardowaDeviation	Liczba	Odchylenie standardowe metryki w przebiegu oceny.	Nie.
compareItems	macierz	Lista wyników porównawczych dla każdego cyklu leczenia.	Tak
ewaluator	ciąg	Imię i nazwisko osoby oceniającej niniejsze kryteria badania.	Tak
metryka	ciąg	Metryka jest oceniana.	Tak
testingCriteria	ciąg	Nazwa kryteriów testowania.	Tak

EvalRunResultSummary

Statystyki podsumowujące metrykę w przebiegu oceny.

Name	Typ	Opis	Wymagane	Default
średnia	Liczba	Średnia wartość metryki w przebiegu oceny.	Tak
identyfikator uruchomienia	ciąg	Identyfikator przebiegu oceny.	Tak
sampleCount	liczba całkowita	Liczba próbek w przebiegu oceny.	Tak
StandardowaDeviation	Liczba	Odchylenie standardowe metryki w przebiegu oceny.	Tak

EvaluationComparisonRequest

Prośba o porównanie oceny

Name	Typ	Opis	Wymagane	Default
baselineRunId	ciąg	Identyfikator uruchomienia punktu odniesienia do porównania.	Tak
evalId	ciąg	Identyfikator oceny.	Tak
leczenieRunIds	macierz	Lista identyfikatorów przebiegów leczenia dla porównania.	Tak
typ	wyliczenie	Typ żądania. Możliwe wartości: EvaluationComparison	Tak

EvaluationResultSample

Próbka z wyniku oceny.

Name	Typ	Opis	Wymagane	Default
evaluationResult	obiekt	Wynik oceny.	Tak
└─ nazwa	ciąg	Nazwa czeku	Nie.
└* zaliczone	typ logiczny (boolowski)	Wskazuje, czy test zakończył się powodzeniem, czy niepowodzeniem	Nie.
└* wynik	Liczba	wynik	Nie.
└typ	ciąg	Rodzaj kontroli	Nie.
typ	wyliczenie	Wynik oceny Typ próbki Możliwe wartości: EvaluationResultSample	Tak

Reguła oceny

Model reguły oceny.

Name	Typ	Opis	Wymagane	Default
akcja	obiekt	Model działania ewaluacyjnego.	Tak
└typ	EvaluationRuleActionType	Rodzaj działania w ramach oceny.	Nie.
opis	ciąg	Opis reguły oceny.	Nie.
displayName	ciąg	Nazwa wyświetlana reguły oceny.	Nie.
włączony	typ logiczny (boolowski)	Wskazuje, czy reguła oceny jest włączona. Wartość domyślna to true.	Tak
eventType	obiekt	Typ zdarzenia reguły oceny.	Tak
filtr	obiekt	Model filtru oceny.	Nie.
└} agentName	ciąg	Filtruj według nazwy agenta.	Nie.
identyfikator	ciąg	Niepowtarzalny identyfikator reguły oceny.	Tak
daneSystemowe	obiekt	Metadane systemowe dla reguły oceny.	Tak

EvaluationRuleAction

Model działania ewaluacyjnego.

Dyskryminowanie ocenyRuleAction

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

Wartość typu	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluation	HumanEvaluationRuleAction

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Rodzaj działania w ramach oceny.	Tak

EvaluationRuleActionType

Rodzaj działania w ramach oceny.

Majątek	Wartość
Opis	Rodzaj działania w ramach oceny.
Typ	ciąg
Wartości	continuousEvaluation humanEvaluation

EvaluationRuleEventType

Typ zdarzenia reguły oceny.

Majątek	Wartość
Opis	Typ zdarzenia reguły oceny.
Typ	ciąg
Wartości	responseCompleted manual

EvaluationRuleFilter

Model filtru oceny.

Name	Typ	Opis	Wymagane	Default
agentName	ciąg	Filtruj według nazwy agenta.	Tak

EvaluationRunClusterInsightResult

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

Name	Typ	Opis	Wymagane	Default
clusterInsight	ClusterInsightResult	Wnioski z analizy skupień.	Tak
typ	wyliczenie	Typ wyniku szczegółowych informacji. Możliwe wartości: EvaluationRunClusterInsight	Tak

EvaluationRunClusterInsightsRequest

Wgląd w zestaw wyników ewaluacji

Name	Typ	Opis	Wymagane	Default
evalId	ciąg	Identyfikator oceny dla szczegółowych informacji.	Tak
modelKonfiguracja	obiekt	Konfiguracja modelu używanego w generowaniu wniosków.	Nie.
└* modelDeploymentName	ciąg	Wdrożenie modelu, które ma zostać ocenione. Akceptuje nazwę wdrożenia samodzielnie lub z nazwą połączenia jako {connectionName}/<modelDeploymentName>.	Nie.
identyfikatory runId	macierz	Lista identyfikatorów przebiegów oceny dla szczegółowych informacji.	Tak
typ	wyliczenie	Typ żądania szczegółowych informacji. Możliwe wartości: EvaluationRunClusterInsight	Tak

EvaluationScheduleTask

Zadanie oceny harmonogramu.

Name	Typ	Opis	Wymagane	Default
evalId	ciąg	Identyfikator grupy oceniającej.	Tak
evalRun	obiekt	Ładunek przebiegu oceny.	Tak
typ	wyliczenie	Możliwe wartości: Evaluation	Tak

EvaluationTaxonomy

Definicja taksonomii oceny

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg	Nazwa zasobu	Tak
properties	obiekt	Dodatkowe właściwości taksonomii oceny.	Nie.
taksonomiaKategorie	macierz	Lista kategorii taksonomii.	Nie.
taksonomiaInput	obiekt	Konfiguracja danych wejściowych dla taksonomii oceny.	Tak
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Nie.
wersja	ciąg	Wersja zasobu	Tak

EvaluationTaxonomyCreateOrUpdate

Definicja taksonomii oceny

Name	Typ	Opis	Wymagane	Default
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	macierz	Lista kategorii taksonomii.	Nie.
taksonomiaInput	obiekt	Konfiguracja danych wejściowych dla taksonomii oceny.	Tak
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Nie.

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:

Wartość typu	Schema
agent	AgentTaxonomyInput

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Rodzaj danych wejściowych oceny taksonomii.	Tak

EvaluationTaxonomyInputType

Rodzaj danych wejściowych oceny taksonomii.

Majątek	Wartość
Opis	Rodzaj danych wejściowych oceny taksonomii.
Typ	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:

Wartość typu	Schema
agent	AgentTaxonomyInputUpdate

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Rodzaj danych wejściowych oceny taksonomii.	Tak

EvaluationTaxonomyUpdate

Definicja taksonomii oceny

Name	Typ	Opis	Wymagane	Default
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	macierz	Lista kategorii taksonomii.	Nie.
taksonomiaInput	obiekt	Konfiguracja danych wejściowych dla taksonomii oceny.	Nie.
└typ	EvaluationTaxonomyInputType	Typ danych wejściowych taksonomii oceny.	Nie.

EwaluatorCategory

Kategoria osoby oceniającej

Majątek	Wartość
Opis	Kategoria osoby oceniającej
Typ	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:

Wartość typu	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Typ	Opis	Wymagane	Default
data_schema		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		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	obiekt	Definicja rodzaju osoby ewaluującej	Tak

EwaluatorDefinitionType

Definicja rodzaju osoby ewaluującej

Majątek	Wartość
Opis	Definicja rodzaju osoby ewaluującej
Typ	ciąg
Wartości	prompt code prompt_and_code service openai_graders

EwaluatorMetric

Metryka ewaluatora

Name	Typ	Opis	Wymagane	Default
desirable_direction	obiekt	Kierunek metryki wskazujący, czy wyższa wartość jest lepsza, niższa wartość jest lepsza, czy neutralna	Nie.
is_primary	typ logiczny (boolowski)	Wskazuje, czy ta metryka jest podstawowa, gdy istnieje wiele metryk.	Nie.
max_value	Liczba	Maksymalna wartość metryki. Jeśli nie zostanie określony, zakłada się, że jest niepowiązany.	Nie.
min_value	Liczba	Minimalna wartość metryki	Nie.
typ	obiekt	Rodzaj osoby oceniającej	Nie.

EwaluatorMetricDirection

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

Majątek	Wartość
Opis	Kierunek metryki wskazujący, czy wyższa wartość jest lepsza, niższa wartość jest lepsza, czy neutralna
Typ	ciąg
Wartości	increase decrease neutral

EwaluatorMetricType

Rodzaj osoby oceniającej

Majątek	Wartość
Opis	Rodzaj osoby oceniającej
Typ	ciąg
Wartości	ordinal continuous boolean

Typ ewaluatora

Rodzaj osoby oceniającej

Majątek	Wartość
Opis	Rodzaj osoby oceniającej
Typ	ciąg
Wartości	builtin custom

EvaluatorVersion

Definicja ewaluatora

Name	Typ	Opis	Wymagane	Default
categories	macierz	Kategorie osoby oceniającej	Tak
utworzono_o	liczba całkowita	Data/godzina utworzenia osoby oceniającej	Tak
utworzone_przez	ciąg	Twórca ewaluatora	Tak
definicja	obiekt	Podstawowa konfiguracja ewaluatora z dyskryminatorem	Tak
└data_schema		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		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	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Pomaga łatwo znaleźć ewaluatora w Foundry. Nie musi być unikalny.	Nie.
evaluator_type	obiekt	Rodzaj osoby oceniającej	Tak
identyfikator	ciąg	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
metadane	obiekt	Metadane dotyczące osoby oceniającej	Nie.
modified_at	liczba całkowita	Data/godzina ostatniej modyfikacji osoby oceniającej	Tak
nazwa	ciąg	Nazwa zasobu	Tak
wersja	ciąg	Wersja zasobu	Tak

EvaluatorVersionTworzenie

Definicja ewaluatora

Name	Typ	Opis	Wymagane	Default
categories	macierz	Kategorie osoby oceniającej	Tak
definicja	obiekt	Podstawowa konfiguracja ewaluatora z dyskryminatorem	Tak
└data_schema		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		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	Nie.
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Pomaga łatwo znaleźć ewaluatora w Foundry. Nie musi być unikalny.	Nie.
evaluator_type	obiekt	Rodzaj osoby oceniającej	Tak
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	Opis	Wymagane	Default
categories	macierz	Kategorie osoby oceniającej	Nie.
opis	ciąg	Tekst opisu zasobu.	Nie.
display_name	ciąg	Nazwa wyświetlana dla ewaluatora. Pomaga łatwo znaleźć ewaluatora w 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	Opis	Wymagane	Default
project_connections	macierz	Połączenia projektu 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	Opis	Wymagane	Default
typ	wyliczenie	Typ zestawu danych Możliwe wartości: uri_file	Tak

FileDatasetVersionUpdate

Definicja wersji pliku FileDatasetVersion

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zestawu danych Możliwe wartości: uri_file	Tak

FolderDatasetVersion

Definicja wersji pliku FileDatasetVersion

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zestawu danych Możliwe wartości: uri_folder	Tak

FolderDatasetVersionUpdate

Definicja wersji pliku FileDatasetVersion

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zestawu danych Możliwe wartości: uri_folder	Tak

HostedAgentDefinition

Definicja hostowanego agenta.

Dyskryminujące dla elementu HostedAgentDefinition

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

Wartość typu	Schema
hosted	ImageBasedHostedAgentDefinition

Name	Typ	Opis	Wymagane	Default
container_protocol_versions	macierz	Protokoły obsługiwane przez agenta na potrzeby komunikacji przychodzącej kontenerów.	Tak
cpu	ciąg	Konfiguracja procesora CPU dla hostowanego agenta.	Tak
environment_variables	obiekt	Zmienne środowiskowe do ustawienia w kontenerze hostowanego agenta.	Nie.
rodzaj	wyliczenie	Możliwe wartości: hosted	Tak
pamięć	ciąg	Konfiguracja pamięci hostowanego agenta.	Tak
narzędzia	macierz	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	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: Hourly	Tak

HumanEvaluationRuleAction

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

Name	Typ	Opis	Wymagane	Default
Identyfikator szablonu	obiekt	Identyfikator zapisanego zasobu.	Tak
typ	wyliczenie	Możliwe wartości: humanEvaluation	Tak

ImageBasedHostedAgentDefinition

Definicja wdrożenia opartego na obrazie dla hostowanego agenta.

Name	Typ	Opis	Wymagane	Default
obraz	ciąg	Obraz hostowanego agenta.	Tak
rodzaj	wyliczenie	Możliwe wartości: hosted	Tak

Index

Definicja zasobu indeksu

Dyskryminujący indeks

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

Wartość typu	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Identyfikator zasobu, unikatowy identyfikator zasobu	Nie.
nazwa	ciąg	Nazwa zasobu	Tak
typ	obiekt		Tak
wersja	ciąg	Wersja zasobu	Tak

Typ indeksu

Majątek	Wartość
Typ	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:

Wartość typu	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Tekst opisu zasobu.	Nie.
tags	obiekt	Słownik tagów. Tagi można dodawać, usuwać i aktualizować.	Nie.
typ	obiekt		Tak

Wgląd

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

Name	Typ	Opis	Wymagane	Default
displayName	ciąg	Przyjazna dla użytkownika nazwa wyświetlana dla szczegółowych informacji.	Tak
identyfikator	ciąg	Unikatowy identyfikator raportu ze statystykami.	Tak
metadane	obiekt	Metadane dotyczące szczegółowych informacji.	Tak
└* completedAt	ciąg	Sygnatura czasowa, kiedy szczegółowe informacje zostały ukończone.	Nie.
└} createdAt	ciąg	Sygnatura czasowa utworzenia szczegółowych informacji.	Nie.
żądanie	obiekt	Żądanie raportu szczegółowych informacji.	Tak
└typ	InsightType	Typ żądania.	Nie.
wynik	obiekt	Wynik spostrzeżeń.	Nie.
└typ	InsightType	Typ wyniku szczegółowych informacji.	Nie.
stan	obiekt	Wyliczenie opisujące dozwolone stany operacji.	Tak

InsightCluster

Klaster próbek analitycznych.

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis grupy analitycznej.	Tak
identyfikator	ciąg	Identyfikator klastra analizy.	Tak
etykieta	ciąg	Etykieta dla klastra	Tak
Próbki	macierz	Lista próbek należących do tego klastra. Puste, jeśli próbki są częścią podklastrów.	Nie.
subClusters	macierz	Lista podklastrów w tym klastrze. Puste, jeśli nie istnieją żadne podklastry.	Nie.
sugestia	ciąg	Sugestia dotycząca klastra	Tak
suggestionTitle	ciąg	Tytuł sugestii dla klastra	Tak
weight	liczba całkowita	Waga klastra analizy. Wskazuje to liczbę próbek w klastrze.	Tak

InsightModelConfiguration

Konfiguracja modelu używanego w generowaniu wniosków.

Name	Typ	Opis	Wymagane	Default
modelDeploymentName	ciąg	Wdrożenie modelu, które ma zostać ocenione. Akceptuje nazwę wdrożenia samodzielnie lub z nazwą połączenia jako {connectionName}/<modelDeploymentName>.	Tak

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:

Wartość typu	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightsRequest
AgentClusterInsight	AgentClusterInsightsRequest
EvaluationComparison	EvaluationComparisonRequest

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Prośba o wglądy.	Tak

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:

Wartość typu	Schema
EvaluationComparison	EvalCompareReport
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Prośba o wglądy.	Tak

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:

Wartość typu	Schema
EvaluationResultSample	EvaluationResultSample

Name	Typ	Opis	Wymagane	Default
correlationInfo	obiekt	Informacja o korelacji dla próbki analizy.	Tak
features	obiekt	Funkcje pomagające w dodatkowym filtrowaniu danych w UX.	Tak
identyfikator	ciąg	Niepowtarzalny identyfikator próbki analitycznej.	Tak
typ	obiekt	Rodzaj próbki użytej w analizie.	Tak

InsightScheduleTask

Zadanie Wgląd dla harmonogramu.

Name	Typ	Opis	Wymagane	Default
analiza	obiekt	Treść odpowiedzi dla szczegółowych informacji o klastrze.	Tak
└} displayName	ciąg	Przyjazna dla użytkownika nazwa wyświetlana dla szczegółowych informacji.	Nie.
└─ ID	ciąg	Unikatowy identyfikator raportu ze statystykami.	Nie.
Metadane └*	InsightsMetadata	Metadane dotyczące raportu ze statystykami.	Nie.
└* żądanie	InsightRequest	Prośba o analizę wniosków.	Nie.
Wynik └*	Szczegółowe informacje	Wynik raportu szczegółowych informacji.	Nie.
Stan └*	Azure.Core.Foundations.OperationState	Bieżący stan szczegółowych informacji.	Nie.
typ	wyliczenie	Możliwe wartości: Insight	Tak

InsightSummary

Podsumowanie analizy skupień błędów.

Name	Typ	Opis	Wymagane	Default
metoda	ciąg	Metoda stosowana do grupowania.	Tak
sampleCount	liczba całkowita	Łączna liczba przeanalizowanych próbek.	Tak
uniqueClusterCount	liczba całkowita	Łączna liczba unikatowych klastrów.	Tak
uniqueSubclusterCount	liczba całkowita	Łączna liczba unikatowych etykiet podklastrów.	Tak
użycie	obiekt	Użycie tokenu do analizy skupień	Tak
└* inputTokenUsage	liczba całkowita	Użycie tokenu wejściowego	Nie.
└} outputTokenUsage	liczba całkowita	Użycie tokenu wyjściowego	Nie.
└* totalTokenUsage	liczba całkowita	Całkowite użycie tokenów	Nie.

InsightType

Prośba o wglądy.

Majątek	Wartość
Typ	ciąg
Wartości	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadane dotyczące szczegółowych informacji.

Name	Typ	Opis	Wymagane	Default
completedAt	ciąg	Sygnatura czasowa, kiedy szczegółowe informacje zostały ukończone.	Nie.
createdAt	ciąg	Sygnatura czasowa utworzenia szczegółowych informacji.	Tak

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:

Wartość typu	Schema

Name	Typ	Opis	Wymagane	Default
typ	ciąg	Typ parametrów generowania elementu do użycia.	Tak

ManagedAzureAISearchIndex

Definicja indeksu wyszukiwania zarządzanej sztucznej inteligencji platformy Azure

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Rodzaj indeksu Możliwe wartości: ManagedAzureSearch	Tak

ManagedAzureAISearchIndexUpdate

Definicja indeksu wyszukiwania zarządzanej sztucznej inteligencji platformy Azure

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Rodzaj indeksu Możliwe wartości: ManagedAzureSearch	Tak

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:

Wartość typu	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg	Zawartość pamięci.	Tak
rodzaj	obiekt	Rodzaj elementu pamięci.	Tak
memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Tak
zakres	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Tak
updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Tak

MemoryItemKind

Rodzaj elementu pamięci.

Majątek	Wartość
Opis	Rodzaj elementu pamięci.
Typ	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	Opis	Wymagane	Default
rodzaj	obiekt	Rodzaj operacji pamięci.	Tak
memory_item	obiekt	Pojedynczy element pamięci przechowywany w magazynie pamięci, zawierający zawartość i metadane.	Tak
└─ zawartość	ciąg	Zawartość pamięci.	Nie.
Rodzaj └*	MemoryItemKind	Rodzaj elementu pamięci.	Nie.
└memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Nie.
Zakres └*	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Nie.
└updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Nie.

MemoryOperationKind

Rodzaj operacji pamięci.

Majątek	Wartość
Opis	Rodzaj operacji pamięci.
Typ	ciąg
Wartości	create update delete

MemorySearchItem

Pobrany element pamięci z wyszukiwania w pamięci.

Name	Typ	Opis	Wymagane	Default
memory_item	obiekt	Pojedynczy element pamięci przechowywany w magazynie pamięci, zawierający zawartość i metadane.	Tak
└─ zawartość	ciąg	Zawartość pamięci.	Nie.
Rodzaj └*	MemoryItemKind	Rodzaj elementu pamięci.	Nie.
└memory_id	ciąg	Unikatowy identyfikator elementu pamięci.	Nie.
Zakres └*	ciąg	Przestrzeń nazw, która logicznie grupuje i izoluje wspomnienia, na przykład identyfikator użytkownika.	Nie.
└updated_at	liczba całkowita	Czas ostatniej aktualizacji elementu pamięci.	Nie.

MemorySearchOptions

Opcje wyszukiwania w pamięci.

Name	Typ	Opis	Wymagane	Default
max_memories	liczba całkowita	Maksymalna liczba elementów pamięci do zwrócenia.	Nie.

MemorySearchTool

Narzędzie do integracji wspomnień z agentem.

Name	Typ	Opis	Wymagane	Default
memory_store_name	ciąg	Nazwa magazynu pamięci, który ma być używany.	Tak
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.	Tak
search_options	obiekt	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. Możliwe wartości: memory_search	Tak
update_delay	liczba całkowita	Czas oczekiwania przed aktualizacją wspomnień po braku aktywności (w sekundach). Domyślnie 300.	Nie.	300

MemorySearchToolCallItemParam

Name	Typ	Opis	Wymagane	Default
results	macierz	Wyniki zwrócone z wyszukiwania w pamięci.	Nie.
typ	wyliczenie	Możliwe wartości: memory_search_call	Tak

MemorySearchToolCallItemResource

Name	Typ	Opis	Wymagane	Default
results	macierz	Wyniki zwrócone z wyszukiwania w pamięci.	Nie.
stan	wyliczenie	Stan wywołania narzędzia wyszukiwania pamięci. Jeden z in_progress searching, completedlub incompletefailed, Możliwe wartości: in_progress, , searchingcompleted, , incompletefailed	Tak
typ	wyliczenie	Możliwe wartości: memory_search_call	Tak

MemoryStoreDefaultDefinition

Domyślna implementacja magazynu pamięci.

Name	Typ	Opis	Wymagane	Default
chat_model	ciąg	Nazwa lub identyfikator wdrożenia modelu uzupełniania czatu używanego do przetwarzania pamięci.	Tak
embedding_model	ciąg	Nazwa lub identyfikator wdrożenia modelu osadzania używanego do przetwarzania pamięci.	Tak
rodzaj	wyliczenie	Rodzaj magazynu pamięci. Możliwe wartości: default	Tak
options	obiekt	Domyślne konfiguracje magazynu pamięci.	Nie.
└chat_summary_enabled	typ logiczny (boolowski)	Określa, czy włączyć wyodrębnianie i przechowywanie podsumowań czatów. Wartość domyślna to true.	Nie.	Prawda
└user_profile_details	ciąg	Określone kategorie lub typy informacji o profilu użytkownika do wyodrębnienia i przechowywania.	Nie.
└user_profile_enabled	typ logiczny (boolowski)	Określa, czy włączyć wyodrębnianie i przechowywanie profilów użytkowników. Wartość domyślna to true.	Nie.	Prawda

MemoryStoreDefaultOptions

Domyślne konfiguracje magazynu pamięci.

Name	Typ	Opis	Wymagane	Default
chat_summary_enabled	typ logiczny (boolowski)	Określa, czy włączyć wyodrębnianie i przechowywanie podsumowań czatów. Wartość domyślna to true.	Tak	Prawda
user_profile_details	ciąg	Określone kategorie lub typy informacji o profilu użytkownika do wyodrębnienia i przechowywania.	Nie.
user_profile_enabled	typ logiczny (boolowski)	Określa, czy włączyć wyodrębnianie i przechowywanie profilów użytkowników. Wartość domyślna to true.	Tak	Prawda

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:

Wartość typu	Schema
default	MemoryStoreDefaultDefinition

Name	Typ	Opis	Wymagane	Default
rodzaj	obiekt	Typ implementacji magazynu pamięci, który ma być używany.	Tak

MemoryStoreDeleteScopeResponse

Odpowiedź na usunięcie wspomnień z zakresu.

Name	Typ	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)	Czy operacja usuwania zakończyła się pomyślnie.	Tak
nazwa	ciąg	Nazwa magazynu pamięci.	Tak
obiekt	wyliczenie	Typ obiektu. Zawsze "memory_store.scope.deleted". Możliwe wartości: memory_store.scope.deleted	Tak
zakres	ciąg	Zakres, z którego usunięto wspomnienia.	Tak

MemoryStoreKind

Typ implementacji magazynu pamięci, który ma być używany.

Majątek	Wartość
Opis	Typ implementacji magazynu pamięci, który ma być używany.
Typ	ciąg
Wartości	default

MemoryStoreObject

Magazyn pamięci, który może przechowywać i pobierać wspomnienia użytkownika.

Name	Typ	Opis	Wymagane	Default
utworzono_o	liczba całkowita	Uniksowy znacznik czasu (w sekundach), kiedy został utworzony magazyn pamięci.	Tak
definicja	obiekt	Podstawowa definicja konfiguracji magazynu pamięci.	Tak
Rodzaj └*	MemoryStoreKind	Rodzaj magazynu pamięci.	Nie.
opis	ciąg	Czytelny dla człowieka opis magazynu pamięci.	Nie.
identyfikator	ciąg	Niepowtarzalny identyfikator magazynu pamięci.	Tak
metadane	obiekt	Dowolne metadane klucz-wartość do skojarzenia z magazynem pamięci.	Nie.
nazwa	ciąg	Nazwa magazynu pamięci.	Tak
obiekt	wyliczenie	Typ obiektu, którym zawsze jest wartość "memory_store". Możliwe wartości: memory_store	Tak
updated_at	liczba całkowita	Uniksowy znacznik czasu (w sekundach) ostatniej aktualizacji magazynu pamięci.	Tak

MemoryStoreOperationUsage

Statystyki użycia operacji składnicy pamięci.

Name	Typ	Opis	Wymagane	Default
embedding_tokens	liczba całkowita	Liczba tokenów osadzania.	Tak
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Tak
input_tokens_details	obiekt	Szczegółowy podział tokenów wejściowych.	Tak
└cached_tokens	liczba całkowita	Liczba tokenów pobranych z pamięci podręcznej. Więcej informacji na temat buforowania monitów.	Nie.
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	Tak
output_tokens_details	obiekt	Szczegółowy podział tokenów wyjściowych.	Tak
└─ tokeny_rozumowania	liczba całkowita	Liczba tokenów rozumowania.	Nie.
total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Tak

MemoryStoreSearchResponse

Odpowiedź na wyszukiwanie w pamięci.

Name	Typ	Opis	Wymagane	Default
Wspomnienia	macierz	Powiązane elementy pamięci znalezione podczas operacji wyszukiwania.	Tak
search_id	ciąg	Unikatowy identyfikator tego żądania wyszukiwania. Użyj tej wartości jako previous_search_id w kolejnych żądaniach, aby przeprowadzić wyszukiwania przyrostowe.	Tak
użycie	obiekt	Statystyki użycia operacji składnicy pamięci.	Tak
└embedding_tokens	liczba całkowita	Liczba tokenów osadzania.	Nie.
└input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Nie.
└input_tokens_details	obiekt	Szczegółowy podział tokenów wejściowych.	Nie.
└cached_tokens	liczba całkowita	Liczba tokenów pobranych z pamięci podręcznej. Więcej informacji na temat buforowania monitów.	Nie.
└─ tokeny_wyjściowe	liczba całkowita	Liczba tokenów wyjściowych.	Nie.
└output_tokens_details	obiekt	Szczegółowy podział tokenów wyjściowych.	Nie.
└─ tokeny_rozumowania	liczba całkowita	Liczba tokenów rozumowania.	Nie.
└total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Nie.

MemoryStoreUpdateCompletedResult

Wynik aktualizacji pamięci.

Name	Typ	Opis	Wymagane	Default
memory_operations	macierz	Lista poszczególnych operacji na pamięci, które zostały wykonane podczas aktualizacji.	Tak
użycie	obiekt	Statystyki użycia operacji składnicy pamięci.	Tak
└embedding_tokens	liczba całkowita	Liczba tokenów osadzania.	Nie.
└input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Nie.
└input_tokens_details	obiekt	Szczegółowy podział tokenów wejściowych.	Nie.
└cached_tokens	liczba całkowita	Liczba tokenów pobranych z pamięci podręcznej. Więcej informacji na temat buforowania monitów.	Nie.
└─ tokeny_wyjściowe	liczba całkowita	Liczba tokenów wyjściowych.	Nie.
└output_tokens_details	obiekt	Szczegółowy podział tokenów wyjściowych.	Nie.
└─ tokeny_rozumowania	liczba całkowita	Liczba tokenów rozumowania.	Nie.
└total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Nie.

MemoryStoreUpdateResponse

Określa stan operacji aktualizacji magazynu pamięci.

Name	Typ	Opis	Wymagane	Default
błąd	obiekt		Nie.
└* additionalInfo	obiekt		Nie.
└─ kod	ciąg		Nie.
└* debugInfo	obiekt		Nie.
└szczegóły	macierz		Nie.
└─ Komunikat	ciąg		Nie.
└* param	ciąg		Nie.
└typ	ciąg		Nie.
wynik	obiekt	Wynik aktualizacji pamięci.	Nie.
└memory_operations	macierz	Lista poszczególnych operacji na pamięci, które zostały wykonane podczas aktualizacji.	Nie.
└─ użycie	MemoryStoreOperationUsage	Statystyki użycia skojarzone z operacją aktualizacji pamięci.	Nie.
stan	obiekt	Stan operacji aktualizacji magazynu pamięci.	Tak
superseded_by	ciąg	update_id operacji została zastąpiona przez sytuację, w której stan jest "zastąpiony".	Nie.
update_id	ciąg	Unikatowy identyfikator tego żądania aktualizacji. Użyj tej wartości jako previous_update_id w kolejnych żądaniach, aby wykonać aktualizacje przyrostowe.	Tak

MemoryStoreUpdateStatus

Stan operacji aktualizacji magazynu pamięci.

Majątek	Wartość
Opis	Stan operacji aktualizacji magazynu pamięci.
Typ	ciąg
Wartości	queued in_progress completed failed superseded

MicrosoftFabricAgentTool

Informacje o definicji danych wejściowych narzędzia Microsoft Fabric używane do konfigurowania agenta.

Name	Typ	Opis	Wymagane	Default
fabric_dataagent_preview	obiekt	Parametry narzędzia agenta danych sieci szkieletowej.	Tak
└project_connections	macierz	Połączenia projektu dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Nie.
typ	wyliczenie	Typ obiektu, który jest zawsze "fabric_dataagent". Możliwe wartości: fabric_dataagent_preview	Tak

ModelDeployment

Definicja wdrożenia modelu

Name	Typ	Opis	Wymagane	Default
capabilities	obiekt	Możliwości wdrożonego modelu	Tak
connectionName (nazwa_połączenia)	ciąg	Nazwa połączenia, z którego pochodzi wdrożenie	Nie.
modelName	ciąg	Nazwa wdrożonego modelu specyficzna dla wydawcy	Tak
modelPublisher	ciąg	Nazwa wydawcy wdrożonego modelu	Tak
wersja modelu	ciąg	Wersja wdrożonego modelu specyficzna dla wydawcy	Tak
sku	obiekt	Informacje o jednostce SKU	Tak
Pojemność └*	liczba całkowita	Pojemność jednostki SKU	Nie.
Rodzina └*	ciąg	Rodzina SKU	Nie.
└─ nazwa	ciąg	Nazwa jednostki SKU	Nie.
└* rozmiar	ciąg	Rozmiar jednostki SKU	Nie.
Warstwa └*	ciąg	Warstwa jednostki SKU	Nie.
typ	wyliczenie	Typ wdrożenia Możliwe wartości: ModelDeployment	Tak

ModelSamplingParams

Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.

Name	Typ	Opis	Wymagane	Default
max_completion_tokens	liczba całkowita	Maksymalna liczba tokenów dozwolonych w zakończeniu.	Tak
seed	liczba całkowita	Losowe inicjatory do odtworzenia.	Tak
temperatura	Liczba	Parametr temperatury do próbkowania.	Tak
top_p	Liczba	Parametr top-p próbkowania jądra.	Tak

ModelSamplingParamsUpdate

Reprezentuje zestaw parametrów używanych do kontrolowania zachowania próbkowania modelu językowego podczas generowania tekstu.

Name	Typ	Opis	Wymagane	Default
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	Liczba	Parametr temperatury do próbkowania.	Nie.
top_p	Liczba	Parametr top-p próbkowania jądra.	Nie.

MonthlyRecurrenceSchedule

Miesięczny harmonogram cykli.

Name	Typ	Opis	Wymagane	Default
daysOfMonth	macierz	Dni miesiąca dla harmonogramu cyklu.	Tak
typ	wyliczenie	Typ cyklu miesięcznego. Możliwe wartości: Monthly	Tak

NoAuthenticationCredentials

Poświadczenia, które nie wymagają uwierzytelniania

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ poświadczeń Możliwe wartości: None	Tak

OAuthConsentRequestItemResource

Żądanie od usługi, aby użytkownik wykonał zgodę OAuth.

Name	Typ	Opis	Wymagane	Default
consent_link	ciąg	Link, za pomocą których użytkownik może wykonać zgodę OAuth.	Tak
identyfikator	ciąg		Tak
etykieta_serwera	ciąg	Etykieta serwera dla żądania zgody OAuth.	Tak
typ	wyliczenie	Możliwe wartości: oauth_consent_request	Tak

OneTimeTrigger

Jednorazowy spust.

Name	Typ	Opis	Wymagane	Default
strefa czasowa	ciąg	Strefa czasowa dla wyzwalacza jednorazowego.	Nie.	UTC
triggerAt	ciąg	Data i godzina jednorazowego wyzwolenia w formacie ISO 8601.	Tak
typ	wyliczenie	Możliwe wartości: OneTime	Tak

OpenAI.Annotation

Dyskryminator dla OpenAI.Annotation.

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

Wartość typu	Schema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.AnnotationType		Tak

OpenAI.AnnotationFileCitation

Cytat do pliku.

Name	Typ	Opis	Wymagane	Default
identyfikator_pliku	ciąg	Identyfikator pliku.	Tak
filename	ciąg	Nazwa pliku cytowanego.	Tak
indeks	liczba całkowita	Indeks pliku na liście plików.	Tak
typ	wyliczenie	Typ cytowania pliku. Zawsze file_citation. Możliwe wartości: file_citation	Tak

OpenAI.AnnotationFilePath

Ścieżka do pliku.

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

OpenAI.AnnotationType

Majątek	Wartość
Typ	ciąg
Wartości	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

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

Name	Typ	Opis	Wymagane	Default
end_index	liczba całkowita	Indeks ostatniego znaku cytatu adresu URL w komunikacie.	Tak
start_index	liczba całkowita	Indeks pierwszego znaku cytatu adresu URL w komunikacie.	Tak
title	ciąg	Tytuł zasobu internetowego.	Tak
typ	wyliczenie	Typ cytatu adresu URL. Zawsze url_citation. Możliwe wartości: url_citation	Tak
Adres URL	ciąg	Adres URL zasobu internetowego.	Tak

OpenAI.PrzybliżonaLokalizacja

Name	Typ	Opis	Wymagane	Default
city	ciąg		Nie.
country	ciąg		Nie.
region	ciąg		Nie.
timezone	ciąg		Nie.
typ	wyliczenie	Możliwe wartości: approximate	Tak

OpenAI.ChatCompletionTool

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

Name	Typ	Opis	Wymagane	Default
funkcja	OpenAI.FunctionObject		Tak
typ	wyliczenie	Typ narzędzia. Obecnie obsługiwany jest tylko function. Możliwe wartości: function	Tak

OpenAI.CodeInterpreterOutput

Dyskryminujące metody OpenAI.CodeInterpreterOutput

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

Wartość typu	Schema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.CodeInterpreterOutputType		Tak

OpenAI.CodeInterpreterOutputImage

Dane wyjściowe obrazu z interpretera kodu.

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ danych wyjściowych. Zawsze "obraz". Możliwe wartości: image	Tak
Adres URL	ciąg	Adres URL danych wyjściowych obrazu z interpretera kodu.	Tak

OpenAI.CodeInterpreterOutputLogs

Dane wyjściowe dzienników z interpretera kodu.

Name	Typ	Opis	Wymagane	Default
dzienniki	ciąg	Dane wyjściowe dzienników z interpretera kodu.	Tak
typ	wyliczenie	Typ danych wyjściowych. Zawsze "dzienniki". Możliwe wartości: logs	Tak

OpenAI.CodeInterpreterOutputType

Majątek	Wartość
Typ	ciąg
Wartości	logs image

OpenAI.CodeInterpreterTool

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

Name	Typ	Opis	Wymagane	Default
kontener	obiekt	Konfiguracja kontenera interpretera kodu. Opcjonalnie określ identyfikatory plików potrzebnych do uruchomienia kodu.	Tak
└ file_ids	macierz	Opcjonalna lista przesłanych plików, które mają być dostępne w Twoim kodzie.	Nie.
└typ	wyliczenie	Zawsze auto. Możliwe wartości: auto	Nie.
typ	wyliczenie	Typ narzędzia interpretera kodu. Zawsze code_interpreter. Możliwe wartości: code_interpreter	Tak

OpenAI.CodeInterpreterToolAuto

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

Name	Typ	Opis	Wymagane	Default
identyfikatory_plików	macierz	Opcjonalna lista przesłanych plików, które mają być dostępne w Twoim kodzie.	Nie.
typ	wyliczenie	Zawsze auto. Możliwe wartości: auto	Tak

OpenAI.CodeInterpreterToolCallItemParam

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Kod do uruchomienia lub wartość null, jeśli nie jest dostępny.	Tak
container_id	ciąg	Identyfikator kontenera używanego do uruchamiania kodu.	Tak
Wyniki	macierz	Dane wyjściowe generowane przez interpreter kodu, takie jak dzienniki lub obrazy. Może mieć wartość null, jeśli żadne dane wyjściowe nie są dostępne.	Tak
typ	wyliczenie	Możliwe wartości: code_interpreter_call	Tak

OpenAI.CodeInterpreterToolCallItemResource

Wywołanie narzędzia w celu uruchomienia kodu.

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Kod do uruchomienia lub wartość null, jeśli nie jest dostępny.	Tak
container_id	ciąg	Identyfikator kontenera używanego do uruchamiania kodu.	Tak
Wyniki	macierz	Dane wyjściowe generowane przez interpreter kodu, takie jak dzienniki lub obrazy. Może mieć wartość null, jeśli żadne dane wyjściowe nie są dostępne.	Tak
stan	wyliczenie	Możliwe wartości: in_progress, , completedincomplete, , interpretingfailed	Tak
typ	wyliczenie	Możliwe wartości: code_interpreter_call	Tak

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	Opis	Wymagane	Default
klucz	ciąg	Klucz do porównania z wartością.	Tak
typ	wyliczenie	Określa operator porównania: eq(równe), (nie równe), negt (większe niż), gte (większe lub równe), (mniejsze niż lub równe), ltlte (mniejsze lub równe). Możliwe wartości: eq, , negt, gte, , ltlte	Tak
wartość	ciąg lub liczba lub wartość logiczna		Tak

OpenAI.CompoundFilter

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

Name	Typ	Opis	Wymagane	Default
filters	macierz	Tablica filtrów do połączenia. Elementy mogą mieć wartość ComparisonFilter lub CompoundFilter.	Tak
typ	wyliczenie	Typ operacji: and lub or. Możliwe wartości: and, or	Tak

OpenAI.ComputerAction

Dyskryminujące dla openAI.ComputerAction

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

Wartość typu	Schema
click	OpenAI.ComputerActionClick
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionScroll
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionWait
keypress	OpenAI.ComputerActionKeyPress

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ComputerActionType		Tak

OpenAI.ComputerActionClick

Akcja kliknięcia.

Name	Typ	Opis	Wymagane	Default
przycisk	wyliczenie	Wskazuje, który przycisk myszy został naciśnięty podczas kliknięcia. leftJeden z , right, wheel, back, lub forward. Możliwe wartości: left, , rightwheel, , backforward	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji kliknięcia ta właściwość to zawsze ustawiony na click. Możliwe wartości: click	Tak
x	liczba całkowita	Współrzędna x, w której wystąpiło kliknięcie.	Tak
y	liczba całkowita	Współrzędna y, w której wystąpiło kliknięcie.	Tak

OpenAI.ComputerActionDoubleClick

Dwukrotne kliknięcie myszy.

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji dwukrotnego kliknięcia ta właściwość jest zawsze ustawiony na double_click. Możliwe wartości: double_click	Tak
x	liczba całkowita	Współrzędna x, w której wystąpiło dwukrotne kliknięcie.	Tak
y	liczba całkowita	Współrzędna y, w której wystąpiło dwukrotne kliknięcie.	Tak

OpenAI.ComputerActionDrag

Czynność przeciągania.

Name	Typ	Opis	Wymagane	Default
ścieżka	macierz	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>	Tak
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	Tak

OpenAI.ComputerActionKeyPress

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

Name	Typ	Opis	Wymagane	Default
keys	macierz	Kombinacja klawiszy, którą model żąda naciśnięcia. Jest to element tablica ciągów, z których każdy reprezentuje klucz.	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji keypress ta właściwość jest zawsze ustawiony na keypress. Możliwe wartości: keypress	Tak

OpenAI.ComputerActionMove

Akcja ruchu myszy.

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przenoszenia ta właściwość to zawsze ustawiony na move. Możliwe wartości: move	Tak
x	liczba całkowita	Współrzędna x, do której należy się przesunąć.	Tak
y	liczba całkowita	Współrzędna y, do której należy się przesunąć.	Tak

OpenAI.ComputerActionScreenshot

Akcja zrzutu ekranu.

Name	Typ	Opis	Wymagane	Default
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	Tak

OpenAI.ComputerActionScroll

Akcja przewijania.

Name	Typ	Opis	Wymagane	Default
scroll_x	liczba całkowita	Odległość przewijania poziomego.	Tak
scroll_y	liczba całkowita	Odległość przewijania w pionie.	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji przewijania ta właściwość to zawsze ustawiony na scroll. Możliwe wartości: scroll	Tak
x	liczba całkowita	Współrzędna x, w której wystąpiło przewijanie.	Tak
y	liczba całkowita	Współrzędna y, w której wystąpiło przewijanie.	Tak

OpenAI.ComputerActionType

Majątek	Wartość
Typ	ciąg
Wartości	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

Akcja wpisywania tekstu.

Name	Typ	Opis	Wymagane	Default
SMS	ciąg	Tekst do wpisania.	Tak
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji typu ta właściwość to zawsze ustawiony na type. Możliwe wartości: type	Tak

OpenAI.ComputerActionWait

Akcja oczekiwania.

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Określa typ zdarzenia. W przypadku akcji oczekiwania ta właściwość to zawsze ustawiony na wait. Możliwe wartości: wait	Tak

OpenAI.ComputerToolCallItemParam

Narzędzie wywołujące narzędzie do korzystania z komputera. Więcej informacji można znaleźć w podręczniku użytkowania komputera .

Name	Typ	Opis	Wymagane	Default
akcja	OpenAI.ComputerAction		Tak
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Tak
pending_safety_checks	macierz	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Tak
typ	wyliczenie	Możliwe wartości: computer_call	Tak

OpenAI.ComputerToolCallItemResource

Narzędzie wywołujące narzędzie do korzystania z komputera. Więcej informacji można znaleźć w podręczniku użytkowania komputera .

Name	Typ	Opis	Wymagane	Default
akcja	OpenAI.ComputerAction		Tak
call_id	ciąg	Identyfikator używany podczas odpowiadania na wywołanie narzędzia z danymi wyjściowymi.	Tak
pending_safety_checks	macierz	Oczekujące kontrole bezpieczeństwa dla wywołania komputera.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden zcompleted, lub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Możliwe wartości: computer_call	Tak

OpenAI.ComputerToolCallOutputItemOutput

Dyskryminujące dla openAI.ComputerToolCallOutputItemOutput

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

Wartość typu	Schema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ComputerToolCallOutputItemOutputType	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.	Tak

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	Typ	Opis	Wymagane	Default
identyfikator_pliku	ciąg		Nie.
image_url	ciąg		Nie.
typ	wyliczenie	Możliwe wartości: computer_screenshot	Tak

OpenAI.ComputerToolCallOutputItemOutputType

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

Majątek	Wartość
Opis	Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.
Typ	ciąg
Wartości	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

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

Name	Typ	Opis	Wymagane	Default
acknowledged_safety_checks	macierz	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.	Tak
We/Wy	OpenAI.ComputerToolCallOutputItemOutput		Tak
typ	wyliczenie	Możliwe wartości: computer_call_output	Tak

OpenAI.ComputerToolCallOutputItemResource

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

Name	Typ	Opis	Wymagane	Default
acknowledged_safety_checks	macierz	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.	Tak
We/Wy	OpenAI.ComputerToolCallOutputItemOutput		Tak
stan	wyliczenie	Stan elementu. in_progressJeden zcompleted, lub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Możliwe wartości: computer_call_output	Tak

OpenAI.ComputerToolCallSafetyCheck

Zaplanowana kontrola bezpieczeństwa dla komputerowego wezwania.

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Typ oczekującego sprawdzenia bezpieczeństwa.	Tak
identyfikator	ciąg	Identyfikator oczekującego sprawdzenia bezpieczeństwa.	Tak
komunikat	ciąg	Szczegółowe informacje na temat nadchodzących kontroli bezpieczeństwa.	Tak

OpenAI.NarzędziePodgląduUżytkowaniaKomputera

Narzędzie kontrolujące komputer wirtualny.

Name	Typ	Opis	Wymagane	Default
wysokość ekranu	liczba całkowita	Wysokość wyświetlacza komputera.	Tak
szerokość_wyświetlacza	liczba całkowita	Szerokość ekranu komputera.	Tak
środowisko	wyliczenie	Typ środowiska komputera do sterowania. Możliwe wartości: windows, , maclinux, , ubuntubrowser	Tak
typ	wyliczenie	Typ narzędzia do użycia komputera. Zawsze computer_use_preview. Możliwe wartości: computer_use_preview	Tak

OpenAI.ConversationItemList

Name	Typ	Opis	Wymagane	Default
dane	macierz		Tak
first_id	ciąg		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Tak
obiekt	wyliczenie	Możliwe wartości: list	Tak

OpenAI.ConversationResource

Name	Typ	Opis	Wymagane	Default
utworzono_o	liczba całkowita		Tak
identyfikator	ciąg	Unikalny identyfikator rozmowy.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze "konwersacją". Możliwe wartości: conversation	Tak

OpenAI.Coordinate

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

Name	Typ	Opis	Wymagane	Default
x	liczba całkowita	Współrzędna x.	Tak
y	liczba całkowita	Współrzędna y.	Tak

OpenAI.CreateConversationRequest

Tworzenie konwersacji

Name	Typ	Opis	Wymagane	Default
items	macierz	Początkowe elementy do uwzględnienia kontekstu konwersacji. Jednocześnie możesz dodać maksymalnie 20 elementów.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Opis	Wymagane	Default
wiadomości wejściowe	obiekt		Nie.
└item_reference	ciąg		Nie.
└─ szablon	macierz		Nie.
└typ	wyliczenie	Możliwe wartości: item_reference	Nie.
model	ciąg	Nazwa modelu do użycia do generowania uzupełniania (np. "o3-mini").	Nie.
parametry_próbowania	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Nie.
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└created_after	OpenAI.integer		Nie.
└created_before	OpenAI.integer		Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└* limit	OpenAI.integer		Nie.
Metadane └*	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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		Nie.
└typ	wyliczenie	Typ źródła. Zawsze stored_completions. Możliwe wartości: stored_completions	Nie.
typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze completions. Możliwe wartości: completions	Tak

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Typ	Opis	Wymagane	Default
item_reference	ciąg		Tak
typ	wyliczenie	Możliwe wartości: item_reference	Tak

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Typ	Opis	Wymagane	Default
szablon	macierz		Tak
typ	wyliczenie	Możliwe wartości: template	Tak

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Typ	Opis	Wymagane	Default
max_completion_tokens	OpenAI.integer		Nie.
wysiłek rozumowania	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
format_odpowiedzi	obiekt	Domyślny format odpowiedzi. Służy do generowania odpowiedzi tekstowych.	Nie.
└json_schema	obiekt	Opcje konfiguracji danych wyjściowych ze strukturą, w tym schemat JSON.	Nie.
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.	Nie.
Schemat └*	obiekt		Nie.
└* ścisłe	typ logiczny (boolowski)	Czy włączyć ścisłe przestrzeganie schematu podczas generowania danych wyjściowych. W przypadku ustawienia wartości true model będzie zawsze przestrzegał dokładnego zdefiniowanego schematu W polu schema. Tylko podzbiór schematu JSON jest obsługiwany, gdy Parametr strict ma wartość true. Aby dowiedzieć się więcej, przeczytaj ustrukturyzowane dane wyjściowe przewodnik.	Nie.	Nieprawda
└typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze json_object. Możliwe wartości: json_object	Nie.
seed	obiekt		Nie.
temperatura	obiekt		Nie.
narzędzia	macierz		Nie.
top_p	obiekt		Nie.

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	Opis	Wymagane	Default
uwzględnij_przykładowy_schemat	typ logiczny (boolowski)	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.	Tak
typ	wyliczenie	Typ źródła danych. Zawsze custom. Możliwe wartości: custom	Tak

OpenAI.CreateEvalJsonlRunDataSource

Obiekt JsonlRunDataSource, który określa plik JSONL odpowiadający ewaluacji.

Name	Typ	Opis	Wymagane	Default
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└typ	wyliczenie	Typ źródła jsonl. Zawsze file_id. Możliwe wartości: file_id	Nie.
typ	wyliczenie	Typ źródła danych. Zawsze jsonl. Możliwe wartości: jsonl	Tak

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	Opis	Wymagane	Default
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	Tak

OpenAI.CreateEvalResponsesRunDataSource

Obiekt ResponsesRunDataSource opisujący konfigurację próbkowania modelu.

Name	Typ	Opis	Wymagane	Default
wiadomości wejściowe	obiekt		Nie.
└item_reference	ciąg		Nie.
└─ szablon	macierz		Nie.
└typ	wyliczenie	Możliwe wartości: item_reference	Nie.
model	ciąg	Nazwa modelu do użycia do generowania uzupełniania (np. "o3-mini").	Nie.
parametry_próbowania	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Nie.
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└created_after	OpenAI.integer		Nie.
└created_before	OpenAI.integer		Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└instructions_search	ciąg		Nie.
Metadane └*	obiekt		Nie.
Model └*	ciąg		Nie.
└reasoning_effort	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
└* temperatura	OpenAI.numeric		Nie.
└─ Narzędzia	macierz		Nie.
└─top_p	OpenAI.numeric		Nie.
└typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze responses. Możliwe wartości: responses	Nie.
Użytkownicy └*	macierz		Nie.
typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze responses. Możliwe wartości: responses	Tak

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Typ	Opis	Wymagane	Default
item_reference	ciąg		Tak
typ	wyliczenie	Możliwe wartości: item_reference	Tak

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Typ	Opis	Wymagane	Default
szablon	macierz		Tak
typ	wyliczenie	Możliwe wartości: template	Tak

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Typ	Opis	Wymagane	Default
max_completion_tokens	OpenAI.integer		Nie.
wysiłek rozumowania	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
seed	obiekt		Nie.
temperatura	obiekt		Nie.
SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Nie.
narzędzia	macierz		Nie.
top_p	obiekt		Nie.

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Typ	Opis	Wymagane	Default
format	OpenAI.TextResponseFormatConfiguration	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } włącza dane wyjściowe ze strukturą, zapewnia, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w 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

Przestarzałe na rzecz logsDataSourceConfig.

Name	Typ	Opis	Wymagane	Default
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	Tak

OpenAI.CreateFineTuningJobRequest

Prawidłowe modele:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Typ	Opis	Wymagane	Default
hiperparametry	obiekt	Hiperparametry używane do zadania dostrajania. Ta wartość jest teraz przestarzała na rzecz parametru methodi powinna zostać przekazana w parametrze method .	Nie.
└batch_size	wyliczenie	Możliwe wartości: auto	Nie.
└learning_rate_multiplier	wyliczenie	Możliwe wartości: auto	Nie.
└n_epochs	wyliczenie	Możliwe wartości: auto	Nie.
Integracje	macierz	Lista integracji umożliwiających dostrajanie zadania.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
seed	liczba całkowita	Nasiono kontroluje reproduktywność procesu. Przekazywanie tych samych parametrów nasion i zadania powinno generować te same wyniki, ale mogą się różnić w rzadkich przypadkach. Jeśli ziarno nie zostanie określone, zostanie wygenerowane dla Ciebie.	Nie.
przyrostek	ciąg	Ciąg zawierający maksymalnie 64 znaki, które zostaną dodane do precyzyjnej nazwy modelu. Na przykład wartość suffix "custom-model-name" spowoduje wygenerowanie nazwy modelu, takiej jak ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Nie.	Żaden
plik szkoleniowy	ciąg	Identyfikator przekazanego pliku zawierającego dane szkoleniowe. Zestaw danych musi być sformatowany jako plik JSONL. Ponadto należy przekazać 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 .	Tak
plik walidacji	ciąg	Identyfikator przekazanego pliku zawierającego dane walidacji. Jeśli podasz ten plik, dane są używane do generowania walidacji metryki okresowo podczas dostrajania. Te metryki można wyświetlić w programie plik wyników dostrajania. Te same dane nie powinny być obecne zarówno w plikach trenowania, jak i sprawdzania poprawności. 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.CreateFineTuningJobRequestIntegration

Dyskryminowanie dla elementu OpenAI.CreateFineTuningJobRequestIntegration

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

Wartość typu	Schema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	Typ	Opis	Wymagane	Default
typ	ciąg (zobacz prawidłowe modele poniżej)		Tak

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: wandb	Tak
wandb	obiekt		Tak
Jednostka └*	ciąg		Nie.
└─ nazwa	ciąg		Nie.
└* projekt	ciąg		Nie.
Tagi └*	macierz		Nie.

OpenAI.CreateResponse

Name	Typ	Opis	Wymagane	Default
agent	obiekt		Nie.
└─ nazwa	ciąg	Nazwa agenta.	Nie.
└typ	wyliczenie	Możliwe wartości: agent_reference	Nie.
└* wersja	ciąg	Identyfikator wersji agenta.	Nie.
tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
konwersacja	obiekt		Nie.
└─ ID	ciąg		Nie.
include	macierz	Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to: - code_interpreter_call.outputs: zawiera dane wyjściowe wykonywania kodu w języku Python w elementy wywołania narzędzia interpretera kodu. - computer_call_output.output.image_url: dołącz adresy URL obrazów z wyników procesu komputerowego. - file_search_call.results: uwzględnij wyniki wyszukiwania wywołanie narzędzia wyszukiwania plików. - message.input_image.image_url: dołącz adresy URL obrazów z komunikatu wejściowego. - message.output_text.logprobs: dołączanie logprobs z komunikatami asystenta. - reasoning.encrypted_content: zawiera zaszyfrowaną wersję rozumowania tokeny w danych wyjściowych elementu rozumowania. Dzięki temu elementy rozumowania mogą być używane w programie konwersacje wieloetapowe przy bezstanowym korzystaniu z interfejsu API Odpowiedzi (na przykład gdy store parametr jest ustawiony na false lub gdy organizacja jest zapisane w programie nieprzechowywania żadnych danych).	Nie.
dane wejściowe	ciąg lub tablica		Nie.
instructions	ciąg	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
monit	obiekt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└─ ID	ciąg	Unikatowy identyfikator szablonu monitu do użycia.	Nie.
Zmienne └*	OpenAI.ResponsePromptVariables	Opcjonalna mapa wartości, które mają być zastępowane zmiennymi w monit. Wartości podstawienia mogą być ciągami lub innymi Typy danych wejściowych odpowiedzi, takie jak obrazy lub pliki.	Nie.
└* wersja	ciąg	Opcjonalna wersja szablonu monitu.	Nie.
reasoning	obiekt	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└─ wysiłek	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
└─ generuj_podsumowanie	wyliczenie	Przestarzałe: użyj summary zamiast. Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.
└─ Podsumowanie	wyliczenie	Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.
poziom usługi	obiekt	Określa typ przetwarzania używany do obsługi żądania. * Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowane w ustawieniach programu Project. Jeśli nie skonfigurowano inaczej, projekt będzie używać wartości domyślnej. * Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardu ceny i wydajność wybranego modelu. * W przypadku ustawienia na wartość "flex" lub "priorytet", a następnie żądanie zostanie przetworzone z odpowiednią usługą kondygnacja. Skontaktuj się ze sprzedażą , aby dowiedzieć się więcej o przetwarzaniu priorytetu. * Jeśli nie ustawiono, domyślne zachowanie to "auto". Po ustawieniu parametru service_tier treść odpowiedzi będzie zawierać wartość service_tier wartość oparta na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może się różnić od wartości ustawionej w parametrze .	Nie.
przechowywać	typ logiczny (boolowski)	Czy zapisać wygenerowaną odpowiedź modelu do późniejszego pobrania? API.	Nie.	Prawda
odtwarzać strumieniowo	typ logiczny (boolowski)	W przypadku ustawienia wartości true dane odpowiedzi modelu będą przesyłane strumieniowo do klienta generowane przy użyciu zdarzeń wysyłanych przez serwer. aby uzyskać więcej informacji.	Nie.	Nieprawda
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	Liczba	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	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
tool_choice	obiekt	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 wiadomości a wykonywaniem połączenia więcej narzędzi required oznacza, że model musi wywoływać co najmniej jedno narzędzie.	Nie.
└typ	OpenAI.ToolChoiceObjectType	Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.	Nie.
narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: - Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie plików. - Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu.	Nie.
top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
top_p	Liczba	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
truncation	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. Możliwe wartości: auto, disabled	Nie.
użytkownik	ciąg	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.

OpenAI.DeletedConversationResource

Name	Typ	Opis	Wymagane	Default
usunięta	typ logiczny (boolowski)		Tak
identyfikator	ciąg		Tak
obiekt	wyliczenie	Możliwe wartości: conversation.deleted	Tak

OpenAI.EasyInputMessage

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg lub tablica		Tak
rola	ciąg		Tak

OpenAI.Error

Name	Typ	Opis	Wymagane	Default
dodatkoweInformacje	obiekt		Nie.
kod	ciąg		Tak
debugInfo (Informacje o debugu)	obiekt		Nie.
details	macierz		Nie.
komunikat	ciąg		Tak
param	ciąg		Tak
typ	ciąg		Tak

OpenAI.EvalApiError

Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Kod błędu.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak

OpenAI.EvalGraderLabelModel

Name	Typ	Opis	Wymagane	Default
dane wejściowe	macierz		Tak
labels	macierz	Etykiety do przypisania do każdego elementu w ocenie.	Tak
model	ciąg	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
przechodzące_etykiety	macierz	Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: label_model	Tak

OpenAI.EvalGraderPython

Name	Typ	Opis	Wymagane	Default
image_tag	ciąg	Tag obrazu do użycia dla skryptu języka Python.	Nie.
nazwa	ciąg	Nazwa oceniającego.	Tak
próg zaliczenia	obiekt		Nie.
przesłać źródło	ciąg	Kod źródłowy skryptu języka Python.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze python. Możliwe wartości: python	Tak

OpenAI.EvalGraderScoreModel

Name	Typ	Opis	Wymagane	Default
dane wejściowe	macierz	Tekst wejściowy. Może to obejmować ciągi szablonu.	Tak
model	ciąg	Model do użycia do oceny.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
próg zaliczenia	obiekt		Nie.
zakres	macierz	Zakres wyniku Wartość domyślna to [0, 1].	Nie.
parametry_próbowania	obiekt		Nie.
└max_completions_tokens	OpenAI.integer		Nie.
└reasoning_effort	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
└─ nasion	OpenAI.integer		Nie.
└* temperatura	OpenAI.numeric		Nie.
└─top_p	OpenAI.numeric		Nie.
typ	wyliczenie	Typ obiektu, który jest zawsze score_model. Możliwe wartości: score_model	Tak

OpenAI.EvalGraderScoreModelSamplingParams

Name	Typ	Opis	Wymagane	Default
max_completions_tokens	obiekt		Nie.
wysiłek rozumowania	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
seed	obiekt		Nie.
temperatura	obiekt		Nie.
top_p	obiekt		Nie.

OpenAI.EvalGraderStringCheck

Name	Typ	Opis	Wymagane	Default
dane wejściowe	ciąg	Tekst wejściowy. Może to obejmować ciągi szablonu.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
operacja	wyliczenie	Operacja sprawdzania ciągów, którą należy wykonać. eqJeden z , ne, likelub ilike. Możliwe wartości: eq, , ne, likeilike	Tak
odwołanie	ciąg	Tekst odwołania. Może to obejmować ciągi szablonu.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze string_check. Możliwe wartości: string_check	Tak

OpenAI.EvalGraderTextSimilarity

Name	Typ	Opis	Wymagane	Default
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	Tak
dane wejściowe	ciąg	Tekst jest oceniany.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
próg zaliczenia	obiekt		Tak
odwołanie	ciąg	Tekst oceniany względem.	Tak
typ	wyliczenie	Typ klasyra. Możliwe wartości: text_similarity	Tak

OpenAI.EvalItem

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	Opis	Wymagane	Default
zawartość	obiekt	Wprowadzanie tekstu do modelu.	Tak
└─ dane	ciąg	Dane audio zakodowane w formacie Base64.	Nie.
└* szczegóły	ciąg		Nie.
Format └─	wyliczenie	Format danych audio. Obecnie obsługiwane formaty to mp3 i wav. Możliwe wartości: mp3, wav	Nie.
└image_url	ciąg		Nie.
└* tekst	ciąg		Nie.
└typ	wyliczenie	Typ elementu wejściowego. Zawsze input_audio. Możliwe wartości: input_audio	Nie.
rola	wyliczenie	Rola wejścia komunikatu. userJeden z, assistant, system lub developer. Możliwe wartości: user, , assistant, systemdeveloper	Tak
typ	wyliczenie	Typ danych wejściowych komunikatu. Zawsze message. Możliwe wartości: message	Nie.

OpenAI.EvalItemContentInputImage

Name	Typ	Opis	Wymagane	Default
detail	ciąg		Nie.
image_url	ciąg		Tak
typ	wyliczenie	Możliwe wartości: input_image	Tak

OpenAI.EvalItemContentOutputText

Name	Typ	Opis	Wymagane	Default
SMS	ciąg		Tak
typ	wyliczenie	Możliwe wartości: output_text	Tak

OpenAI.EvalJsonlFileContentSource

Name	Typ	Opis	Wymagane	Default
zawartość	macierz	Zawartość pliku jsonl.	Tak
typ	wyliczenie	Typ źródła jsonl. Zawsze file_content. Możliwe wartości: file_content	Tak

OpenAI.EvalJsonlFileContentSourceContent

Name	Typ	Opis	Wymagane	Default
element	obiekt		Tak
próbka	obiekt		Nie.

OpenAI.EvalJsonlFileIdSource

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Identyfikator pliku.	Tak
typ	wyliczenie	Typ źródła jsonl. Zawsze file_id. Możliwe wartości: file_id	Tak

OpenAI.EvalResponsesSource

Obiekt EvalResponsesSource opisujący konfigurację uruchamiania źródła danych.

Name	Typ	Opis	Wymagane	Default
stworzone_po	obiekt		Nie.
utworzone_przed	obiekt		Nie.
instructions_search	ciąg		Nie.
metadane	obiekt		Nie.
model	ciąg		Nie.
wysiłek rozumowania	obiekt	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
temperatura	obiekt		Nie.
narzędzia	macierz		Nie.
top_p	obiekt		Nie.
typ	wyliczenie	Typ uruchomionego źródła danych. Zawsze responses. Możliwe wartości: responses	Tak
users	macierz		Nie.

OpenAI.EvalRunOutputItemSample

Name	Typ	Opis	Wymagane	Default
błąd	OpenAI.EvalApiError	Obiekt reprezentujący odpowiedź o błędzie z interfejsu API Eval.	Tak
powód zakończenia	ciąg		Tak
dane wejściowe	macierz		Tak
max_completion_tokens	OpenAI.integer		Tak
model	ciąg		Tak
We/Wy	macierz		Tak
seed	OpenAI.integer		Tak
temperatura	OpenAI.numeric		Tak
top_p	OpenAI.numeric		Tak
użycie	OpenAI.EvalRunOutputItemSampleUsage		Tak

OpenAI.EvalRunOutputItemSampleInput

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg		Tak
rola	ciąg		Tak

OpenAI.EvalRunOutputItemSampleOutput

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg		Nie.
rola	ciąg		Nie.

OpenAI.EvalRunOutputItemSampleUsage

Name	Typ	Opis	Wymagane	Default
cached_tokens	OpenAI.integer		Tak
completion_tokens	OpenAI.integer		Tak
prompt_tokens	OpenAI.integer		Tak
total_tokens	OpenAI.integer		Tak

OpenAI.EvalRunPerModelUsage

Name	Typ	Opis	Wymagane	Default
cached_tokens	OpenAI.integer		Tak
completion_tokens	OpenAI.integer		Tak
invocation_count	OpenAI.integer		Tak
model_name	ciąg		Tak
prompt_tokens	OpenAI.integer		Tak
total_tokens	OpenAI.integer		Tak

OpenAI.EvalRunPerTestingCriteriaResults

Name	Typ	Opis	Wymagane	Default
niepowodzenie	OpenAI.integer		Tak
Przekazywane	OpenAI.integer		Tak
kryteria_testowe	ciąg		Tak

OpenAI.EvalRunResultCounts

Name	Typ	Opis	Wymagane	Default
błąd	OpenAI.integer		Tak
niepowodzenie	OpenAI.integer		Tak
Przekazywane	OpenAI.integer		Tak
łączny	OpenAI.integer		Tak

OpenAI.EvalStoredCompletionsSource

Konfiguracja StoredCompletionsRunDataSource opisująca zestaw filtrów

Name	Typ	Opis	Wymagane	Default
stworzone_po	obiekt		Nie.
utworzone_przed	obiekt		Nie.
limit	obiekt		Nie.
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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		Nie.
typ	wyliczenie	Typ źródła. Zawsze stored_completions. Możliwe wartości: stored_completions	Tak

OpenAI.FileSearchTool

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

Name	Typ	Opis	Wymagane	Default
filters	obiekt		Nie.
maks_liczba_wyników	liczba całkowita	Maksymalna liczba wyników do zwrócenia. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.	Nie.
opcje rankingu	obiekt		Nie.
└} ranker	wyliczenie	Klasyfikator używany do wyszukiwania plików. Możliwe wartości: auto, default-2024-11-15	Nie.
└─ próg_punktowy	Liczba	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	Tak
identyfikatory_sklepu_wektorów	macierz	Identyfikatory wektorów są przechowywane do wyszukiwania.	Tak

OpenAI.FileSearchToolCallItemParam

Wyniki wywołania narzędzia wyszukiwania plików. Więcej informacji można znaleźć w przewodniku wyszukiwania plików .

Name	Typ	Opis	Wymagane	Default
queries	macierz	Zapytania używane do wyszukiwania plików.	Tak
results	macierz	Wyniki wywołania narzędzia wyszukiwania plików.	Nie.
typ	wyliczenie	Możliwe wartości: file_search_call	Tak

OpenAI.FileSearchToolCallItemResource

Wyniki wywołania narzędzia wyszukiwania plików. Więcej informacji można znaleźć w przewodniku wyszukiwania plików .

Name	Typ	Opis	Wymagane	Default
queries	macierz	Zapytania używane do wyszukiwania plików.	Tak
results	macierz	Wyniki wywołania narzędzia wyszukiwania plików.	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	Tak
typ	wyliczenie	Możliwe wartości: file_search_call	Tak

OpenAI.Filters

Name	Typ	Opis	Wymagane	Default
filters	macierz	Tablica filtrów do połączenia. Elementy mogą mieć wartość ComparisonFilter lub CompoundFilter.	Tak
klucz	ciąg	Klucz do porównania z wartością.	Tak
typ	wyliczenie	Typ operacji: and lub or. Możliwe wartości: and, or	Tak
wartość	ciąg lub liczba lub wartość logiczna	Wartość do porównania z kluczem atrybutu; obsługuje typy ciągów, liczb lub wartości logicznych.	Tak

OpenAI.FineTuneDPOHyperparameters

Hiperparametry używane do zadania dostrajania obiektu DPO.

Name	Typ	Opis	Wymagane	Default
rozmiar partii	wyliczenie	Możliwe wartości: auto	Nie.
wersja beta	wyliczenie	Możliwe wartości: auto	Nie.
mnożnik szybkości uczenia	wyliczenie	Możliwe wartości: auto	Nie.
n_epochs (liczba epok)	wyliczenie	Możliwe wartości: auto	Nie.

OpenAI.FineTuneDPOMethod

Konfiguracja metody dostrajania obiektu DPO.

Name	Typ	Opis	Wymagane	Default
hiperparametry	OpenAI.FineTuneDPOHyperparameters	Hiperparametry używane do zadania dostrajania obiektu DPO.	Nie.

OpenAI.FineTuneMethod

Metoda używana do dostrajania.

Name	Typ	Opis	Wymagane	Default
dpo	OpenAI.FineTuneDPOMethod	Konfiguracja metody dostrajania obiektu DPO.	Nie.
Zbrojenia	OpenAI.FineTuneReinforcementMethod	Konfiguracja metody dostrajania wzmocnienia.	Nie.
Nadzorowany	OpenAI.FineTuneSupervisedMethod	Konfiguracja nadzorowanej metody dostrajania.	Nie.
typ	wyliczenie	Typ metody. Ma wartość supervised, dpolub reinforcement. Możliwe wartości: supervised, , dporeinforcement	Tak

OpenAI.FineTuneReinforcementHyperparameters

Hiperparametry używane do zadania dostrajania wzmocnienia.

Name	Typ	Opis	Wymagane	Default
rozmiar partii	wyliczenie	Możliwe wartości: auto	Nie.
compute_multiplier	wyliczenie	Możliwe wartości: auto	Nie.
eval_interval	wyliczenie	Możliwe wartości: auto	Nie.
eval_samples	wyliczenie	Możliwe wartości: auto	Nie.
mnożnik szybkości uczenia	wyliczenie	Możliwe wartości: auto	Nie.
n_epochs (liczba epok)	wyliczenie	Możliwe wartości: auto	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	Opis	Wymagane	Default
Równiarka	obiekt	Obiekt StringCheckGrader, który wykonuje porównanie ciągów między danymi wejściowymi i odwołaniami przy użyciu określonej operacji.	Tak
└calculate_output	ciąg	Formuła do obliczenia danych wyjściowych na podstawie wyników klasyra.	Nie.
└evaluation_metric	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	Nie.
└* klasy	OpenAI.GraderStringCheck lub OpenAI.GraderTextSimilarity lub OpenAI.GraderPython lub OpenAI.GraderScoreModel lub OpenAI.GraderLabelModel	Obiekt StringCheckGrader, który wykonuje porównanie ciągów między danymi wejściowymi i odwołaniami przy użyciu określonej operacji.	Nie.
└image_tag	ciąg	Tag obrazu do użycia dla skryptu języka Python.	Nie.
└─ Wejście	macierz	Tekst wejściowy. Może to obejmować ciągi szablonu.	Nie.
Model └*	ciąg	Model do użycia do oceny.	Nie.
└─ nazwa	ciąg	Nazwa oceniającego.	Nie.
Operacja └*	wyliczenie	Operacja sprawdzania ciągów, którą należy wykonać. eqJeden z , ne, likelub ilike. Możliwe wartości: eq, , ne, likeilike	Nie.
Zakres └*	macierz	Zakres wyniku Wartość domyślna to [0, 1].	Nie.
└— odwołanie	ciąg	Tekst oceniany względem.	Nie.
└parametry_próbkowania	OpenAI.EvalGraderScoreModelSamplingParams	Parametry próbkowania dla modelu.	Nie.
└— źródło	ciąg	Kod źródłowy skryptu języka Python.	Nie.
└typ	wyliczenie	Typ obiektu, który jest zawsze multi. Możliwe wartości: multi	Nie.
hiperparametry	OpenAI.FineTuneReinforcementHyperparameters	Hiperparametry używane do zadania dostrajania wzmocnienia.	Nie.

OpenAI.FineTuneSupervisedHyperparameters

Hiperparametry używane do zadania dostrajania.

Name	Typ	Opis	Wymagane	Default
rozmiar partii	wyliczenie	Możliwe wartości: auto	Nie.
mnożnik szybkości uczenia	wyliczenie	Możliwe wartości: auto	Nie.
n_epochs (liczba epok)	wyliczenie	Możliwe wartości: auto	Nie.

OpenAI.FineTuneSupervisedMethod

Konfiguracja nadzorowanej metody dostrajania.

Name	Typ	Opis	Wymagane	Default
hiperparametry	OpenAI.FineTuneSupervisedHyperparameters	Hiperparametry używane do zadania dostrajania.	Nie.

OpenAI.FineTuningIntegration

Dyskryminowanie dla openAI.FineTuningIntegration

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

Wartość typu	Schema
wandb	OpenAI.FineTuningIntegrationWandb

Name	Typ	Opis	Wymagane	Default
typ	ciąg (zobacz prawidłowe modele poniżej)		Tak

OpenAI.FineTuningIntegrationWandb

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ włączonej integracji dla zadania dostrajania Możliwe wartości: wandb	Tak
wandb	obiekt	Ustawienia integracji z wagami i uprzedzeniami. Ten ładunek określa projekt, który metryki zostaną wysłane do. Opcjonalnie możesz ustawić jawną nazwę wyświetlaną przebiegu, dodać tagi na przebieg i ustaw domyślną jednostkę (zespół, nazwę użytkownika itp.), która ma być skojarzona z przebiegiem.	Tak
Jednostka └*	ciąg	Jednostka do użycia na potrzeby przebiegu. Dzięki temu możesz ustawić zespół lub nazwę użytkownika platformy WandB, którego chcesz uruchomić podobnie jak skojarzone z przebiegiem. Jeśli nie zostanie ustawiona, zostanie użyta domyślna jednostka zarejestrowanego klucza interfejsu API WandB.	Nie.
└─ nazwa	ciąg	Nazwa wyświetlana ustawiona dla przebiegu. Jeśli nie zostanie ustawiona, użyjemy identyfikatora zadania jako nazwy.	Nie.
└* projekt	ciąg	Nazwa projektu, w ramach którego zostanie utworzone nowe uruchomienie.	Nie.
Tagi └*	macierz	Lista tagów do dołączenia do nowo utworzonego przebiegu. Te tagi są przekazywane bezpośrednio do usługi WandB. Some tagi domyślne są generowane przez interfejs OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Nie.

OpenAI.FineTuningJob

Obiekt fine_tuning.job reprezentuje zadanie dostrajania, które zostało utworzone za pośrednictwem interfejsu API.

Name	Typ	Opis	Wymagane	Default
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia zadania dostrajania.	Tak
błąd	obiekt	W przypadku zadań dostrajania, które mają failedparametr , będzie to zawierać więcej informacji na temat przyczyny awarii.	Tak
└─ kod	ciąg	Kod błędu czytelny dla maszyny.	Nie.
└─ Komunikat	ciąg	Czytelny dla człowieka komunikat o błędzie.	Nie.
└* param	ciąg	Parametr, który był nieprawidłowy, zwykle training_file lub validation_file. To pole będzie miało wartość null, jeśli błąd nie był specyficzny dla parametru.	Nie.
szacowany czas zakończenia	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu zakończenia zadania dostrajania. Wartość będzie mieć wartość null, jeśli zadanie dostrajania szczegółowego nie jest uruchomione.	Nie.
fine_tuned_model	ciąg	Nazwa tworzonego modelu. Wartość będzie mieć wartość null, jeśli zadanie dostrajania jest nadal uruchomione.	Tak
zakończono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu zakończenia zadania dostrajania. Wartość będzie mieć wartość null, jeśli zadanie dostrajania jest nadal uruchomione.	Tak
hiperparametry	obiekt	Hiperparametry używane do zadania dostrajania. Ta wartość zostanie zwrócona tylko podczas uruchamiania supervised zadań.	Tak
└batch_size	wyliczenie	Możliwe wartości: auto	Nie.
└learning_rate_multiplier	wyliczenie	Możliwe wartości: auto	Nie.
└n_epochs	wyliczenie	Możliwe wartości: auto	Nie.
identyfikator	ciąg	Identyfikator obiektu, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
Integracje	macierz	Lista integracji umożliwiających wykonanie tego zadania dostrajania.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
metoda	OpenAI.FineTuneMethod	Metoda używana do dostrajania.	Nie.
model	ciąg	Model podstawowy, który jest dostrojony.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze "fine_tuning.job". Możliwe wartości: fine_tuning.job	Tak
organization_id	ciąg	Organizacja, która jest właścicielem zadania dostrajania.	Tak
pliki_wynikowe	macierz	Skompilowane identyfikatory plików wyników dla zadania dostrajania. Wyniki można pobrać za pomocą interfejsu API plików.	Tak
seed	liczba całkowita	Nasiono używane do działania dostrajania.	Tak
stan	wyliczenie	Bieżący stan zadania dostrajania, które może mieć validating_fileswartość , , queued, running, succeeded, failedlub cancelled. Możliwe wartości: validating_files, , queuedrunning, succeeded, , failedcancelled	Tak
tokeny szkoleniowe	liczba całkowita	Łączna liczba rozliczanych tokenów przetworzonych przez to zadanie dostrajania. Wartość będzie mieć wartość null, jeśli zadanie dostrajania jest nadal uruchomione.	Tak
plik szkoleniowy	ciąg	Identyfikator pliku używany do trenowania. Dane szkoleniowe można pobrać za pomocą interfejsu API plików.	Tak
user_provided_suffix	ciąg	Sufiks opisowy zastosowany do zadania, jak określono w żądaniu tworzenia zadania.	Nie.
plik walidacji	ciąg	Identyfikator pliku używany do walidacji. Wyniki weryfikacji można pobrać za pomocą interfejsu API plików.	Tak

OpenAI.FineTuningJobCheckpoint

Obiekt fine_tuning.job.checkpoint reprezentuje punkt kontrolny modelu dla zadania dostrajania, które jest gotowe do użycia.

Name	Typ	Opis	Wymagane	Default
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia punktu kontrolnego.	Tak
punkt kontrolny modelu dostrojonego	ciąg	Nazwa utworzonego modelu punktów kontrolnych.	Tak
identyfikator_zadania_dostrajania	ciąg	Nazwa zadania dostrajania, na podstawie którego utworzono ten punkt kontrolny.	Tak
identyfikator	ciąg	Identyfikator punktu kontrolnego, do którego można odwoływać się w punktach końcowych interfejsu API.	Tak
metryki	obiekt	Metryki w numerze kroku podczas zadania dostrajania.	Tak
└full_valid_loss	Liczba		Nie.
└full_valid_mean_token_accuracy	Liczba		Nie.
Krok └*	Liczba		Nie.
└train_loss	Liczba		Nie.
└train_mean_token_accuracy	Liczba		Nie.
└valid_loss	Liczba		Nie.
└valid_mean_token_accuracy	Liczba		Nie.
obiekt	wyliczenie	Typ obiektu, który jest zawsze "fine_tuning.job.checkpoint". Możliwe wartości: fine_tuning.job.checkpoint	Tak
numer_kroku	liczba całkowita	Numer kroku, na który został utworzony punkt kontrolny.	Tak

OpenAI.FineTuningJobEvent

Obiekt zdarzenia zadania dostrajania

Name	Typ	Opis	Wymagane	Default
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia zadania dostrajania.	Tak
dane		Dane skojarzone ze zdarzeniem.	Nie.
identyfikator	ciąg	Identyfikator obiektu.	Tak
poziom	wyliczenie	Poziom dziennika zdarzenia. Możliwe wartości: info, , warnerror	Tak
komunikat	ciąg	Komunikat zdarzenia.	Tak
obiekt	wyliczenie	Typ obiektu, który jest zawsze "fine_tuning.job.event". Możliwe wartości: fine_tuning.job.event	Tak
typ	wyliczenie	Typ zdarzenia. Możliwe wartości: message, metrics	Nie.

OpenAI.FunctionObject

Name	Typ	Opis	Wymagane	Default
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.	Tak
parametry		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	typ logiczny (boolowski)	Czy włączyć ścisłe przestrzeganie schematu podczas generowania wywołania funkcji. Jeśli ustawiono wartość true, model będzie postępować zgodnie z dokładnym schematem zdefiniowanym parameters w polu. Tylko podzbiór schematu JSON jest obsługiwany, gdy strict ma wartość true. Dowiedz się więcej o danych wyjściowych ze strukturą w	Nie.	Nieprawda

OpenAI.FunctionTool

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

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis funkcji. Używany przez model do określania, czy wywołać funkcję.	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
parametry		Obiekt schematu JSON opisujący parametry funkcji.	Tak
surowy	typ logiczny (boolowski)	Czy wymusić ścisłą walidację parametrów. Wartość domyślna true.	Tak
typ	wyliczenie	Typ narzędzia funkcji. Zawsze function. Możliwe wartości: function	Tak

OpenAI.FunctionToolCallItemParam

Wywołanie narzędzia w celu uruchomienia funkcji. Aby uzyskać więcej informacji, zobacz przewodnik wywoływania funkcji .

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Tak
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Tak
typ	wyliczenie	Możliwe wartości: function_call	Tak

OpenAI.FunctionToolCallItemResource

Wywołanie narzędzia w celu uruchomienia funkcji. Aby uzyskać więcej informacji, zobacz przewodnik wywoływania funkcji .

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Łańcuch JSON zawierający argumenty do przekazania do funkcji.	Tak
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
nazwa	ciąg	Nazwa funkcji do uruchomienia.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden zcompleted, lub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Możliwe wartości: function_call	Tak

OpenAI.FunctionToolCallOutputItemParam

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

Name	Typ	Opis	Wymagane	Default
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
We/Wy	ciąg	Ciąg JSON zawierający dane wyjściowe z wywołania narzędzia funkcji.	Tak
typ	wyliczenie	Możliwe wartości: function_call_output	Tak

OpenAI.FunctionToolCallOutputItemResource

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

Name	Typ	Opis	Wymagane	Default
call_id	ciąg	Unikalny identyfikator wywołania funkcji narzędzia wygenerowany przez model.	Tak
We/Wy	ciąg	Ciąg JSON zawierający dane wyjściowe z wywołania narzędzia funkcji.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden zcompleted, lub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Możliwe wartości: function_call_output	Tak

OpenAI.GraderLabelModel

Obiekt LabelModelGrader, który używa modelu do przypisywania etykiet do każdego elementu w ocenie.

Name	Typ	Opis	Wymagane	Default
dane wejściowe	macierz		Tak
labels	macierz	Etykiety do przypisania do każdego elementu w ocenie.	Tak
model	ciąg	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
przechodzące_etykiety	macierz	Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: label_model	Tak

OpenAI.GraderMulti

Obiekt MultiGrader łączy dane wyjściowe wielu klasykatorów w celu utworzenia pojedynczego wyniku.

Name	Typ	Opis	Wymagane	Default
calculate_output	ciąg	Formuła do obliczenia danych wyjściowych na podstawie wyników klasyra.	Tak
Równiarki	obiekt	Obiekt StringCheckGrader, który wykonuje porównanie ciągów między danymi wejściowymi i odwołaniami przy użyciu określonej operacji.	Tak
└evaluation_metric	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	Nie.
└image_tag	ciąg	Tag obrazu do użycia dla skryptu języka Python.	Nie.
└─ Wejście	macierz		Nie.
Etykiety └*	macierz	Etykiety do przypisania do każdego elementu w ocenie.	Nie.
Model └*	ciąg	Model do użycia do oceny. Musi obsługiwać dane wyjściowe ze strukturą.	Nie.
└─ nazwa	ciąg	Nazwa oceniającego.	Nie.
Operacja └*	wyliczenie	Operacja sprawdzania ciągów, którą należy wykonać. eqJeden z , ne, likelub ilike. Możliwe wartości: eq, , ne, likeilike	Nie.
└passing_labels	macierz	Etykiety wskazujące wynik pozytywny. Musi być podzbiorem etykiet.	Nie.
Zakres └*	macierz	Zakres wyniku Wartość domyślna to [0, 1].	Nie.
└— odwołanie	ciąg	Tekst oceniany względem.	Nie.
└parametry_próbkowania	OpenAI.EvalGraderScoreModelSamplingParams	Parametry próbkowania dla modelu.	Nie.
└— źródło	ciąg	Kod źródłowy skryptu języka Python.	Nie.
└typ	wyliczenie	Typ obiektu, który jest zawsze label_model. Możliwe wartości: label_model	Nie.
nazwa	ciąg	Nazwa oceniającego.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze multi. Możliwe wartości: multi	Tak

OpenAI.GraderPython

Obiekt PythonGrader, który uruchamia skrypt języka Python na danych wejściowych.

Name	Typ	Opis	Wymagane	Default
image_tag	ciąg	Tag obrazu do użycia dla skryptu języka Python.	Nie.
nazwa	ciąg	Nazwa oceniającego.	Tak
przesłać źródło	ciąg	Kod źródłowy skryptu języka Python.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze python. Możliwe wartości: python	Tak

OpenAI.GraderScoreModel

Obiekt ScoreModelGrader, który używa modelu do przypisania wyniku do danych wejściowych.

Name	Typ	Opis	Wymagane	Default
dane wejściowe	macierz	Tekst wejściowy. Może to obejmować ciągi szablonu.	Tak
model	ciąg	Model do użycia do oceny.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
zakres	macierz	Zakres wyniku Wartość domyślna to [0, 1].	Nie.
parametry_próbowania	obiekt		Nie.
└max_completions_tokens	OpenAI.integer		Nie.
└reasoning_effort	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
└─ nasion	OpenAI.integer		Nie.
└* temperatura	OpenAI.numeric		Nie.
└─top_p	OpenAI.numeric		Nie.
typ	wyliczenie	Typ obiektu, który jest zawsze score_model. Możliwe wartości: score_model	Tak

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	Opis	Wymagane	Default
dane wejściowe	ciąg	Tekst wejściowy. Może to obejmować ciągi szablonu.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
operacja	wyliczenie	Operacja sprawdzania ciągów, którą należy wykonać. eqJeden z , ne, likelub ilike. Możliwe wartości: eq, , ne, likeilike	Tak
odwołanie	ciąg	Tekst odwołania. Może to obejmować ciągi szablonu.	Tak
typ	wyliczenie	Typ obiektu, który jest zawsze string_check. Możliwe wartości: string_check	Tak

OpenAI.GraderTextSimilarity

Obiekt TextSimilarityGrader, który klasyfikuje tekst na podstawie metryk podobieństwa.

Name	Typ	Opis	Wymagane	Default
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	Tak
dane wejściowe	ciąg	Tekst jest oceniany.	Tak
nazwa	ciąg	Nazwa oceniającego.	Tak
odwołanie	ciąg	Tekst oceniany względem.	Tak
typ	wyliczenie	Typ klasyra. Możliwe wartości: text_similarity	Tak

OpenAI.ImageGenTool

Narzędzie, które generuje obrazy przy użyciu modelu, takiego jak gpt-image-1.

Name	Typ	Opis	Wymagane	Default
tło	wyliczenie	Typ tła wygenerowanego obrazu. Jeden z transparent opaquelub auto. Wartość domyślna: auto. Możliwe wartości: transparent, , opaqueauto	Nie.
maska_wprowadzania_obrazu	obiekt	Opcjonalna maska do inpaintingu. Zawiera image_url (ciąg, opcjonalny) i file_id (ciąg, opcjonalny).	Nie.
└ file_id	ciąg	Identyfikator pliku dla obrazu maski.	Nie.
└image_url	ciąg	Obraz maski zakodowanej w formacie Base64.	Nie.
model	wyliczenie	Model generowania obrazów do użycia. Wartość domyślna: gpt-image-1. Możliwe wartości: gpt-image-1	Nie.
moderation	wyliczenie	Poziom moderowania wygenerowanego obrazu. Wartość domyślna: auto. Możliwe wartości: auto, low	Nie.
kompresja wyjściowa	liczba całkowita	Poziom kompresji obrazu wyjściowego. Wartość domyślna: 100.	Nie.	100
format_wyjściowy	wyliczenie	Format danych wyjściowych wygenerowanego obrazu. pngJeden zwebp, lub jpeg. Wartość domyślna: png. Możliwe wartości: png, , webpjpeg	Nie.
częściowe_obrazy	liczba całkowita	Liczba częściowych obrazów do wygenerowania w trybie przesyłania strumieniowego z zakresu od 0 (wartość domyślna) do 3.	Nie.	0
jakość	wyliczenie	Jakość wygenerowanego obrazu. Jeden z low, , medium, , high lub auto. Wartość domyślna: auto. Możliwe wartości: low, , medium, highauto	Nie.
rozmiar	wyliczenie	Rozmiar wygenerowanego obrazu. 1024x1024Jeden z , , 1024x1536 1536x1024lub 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	Tak

OpenAI.ImageGenToolCallItemParam

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Opis	Wymagane	Default
wynik	ciąg	Wygenerowany obraz zakodowany w formacie base64.	Tak
typ	wyliczenie	Możliwe wartości: image_generation_call	Tak

OpenAI.ImageGenToolCallItemResource

Żądanie generowania obrazu wykonane przez model.

Name	Typ	Opis	Wymagane	Default
wynik	ciąg	Wygenerowany obraz zakodowany w formacie base64.	Tak
stan	wyliczenie	Możliwe wartości: in_progress, , completed, generatingfailed	Tak
typ	wyliczenie	Możliwe wartości: image_generation_call	Tak

OpenAI.Includable

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

• code_interpreter_call.outputs: zawiera dane wyjściowe wykonywania kodu języka Python w elementach wywołania 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łączanie logprobs z komunikatami 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).

Majątek	Wartość
Opis	Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to: - code_interpreter_call.outputs: zawiera dane wyjściowe wykonywania kodu w języku Python w elementy wywołania narzędzia interpretera kodu. - computer_call_output.output.image_url: dołącz adresy URL obrazów z wyników procesu komputerowego. - file_search_call.results: uwzględnij wyniki wyszukiwania wywołanie narzędzia wyszukiwania plików. - message.input_image.image_url: dołącz adresy URL obrazów z komunikatu wejściowego. - message.output_text.logprobs: dołączanie logprobs z komunikatami asystenta. - reasoning.encrypted_content: zawiera zaszyfrowaną wersję rozumowania tokeny w danych wyjściowych elementu rozumowania. Dzięki temu elementy rozumowania mogą być używane w programie konwersacje wieloetapowe przy bezstanowym korzystaniu z interfejsu API Odpowiedzi (na przykład gdy store parametr jest ustawiony na false lub gdy organizacja jest zapisane w programie nieprzechowywania żadnych danych).
Typ	ciąg
Wartości	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content web_search_call.results web_search_call.action.sources memory_search_call.results

OpenAI.ItemContent

Dyskryminujący element OpenAI.ItemContent

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

Wartość typu	Schema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ItemContentType	Zawartość danych wejściowych i wyjściowych wielomodalnych.	Tak

OpenAI.ItemContentInputAudio

Dane audio jako wejście do modelu.

Name	Typ	Opis	Wymagane	Default
dane	ciąg	Dane audio zakodowane w formacie Base64.	Tak
format	wyliczenie	Format danych audio. Obecnie obsługiwane formaty to mp3 i wav. Możliwe wartości: mp3, wav	Tak
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_audio. Możliwe wartości: input_audio	Tak

OpenAI.ItemContentInputFile

Plik wejściowy do modelu.

Name	Typ	Opis	Wymagane	Default
file_data	ciąg	Zawartość pliku, który ma zostać wysłany do modelu.	Nie.
identyfikator_pliku	ciąg	Identyfikator 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	Tak

OpenAI.ItemContentInputImage

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazu.

Name	Typ	Opis	Wymagane	Default
detail	wyliczenie	Poziom szczegółowości obrazu, który ma zostać wysłany do modelu. highJeden z , lowlub auto. Wartość domyślna to auto. Możliwe wartości: low, , highauto	Nie.
identyfikator_pliku	ciąg	Identyfikator pliku, który ma zostać wysłany do modelu.	Nie.
image_url	ciąg	Adres URL obrazu, który ma zostać wysłany do modelu. W pełni kwalifikowany adres URL lub obraz zakodowany w formacie base64 w adresie URL danych.	Nie.
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_image. Możliwe wartości: input_image	Tak

OpenAI.ItemContentInputText

Wprowadzanie tekstu do modelu.

Name	Typ	Opis	Wymagane	Default
SMS	ciąg	Wprowadzanie tekstu do modelu.	Tak
typ	wyliczenie	Typ elementu wejściowego. Zawsze input_text. Możliwe wartości: input_text	Tak

OpenAI.ItemContentOutputAudio

Sygnał wyjściowy audio z modelu.

Name	Typ	Opis	Wymagane	Default
dane	ciąg	Dane audio zakodowane w formacie Base64 z modelu.	Tak
transkrypcja	ciąg	Transkrypcja danych audio z modelu.	Tak
typ	wyliczenie	Typ dźwięku wyjściowego. Zawsze output_audio. Możliwe wartości: output_audio	Tak

OpenAI.ItemContentOutputText

Dane wyjściowe tekstowe z modelu.

Name	Typ	Opis	Wymagane	Default
Adnotacje	macierz	Adnotacje tekstu wyjściowego.	Tak
logprobs	macierz		Nie.
SMS	ciąg	Dane wyjściowe tekstu z modelu.	Tak
typ	wyliczenie	Typ tekstu wyjściowego. Zawsze output_text. Możliwe wartości: output_text	Tak

OpenAI.ItemContentRefusal

Odmowa ze strony modelu.

Name	Typ	Opis	Wymagane	Default
refusal	ciąg	Wyjaśnienie odmowy z modelu.	Tak
typ	wyliczenie	Rodzaj odmowy. Zawsze refusal. Możliwe wartości: refusal	Tak

OpenAI.ItemContentType

Zawartość danych wejściowych i wyjściowych wielomodalnych.

Majątek	Wartość
Opis	Zawartość danych wejściowych i wyjściowych wielomodalnych.
Typ	ciąg
Wartości	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

Element zawartości używany do generowania odpowiedzi.

Dyskryminator dla OpenAI.ItemParam

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

Wartość typu	Schema
message	OpenAI.ResponsesMessageItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
memory_search_call	MemorySearchToolCallItemParam

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ItemType		Tak

OpenAI.ItemReferenceItemParam

Wewnętrzny identyfikator elementu do celów odniesienia.

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Identyfikator pochodzący z usługi wcześniej wygenerowanego elementu odpowiedzi, do którego się odnosi.	Tak
typ	wyliczenie	Możliwe wartości: item_reference	Tak

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:

Wartość typu	Schema
structured_outputs	StructuredOutputsItemResource
workflow_action	WorkflowActionOutputItemResource
oauth_consent_request	OAuthConsentRequestItemResource
message	OpenAI.ResponsesMessageItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_call	OpenAI.MCPCallItemResource
memory_search_call	MemorySearchToolCallItemResource

Name	Typ	Opis	Wymagane	Default
utworzone_przez	obiekt		Nie.
└* agent	Identyfikator agenta	Agent, który utworzył element.	Nie.
└response_id	ciąg	Odpowiedź, na której jest tworzony element.	Nie.
identyfikator	ciąg		Tak
typ	OpenAI.ItemType		Tak

OpenAI.ItemType

Majątek	Wartość
Typ	ciąg
Wartości	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call structured_outputs workflow_action memory_search_call oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Typ	Opis	Wymagane	Default
dane	macierz		Tak
first_id	ciąg		Nie.
zawiera_więcej	typ logiczny (boolowski)		Tak
last_id	ciąg		Nie.
obiekt	wyliczenie	Możliwe wartości: list	Tak

OpenAI.ListFineTuningJobEventsResponse

Name	Typ	Opis	Wymagane	Default
dane	macierz		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
obiekt	wyliczenie	Możliwe wartości: list	Tak

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Typ	Opis	Wymagane	Default
dane	macierz		Tak
zawiera_więcej	typ logiczny (boolowski)		Tak
obiekt	wyliczenie	Możliwe wartości: list	Tak

OpenAI.LocalShellExecAction

Wykonaj polecenie powłoki na serwerze.

Name	Typ	Opis	Wymagane	Default
polecenie	macierz	Polecenie do uruchomienia.	Tak
środowisko	obiekt	Zmienne środowiskowe do ustawienia dla polecenia .	Tak
limit_czasu_ms	liczba całkowita	Opcjonalny limit czasu w milisekundach dla polecenia.	Nie.
typ	wyliczenie	Typ akcji powłoki lokalnej. Zawsze exec. Możliwe wartości: exec	Tak
użytkownik	ciąg	Opcjonalny użytkownik, aby uruchomić polecenie jako.	Nie.
working_directory	ciąg	Opcjonalny katalog roboczy do uruchomienia polecenia w programie .	Nie.

OpenAI.LocalShellTool

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ lokalnego narzędzia powłoki. Zawsze local_shell. Możliwe wartości: local_shell	Tak

OpenAI.LocalShellToolCallItemParam

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

Name	Typ	Opis	Wymagane	Default
akcja	OpenAI.LocalShellExecAction	Wykonaj polecenie powłoki na serwerze.	Tak
call_id	ciąg	Unikatowy identyfikator wywołania lokalnego narzędzia powłoki wygenerowanego przez model.	Tak
typ	wyliczenie	Możliwe wartości: local_shell_call	Tak

OpenAI.LocalShellToolCallItemResource

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

Name	Typ	Opis	Wymagane	Default
akcja	OpenAI.LocalShellExecAction	Wykonaj polecenie powłoki na serwerze.	Tak
call_id	ciąg	Unikatowy identyfikator wywołania lokalnego narzędzia powłoki wygenerowanego przez model.	Tak
stan	wyliczenie	Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Możliwe wartości: local_shell_call	Tak

OpenAI.LocalShellToolCallOutputItemParam

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

Name	Typ	Opis	Wymagane	Default
We/Wy	ciąg	Ciąg JSON danych wyjściowych wywołania lokalnego narzędzia powłoki.	Tak
typ	wyliczenie	Możliwe wartości: local_shell_call_output	Tak

OpenAI.LocalShellToolCallOutputItemResource

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

Name	Typ	Opis	Wymagane	Default
We/Wy	ciąg	Ciąg JSON danych wyjściowych wywołania lokalnego narzędzia powłoki.	Tak
stan	wyliczenie	Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Możliwe wartości: local_shell_call_output	Tak

OpenAI.Location

Dyskryminator dla OpenAI.Location

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

Wartość typu	Schema
approximate	OpenAI.ApproximateLocation

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.LocationType		Tak

OpenAI.TypLokalizacji

Majątek	Wartość
Typ	ciąg
Wartości	approximate

OpenAI.LogProb

Prawdopodobieństwo dziennika tokenu.

Name	Typ	Opis	Wymagane	Default
bytes	macierz		Tak
logprob	Liczba		Tak
kod przedpłaty	ciąg		Tak
top_logprobs	macierz		Tak

OpenAI.MCPApprovalRequestItemParam

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

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Ciąg JSON argumentów dla narzędzia.	Tak
nazwa	ciąg	Nazwa narzędzia do uruchomienia.	Tak
etykieta_serwera	ciąg	Etykieta serwera MCP wysyłającego żądanie.	Tak
typ	wyliczenie	Możliwe wartości: mcp_approval_request	Tak

OpenAI.MCPApprovalRequestItemResource

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

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Ciąg JSON argumentów dla narzędzia.	Tak
nazwa	ciąg	Nazwa narzędzia do uruchomienia.	Tak
etykieta_serwera	ciąg	Etykieta serwera MCP wysyłającego żądanie.	Tak
typ	wyliczenie	Możliwe wartości: mcp_approval_request	Tak

OpenAI.MCPApprovalResponseItemParam

Odpowiedź na żądanie zatwierdzenia MCP.

Name	Typ	Opis	Wymagane	Default
approval_request_id	ciąg	Identyfikator odpowiedzi na żądanie zatwierdzenia.	Tak
approve	typ logiczny (boolowski)	Czy żądanie zostało zatwierdzone.	Tak
powód	ciąg	Opcjonalna przyczyna decyzji.	Nie.
typ	wyliczenie	Możliwe wartości: mcp_approval_response	Tak

OpenAI.MCPApprovalResponseItemResource

Odpowiedź na żądanie zatwierdzenia MCP.

Name	Typ	Opis	Wymagane	Default
approval_request_id	ciąg	Identyfikator odpowiedzi na żądanie zatwierdzenia.	Tak
approve	typ logiczny (boolowski)	Czy żądanie zostało zatwierdzone.	Tak
powód	ciąg	Opcjonalna przyczyna decyzji.	Nie.
typ	wyliczenie	Możliwe wartości: mcp_approval_response	Tak

OpenAI.MCPCallItemParam

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Tak
błąd	ciąg	Błąd wywołania narzędzia, jeśli istnieje.	Nie.
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Tak
We/Wy	ciąg	Dane wyjściowe z wywołania narzędzia.	Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP z uruchomionym narzędziem.	Tak
typ	wyliczenie	Możliwe wartości: mcp_call	Tak

OpenAI.MCPCallItemResource

Wywołanie narzędzia na serwerze MCP.

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Ciąg JSON argumentów przekazanych do narzędzia.	Tak
błąd	ciąg	Błąd wywołania narzędzia, jeśli istnieje.	Nie.
nazwa	ciąg	Nazwa uruchomionego narzędzia.	Tak
We/Wy	ciąg	Dane wyjściowe z wywołania narzędzia.	Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP z uruchomionym narzędziem.	Tak
typ	wyliczenie	Możliwe wartości: mcp_call	Tak

OpenAI.MCPListToolsItemParam

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Opis	Wymagane	Default
błąd	ciąg	Komunikat o błędzie, jeśli serwer nie może wyświetlić listy narzędzi.	Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP.	Tak
narzędzia	macierz	Narzędzia dostępne na serwerze.	Tak
typ	wyliczenie	Możliwe wartości: mcp_list_tools	Tak

OpenAI.MCPListToolsItemResource

Lista narzędzi dostępnych na serwerze MCP.

Name	Typ	Opis	Wymagane	Default
błąd	ciąg	Komunikat o błędzie, jeśli serwer nie może wyświetlić listy narzędzi.	Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP.	Tak
narzędzia	macierz	Narzędzia dostępne na serwerze.	Tak
typ	wyliczenie	Możliwe wartości: mcp_list_tools	Tak

OpenAI.MCPListToolsTool

Narzędzie dostępne na serwerze MCP.

Name	Typ	Opis	Wymagane	Default
Adnotacje		Dodatkowe adnotacje dotyczące narzędzia.	Nie.
opis	ciąg	Opis narzędzia.	Nie.
input_schema		Schemat JSON opisujący dane wejściowe narzędzia.	Tak
nazwa	ciąg	Nazwa narzędzia.	Tak

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	Opis	Wymagane	Default
dozwolone_narzędzia	obiekt		Nie.
└─ nazwy_narzędzi	macierz	Lista dozwolonych nazw narzędzi.	Nie.
headers	obiekt	Opcjonalne nagłówki HTTP do wysyłania do serwera MCP. Używanie do uwierzytelniania lub innych celów.	Nie.
project_connection_id	ciąg	Identyfikator połączenia w projekcie 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)	Określ, które narzędzia serwera MCP wymagają zatwierdzenia.	Nie.
etykieta_serwera	ciąg	Etykieta dla tego serwera MCP używana do identyfikowania go w wywołaniach narzędzi.	Tak
adres_serwera	ciąg	Adres URL serwera MCP.	Tak
typ	wyliczenie	Typ narzędzia MCP. Zawsze mcp. Możliwe wartości: mcp	Tak

OpenAI.Metadata

Zestaw 16 par klucz-wartość, 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.Prompt

Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.

Name	Typ	Opis	Wymagane	Default
identyfikator	ciąg	Unikatowy identyfikator szablonu monitu do użycia.	Tak
zmienne	obiekt	Opcjonalna mapa wartości, które mają być zastępowane zmiennymi w monit. Wartości podstawienia mogą być ciągami lub innymi Typy danych wejściowych odpowiedzi, takie jak obrazy lub pliki.	Nie.
wersja	ciąg	Opcjonalna wersja szablonu monitu.	Nie.

OpenAI.RankingOptions

Name	Typ	Opis	Wymagane	Default
klasyfikator	wyliczenie	Klasyfikator używany do wyszukiwania plików. Możliwe wartości: auto, default-2024-11-15	Nie.
próg punktowy	Liczba	Próg oceny dla wyszukiwania plików, liczba z zakresu od 0 do 1. Liczby bliżej 1 będą próbować zwracać tylko najbardziej odpowiednie wyniki, ale mogą zwracać mniej wyników.	Nie.

OpenAI.Reasoning

Tylko modele serii o

Opcje konfiguracji dla modeli rozumowania.

Name	Typ	Opis	Wymagane	Default
nakład pracy	obiekt	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
generate_summary	wyliczenie	Przestarzałe: użyj summary zamiast. Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.
podsumowanie	wyliczenie	Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.

OpenAI.ReasoningEffort

Ogranicza nakład pracy na rozumowanie modeli rozumowania.

Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie.

Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi.

Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1.

Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego.

Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.

Majątek	Wartość
Opis	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.
Typ	ciąg
Wartości	none minimal low medium high

OpenAI.ReasoningItemParam

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 dla kolejnych tur konwersacji, jeśli ręcznie zarządzasz stanem konwersacji.

Name	Typ	Opis	Wymagane	Default
encrypted_content	ciąg	Zaszyfrowana zawartość elementu rozumowania — wypełniana, gdy odpowiedź jest wygenerowany za pomocą reasoning.encrypted_content polecenia w parametrze include .	Nie.
podsumowanie	macierz	Analiza zawartości tekstu.	Tak
typ	wyliczenie	Możliwe wartości: reasoning	Tak

OpenAI.ReasoningItemResource

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 dla kolejnych tur konwersacji, jeśli ręcznie zarządzasz stanem konwersacji.

Name	Typ	Opis	Wymagane	Default
encrypted_content	ciąg	Zaszyfrowana zawartość elementu rozumowania — wypełniana, gdy odpowiedź jest wygenerowany za pomocą reasoning.encrypted_content polecenia w parametrze include .	Nie.
podsumowanie	macierz	Analiza zawartości tekstu.	Tak
typ	wyliczenie	Możliwe wartości: reasoning	Tak

OpenAI.ReasoningItemSummaryPart

Klasyfikator OpenAI.ReasoningItemSummaryPart

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

Wartość typu	Schema
summary_text	OpenAI.ReasoningItemSummaryTextPart

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ReasoningItemSummaryPartType		Tak

OpenAI.ReasoningItemSummaryPartType

Majątek	Wartość
Typ	ciąg
Wartości	summary_text

OpenAI.ReasoningItemSummaryTextPart

Name	Typ	Opis	Wymagane	Default
SMS	ciąg		Tak
typ	wyliczenie	Możliwe wartości: summary_text	Tak

OpenAI.Response

Name	Typ	Opis	Wymagane	Default
agent	obiekt		Nie.
└─ nazwa	ciąg	Nazwa agenta.	Nie.
└typ	wyliczenie	Możliwe wartości: agent_id	Nie.
└* wersja	ciąg	Identyfikator wersji agenta.	Nie.
tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
konwersacja	obiekt		Tak
└─ ID	ciąg		Nie.
utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Tak
błąd	obiekt	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Tak
└─ kod	OpenAI.ResponseErrorCode	Kod błędu odpowiedzi.	Nie.
└─ Komunikat	ciąg	Czytelny dla człowieka opis błędu.	Nie.
identyfikator	ciąg	Unikatowy identyfikator tej odpowiedzi.	Tak
incomplete_details	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Tak
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
instructions	ciąg lub tablica		Tak
max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak
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	Tak
We/Wy	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Tak
output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
wywołania_narzędzia_równoległe	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Tak	Prawda
previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
monit	obiekt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└─ ID	ciąg	Unikatowy identyfikator szablonu monitu do użycia.	Nie.
Zmienne └*	OpenAI.ResponsePromptVariables	Opcjonalna mapa wartości, które mają być zastępowane zmiennymi w monit. Wartości podstawienia mogą być ciągami lub innymi Typy danych wejściowych odpowiedzi, takie jak obrazy lub pliki.	Nie.
└* wersja	ciąg	Opcjonalna wersja szablonu monitu.	Nie.
reasoning	obiekt	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└─ wysiłek	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
└─ generuj_podsumowanie	wyliczenie	Przestarzałe: użyj summary zamiast. Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.
└─ Podsumowanie	wyliczenie	Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.
poziom usługi	obiekt	Określa typ przetwarzania używany do obsługi żądania. * Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowane w ustawieniach programu Project. Jeśli nie skonfigurowano inaczej, projekt będzie używać wartości domyślnej. * Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardu ceny i wydajność wybranego modelu. * W przypadku ustawienia na wartość "flex" lub "priorytet", a następnie żądanie zostanie przetworzone z odpowiednią usługą kondygnacja. Skontaktuj się ze sprzedażą , aby dowiedzieć się więcej o przetwarzaniu priorytetu. * Jeśli nie ustawiono, domyślne zachowanie to "auto". Po ustawieniu parametru service_tier treść odpowiedzi będzie zawierać wartość service_tier wartość oparta na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może się różnić od wartości ustawionej w parametrze .	Nie.
stan	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.	Tak
SMS	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
tool_choice	obiekt	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 wiadomości a wykonywaniem połączenia więcej narzędzi required oznacza, że model musi wywoływać co najmniej jedno narzędzie.	Nie.
└typ	OpenAI.ToolChoiceObjectType	Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.	Nie.
narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
top_p	Liczba	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.	Tak
truncation	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Tak

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitowane, gdy fragment kodu jest przesyłany strumieniowo przez interpreter kodu.

Name	Typ	Opis	Wymagane	Default
delta	ciąg	Fragment kodu przesyłany strumieniowo przez interpreter kodu.	Tak
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której jest przesyłany strumieniowo kod.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call_code.delta. Możliwe wartości: response.code_interpreter_call_code.delta	Tak

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Emitowane, gdy fragment kodu jest finalizowany przez interpreter kodu.

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Ostateczny wynik fragmentu kodu generowany przez interpretatora kodu.	Tak
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której kod jest sfinalizowany.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call_code.done. Możliwe wartości: response.code_interpreter_call_code.done	Tak

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Emitowane po zakończeniu wywołania interpretera kodu.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której wykonano wywołanie interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.completed. Możliwe wartości: response.code_interpreter_call.completed	Tak

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitowane, gdy trwa wywołanie interpretera kodu.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której trwa wywołanie interpretera kodu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.in_progress. Możliwe wartości: response.code_interpreter_call.in_progress	Tak

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitowane, gdy interpreter kodu aktywnie interpretuje fragment kodu.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu wywołania narzędzia interpretera kodu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w odpowiedzi, dla której interpreter kodu interpretuje kod.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.code_interpreter_call.interpreting. Możliwe wartości: response.code_interpreter_call.interpreting	Tak

OpenAI.ResponseCompletedEvent

Emitowane po zakończeniu odpowiedzi modelu.

Name	Typ	Opis	Wymagane	Default
odpowiedź	obiekt		Tak
└* agent	Identyfikator agenta	Agent używany na potrzeby tej odpowiedzi	Nie.
└* tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
Konwersacja └*	obiekt		Nie.
└─ ID	ciąg		Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Nie.
└─ błąd	OpenAI.ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Nie.
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Nie.
└niekompletne_szczegóły	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Nie.
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
└─ instrukcje	ciąg lub tablica	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
└max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
└max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
Metadane └*	obiekt	Zestaw 16 par klucz-wartość, 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	Nie.
└─ Dane wyjściowe	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Nie.
└output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
└parallel_tool_calls	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
└previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└* rozumowanie	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└service_tier	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
Stan └*	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.
└* tekst	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
└─ Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
└ top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
└─top_p	Liczba	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.
└* skrócenie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.completed. Możliwe wartości: response.completed	Tak

OpenAI.ResponseContentPartAddedEvent

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

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks dodanej części zawartości.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Tak
część	obiekt		Tak
└typ	OpenAI.ItemContentType	Zawartość danych wejściowych i wyjściowych wielomodalnych.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.content_part.added. Możliwe wartości: response.content_part.added	Tak

OpenAI.ResponseContentPartDoneEvent

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

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks części zawartości, która jest ukończona.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego została dodana część zawartości.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego została dodana część zawartości.	Tak
część	obiekt		Tak
└typ	OpenAI.ItemContentType	Zawartość danych wejściowych i wyjściowych wielomodalnych.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.content_part.done. Możliwe wartości: response.content_part.done	Tak

OpenAI.ResponseCreatedEvent

Zdarzenie emitowane podczas tworzenia odpowiedzi.

Name	Typ	Opis	Wymagane	Default
odpowiedź	obiekt		Tak
└* agent	Identyfikator agenta	Agent używany na potrzeby tej odpowiedzi	Nie.
└* tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
Konwersacja └*	obiekt		Nie.
└─ ID	ciąg		Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Nie.
└─ błąd	OpenAI.ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Nie.
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Nie.
└niekompletne_szczegóły	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Nie.
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
└─ instrukcje	ciąg lub tablica	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
└max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
└max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
Metadane └*	obiekt	Zestaw 16 par klucz-wartość, 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	Nie.
└─ Dane wyjściowe	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Nie.
└output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
└parallel_tool_calls	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
└previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└* rozumowanie	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└service_tier	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
Stan └*	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.
└* tekst	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
└─ Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
└ top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
└─top_p	Liczba	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.
└* skrócenie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.created. Możliwe wartości: response.created	Tak

OpenAI.ResponseError

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

Name	Typ	Opis	Wymagane	Default
kod	OpenAI.ResponseErrorCode	Kod błędu odpowiedzi.	Tak
komunikat	ciąg	Czytelny dla człowieka opis błędu.	Tak

OpenAI.ResponseErrorCode

Kod błędu odpowiedzi.

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

OpenAI.ResponseErrorEvent

Emitowane w przypadku wystąpienia błędu.

Name	Typ	Opis	Wymagane	Default
kod	ciąg	Kod błędu.	Tak
komunikat	ciąg	Komunikat o błędzie.	Tak
param	ciąg	Parametr błędu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze error. Możliwe wartości: error	Tak

OpenAI.ResponseFailedEvent

Zdarzenie emitowane w przypadku niepowodzenia odpowiedzi.

Name	Typ	Opis	Wymagane	Default
odpowiedź	obiekt		Tak
└* agent	Identyfikator agenta	Agent używany na potrzeby tej odpowiedzi	Nie.
└* tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
Konwersacja └*	obiekt		Nie.
└─ ID	ciąg		Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Nie.
└─ błąd	OpenAI.ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Nie.
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Nie.
└niekompletne_szczegóły	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Nie.
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
└─ instrukcje	ciąg lub tablica	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
└max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
└max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
Metadane └*	obiekt	Zestaw 16 par klucz-wartość, 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	Nie.
└─ Dane wyjściowe	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Nie.
└output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
└parallel_tool_calls	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
└previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└* rozumowanie	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└service_tier	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
Stan └*	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.
└* tekst	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
└─ Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
└ top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
└─top_p	Liczba	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.
└* skrócenie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.failed. Możliwe wartości: response.failed	Tak

OpenAI.ResponseFileSearchCallCompletedEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.file_search_call.completed. Możliwe wartości: response.file_search_call.completed	Tak

OpenAI.ResponseFileSearchCallInProgressEvent

Emitowane po zainicjowaniu wywołania wyszukiwania plików.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.file_search_call.in_progress. Możliwe wartości: response.file_search_call.in_progress	Tak

OpenAI.ResponseFileSearchCallSearchingEvent

Emitowane, gdy wyszukiwanie plików jest obecnie przeszukiwane.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego zainicjowano wywołanie wyszukiwania plików.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego przeszukiwanego przez wywołanie wyszukiwania plików.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.file_search_call.searching. Możliwe wartości: response.file_search_call.searching	Tak

OpenAI.ResponseFormat

Dyskryminator dla OpenAI.ResponseFormat

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

Wartość typu	Schema
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: text, , json_objectjson_schema	Tak

OpenAI.ResponseFormatJsonObject

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	Opis	Wymagane	Default
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze json_object. Możliwe wartości: json_object	Tak

OpenAI.ResponseFormatJsonSchema

Schemat formatu odpowiedzi, opisany jako obiekt schematu JSON. Dowiedz się, jak tworzyć schematy JSON tutaj. Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

Name	Typ	Opis	Wymagane	Default
json_schema	obiekt	Opcje konfiguracji danych wyjściowych ze strukturą, w tym schemat JSON.	Tak
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.	Nie.
Schemat └*	obiekt		Nie.
└* ścisłe	typ logiczny (boolowski)	Czy włączyć ścisłe przestrzeganie schematu podczas generowania danych wyjściowych. W przypadku ustawienia wartości true model będzie zawsze przestrzegał dokładnego zdefiniowanego schematu W polu schema. Tylko podzbiór schematu JSON jest obsługiwany, gdy Parametr strict ma wartość true. Aby dowiedzieć się więcej, przeczytaj ustrukturyzowane dane wyjściowe przewodnik.	Nie.	Nieprawda
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze json_schema. Możliwe wartości: json_schema	Tak

OpenAI.ResponseFormatText

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze text. Możliwe wartości: text	Tak

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

Name	Typ	Opis	Wymagane	Default
delta	ciąg	Dodano argument delta w wywołaniu funkcji.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę argumentów wywołania funkcji.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego do którego zostanie dodana różnica w argumentach wywołania funkcji.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.function_call_arguments.delta. Możliwe wartości: response.function_call_arguments.delta	Tak

OpenAI.ResponseFunctionCallArgumentsDoneEvent

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

Name	Typ	Opis	Wymagane	Default
Argumenty	ciąg	Argumenty wywołania funkcji.	Tak
item_id	ciąg	Identyfikator elementu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego.	Tak
typ	wyliczenie	Możliwe wartości: response.function_call_arguments.done	Tak

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	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.completed". Możliwe wartości: response.image_generation_call.completed	Tak

OpenAI.ResponseImageGenCallGeneratingEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.generating". Możliwe wartości: response.image_generation_call.generating	Tak

OpenAI.ResponseImageGenCallInProgressEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu generowania obrazu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.image_generation_call.in_progress". Możliwe wartości: response.image_generation_call.in_progress	Tak

OpenAI.ResponseImageGenCallPartialImageEvent

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

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

OpenAI.ResponseInProgressEvent

Emitowane, gdy odpowiedź jest w toku.

Name	Typ	Opis	Wymagane	Default
odpowiedź	obiekt		Tak
└* agent	Identyfikator agenta	Agent używany na potrzeby tej odpowiedzi	Nie.
└* tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
Konwersacja └*	obiekt		Nie.
└─ ID	ciąg		Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Nie.
└─ błąd	OpenAI.ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Nie.
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Nie.
└niekompletne_szczegóły	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Nie.
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
└─ instrukcje	ciąg lub tablica	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
└max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
└max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
Metadane └*	obiekt	Zestaw 16 par klucz-wartość, 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	Nie.
└─ Dane wyjściowe	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Nie.
└output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
└parallel_tool_calls	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
└previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└* rozumowanie	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└service_tier	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
Stan └*	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.
└* tekst	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
└─ Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
└ top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
└─top_p	Liczba	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.
└* skrócenie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.in_progress. Możliwe wartości: response.in_progress	Tak

OpenAI.ResponseIncompleteEvent

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

Name	Typ	Opis	Wymagane	Default
odpowiedź	obiekt		Tak
└* agent	Identyfikator agenta	Agent używany na potrzeby tej odpowiedzi	Nie.
└* tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
Konwersacja └*	obiekt		Nie.
└─ ID	ciąg		Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Nie.
└─ błąd	OpenAI.ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Nie.
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Nie.
└niekompletne_szczegóły	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Nie.
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
└─ instrukcje	ciąg lub tablica	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
└max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
└max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
Metadane └*	obiekt	Zestaw 16 par klucz-wartość, 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	Nie.
└─ Dane wyjściowe	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Nie.
└output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
└parallel_tool_calls	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
└previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└* rozumowanie	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└service_tier	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
Stan └*	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.
└* tekst	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
└─ Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
└ top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
└─top_p	Liczba	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.
└* skrócenie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze response.incomplete. Możliwe wartości: response.incomplete	Tak

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

Name	Typ	Opis	Wymagane	Default
delta		Częściowa aktualizacja argumentów wywołania narzędzia MCP.	Tak
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.arguments_delta". Możliwe wartości: response.mcp_call.arguments_delta	Tak

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

Name	Typ	Opis	Wymagane	Default
Argumenty		Sfinalizowane argumenty wywołania narzędzia MCP.	Tak
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.arguments_done". Możliwe wartości: response.mcp_call.arguments_done	Tak

OpenAI.ResponseMCPCallCompletedEvent

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.completed". Możliwe wartości: response.mcp_call.completed	Tak

OpenAI.ResponseMCPCallFailedEvent

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.failed". Możliwe wartości: response.mcp_call.failed	Tak

OpenAI.ResponseMCPCallInProgressEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator przetwarzanego elementu wywołania narzędzia MCP.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_call.in_progress". Możliwe wartości: response.mcp_call.in_progress	Tak

OpenAI.ResponseMCPListToolsCompletedEvent

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zdarzenia. Zawsze „response.mcp_list_tools.completed”. Możliwe wartości: response.mcp_list_tools.completed	Tak

OpenAI.ResponseMCPListToolsFailedEvent

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_list_tools.failed". Możliwe wartości: response.mcp_list_tools.failed	Tak

OpenAI.ResponseMCPListToolsInProgressEvent

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ zdarzenia. Zawsze "response.mcp_list_tools.in_progress". Możliwe wartości: response.mcp_list_tools.in_progress	Tak

OpenAI.ResponseOutputItemAddedEvent

Emitowane po dodaniu nowego elementu wyjściowego.

Name	Typ	Opis	Wymagane	Default
element	obiekt	Element zawartości używany do generowania odpowiedzi.	Tak
└created_by	Utworzone przez	Informacje o twórcy elementu	Nie.
└─ ID	ciąg		Nie.
└typ	OpenAI.ItemType		Nie.
output_index	liczba całkowita	Indeks dodanego elementu wyjściowego.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_item.added. Możliwe wartości: response.output_item.added	Tak

OpenAI.ResponseOutputItemDoneEvent

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

Name	Typ	Opis	Wymagane	Default
element	obiekt	Element zawartości używany do generowania odpowiedzi.	Tak
└created_by	Utworzone przez	Informacje o twórcy elementu	Nie.
└─ ID	ciąg		Nie.
└typ	OpenAI.ItemType		Nie.
output_index	liczba całkowita	Indeks elementu wyjściowego, który został oznaczony jako wykonany.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_item.done. Możliwe wartości: response.output_item.done	Tak

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	Opis	Wymagane	Default
odpowiedź	obiekt		Tak
└* agent	Identyfikator agenta	Agent używany na potrzeby tej odpowiedzi	Nie.
└* tło	typ logiczny (boolowski)	Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej o odpowiedziach w tle.	Nie.	Nieprawda
Konwersacja └*	obiekt		Nie.
└─ ID	ciąg		Nie.
└─ utworzono_o	liczba całkowita	Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi.	Nie.
└─ błąd	OpenAI.ResponseError	Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.	Nie.
└─ ID	ciąg	Unikatowy identyfikator tej odpowiedzi.	Nie.
└niekompletne_szczegóły	obiekt	Szczegółowe informacje o tym, dlaczego odpowiedź jest niekompletna.	Nie.
└* przyczyna	wyliczenie	Powód, dla którego odpowiedź jest niekompletna. Możliwe wartości: max_output_tokens, content_filter	Nie.
└─ instrukcje	ciąg lub tablica	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. Podczas używania z previous_response_id, instrukcje z poprzedniego odpowiedź nie zostanie przeniesiona do następnej odpowiedzi. To sprawia, że jest to proste w celu wymiany komunikatów systemowych (lub od deweloperów) w nowych odpowiedziach.	Nie.
└max_output_tokens	liczba całkowita	Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania.	Nie.
└max_tool_calls	liczba całkowita	Maksymalna liczba wywołań do wbudowanych narzędzi, które można przetworzyć w odpowiedzi. Ta maksymalna liczba dotyczy wszystkich wbudowanych wywołań narzędzi, a nie poszczególnych narzędzi. Wszelkie dalsze próby wywołania narzędzia przez model zostaną zignorowane.	Nie.
Metadane └*	obiekt	Zestaw 16 par klucz-wartość, 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	Nie.
└─ Dane wyjściowe	macierz	Tablica elementów zawartości wygenerowanych przez model. - Długość i kolejność elementów w tablicy output jest zależna na odpowiedzi modelu. — Zamiast uzyskiwać dostęp do pierwszego elementu w tablicy output i 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.	Nie.
└output_text	ciąg	Właściwość wygody tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich output_text elementów w tablicy output , jeśli istnieją. Obsługiwane w zestawach SDK python i JavaScript.	Nie.
└parallel_tool_calls	typ logiczny (boolowski)	Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi.	Nie.	Prawda
└previous_response_id	ciąg	Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego do tworzenie konwersacji o wielu wymianach. Dowiedz się więcej o zarządzanie stanem konwersacji.	Nie.
Zachęta └*	OpenAI.Prompt	Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.	Nie.
└* rozumowanie	OpenAI.Reasoning	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└service_tier	OpenAI.ServiceTier	Uwaga: service_tier nie ma zastosowania do usługi Azure OpenAI.	Nie.
Stan └*	wyliczenie	Stan generowania odpowiedzi. completedJeden z , , failed in_progress, cancelled, queued lub incomplete. Możliwe wartości: completed, , failedin_progress, cancelled, , queuedincomplete	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	Liczba	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.
└* tekst	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może być zwykły tekstowe lub ustrukturyzowane dane JSON. Zobacz Wprowadzanie tekstu i dane wyjściowe i dane wyjściowe ze strukturą	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
└wybór_narzędzia	OpenAI.ToolChoiceOptions lub OpenAI.ToolChoiceObject	Jak model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedź. Zobacz parametr , tools aby zobaczyć, jak określić narzędzia model może wywoływać.	Nie.
└─ Narzędzia	macierz	Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Ty może określić, które narzędzie ma być używane przez ustawienie parametru tool_choice . Dwie kategorie narzędzi, które można modelowi podać, to: * Wbudowane narzędzia: narzędzia dostarczane przez firmę OpenAI, które rozszerzają możliwości modelu, takie jak wyszukiwanie w Internecie lub wyszukiwanie plików. Dowiedz się więcej o wbudowane narzędzia. * Wywołania funkcji (narzędzia niestandardowe): funkcje zdefiniowane przez Użytkownika umożliwienie modelowi wywołania własnego kodu. Dowiedz się więcej o wywoływanie funkcji.	Nie.
└ top_logprobs	liczba całkowita	Liczba całkowita z zakresu od 0 do 20 określająca liczbę najbardziej prawdopodobnych tokenów do zwrócenia na każdej pozycji, z których każdy ma skojarzone logarytmiczne prawdopodobieństwo.	Nie.
└─top_p	Liczba	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.
└* skrócenie	wyliczenie	Strategia obcinania, która ma być użyta dla odpowiedzi modelu. - auto: Jeśli kontekst tej odpowiedzi i poprzednich przekroczy określony limit rozmiar okna kontekstu modelu, model zostanie obcięty odpowiedź, aby dopasować okno kontekstu, upuszczając elementy wejściowe. w środku rozmowy - disabled (ustawienie domyślne): jeśli odpowiedź modelu przekroczy okno kontekstu rozmiar modelu, żądanie zakończy się niepowodzeniem z błędem 400. 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	Dowiedz się więcej o najlepszych rozwiązaniach dotyczących bezpieczeństwa.	Nie.
typ	wyliczenie	Typ zdarzenia. Zawsze "response.queued". Możliwe wartości: response.queued	Tak

OpenAI.ResponseReasoningDeltaEvent

Emitowane w przypadku zmiany (częściowej aktualizacji) treści rozumowania.

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks zawartości części rozumowania w elemencie wyjściowym.	Tak
delta		Częściowa aktualizacja zawartości rozumowania.	Tak
item_id	ciąg	Unikatowy identyfikator elementu, dla którego jest aktualizowane rozumowanie.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.reasoning.delta". Możliwe wartości: response.reasoning.delta	Tak

OpenAI.ResponseReasoningDoneEvent

Emitowane, gdy zawartość rozumowania jest finalizowana dla elementu.

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks zawartości części rozumowania w elemencie wyjściowym.	Tak
item_id	ciąg	Unikatowy identyfikator elementu, dla którego rozumowanie jest finalizowane.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
SMS	ciąg	Sfinalizowany tekst rozumowania.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.reasoning.done". Możliwe wartości: response.reasoning.done	Tak

OpenAI.ResponseReasoningSummaryDeltaEvent

Emitowane w przypadku zmiany (częściowej aktualizacji) w zawartości podsumowania wnioskowania.

Name	Typ	Opis	Wymagane	Default
delta		Częściowa aktualizacja zawartości podsumowania przyczyn.	Tak
item_id	ciąg	Unikatowy identyfikator elementu, dla którego jest aktualizowane podsumowanie rozumowania.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
summary_index	liczba całkowita	Indeks części podsumowania w elemencie wyjściowym.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.reasoning_summary.delta". Możliwe wartości: response.reasoning_summary.delta	Tak

OpenAI.ResponseReasoningSummaryDoneEvent

Emitowane, gdy zawartość podsumowania rozumowania jest finalizowana dla elementu.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu, dla którego podsumowanie rozumowania jest finalizowane.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego w tablicy wyjściowej odpowiedzi.	Tak
summary_index	liczba całkowita	Indeks części podsumowania w elemencie wyjściowym.	Tak
SMS	ciąg	Sfinalizowany tekst podsumowania rozumowania.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze "response.reasoning_summary.done". Możliwe wartości: response.reasoning_summary.done	Tak

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitowane po dodaniu nowej części podsumowania rozumowania.

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Identyfikator elementu, z którym ta część podsumowania jest skojarzona.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego jest skojarzony z tą częścią podsumowania.	Tak
część	obiekt		Tak
└typ	OpenAI.ReasoningItemSummaryPartType		Nie.
summary_index	liczba całkowita	Indeks części podsumowania w podsumowaniu rozumowania.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.reasoning_summary_part.added. Możliwe wartości: response.reasoning_summary_part.added	Tak

OpenAI.ResponseReasoningSummaryPartDoneEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Identyfikator elementu, z którym ta część podsumowania jest skojarzona.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego jest skojarzony z tą częścią podsumowania.	Tak
część	obiekt		Tak
└typ	OpenAI.ReasoningItemSummaryPartType		Nie.
summary_index	liczba całkowita	Indeks części podsumowania w podsumowaniu rozumowania.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.reasoning_summary_part.done. Możliwe wartości: response.reasoning_summary_part.done	Tak

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitowane po dodaniu zmiany do tekstu podsumowującego rozumowanie.

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

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitowany po zakończeniu tekstu podsumowania rozumowania.

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

OpenAI.ResponseRefusalDeltaEvent

Emitowane w przypadku częściowego tekstu odmowy.

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks części zawartości, do którego jest dodawany tekst odmowy.	Tak
delta	ciąg	Tekst odmowy, który został dodany.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego jest dodawany tekst odmowy.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest dodawany tekst odmowy.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.refusal.delta. Możliwe wartości: response.refusal.delta	Tak

OpenAI.ResponseRefusalDoneEvent

Emitowane, gdy tekst odmowy jest sfinalizowany.

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks części treści, w której tekst odmowy jest sfinalizowany.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, dla którego tekst odmowy jest finalizowany.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, w którym tekst odmowy został sfinalizowany.	Tak
refusal	ciąg	Tekst odmowy, który jest sfinalizowany.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.refusal.done. Możliwe wartości: response.refusal.done	Tak

OpenAI.ResponseStreamEvent

Dyskryminator dla OpenAI.ResponseStreamEvent

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

Wartość typu	Schema
response.completed	OpenAI.ResponseCompletedEvent
response.content_part.added	OpenAI.ResponseContentPartAddedEvent
response.content_part.done	OpenAI.ResponseContentPartDoneEvent
response.created	OpenAI.ResponseCreatedEvent
error	OpenAI.ResponseErrorEvent
response.file_search_call.completed	OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress	OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching	OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done	OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress	OpenAI.ResponseInProgressEvent
response.failed	OpenAI.ResponseFailedEvent
response.incomplete	OpenAI.ResponseIncompleteEvent
response.output_item.added	OpenAI.ResponseOutputItemAddedEvent
response.output_item.done	OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta	OpenAI.ResponseRefusalDeltaEvent
response.refusal.done	OpenAI.ResponseRefusalDoneEvent
response.output_text.delta	OpenAI.ResponseTextDeltaEvent
response.output_text.done	OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added	OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done	OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta	OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done	OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed	OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress	OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching	OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed	OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating	OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress	OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image	OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta	OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done	OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed	OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed	OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress	OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed	OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed	OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress	OpenAI.ResponseMCPListToolsInProgressEvent
response.queued	OpenAI.ResponseQueuedEvent
response.reasoning.delta	OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done	OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta	OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done	OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed	OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress	OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Name	Typ	Opis	Wymagane	Default
sequence_number	liczba całkowita	Numer sekwencji dla tego zdarzenia.	Tak
typ	OpenAI.ResponseStreamEventType		Tak

OpenAI.ResponseStreamEventType

Majątek	Wartość
Typ	ciąg
Wartości	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Emitowane w przypadku dodatkowej zmiany tekstu.

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks części zawartości, do której dodano zmianę tekstową.	Tak
delta	ciąg	Dodano zmianę tekstu.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, do którego dodano różnicę tekstu.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego dodano różnicę tekstu.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_text.delta. Możliwe wartości: response.output_text.delta	Tak

OpenAI.ResponseTextDoneEvent

Emitowane po sfinalizowaniu zawartości tekstowej.

Name	Typ	Opis	Wymagane	Default
content_index	liczba całkowita	Indeks części zawartości, w której treść tekstowa jest sfinalizowana.	Tak
item_id	ciąg	Identyfikator elementu wyjściowego, którego zawartość tekstowa jest finalizowana.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, którego treść tekstowa jest sfinalizowana.	Tak
SMS	ciąg	Zawartość tekstowa, która jest sfinalizowana.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.output_text.done. Możliwe wartości: response.output_text.done	Tak

KonfiguracjaFormatuTekstuOdpowiedzi.OpenAI

Dyskryminowanie pliku OpenAI.ResponseTextFormatConfiguration

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

Wartość typu	Schema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ResponseTextFormatConfigurationType	Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } włącza dane wyjściowe ze strukturą, zapewnia, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w 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ą.	Tak

OpenAI.ResponseTextFormatConfigurationJsonObject

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: json_object	Tak

OpenAI.ResponseTextFormatConfigurationJsonSchema (konfiguracja formatu tekstu odpowiedzi OpenAI według schematu JSON)

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

Name	Typ	Opis	Wymagane	Default
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.	Tak
schemat	obiekt		Tak
surowy	typ logiczny (boolowski)	Czy włączyć ścisłe przestrzeganie schematu podczas generowania danych wyjściowych. W przypadku ustawienia wartości true model będzie zawsze przestrzegał dokładnego zdefiniowanego schematu W polu schema. Tylko podzbiór schematu JSON jest obsługiwany, gdy Parametr strict ma wartość true. Aby dowiedzieć się więcej, przeczytaj ustrukturyzowane dane wyjściowe przewodnik.	Nie.	Nieprawda
typ	wyliczenie	Typ zdefiniowanego formatu odpowiedzi. Zawsze json_schema. Możliwe wartości: json_schema	Tak

Konfiguracja formatu tekstu odpowiedzi OpenAI

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: text	Tak

OpenAI.TypKonfiguracjiFormatowaniaTekstu odpowiedzi

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 w witrynie

Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji.

Niezalecane w przypadku modeli gpt-4o i nowszych:

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ą.

Majątek	Wartość
Opis	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 w witrynie

Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji.

Niezalecane w przypadku modeli gpt-4o i nowszych:

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ą. | | Typ | ciąg | | Wartości | text
json_schema
json_object |

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	Opis	Wymagane	Default
input_tokens	liczba całkowita	Liczba tokenów wejściowych.	Tak
input_tokens_details	obiekt	Szczegółowy podział tokenów wejściowych.	Tak
└cached_tokens	liczba całkowita	Liczba tokenów pobranych z pamięci podręcznej. Więcej informacji na temat buforowania monitów.	Nie.
output_tokens	liczba całkowita	Liczba tokenów wyjściowych.	Tak
output_tokens_details	obiekt	Szczegółowy podział tokenów wyjściowych.	Tak
└─ tokeny_rozumowania	liczba całkowita	Liczba tokenów rozumowania.	Nie.
total_tokens	liczba całkowita	Całkowita liczba użytych tokenów.	Tak

OpenAI.ResponseWebSearchCallCompletedEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest skojarzone wywołanie wyszukiwania w Internecie.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.web_search_call.completed. Możliwe wartości: response.web_search_call.completed	Tak

OpenAI.ResponseWebSearchCallInProgressEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest skojarzone wywołanie wyszukiwania w Internecie.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.web_search_call.in_progress. Możliwe wartości: response.web_search_call.in_progress	Tak

OpenAI.ResponseWebSearchCallSearchingEvent

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

Name	Typ	Opis	Wymagane	Default
item_id	ciąg	Unikatowy identyfikator elementu wyjściowego skojarzonego z wywołaniem wyszukiwania w Internecie.	Tak
output_index	liczba całkowita	Indeks elementu wyjściowego, do którego jest skojarzone wywołanie wyszukiwania w Internecie.	Tak
typ	wyliczenie	Typ zdarzenia. Zawsze response.web_search_call.searching. Możliwe wartości: response.web_search_call.searching	Tak

OpenAI.ResponsesAssistantMessageItemParam

Element parametru komunikatu z rolą assistant .

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg lub tablica		Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze assistant. Możliwe wartości: assistant	Tak

OpenAI.ResponsesAssistantMessageItemResource

Element zasobu komunikatu z rolą assistant .

Name	Typ	Opis	Wymagane	Default
zawartość	macierz	Zawartość skojarzona z wiadomością.	Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze assistant. Możliwe wartości: assistant	Tak

OpenAI.ResponsesDeveloperMessageItemParam

Element parametru komunikatu z rolą developer .

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg lub tablica		Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze developer. Możliwe wartości: developer	Tak

OpenAI.ResponsesDeveloperMessageItemResource

Element zasobu komunikatu z rolą developer .

Name	Typ	Opis	Wymagane	Default
zawartość	macierz	Zawartość skojarzona z wiadomością.	Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze developer. Możliwe wartości: developer	Tak

OpenAI.ResponsesMessageItemParam

Element komunikatu odpowiedzi reprezentujący rolę i zawartość, jak podano jako parametry żądania klienta.

Klasyfikator dla OpenAI.ResponsesMessageItemParam

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

Wartość typu	Schema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

Name	Typ	Opis	Wymagane	Default
rola	obiekt	Kolekcja prawidłowych ról dla elementów komunikatów odpowiedzi.	Tak
typ	wyliczenie	Typ elementu odpowiedzi, który jest zawsze "komunikatem". Możliwe wartości: message	Tak

OpenAI.ResponsesMessageItemResource

Element zasobu komunikatu odpowiedzi reprezentujący rolę i zawartość podaną w odpowiedziach usługi.

Dyskryminujące dla openAI.ResponsesMessageItemResource

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

Wartość typu	Schema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

Name	Typ	Opis	Wymagane	Default
rola	obiekt	Kolekcja prawidłowych ról dla elementów komunikatów odpowiedzi.	Tak
stan	wyliczenie	Stan elementu. in_progressJeden zcompleted, lub incomplete. Wypełniane, gdy elementy są zwracane za pośrednictwem interfejsu API. Możliwe wartości: in_progress, , completedincomplete	Tak
typ	wyliczenie	Typ elementu odpowiedzi, który jest zawsze "komunikatem". Możliwe wartości: message	Tak

OpenAI.ResponsesMessageRole

Kolekcja prawidłowych ról dla elementów komunikatów odpowiedzi.

Majątek	Wartość
Opis	Kolekcja prawidłowych ról dla elementów komunikatów odpowiedzi.
Typ	ciąg
Wartości	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Element parametru komunikatu z rolą system .

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg lub tablica		Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze system. Możliwe wartości: system	Tak

OpenAI.ResponsesSystemMessageItemResource

Element zasobu komunikatu z rolą system .

Name	Typ	Opis	Wymagane	Default
zawartość	macierz	Zawartość skojarzona z wiadomością.	Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze system. Możliwe wartości: system	Tak

OpenAI.ResponsesUserMessageItemParam

Element parametru komunikatu z rolą user .

Name	Typ	Opis	Wymagane	Default
zawartość	ciąg lub tablica		Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze user. Możliwe wartości: user	Tak

OpenAI.ResponsesUserMessageItemResource

Element zasobu komunikatu z rolą user .

Name	Typ	Opis	Wymagane	Default
zawartość	macierz	Zawartość skojarzona z wiadomością.	Tak
rola	wyliczenie	Rola komunikatu, czyli zawsze user. Możliwe wartości: user	Tak

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 projektu. Jeśli nie skonfigurowano inaczej, projekt 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. Skontaktuj się ze sprzedażą , aby dowiedzieć się więcej o przetwarzaniu priorytetu.
• 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 .

Majątek	Wartość
Opis	Określa typ przetwarzania używany do obsługi żądania. * Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowane w ustawieniach programu Project. Jeśli nie skonfigurowano inaczej, projekt będzie używać wartości domyślnej. * Jeśli ustawiono wartość "default", żądanie zostanie przetworzone przy użyciu standardu ceny i wydajność wybranego modelu. * W przypadku ustawienia na wartość "flex" lub "priorytet", a następnie żądanie zostanie przetworzone z odpowiednią usługą kondygnacja. Skontaktuj się ze sprzedażą , aby dowiedzieć się więcej o przetwarzaniu priorytetu. * Jeśli nie ustawiono, domyślne zachowanie to "auto". Po ustawieniu parametru service_tier treść odpowiedzi będzie zawierać wartość service_tier wartość oparta na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może się różnić od wartości ustawionej w parametrze .
Typ	ciąg
Wartości	auto default flex scale priority

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 w witrynie

Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji.

Niezalecane w przypadku modeli gpt-4o i nowszych:*

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ą.

Dyskryminowanie dla elementu OpenAI.TextResponseFormatConfiguration

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

Wartość typu	Schema

Name	Typ	Opis	Wymagane	Default
typ	ciąg		Tak

OpenAI.Tool

Dyskryminator dla OpenAI.Tool

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

Wartość typu	Schema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool
bing_grounding	BingGroundingAgentTool
fabric_dataagent_preview	MicrosoftFabricAgentTool
sharepoint_grounding_preview	SharepointAgentTool
azure_ai_search	AzureAISearchAgentTool
openapi	OpenApiAgentTool
bing_custom_search_preview	BingCustomSearchAgentTool
browser_automation_preview	BrowserAutomationAgentTool
azure_function	AzureFunctionAgentTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2ATool
memory_search	MemorySearchTool

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ToolType	Narzędzie, które może służyć do generowania odpowiedzi.	Tak

OpenAI.ToolChoiceObject

Dyskryminator dla OpenAI.ToolChoiceObject

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

Wartość typu	Schema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.ToolChoiceObjectType	Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi. Dowiedz się więcej o wbudowanych narzędziach.	Tak

OpenAI.ToolChoiceObjectCodeInterpreter

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: code_interpreter	Tak

OpenAI.ToolChoiceObjectComputer

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: computer_use_preview	Tak

OpenAI.ToolChoiceObjectFileSearch

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: file_search	Tak

OpenAI.ToolChoiceObjectFunction

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

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
typ	wyliczenie	W przypadku wywoływania funkcji typ to zawsze function. Możliwe wartości: function	Tak

OpenAI.ToolChoiceObjectImageGen

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: image_generation	Tak

OpenAI.ToolChoiceObjectMCP

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

Name	Typ	Opis	Wymagane	Default
nazwa	ciąg	Nazwa narzędzia do wywołania na serwerze.	Nie.
etykieta_serwera	ciąg	Etykieta serwera MCP do użycia.	Tak
typ	wyliczenie	W przypadku narzędzi MCP typ to zawsze mcp. Możliwe wartości: mcp	Tak

OpenAI.ToolChoiceObjectType

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

Majątek	Wartość
Opis	Wskazuje, że model powinien używać wbudowanego narzędzia do generowania odpowiedzi.
Dowiedz się więcej o wbudowanych narzędziach.
Typ	ciąg
Wartości	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: web_search_preview	Tak

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.

Majątek	Wartość
Opis	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 wiadomości a wykonywaniem połączenia więcej narzędzi required oznacza, że model musi wywoływać co najmniej jedno narzędzie.
Typ	ciąg
Wartości	none auto required

OpenAI.ToolType

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

Majątek	Wartość
Opis	Narzędzie, które może służyć do generowania odpowiedzi.
Typ	ciąg
Wartości	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell bing_grounding browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview azure_ai_search openapi bing_custom_search_preview capture_structured_outputs a2a_preview azure_function memory_search

OpenAI.TopLogProb

Najwyższe prawdopodobieństwo dziennika tokenu.

Name	Typ	Opis	Wymagane	Default
bytes	macierz		Tak
logprob	Liczba		Tak
kod przedpłaty	ciąg		Tak

OpenAI.UpdateConversationRequest

Aktualizowanie konwersacji

Name	Typ	Opis	Wymagane	Default
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.VectorStoreFileAttributes

Zestaw 16 par klucz-wartość, 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, wartości logiczne lub liczby.

Typ: obiekt

OpenAI.WebSearchAction

Dyskryminowanie openAI.WebSearchAction

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

Wartość typu	Schema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

Name	Typ	Opis	Wymagane	Default
typ	OpenAI.WebSearchActionType		Tak

OpenAI.WebSearchActionFind

Typ akcji "find": wyszukuje wzorzec na załadowanej stronie.

Name	Typ	Opis	Wymagane	Default
wzorzec	ciąg	Wzorzec lub tekst do wyszukania na stronie.	Tak
typ	wyliczenie	Typ akcji. Możliwe wartości: find	Tak
Adres URL	ciąg	Adres URL strony wyszukał wzorzec.	Tak

OpenAI.WebSearchActionOpenPage

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

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ akcji. Możliwe wartości: open_page	Tak
Adres URL	ciąg	Adres URL otwarty przez model.	Tak

OpenAI.WebSearchActionSearch

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

Name	Typ	Opis	Wymagane	Default
kwerenda	ciąg	Zapytanie wyszukiwania.	Tak
Źródeł	macierz	Źródła wykorzystane w wyszukiwaniu.	Nie.
typ	wyliczenie	Typ akcji. Możliwe wartości: search	Tak

OpenAI.WebSearchActionSearchSources

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Możliwe wartości: url	Tak
Adres URL	ciąg		Tak

OpenAI.WebSearchActionType

Majątek	Wartość
Typ	ciąg
Wartości	search open_page find

OpenAI.WebSearchPreviewTool

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

Name	Typ	Opis	Wymagane	Default
rozmiar_kontekstu_wyszukiwania	wyliczenie	Ogólne wskazówki dotyczące ilości miejsca w oknie kontekstowym do użycia w wyszukiwaniu. lowJeden z , mediumlub high. medium jest wartością domyślną. Możliwe wartości: low, , mediumhigh	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	Tak
lokalizacja_użytkownika	obiekt		Nie.
└typ	OpenAI.LocationType		Nie.

OpenAI.WebSearchToolCallItemParam

Wyniki wywołania narzędzia wyszukiwania w sieci. Więcej informacji można znaleźć w przewodniku wyszukiwania w Internecie .

Name	Typ	Opis	Wymagane	Default
akcja	obiekt		Tak
└typ	OpenAI.WebSearchActionType		Nie.
typ	wyliczenie	Możliwe wartości: web_search_call	Tak

OpenAI.WebSearchToolCallItemResource

Wyniki wywołania narzędzia wyszukiwania w sieci. Więcej informacji można znaleźć w przewodniku wyszukiwania w Internecie .

Name	Typ	Opis	Wymagane	Default
akcja	obiekt		Tak
└typ	OpenAI.WebSearchActionType		Nie.
stan	wyliczenie	Stan działania wyszukiwarki internetowej. Możliwe wartości: in_progress, , searching, completedfailed	Tak
typ	wyliczenie	Możliwe wartości: web_search_call	Tak

OpenAI.integer

Typ: liczba całkowita

Format: int64

OpenAI.numeric

Typ: liczba

Format: podwójne

OpenApiAgentTool

Informacje o definicji danych wejściowych narzędzia OpenAPI używane do konfigurowania agenta.

Name	Typ	Opis	Wymagane	Default
openapi	obiekt	Informacje o definicji danych wejściowych dla funkcji openapi.	Tak
└* uwierzytelnianie	OpenApiAuthDetails	Szczegóły uwierzytelniania interfejsu API	Nie.
└default_params	macierz	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 └*	macierz	Lista definicji funkcji używanych przez narzędzie OpenApi	Nie.
└─ nazwa	ciąg	Nazwa funkcji do wywołania.	Nie.
└* specyfikacja		Kształt funkcji openapi opisany jako obiekt schematu JSON.	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest 'openapi'. Możliwe wartości: openapi	Tak

OpenApiAnonymousAuthDetails

Szczegóły zabezpieczeń uwierzytelniania anonimowego openApi

Name	Typ	Opis	Wymagane	Default
typ	wyliczenie	Typ obiektu, który jest zawsze "anonimowy". Możliwe wartości: anonymous	Tak

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:

Wartość typu	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to: — Anonimowe (bez wymaganego uwierzytelniania) — Połączenie projektu (wymaga project_connection_id do punktu końcowego, zgodnie z konfiguracją w narzędziu Foundry) - Managed_Identity (wymaga odbiorców uwierzytelniania opartego na tożsamościach)	Tak

OpenApiAuthType

Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to:

• Anonimowy (uwierzytelnianie nie jest wymagane)
• Połączenie projektu (wymaga project_connection_id do punktu końcowego, zgodnie z konfiguracją w narzędziu Foundry)
• Managed_Identity (wymaga odbiorców do uwierzytelniania opartego na tożsamości)

Majątek	Wartość
Typ	ciąg
Wartości	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Informacje o definicji danych wejściowych dla funkcji openapi.

Name	Typ	Opis	Wymagane	Default
auth	obiekt	szczegóły uwierzytelniania dla elementu OpenApiFunctionDefinition	Tak
└typ	OpenApiAuthType	Typ uwierzytelniania musi być anonimowy/project_connection/managed_identity	Nie.
default_params	macierz	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	macierz	Lista definicji funkcji używanych przez narzędzie OpenApi	Nie.
nazwa	ciąg	Nazwa funkcji do wywołania.	Tak
specyfikacja		Kształt funkcji openapi opisany jako obiekt schematu JSON.	Tak

OpenApiManagedAuthDetails

Szczegóły zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Name	Typ	Opis	Wymagane	Default
security_scheme	obiekt	Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity	Tak
└odbiorców	ciąg	Zakres uwierzytelniania dla typu uwierzytelniania managed_identity	Nie.
typ	wyliczenie	Typ obiektu, który jest zawsze "managed_identity". Możliwe wartości: managed_identity	Tak

OpenApiManagedSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Name	Typ	Opis	Wymagane	Default
audience	ciąg	Zakres uwierzytelniania dla typu uwierzytelniania managed_identity	Tak

OpenApiProjectConnectionAuthDetails

Szczegóły zabezpieczeń dotyczące uwierzytelniania połączenia projektu OpenApi

Name	Typ	Opis	Wymagane	Default
security_scheme	obiekt	Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity	Tak
└project_connection_id	ciąg	Identyfikator połączenia projektu dla typu uwierzytelniania połączenia projektu	Nie.
typ	wyliczenie	Typ obiektu, którym zawsze jest 'project_connection'. Możliwe wartości: project_connection	Tak

OpenApiProjectConnectionSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Name	Typ	Opis	Wymagane	Default
project_connection_id	ciąg	Identyfikator połączenia projektu dla typu uwierzytelniania połączenia projektu	Tak

PagedConnection

Stronicowana kolekcja elementów połączenia

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy połączenia na tej stronie	Tak

PagedDatasetVersion

Stronicowana kolekcja elementów DatasetVersion

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy DatasetVersion na tej stronie	Tak

PagedDeployment

Stronicowana kolekcja elementów wdrożenia

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy wdrożenia na tej stronie	Tak

PagedEvaluationRule

Stronicowana kolekcja elementów EvaluationRule

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy EvaluationRule na tej stronie	Tak

PagedEvaluationTaxonomy

Stronicowana kolekcja elementów EvaluationTaxonomy

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy EvaluationTaxonomy na tej stronie	Tak

PagedEvaluatorVersion

Stronicowana kolekcja elementów EvaluatorVersion

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy EvaluatorVersion na tej stronie	Tak

PagedIndex

Stronicowana kolekcja elementów indeksu

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy indeksu na tej stronie	Tak

PagedInsight

Stronicowana kolekcja elementów szczegółowych informacji

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy szczegółowych informacji na tej stronie	Tak

PagedRedTeam

Stronicowana kolekcja elementów RedTeam

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy RedTeam na tej stronie	Tak

PagedSchedule

Stronicowana kolekcja elementów harmonogramu

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy harmonogramu na tej stronie	Tak

PagedScheduleRun

Stronicowana kolekcja elementów ScheduleRun

Name	Typ	Opis	Wymagane	Default
nextLink	ciąg	Link do następnej strony elementów	Nie.
wartość	macierz	Elementy ScheduleRun na tej stronie	Tak

PendingUploadRequest

Reprezentuje prośbę o oczekujące przesłanie.

Name	Typ	Opis	Wymagane	Default
connectionName (nazwa_połączenia)	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	BlobReference jest jedynym obsługiwanym typem. Możliwe wartości: BlobReference	Tak

PendingUploadResponse

Reprezentuje odpowiedź na oczekujące żądanie przesłania

Name	Typ	Opis	Wymagane	Default
BlobReference	obiekt	Szczegóły odwołania do obiektu blob.	Tak
└* 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	Nie.
Poświadczenie └*	SasCredential	Informacje o poświadczeniach w celu uzyskania dostępu do konta magazynu.	Nie.
└* storageAccountArmId	ciąg	Identyfikator usługi ARM konta magazynu do użycia.	Nie.
pendingUploadId	ciąg	Identyfikator tego żądania przesłania.	Tak
pendingUploadType	wyliczenie	BlobReference jest jedynym obsługiwanym typem Możliwe wartości: BlobReference	Tak
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	Opis	Wymagane	Default
instructions	ciąg	Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu.	Nie.
rodzaj	wyliczenie	Możliwe wartości: prompt	Tak
model	ciąg	Wdrożenie modelu do użycia dla tego agenta.	Tak
reasoning	obiekt	Tylko modele serii o Opcje konfiguracji dla modeli rozumowania.	Nie.
└─ wysiłek	OpenAI.ReasoningEffort	Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości nie są żadne, minimalne, niskie, średnie i wysokie. Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi. Wartość domyślna gpt-5.1 nie jest równa żadnej, która nie wykonuje rozumowania. Obsługiwane wartości rozumowania dla biblioteki gpt-5.1 nie są żadne, niskie, średnie i wysokie. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1. Wszystkie modele przed gpt-5.1 domyślnie średni wysiłek rozumowania i nie obsługują żadnego. Domyślnie model gpt-5-pro ma wartość (i obsługuje tylko) duży wysiłek rozumowania.	Nie.
└─ generuj_podsumowanie	wyliczenie	Przestarzałe: użyj summary zamiast. Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. Możliwe wartości: auto, , concisedetailed	Nie.
└─ Podsumowanie	wyliczenie	Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu. autoJeden z , conciselub detailed. 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	Liczba	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	obiekt	Opcje konfiguracji generowania odpowiedzi tekstowej przez model. Może to być zwykły tekst lub dane JSON ze strukturą.	Nie.
Format └─	OpenAI.ResponseTextFormatConfiguration		Nie.
narzędzia	macierz	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	Liczba	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

PromptBasedEvaluatorDefinition

Ewaluator oparty na podpowiedziach

Name	Typ	Opis	Wymagane	Default
prompt_text	ciąg	Tekst monitu używany do oceny	Tak
typ	wyliczenie	Możliwe wartości: prompt	Tak

ProtocolVersionRecord

Mapowanie rekordu dla pojedynczego protokołu i jego wersji.

Name	Typ	Opis	Wymagane	Default
protokół	obiekt		Tak
wersja	ciąg	Ciąg wersji protokołu, np. 'v0.1.1'.	Tak

RaiConfig

Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).

Name	Typ	Opis	Wymagane	Default
rai_policy_name	ciąg	Nazwa zasady RAI, która ma zostać zastosowana.	Tak

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:

Wartość typu	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Typ cyklu.	Tak

RecurrenceTrigger

Wyzwalacz oparty na cyklu.

Name	Typ	Opis	Wymagane	Default
endTime	ciąg	Godzina zakończenia harmonogramu cyklu w formacie ISO 8601.	Nie.
interwał	liczba całkowita	Interwał harmonogramu cyklu.	Tak
grafik	obiekt	Model harmonogramu cykli.	Tak
└typ	Typ cyklu	Typ cyklu dla harmonogramu cyklu.	Nie.
startTime	ciąg	Godzina rozpoczęcia harmonogramu cyklu w formacie ISO 8601.	Nie.
strefa czasowa	ciąg	Strefa czasowa dla harmonogramu cyklu.	Nie.	UTC
typ	wyliczenie	Typ wyzwalacza. Możliwe wartości: Recurrence	Tak

Typ cyklu

Typ cyklu.

Majątek	Wartość
Opis	Typ cyklu.
Typ	ciąg
Wartości	Hourly Daily Weekly Monthly

RedTeam

Szczegóły czerwonej drużyny.

Name	Typ	Opis	Wymagane	Default
applicationScenario	ciąg	Scenariusz aplikacji dla operacji red team, w celu wygenerowania ataków specyficznych dla scenariusza.	Nie.
attackStrategies	macierz	Lista strategii ataku lub zagnieżdżone listy strategii ataku.	Nie.
displayName	ciąg	Nazwa biegu czerwonej drużyny.	Nie.
identyfikator	ciąg	Identyfikator biegu drużyny czerwonej.	Tak
liczbawywracania	liczba całkowita	Liczba rund symulacji.	Nie.
properties	obiekt	Właściwości czerwonej drużyny. 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	macierz	Lista kategorii ryzyka, dla których mają być generowane cele ataku.	Nie.
symulacjaOnly	typ logiczny (boolowski)	Tylko symulacja lub Symulacja + ocena. Wartość domyślna false, jeśli true skanowanie generuje wynik konwersacji, a nie wynik oceny.	Nie.	Nieprawda
stan	ciąg	Status czerwonej drużyny. Jest on ustawiany przez usługę i jest tylko do odczytu.	Nie.
tags	obiekt	Tagi czerwonej drużyny. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
miejsce docelowe	obiekt	Klasa abstrakcyjna dla konfiguracji docelowej.	Tak
└typ	ciąg	Typ konfiguracji modelu.	Nie.

RedTeamItemGenerationParams

Reprezentuje parametry generowania elementów zespołu czerwonego.

Name	Typ	Opis	Wymagane	Default
attack_strategies	macierz	Kolekcja strategii ataków, które mają być używane.	Tak
num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Tak
typ	wyliczenie	Typ parametrów generowania elementów, zawsze red_team. Możliwe wartości: red_team	Tak

Kategoria ryzyka

Kategoria ryzyka dla celu ataku.

Majątek	Wartość
Opis	Kategoria ryzyka dla celu ataku.
Typ	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	Opis	Wymagane	Default
SAS	ciąg	token SAS	Nie.
typ	wyliczenie	Typ poświadczeń Możliwe wartości: SAS	Tak

SampleType

Rodzaj próbki użytej w analizie.

Majątek	Wartość
Typ	ciąg
Wartości	EvaluationResultSample

Poświadczenia SasCredential

Definicja poświadczeń sygnatury dostępu współdzielonego

Name	Typ	Opis	Wymagane	Default
sasUri	ciąg	Identyfikator URI sygnatury dostępu współdzielonego	Tak
typ	wyliczenie	Rodzaj poświadczenia Możliwe wartości: SAS	Tak

Schedule

Model harmonogramu.

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis harmonogramu.	Nie.
displayName	ciąg	Nazwa harmonogramu.	Nie.
włączony	typ logiczny (boolowski)	Włączony stan harmonogramu.	Tak
identyfikator	ciąg	Identyfikator harmonogramu.	Tak
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)	obiekt	Zaplanuj stan apryfikacji.	Nie.
daneSystemowe	obiekt	Metadane systemowe zasobu.	Tak
tags	obiekt	Tagi harmonogramu. W przeciwieństwie do właściwości tagi są w pełni modyfikowalne.	Nie.
zadanie	obiekt	Zaplanuj model zadań.	Tak
Konfiguracja └*	obiekt	Konfiguracja dla zadania.	Nie.
└typ	ScheduleTaskType	Typ zadania.	Nie.
wyzwalacz	obiekt	Model podstawowy dla wyzwalacza harmonogramu.	Tak
└typ	Typ wyzwalacza	Typ wyzwalacza.	Nie.

ScheduleProvisioningStatus

Zaplanuj stan apryfikacji.

Majątek	Wartość
Opis	Zaplanuj stan apryfikacji.
Typ	ciąg
Wartości	Creating Updating Deleting Succeeded Failed

ScheduleRun

Zaplanuj model uruchamiania.

Name	Typ	Opis	Wymagane	Default
błąd	ciąg	Informacje o błędzie dla uruchomienia harmonogramu.	Nie.
identyfikator	ciąg	Identyfikator przebiegu harmonogramu.	Tak
properties	obiekt	Właściwości harmonogramu są uruchamiane.	Tak
identyfikator harmonogramu	ciąg	Identyfikator harmonogramu.	Tak
sukces	typ logiczny (boolowski)	Wyzwalanie stanu powodzenia uruchomienia harmonogramu.	Tak
triggerTime	ciąg	Czas wyzwolenia uruchomienia 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:

Wartość typu	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Name	Typ	Opis	Wymagane	Default
konfiguracja	obiekt	Konfiguracja dla zadania.	Nie.
typ	obiekt	Typ zadania.	Tak

ScheduleTaskType

Typ zadania.

Majątek	Wartość
Opis	Typ zadania.
Typ	ciąg
Wartości	Evaluation Insight

SeedPromptsRedTeamItemGenerationParams

Reprezentuje parametry generowania czerwonego elementu zespołu z monitami dotyczącymi inicjatora.

Name	Typ	Opis	Wymagane	Default
attack_strategies	macierz	Kolekcja strategii ataków, które mają być używane.	Tak
num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Tak
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└typ	wyliczenie	Typ źródła jsonl. Zawsze file_id. Możliwe wartości: file_id	Nie.
typ	wyliczenie	Typ parametrów generowania elementów, zawsze red_team. Możliwe wartości: red_team_seed_prompts	Tak

SharepointAgentTool

Informacje o definicji danych wejściowych narzędzia sharepoint używane do konfigurowania agenta.

Name	Typ	Opis	Wymagane	Default
sharepoint_grounding_preview	obiekt	Parametry narzędzia do uziemiania programu sharepoint.	Tak
└project_connections	macierz	Połączenia projektu dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Nie.
typ	wyliczenie	Typ obiektu, który jest zawsze "sharepoint_grounding". Możliwe wartości: sharepoint_grounding_preview	Tak

SharepointGroundingToolParameters

Parametry narzędzia do uziemiania programu sharepoint.

Name	Typ	Opis	Wymagane	Default
project_connections	macierz	Połączenia projektu dołączone do tego narzędzia. Może istnieć maksymalnie 1 połączenie zasób dołączony do narzędzia.	Nie.

SKU

Informacje o jednostce SKU

Name	Typ	Opis	Wymagane	Default
dyspozycyjność	liczba całkowita	Pojemność jednostki SKU	Tak
family	ciąg	Rodzina SKU	Tak
nazwa	ciąg	Nazwa jednostki SKU	Tak
rozmiar	ciąg	Rozmiar jednostki SKU	Tak
warstwa	ciąg	Warstwa jednostki SKU	Tak

StructuredInputDefinition

Ustrukturyzowane dane wejściowe, które mogą uczestniczyć w monitujących podstawieniach szablonów i wiązaniu argumentów narzędzia.

Name	Typ	Opis	Wymagane	Default
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	typ logiczny (boolowski)	Określa, czy właściwość wejściowa jest wymagana, gdy agent jest wywoływany.	Nie.	Nieprawda
schemat		Schemat JSON dla danych wejściowych ze strukturą (opcjonalnie).	Nie.

StructuredOutputDefinition

Ustrukturyzowane dane wyjściowe, które mogą być generowane przez agenta.

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis danych wyjściowych, które mają zostać wyemitowane. Używany przez model do określania, kiedy należy wyemitować dane wyjściowe.	Tak
nazwa	ciąg	Nazwa ustrukturyzowanych danych wyjściowych.	Tak
schemat		Schemat JSON dla ustrukturyzowanych danych wyjściowych.	Tak
surowy	typ logiczny (boolowski)	Określa, czy wymuszać ścisłą walidację. Wartość domyślna true.	Tak

StructuredOutputsItemResource

Name	Typ	Opis	Wymagane	Default
We/Wy		Dane wyjściowe ze strukturą przechwycone podczas odpowiedzi.	Tak
typ	wyliczenie	Możliwe wartości: structured_outputs	Tak

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:

Wartość typu	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget
azure_ai_assistant	AzureAIAssistantTarget

Name	Typ	Opis	Wymagane	Default
typ	ciąg	Typ obiektu docelowego.	Tak

TargetCompletions

Reprezentuje źródło danych dla docelowej konfiguracji oceny ukończenia.

Name	Typ	Opis	Wymagane	Default
wiadomości wejściowe	obiekt		Nie.
└item_reference	ciąg		Nie.
└typ	wyliczenie	Możliwe wartości: item_reference	Nie.
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└typ	wyliczenie	Typ źródła jsonl. Zawsze file_id. Możliwe wartości: file_id	Nie.
miejsce docelowe	obiekt	Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.	Tak
└typ	ciąg	Typ obiektu docelowego.	Nie.
typ	wyliczenie	Typ źródła danych, zawsze TargetCompletions. Możliwe wartości: azure_ai_target_completions	Tak

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:

Wartość typu	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Typ	Opis	Wymagane	Default
typ	ciąg	Typ konfiguracji modelu.	Tak

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:

Wartość typu	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_assistant	AzureAIAssistantTargetUpdate

Name	Typ	Opis	Wymagane	Default
typ	ciąg	Typ obiektu docelowego.	Tak

TaksonomiaCategory

Definicja kategorii taksonomii.

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis kategorii taksonomii.	Nie.
identyfikator	ciąg	Niepowtarzalny identyfikator kategorii taksonomii.	Tak
nazwa	ciąg	Nazwa kategorii taksonomii.	Tak
properties	obiekt	Dodatkowe właściwości dla kategorii taksonomii.	Nie.
riskCategory	obiekt	Kategoria ryzyka dla celu ataku.	Tak
Podkategorie	macierz	Lista podkategorii taksonomii.	Tak

TaksonomyRedTeamItemGenerationParams

Reprezentuje parametry generowania czerwonego elementu zespołu z monitami dotyczącymi inicjatora.

Name	Typ	Opis	Wymagane	Default
attack_strategies	macierz	Kolekcja strategii ataków, które mają być używane.	Tak
num_turns	liczba całkowita	Liczba zakrętów dozwolona w grze.	Tak
przesłać źródło	obiekt		Tak
└─ zawartość	macierz	Zawartość pliku jsonl.	Nie.
└─ ID	ciąg	Identyfikator pliku.	Nie.
└typ	wyliczenie	Typ źródła jsonl. Zawsze file_id. Możliwe wartości: file_id	Nie.
typ	wyliczenie	Typ parametrów generowania elementów, zawsze red_team. Możliwe wartości: red_team_taxonomy	Tak

TaksonomiaSubCategory

Definicja podkategorii taksonomii.

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Opis podkategorii taksonomii.	Nie.
włączony	typ logiczny (boolowski)	Wykaz pozycji taksonomii w ramach tej podkategorii.	Tak
identyfikator	ciąg	Niepowtarzalny identyfikator podkategorii taksonomii.	Tak
nazwa	ciąg	Nazwa podkategorii taksonomii.	Tak
properties	obiekt	Dodatkowe właściwości dla podkategorii taksonomii.	Nie.

ToolDescription

Opis narzędzia, które może być używane przez agenta.

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Krótki opis przeznaczenia narzędzia.	Nie.
nazwa	ciąg	Nazwa narzędzia.	Nie.

ToolProjectConnection

Zasób połączenia z projektem.

Name	Typ	Opis	Wymagane	Default
project_connection_id	ciąg	Połączenie projektu w elemencie ToolProjectConnectionList dołączonym do tego narzędzia.	Tak

TracesEvalRunDataSource

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	Opis	Wymagane	Default
lookback_hours	liczba całkowita	Okno wyszukiwania (w godzinach) stosowane podczas pobierania śladów z usługi Application Insights.	Nie.	168
trace_ids	macierz	Kolekcja identyfikatorów śledzenia agenta, które powinny być oceniane.	Tak
typ	wyliczenie	Typ źródła danych, zawsze azure_ai_traces. Możliwe wartości: azure_ai_traces	Tak

TreatmentEffectType

Rodzaj efektu zabiegu.

Majątek	Wartość
Typ	ciąg
Wartości	TooFewSamples Inconclusive Changed Improved Degraded

Wyzwalacz

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:

Wartość typu	Schema
Cron	CronTrigger (Wyzwalacz Crona)
Recurrence	Wyzwalacz cyklu
OneTime	OneTimeTrigger

Name	Typ	Opis	Wymagane	Default
typ	obiekt	Typ wyzwalacza.	Tak

Typ wyzwalacza

Typ wyzwalacza.

Majątek	Wartość
Opis	Typ wyzwalacza.
Typ	ciąg
Wartości	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Typ	Opis	Wymagane	Default
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
manifest_id	ciąg	Identyfikator manifestu do zaimportowania wersji agenta.	Tak
metadane	obiekt	Zestaw 16 par klucz-wartość, 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.	Tak

UpdateAgentRequest

Name	Typ	Opis	Wymagane	Default
definicja	obiekt		Tak
Rodzaj └*	AgentKind		Nie.
└rai_config	RaiConfig	Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).	Nie.
opis	ciąg	Czytelny dla człowieka opis agenta.	Nie.
metadane	obiekt	Zestaw 16 par klucz-wartość, 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	Opis	Wymagane	Default
metadane	OpenAI.Metadata	Zestaw 16 par klucz-wartość, 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	Opis	Wymagane	Default
rodzaj	wyliczenie	Rodzaj elementu pamięci. Możliwe wartości: user_profile	Tak

WeeklyRecurrenceSchedule

Tygodniowy harmonogram nawrotów.

Name	Typ	Opis	Wymagane	Default
Dni tygodnia	macierz	Dni tygodnia dla harmonogramu cyklu.	Tak
typ	wyliczenie	Typ nawrotu tygodniowego. Możliwe wartości: Weekly	Tak

WorkflowActionOutputItemResource

Name	Typ	Opis	Wymagane	Default
action_id	ciąg	Unikatowy identyfikator akcji.	Tak
rodzaj	ciąg	Rodzaj akcji CSDL (np. "SetVariable", "InvokeAzureAgent").	Tak
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.
stan	wyliczenie	Stan akcji (np. "in_progress", "completed", "failed", "cancelled". Możliwe wartości: completed, , failed, in_progresscancelled	Tak
typ	wyliczenie	Możliwe wartości: workflow_action	Tak

WorkflowAgentDefinition

Definicja agenta przepływu pracy.

Name	Typ	Opis	Wymagane	Default
rodzaj	wyliczenie	Możliwe wartości: workflow	Tak
przepływ pracy	ciąg	Definicja CSDL YAML przepływu pracy.	Nie.

liczba całkowita

Typ: liczba całkowita

Format: int64