Azure AI Foundry Agent Service (wersja zapoznawcza)
Łatwo integruj Azure AI Foundry Agent Service możliwości z przepływami pracy.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Power Apps | Standard | Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Standard | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft |
| adres URL | https://support.microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://learn.microsoft.com/en-us/azure/ai-services/agents/ |
| Zasady ochrony prywatności | https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security |
| Kategorie | AI; Analiza biznesowa |
Azure usługa agenta sztucznej inteligencji to w pełni zarządzana usługa umożliwiająca deweloperom bezpieczne tworzenie, wdrażanie i skalowanie wysokiej jakości oraz rozszerzalnych agentów sztucznej inteligencji bez konieczności zarządzania podstawowymi zasobami obliczeniowymi i magazynowymi. Azure usługa agenta sztucznej inteligencji integruje modele, narzędzia i technologię oraz umożliwia rozszerzanie agentów z wiedzy na podstawie połączonych źródeł (takich jak wyszukiwanie Bing, SharePoint, Fabric, magazyn obiektów blob Azure i licencjonowane dane) oraz akcje przy użyciu narzędzi, takich jak Azure Logic Apps, Azure Functions, określone narzędzia interfejsu OpenAPI 3.0 i interpreter kodu
Wymagania wstępne
- Azure subskrypcji — Utwórz ją bezpłatnie.
-
Utwórz zasób usługi agenta sztucznej inteligencji Azure w portalu Azure. Pamiętaj, aby utworzyć zasób w obsługiwanym regionie.
- Upewnij się, że masz przypisaną co najmniej rolę użytkownika usługi Cognitive Services dla zasobu usługi agenta sztucznej inteligencji Azure.
Pobieranie poświadczeń
Aby uwierzytelnić żądania interfejsu API, potrzebny będzie punkt końcowy dla zasobów usługi agenta sztucznej inteligencji Azure.
Dla zasobu usługi agenta sztucznej inteligencji Azure:
- Przejdź do zasobu w portalu Azure.
- Na stronie zasobu wybierz pozycję Klucze i punkt końcowy w menu nawigacji po lewej stronie. Zanotuj swoje poświadczenia. Użyjesz jednego z kluczy i punktu końcowego.
Znane problemy i ograniczenia
- Tylko Azure usługa agenta sztucznej inteligencji jest obsługiwana jako usługa agenta z tym łącznikiem platformy Power Platform tylko dla usługi Logic Apps. Nie dotyczy usługi Power Automate i power apps
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Tożsamość zarządzana | Tworzenie połączenia przy użyciu tożsamości zarządzanej | Tylko USŁUGA LOGICAPPS | Udostępnialne |
| Microsoft Entra ID Logowanie użytkownika | Logowanie przy użyciu poświadczeń Microsoft Entra ID | Wszystkie regiony | Nie można udostępniać |
| Domyślne [PRZESTARZAŁE] | Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. | Wszystkie regiony | Nie można udostępniać |
Zarządzana Tożsamość
Identyfikator uwierzytelniania: managedIdentityAuth
Dotyczy: tylko USŁUGA LOGICAPPS
Tworzenie połączenia przy użyciu tożsamości zarządzanej
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz omówienie Connectors dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Zarządzana Tożsamość | managedIdentity | Logowanie przy użyciu tożsamości zarządzanej | Prawda |
| punkt końcowy Project sztucznej inteligencji Azure | ciąg | Nazwa punktu końcowego Project sztucznej inteligencji Azure, na przykład https://{nazwa konta}.services.ai.azure. com/api/projects/{project-name} | Prawda |
logowanie użytkownika Microsoft Entra ID
Identyfikator uwierzytelniania: entraIDUserLogin
Dotyczy: wszystkie regiony
Logowanie przy użyciu poświadczeń Microsoft Entra ID
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| punkt końcowy Project sztucznej inteligencji Azure | ciąg | Nazwa punktu końcowego Project sztucznej inteligencji Azure, na przykład https://{nazwa konta}.services.ai.azure. com/api/projects/{project-name} | Prawda |
Domyślne [PRZESTARZAŁE]
Dotyczy: wszystkie regiony
Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
Limity ograniczania
| Nazwisko | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 1000 | 60 sekund |
Akcje
| Aktualizowanie routingu hostowanego agenta |
Aktualizuje punkt końcowy hostowanego agenta, aby kierować ruch o 100% do określonej aktywnej wersji agenta. Wersje robocze nie mogą być miejscami docelowymi routingu. |
| Biegnij |
Biegnij |
| Lista agentów (usługa agenta) |
Wyświetlanie listy agentów z usługi agenta |
| Pobierz plik hostowanej sesji |
Pobiera zawartość binarną pliku z hostowanej sesji. |
| Protokół aktywności agenta zewnętrznego na podstawie identyfikatora agenta |
Protokół aktywności agenta zewnętrznego na podstawie identyfikatora agenta |
| Protokół aktywności agenta zewnętrznego oparty na aplikacji |
Protokół aktywności agenta zewnętrznego oparty na aplikacji |
| Protokół aktywności agenta zewnętrznego oparty na identyfikatorze agenta z punktem końcowym w wersji 2 |
Protokół aktywności agenta zewnętrznego oparty na identyfikatorze agenta z punktem końcowym w wersji 2 |
| Przekazywanie pliku hostowanej sesji |
Przekazuje nieprzetworzonej zawartości pliku do hostowanej sesji. Maksymalny rozmiar pliku to 50 MB. |
| Tworzenie hostowanego agenta |
Tworzy hostowanego agenta i jego początkową wersję na podstawie obrazu kontenera. |
| Tworzenie sesji hostowanej |
Tworzy sesję hostowanego agenta. Opcjonalnie wybierz określoną wersję agenta; w przeciwnym razie konfiguracja routingu hostowanego agenta wybiera wersję. |
| Tworzenie wersji agenta monitu |
Tworzy nową wersję agenta monitu przy użyciu wdrożenia modelu, instrukcji i narzędzi opcjonalnych. |
| Tworzenie wersji hostowanego agenta |
Tworzy nową wersję hostowanego agenta na podstawie obrazu kontenera. |
| Tworzenie wątku |
Tworzenie wątku |
| Usuń agenta |
Trwale usuwa agenta i wszystkie jego wersje. W przypadku hostowanych agentów aktywne sesje powodują konflikt, chyba że włączono opcję Wymuś usunięcie. |
| Usuń hostowaną sesję |
Usuwa hostowaną sesję agenta, przerywa piaskownicę i zwalnia zasoby. |
| Usuń plik hostowanej sesji |
Usuwa plik lub katalog z hostowanej sesji. |
| Usuń wersję agenta |
Trwale usuwa określoną wersję agenta. W przypadku hostowanych agentów aktywne sesje powodują konflikt, chyba że włączono opcję Wymuś usunięcie. |
| Utwórz przebieg |
Utwórz przebieg |
| Uzyskiwanie sesji hostowanej |
Pobiera hostowaną sesję agenta według identyfikatora sesji. |
| Uzyskiwanie wersji agenta |
Pobiera określoną wersję agenta. |
| Wywołaj agenta monitu |
Wywołuje agenta monitu. |
| Wywoływanie hostowanego agenta (odpowiedzi) |
Wywołuje hostowanego agenta, który uwidacznia protokół Responses. Akcja używa odpowiedzi JSON spoza przesyłania strumieniowego. |
| Wywoływanie hostowanego agenta (wywołania) |
Wywołuje hostowanego agenta, który uwidacznia protokół Wywołania. Kod JSON żądania i odpowiedzi jest definiowany przez implementację hostowanego agenta. |
| Wyłączanie hostowanego agenta |
Wyłącza punkt końcowy hostowanego agenta bez usuwania agenta lub jego wersji. |
| Wyświetlanie listy agentów |
Wyświetlanie listy agentów |
| Wyświetlanie listy hostowanych plików sesji |
Wyświetla listę plików i katalogów w ścieżce w hostowanej sesji. |
| Wyświetlanie listy hostowanych sesji |
Wyświetla listę hostowanych sesji agenta, który jest dostępny dla wywołującego. |
| Wyświetlanie listy komunikatów |
Wyświetlanie listy komunikatów |
| Wyświetlanie listy wersji agenta |
Wyświetla listę wersji agenta. |
| Włączanie hostowanego agenta |
Włącza hostowany punkt końcowy agenta, aby mógł obsługiwać żądania. |
| Zdobądź agenta |
Pobiera agenta i jego najnowszą wersję. |
Aktualizowanie routingu hostowanego agenta
Aktualizuje punkt końcowy hostowanego agenta, aby kierować ruch o 100% do określonej aktywnej wersji agenta. Wersje robocze nie mogą być miejscami docelowymi routingu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Wersja agenta
|
agent_version | True | string |
Aktywna wersja agenta innego niż wersja robocza, która odbiera ruch punktów końcowych. |
Zwraca
- Body
- AgentRecord
Biegnij
Biegnij
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wersja API
|
api-version | True | string |
wersja API |
|
Identyfikator wątku do utworzenia komunikatu.
|
ThreadId | True | string |
Identyfikator wątku do utworzenia komunikatu. |
|
Identyfikator przebiegu.
|
RunId | True | string |
Identyfikator przebiegu. |
Zwraca
- Body
- getRunResponse
Lista agentów (usługa agenta)
Pobierz plik hostowanej sesji
Pobiera zawartość binarną pliku z hostowanej sesji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Identyfikator sesji
|
SessionId | True | string |
Identyfikator hostowanej sesji. |
|
Ścieżka pliku
|
path | True | string |
Ścieżka pliku lub katalogu w hostowanej sesji. |
Zwraca
Zawartość pliku hostowanej sesji.
- Zawartość pliku
- binary
Protokół aktywności agenta zewnętrznego na podstawie identyfikatora agenta
Protokół aktywności agenta zewnętrznego na podstawie identyfikatora agenta
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator agenta do wysłania wiadomości.
|
AgentId | True | string |
Identyfikator agenta do wysłania wiadomości. |
|
|
object |
Zwraca
- response
- object
Protokół aktywności agenta zewnętrznego oparty na aplikacji
Protokół aktywności agenta zewnętrznego oparty na aplikacji
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Aplikacja agenta.
|
MyApplication | True | string |
Aplikacja agenta. |
|
|
object |
Zwraca
- response
- object
Protokół aktywności agenta zewnętrznego oparty na identyfikatorze agenta z punktem końcowym w wersji 2
Protokół aktywności agenta zewnętrznego oparty na identyfikatorze agenta z punktem końcowym w wersji 2
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator agenta do wysłania wiadomości.
|
AgentId | True | string |
Identyfikator agenta do wysłania wiadomości. |
|
|
object |
Zwraca
- response
- object
Przekazywanie pliku hostowanej sesji
Przekazuje nieprzetworzonej zawartości pliku do hostowanej sesji. Maksymalny rozmiar pliku to 50 MB.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Identyfikator sesji
|
SessionId | True | string |
Identyfikator hostowanej sesji. |
|
Ścieżka pliku
|
path | True | string |
Ścieżka pliku lub katalogu w hostowanej sesji. |
|
Zawartość pliku
|
body | True | binary |
Zawartość binarna pliku do przekazania. |
Zwraca
Tworzenie hostowanego agenta
Tworzy hostowanego agenta i jego początkową wersję na podstawie obrazu kontenera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
name | True | string |
Nazwa hostowanego agenta. |
|
Description
|
description | string |
Czytelny dla człowieka opis hostowanego agenta. |
|
|
Metadata
|
metadata | object |
Metadane do skojarzenia z hostowanym agentem. |
|
|
Obraz kontenera
|
image | True | string |
Pełne odwołanie do obrazu kontenera, na przykład myregistry.azurecr.io/my-agent:v1. |
|
Identyfikator połączenia rejestru
|
registry_connection_id | string |
Identyfikator połączenia projektu Foundry dla rejestru kontenerów, jeśli jest to wymagane. |
|
|
CPU
|
cpu | True | string |
Liczba rdzeni procesora CPU żądanych dla kontenera hostowanego agenta, na przykład 1. |
|
Memory
|
memory | True | string |
Ilość pamięci żądanej dla kontenera hostowanego agenta, na przykład 2Gi. |
|
Protocol
|
protocol | True | string |
Protokół udostępniany przez hostowanego agenta. Wybierz pozycję Odpowiedzi lub wywołania. |
|
Zmienne środowiskowe
|
environment_variables | object |
Zmienne środowiskowe przekazane do kontenera hostowanego agenta. |
|
|
Konfiguracja odpowiedzialnej sztucznej inteligencji
|
rai_config | object |
Opcjonalna konfiguracja odpowiedzialnego filtru zawartości sztucznej inteligencji. |
|
|
Konfiguracja telemetrii
|
telemetry_config | object |
Opcjonalna konfiguracja telemetrii. |
|
|
Konfiguracja sesji
|
session_configuration | object |
Opcjonalna konfiguracja sesji hostowanego agenta. |
Zwraca
- Body
- AgentVersionRecord
Tworzenie sesji hostowanej
Tworzy sesję hostowanego agenta. Opcjonalnie wybierz określoną wersję agenta; w przeciwnym razie konfiguracja routingu hostowanego agenta wybiera wersję.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Wersja agenta
|
agent_version | string |
Określona wersja hostowanego agenta dla sesji. Pozostaw wartość pustą, aby użyć konfiguracji routingu hostowanego agenta. |
Zwraca
- Body
- HostedSession
Tworzenie wersji agenta monitu
Tworzy nową wersję agenta monitu przy użyciu wdrożenia modelu, instrukcji i narzędzi opcjonalnych.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Description
|
description | string |
Czytelny dla człowieka opis wersji agenta monitu. |
|
|
Metadata
|
metadata | object |
Metadane do skojarzenia z wersją agenta monitu. |
|
|
Utwórz jako wersję roboczą
|
draft | boolean |
Czy utworzyć wersję roboczą. |
|
|
Wdrożenie modelu
|
model | True | string |
Nazwa wdrożenia modelu dostępna w bieżącym projekcie Foundry. Obsługiwane nazwy modeli bezpośrednich programu Foundry można również wprowadzić ręcznie. |
|
Instructions
|
instructions | string |
Instrukcje systemowe definiujące zachowanie agenta monitu. |
|
|
Tools
|
Tools | object | ||
|
Wybór narzędzia
|
tool_choice |
Określa sposób wybierania narzędzi przez agenta monitu. |
||
|
Temperatura
|
temperature | float |
Temperatura próbkowania z zakresu od 0 do 2. |
|
|
Góra P
|
top_p | float |
Prawdopodobieństwo próbkowania jądra z zakresu od 0 do 1. |
|
|
Konfiguracja tekstu
|
text | object |
Opcjonalna konfiguracja tekstu i danych wyjściowych ze strukturą. |
|
|
Konfiguracja rozumowania
|
reasoning | object |
Opcjonalna konfiguracja rozumowania dla obsługiwanych modeli. |
|
|
Skills
|
Skills | object | ||
|
Dane wejściowe ze strukturą
|
structured_inputs | object |
Opcjonalne definicje danych wejściowych ze strukturą. |
|
|
Uprząż
|
harness | object |
Opcjonalna konfiguracja wykorzystania agenta. |
Zwraca
- Body
- AgentVersionRecord
Tworzenie wersji hostowanego agenta
Tworzy nową wersję hostowanego agenta na podstawie obrazu kontenera.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Description
|
description | string |
Czytelny dla człowieka opis wersji hostowanego agenta. |
|
|
Metadata
|
metadata | object |
Metadane do skojarzenia z wersją hostowanego agenta. |
|
|
Utwórz jako wersję roboczą
|
draft | boolean |
Czy utworzyć wersję roboczą. Wersje robocze są wykluczone z normalnego routingu i list. |
|
|
Obraz kontenera
|
image | True | string |
Pełne odwołanie do obrazu kontenera, na przykład myregistry.azurecr.io/my-agent:v1. |
|
Identyfikator połączenia rejestru
|
registry_connection_id | string |
Identyfikator połączenia projektu Foundry dla rejestru kontenerów, jeśli jest to wymagane. |
|
|
CPU
|
cpu | True | string |
Liczba rdzeni procesora CPU żądanych dla kontenera hostowanego agenta, na przykład 1. |
|
Memory
|
memory | True | string |
Ilość pamięci żądanej dla kontenera hostowanego agenta, na przykład 2Gi. |
|
Protocol
|
protocol | True | string |
Protokół udostępniany przez hostowanego agenta. Wybierz pozycję Odpowiedzi lub wywołania. |
|
Zmienne środowiskowe
|
environment_variables | object |
Zmienne środowiskowe przekazane do kontenera hostowanego agenta. |
|
|
Konfiguracja odpowiedzialnej sztucznej inteligencji
|
rai_config | object |
Opcjonalna konfiguracja odpowiedzialnego filtru zawartości sztucznej inteligencji. |
|
|
Konfiguracja telemetrii
|
telemetry_config | object |
Opcjonalna konfiguracja telemetrii. |
|
|
Konfiguracja sesji
|
session_configuration | object |
Opcjonalna konfiguracja sesji hostowanego agenta. |
Zwraca
- Body
- AgentVersionRecord
Tworzenie wątku
Tworzenie wątku
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wersja API
|
api-version | True | string |
wersja API |
|
rola
|
role | string |
Rola jednostki tworzącej komunikat. Może być użytkownikiem lub asystentem. "użytkownik" wskazuje, że komunikat jest wysyłany przez rzeczywistego użytkownika i powinien być używany w większości przypadków do reprezentowania komunikatów generowanych przez użytkownika. "asystent" wskazuje, że komunikat jest generowany przez asystenta. Użyj tej wartości, aby wstawić wiadomości z asystenta do konwersacji. |
|
|
zawartość
|
content | string |
Zawartość wiadomości. |
|
|
nazwa
|
name | string |
Lista identyfikatorów plików lub komunikatów, których można użyć w przebiegu. |
|
|
metadane
|
metadata | object |
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. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków. |
|
|
metadane
|
metadata | object |
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. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków. |
|
|
tool_resources
|
tool_resources | object |
Zestaw zasobów udostępnianych narzędziom asystenta w tym wątku. Zasoby są specyficzne dla typu narzędzia. Na przykład narzędzie code_interpreter wymaga listy identyfikatorów plików, a narzędzie file_search wymaga listy identyfikatorów magazynów wektorów. |
Zwraca
- Body
- createThreadResponse
Usuń agenta
Trwale usuwa agenta i wszystkie jego wersje. W przypadku hostowanych agentów aktywne sesje powodują konflikt, chyba że włączono opcję Wymuś usunięcie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Wymuś usunięcie
|
force | boolean |
W przypadku hostowanych agentów usuń aktywne sesje skojarzone z agentem lub wersją. |
Usuń hostowaną sesję
Usuwa hostowaną sesję agenta, przerywa piaskownicę i zwalnia zasoby.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Identyfikator sesji
|
SessionId | True | string |
Identyfikator hostowanej sesji. |
Usuń plik hostowanej sesji
Usuwa plik lub katalog z hostowanej sesji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Identyfikator sesji
|
SessionId | True | string |
Identyfikator hostowanej sesji. |
|
Ścieżka pliku
|
path | True | string |
Ścieżka pliku lub katalogu w hostowanej sesji. |
Usuń wersję agenta
Trwale usuwa określoną wersję agenta. W przypadku hostowanych agentów aktywne sesje powodują konflikt, chyba że włączono opcję Wymuś usunięcie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Wersja agenta
|
AgentVersion | True | string |
Identyfikator wersji agenta. |
|
Wymuś usunięcie
|
force | boolean |
W przypadku hostowanych agentów usuń aktywne sesje skojarzone z agentem lub wersją. |
Utwórz przebieg
Utwórz przebieg
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wersja API
|
api-version | True | string |
wersja API |
|
Identyfikator wątku do utworzenia komunikatu.
|
ThreadId | True | string |
Identyfikator wątku do utworzenia komunikatu. |
|
assistant_id
|
assistant_id | True | string |
Identyfikator asystenta do wykonania tego przebiegu. |
|
model
|
model | string |
Nazwa wdrożenia modelu, która ma być używana do wykonania tego przebiegu. Jeśli zostanie podana, zastąpi nazwę wdrożenia modelu asystenta. |
|
|
instructions
|
instructions | string |
Zastępuje instrukcje asystenta. Przydatne do modyfikowania zachowania dla poszczególnych przebiegów. |
|
|
additional_instructions
|
additional_instructions | string |
Dołącza dodatkowe instrukcje na końcu instrukcji dotyczących przebiegu. |
|
|
rola
|
role | string |
Rola jednostki tworzącej komunikat. Może być użytkownikiem lub asystentem. "użytkownik" wskazuje, że komunikat jest wysyłany przez rzeczywistego użytkownika i powinien być używany w większości przypadków do reprezentowania komunikatów generowanych przez użytkownika. "asystent" wskazuje, że komunikat jest generowany przez asystenta. Użyj tej wartości, aby wstawić wiadomości z asystenta do konwersacji. |
|
|
zawartość
|
content | string |
Zawartość wiadomości. |
|
|
nazwa
|
name | string |
Lista identyfikatorów plików lub komunikatów, których można użyć w przebiegu. |
|
|
metadane
|
metadata | object |
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. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków. |
|
|
nazwa
|
name | string |
Lista narzędzi, które mogą być używane w przebiegu. |
|
|
metadane
|
metadata | object |
Zestaw 16 par klucz-wartość dołączonych do obiektu. Maksymalna długość kluczy: 64 znaki, Maksymalna długość wartości: 512 znaków. |
|
|
temperatura
|
temperature | number |
Temperatura próbkowania (0–2). Wyższe wartości (np. 0,8) zwiększają losowość, niższe wartości (np. 0,2) sprawiają, że dane wyjściowe będą bardziej deterministyczne. |
|
|
top_p
|
top_p | number |
Próbkowanie jądra alternatywą dla temperatury. 0,1 oznacza, że rozważa się 10% masy prawdopodobieństwa. |
|
|
odtwarzać strumieniowo
|
stream | boolean |
Jeśli wartość true, zwraca strumień zdarzeń podczas uruchamiania jako zdarzenia wysyłane przez serwer, kończąc z komunikatem "data: [DONE]". |
|
|
max_prompt_tokens
|
max_prompt_tokens | integer |
Maksymalna liczba tokenów ukończenia, które mogą być używane przez przebieg. W przypadku przekroczenia przebieg kończy się jako niekompletny. |
|
|
max_completion_tokens
|
max_completion_tokens | integer |
Maksymalna liczba tokenów ukończenia, które mogą być używane przez przebieg. W przypadku przekroczenia przebieg kończy się jako niekompletny. |
|
|
truncation_strategy
|
truncation_strategy | object |
Określa sposób obcinania wątku przed uruchomieniem w celu zarządzania początkowym oknem kontekstu. |
|
|
tool_choice
|
tool_choice |
Określa narzędzie, które wywołuje model. Wartość domyślna to "auto", co pozwala modelowi zdecydować. Można ustawić wartość "none", aby wyłączyć użycie narzędzia. |
||
|
format_odpowiedzi
|
response_format | object |
Określa format danych wyjściowych. Ustawienie { "type": "json_object" } włącza tryb JSON dla prawidłowych odpowiedzi JSON. |
Zwraca
- Body
- createRunResponse
Uzyskiwanie sesji hostowanej
Pobiera hostowaną sesję agenta według identyfikatora sesji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Identyfikator sesji
|
SessionId | True | string |
Identyfikator hostowanej sesji. |
Zwraca
- Body
- HostedSession
Uzyskiwanie wersji agenta
Pobiera określoną wersję agenta.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Wersja agenta
|
AgentVersion | True | string |
Identyfikator wersji agenta. |
Zwraca
- Body
- AgentVersionRecord
Wywołaj agenta monitu
Wywołuje agenta monitu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wersja API
|
api-version | True | string |
wersja API |
|
metadane
|
metadata | object |
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. |
|
|
użytkownik
|
user | string |
Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. Dowiedz się więcej. |
|
|
top_logprobs
|
top_logprobs | integer |
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. |
|
|
previous_response_id
|
previous_response_id | string |
Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego, aby utworzyć wielokrotne konwersacje. Dowiedz się więcej o stanie konwersacji. |
|
|
tło
|
background | boolean |
Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej. |
|
|
max_output_tokens
|
max_output_tokens | integer |
Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania. |
|
|
max_tool_calls
|
max_tool_calls | integer |
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. |
|
|
typ
|
type | True | string |
Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie Domyślny format to Niezalecane w przypadku modeli gpt-4o i nowszych: Włączenie trybu |
|
typ
|
type | True | string |
Narzędzie, które może służyć do generowania odpowiedzi. |
|
tool_choice
|
tool_choice |
W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , |
||
|
id
|
id | True | string |
Unikatowy identyfikator szablonu monitu do użycia. |
|
wersja
|
version | string |
Opcjonalna wersja szablonu monitu. |
|
|
variables
|
variables | object |
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. |
|
|
truncation
|
truncation | string |
Strategia obcinania, która ma być użyta dla odpowiedzi modelu.
|
|
|
dane wejściowe
|
input |
Dane wejściowe tekstu, obrazu lub pliku w modelu używane do generowania odpowiedzi. Więcej informacji: |
||
|
include
|
include | string |
Określ dodatkowe dane wyjściowe do uwzględnienia w odpowiedzi modelu. Obecnie obsługiwane wartości to:
|
|
|
wywołania_narzędzia_równoległe
|
parallel_tool_calls | boolean |
Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi. |
|
|
przechowywać
|
store | boolean |
Określa, czy przechowywać wygenerowaną odpowiedź modelu na potrzeby późniejszego pobierania za pośrednictwem interfejsu API. |
|
|
instructions
|
instructions | string |
Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. W przypadku używania wraz z |
|
|
Identyfikator konwersacji
|
id | True | string |
Identyfikator konwersacji. Wybierz pozycję "Utwórz nową konwersację", aby utworzyć nową konwersację. |
|
typ
|
type | True | string | |
|
nazwa
|
name | True | string |
Nazwa agenta. |
|
wersja
|
version | True | string |
Identyfikator wersji agenta. |
Zwraca
- Body
- OpenAI.Response
Wywoływanie hostowanego agenta (odpowiedzi)
Wywołuje hostowanego agenta, który uwidacznia protokół Responses. Akcja używa odpowiedzi JSON spoza przesyłania strumieniowego.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Dane wejściowe
|
input | True |
Tekst, obraz, plik lub ustrukturyzowane dane wejściowe dla hostowanego agenta. |
|
|
Poprzedni identyfikator odpowiedzi
|
previous_response_id | string |
Poprzedni identyfikator odpowiedzi umożliwiający kontynuowanie interakcji obejmującej wiele obrotu. |
|
|
Instructions
|
instructions | string |
Dodatkowe instrukcje dotyczące tej odpowiedzi. |
|
|
Odpowiedź na magazyn
|
store | boolean |
Czy przechowywać odpowiedź na potrzeby późniejszego pobierania. |
|
|
Uruchamianie w tle
|
background | boolean |
Czy uruchomić odpowiedź w tle. |
|
|
Maksymalna liczba tokenów wyjściowych
|
max_output_tokens | integer |
Maksymalna liczba tokenów wyjściowych. |
|
|
Metadata
|
metadata | object |
Metadane do skojarzenia z odpowiedzią. |
|
|
User
|
user | string |
Unikatowy identyfikator użytkownika końcowego. |
Zwraca
- Body
- OpenAI.Response
Wywoływanie hostowanego agenta (wywołania)
Wywołuje hostowanego agenta, który uwidacznia protokół Wywołania. Kod JSON żądania i odpowiedzi jest definiowany przez implementację hostowanego agenta.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
|
object |
Ładunek JSON oczekiwany przez program obsługi wywołań agenta hostowanego. |
Zwraca
- response
- object
Wyłączanie hostowanego agenta
Wyłącza punkt końcowy hostowanego agenta bez usuwania agenta lub jego wersji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
Wyświetlanie listy agentów
Wyświetlanie listy agentów
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wersja API
|
api-version | True | string |
wersja API |
Zwraca
- Body
- listAgentsResponse
Wyświetlanie listy hostowanych plików sesji
Wyświetla listę plików i katalogów w ścieżce w hostowanej sesji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
|
|
Identyfikator sesji
|
SessionId | True | string |
Identyfikator hostowanej sesji. |
|
Ścieżka katalogu
|
path | string |
Ścieżka katalogu do listy. Wartość domyślna to bieżący katalog sesji. |
Zwraca
Wyświetlanie listy hostowanych sesji
Wyświetla listę hostowanych sesji agenta, który jest dostępny dla wywołującego.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Klucz izolacji użytkownika
|
x-ms-user-isolation-key | string |
Opcjonalny klucz partycjonowania dla hostowanych agentów skonfigurowany z izolacją sesji opartej na nagłówku. Użyj tej samej wartości dla każdej operacji w sesji. Ten klucz nie zapewnia uwierzytelniania. |
Zwraca
Wyświetlanie listy komunikatów
Wyświetlanie listy komunikatów
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
wersja API
|
api-version | True | string |
wersja API |
|
Identyfikator wątku do utworzenia komunikatu.
|
ThreadId | True | string |
Identyfikator wątku do utworzenia komunikatu. |
Zwraca
- Body
- listMessageResponse
Wyświetlanie listy wersji agenta
Wyświetla listę wersji agenta.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
|
Uwzględnij wersje robocze
|
include_drafts | boolean |
Czy należy uwzględnić wersje robocze. Usługa domyślnie wyklucza wersje robocze. |
|
|
Limit
|
limit | integer |
Maksymalna liczba wersji do zwrócenia. |
|
|
Order
|
order | string |
Kolejność sortowania według znacznika czasu created_at. |
|
|
Po kursorze
|
after | string |
Zwraca wersje po tym kursorze. |
|
|
Przed kursorem
|
before | string |
Zwraca wersje przed tym kursorem. |
Zwraca
Włączanie hostowanego agenta
Włącza hostowany punkt końcowy agenta, aby mógł obsługiwać żądania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
Zdobądź agenta
Pobiera agenta i jego najnowszą wersję.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa agenta
|
AgentName | True | string |
Nazwa agenta. |
Zwraca
- Body
- AgentRecord
Definicje
listAgentsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
obiekt
|
object | string |
Szczegóły typu obiektu odpowiedzi. |
|
dane
|
data | array of Data |
Lista komunikatów zwracanych przez usługę. |
|
first_id
|
first_id | string |
Szczegóły pierwszego identyfikatora. |
|
last_id
|
last_id | string |
Szczegóły ostatniego identyfikatora. |
|
zawiera_więcej
|
has_more | boolean |
Informuje, czy jest tam więcej agentów. |
listAgentsServiceResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of AgentServiceData |
Lista agentów zwróconych przez usługę. |
AgentServiceData
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator agenta. |
|
nazwa
|
name | string |
Nazwa agenta. |
|
opis
|
description | string |
Opis agenta. |
|
wersja
|
version | string |
Wersja agenta. |
|
createdAt
|
createdAt | date-time |
Po utworzeniu agenta. |
AgentRecord
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
obiekt
|
object | string |
Typ obiektu. |
|
id
|
id | string |
Unikatowy identyfikator agenta. |
|
nazwa
|
name | string |
Nazwa agenta. |
|
stan
|
state | string |
Stan operacyjny agenta. |
|
configuration_state
|
configuration_state | string |
Stan konfiguracji agenta. |
|
state_source
|
state_source | string |
Źródło bieżącego stanu. |
|
versions
|
versions | AgentRecordVersions | |
|
agent_endpoint
|
agent_endpoint | object |
Konfiguracja punktu końcowego agenta. |
|
digital_worker_type
|
digital_worker_type | string |
Typ cyfrowego procesu roboczego, jeśli ma to zastosowanie. |
|
instance_identity
|
instance_identity | object |
Tożsamość wystąpienia agenta. |
|
konspekt
|
blueprint | object |
Tożsamość strategii agenta. |
|
blueprint_reference
|
blueprint_reference | object |
Referencja do planu agenta. |
|
agent_card
|
agent_card | object |
Karta agenta, jeśli jest dostępna. |
AgentRecordVersions
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
najnowszy
|
latest | AgentVersionRecord |
AgentVersionRecord
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
metadane
|
metadata | object |
Metadane skojarzone z wersją agenta. |
|
obiekt
|
object | string |
Typ obiektu. |
|
id
|
id | string |
Unikatowy identyfikator wersji agenta. |
|
nazwa
|
name | string |
Nazwa agenta. |
|
wersja
|
version | string |
Identyfikator wersji. |
|
opis
|
description | string |
Czytelny dla człowieka opis wersji agenta. |
|
utworzono_o
|
created_at | integer |
Sygnatura czasowa systemu Unix w sekundach utworzenia wersji agenta. |
|
definicja
|
definition | object |
Definicja agenta. |
|
roboczy
|
draft | boolean |
Czy jest to wersja robocza. |
|
stan
|
status | string |
Status provisioningu wersji agenta. |
|
instance_identity
|
instance_identity | object |
Tożsamość wystąpienia wersji agenta. |
|
konspekt
|
blueprint | object |
Tożsamość strategii wersji agenta. |
|
blueprint_reference
|
blueprint_reference | object |
Dokumentacja strategii dla wersji agenta. |
|
agent_guid
|
agent_guid | string |
Unikalny identyfikator GUID agenta. |
AgentVersionListResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
obiekt
|
object | string |
Typ obiektu. |
|
dane
|
data | array of AgentVersionRecord |
Lista wersji agentów zwracanych przez usługę. |
|
first_id
|
first_id | string |
Pierwszy identyfikator obiektu na stronie. |
|
last_id
|
last_id | string |
Ostatni identyfikator obiektu na stronie. |
|
zawiera_więcej
|
has_more | boolean |
Czy są dostępne więcej wyników. |
HostedSession
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
agent_session_id
|
agent_session_id | string |
Identyfikator hostowanej sesji. |
|
version_indicator
|
version_indicator | HostedSessionVersionIndicator | |
|
stan
|
status | string |
Bieżący stan sesji. |
|
utworzono_o
|
created_at | integer |
Sygnatura czasowa systemu Unix w sekundach, kiedy sesja została utworzona. |
|
last_accessed_at
|
last_accessed_at | integer |
Sygnatura czasowa systemu Unix w sekundach, kiedy sesja była ostatnio uzyskiwana. |
|
wygasa_o
|
expires_at | integer |
Sygnatura czasowa systemu Unix w sekundach po wygaśnięciu sesji. |
|
stopped_at
|
stopped_at | integer |
Sygnatura czasowa systemu Unix w sekundach, kiedy sesja została zatrzymana, jeśli ma to zastosowanie. |
HostedSessionVersionIndicator
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Typ wskaźnika wyboru wersji. |
|
agent_version
|
agent_version | string |
Wersja hostowanego agenta przypisana do sesji. |
HostedSessionListResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of HostedSession |
Sesje hostowane zwrócone przez usługę. |
|
first_id
|
first_id | string |
Pierwszy identyfikator hostowanej sesji na stronie. |
|
last_id
|
last_id | string |
Ostatni identyfikator hostowanej sesji na stronie. |
|
zawiera_więcej
|
has_more | boolean |
Czy są dostępne więcej hostowanych sesji. |
HostedSessionFileUploadResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ścieżka
|
path | string |
Ścieżka przekazanego pliku. |
|
bytes_written
|
bytes_written | integer |
Liczba zapisanych bajtów. |
|
success
|
success | boolean |
Czy przekazywanie powiodło się. |
|
source_type
|
source_type | string |
Typ źródła używany do przekazywania. |
HostedSessionFileListResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ścieżka
|
path | string |
Ścieżka katalogu, która została wyświetlona. |
|
Wpisy
|
entries | array of HostedSessionFileEntry |
Pliki i katalogi w żądanej ścieżce. |
|
zawiera_więcej
|
has_more | boolean |
Określa, czy są dostępne więcej wpisów. |
HostedSessionFileEntry
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa pliku lub katalogu. |
|
size
|
size | integer |
Rozmiar pliku w bajtach. |
|
is_directory
|
is_directory | boolean |
Czy wpis jest katalogiem. |
|
modified_time
|
modified_time | integer |
Czas modyfikacji wpisu zgłoszony przez hostowaną sesję. |
createThreadResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. |
|
obiekt
|
object | string |
Typ obiektu, który jest zawsze wątkiem. |
|
utworzono_o
|
created_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia wątku. |
|
metadane
|
metadata | object |
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. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć długość maksymalnie 512 znaków. |
createRunResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. |
|
obiekt
|
object | string |
Typ obiektu, który jest zawsze thread.run. |
|
utworzono_o
|
created_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia przebiegu. |
|
thread_id
|
thread_id | string |
Identyfikator wątku, który został wykonany w ramach tego przebiegu. |
|
assistant_id
|
assistant_id | string |
Identyfikator asystenta używanego do wykonywania tego przebiegu. |
|
stan
|
status | string |
Stan przebiegu, który można umieścić w kolejce, in_progress, requires_action, anulowanie, anulowanie, niepowodzenie, ukończenie lub wygaśnięcie. |
|
required_action
|
required_action | object |
Szczegółowe informacje na temat akcji wymaganej do kontynuowania przebiegu. Jeśli żadna akcja nie jest wymagana, będzie mieć wartość null. |
|
ostatni błąd
|
last_error | object |
Ostatni błąd skojarzony z tym przebiegiem. Wartość null będzie mieć wartość null, jeśli nie ma żadnych błędów. |
|
wygasa_o
|
expires_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia przebiegu. |
|
started_at
|
started_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu uruchomienia przebiegu. |
|
anulowano_o
|
cancelled_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania przebiegu. |
|
nie powiodło się o
|
failed_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla czasu niepowodzenia uruchomienia. |
|
zakończono_o
|
completed_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia przebiegu. |
|
model
|
model | string |
Nazwa wdrożenia modelu używana przez asystenta do tego przebiegu. |
|
instructions
|
instructions | string |
Instrukcje używane przez asystenta do tego przebiegu. |
|
narzędzia
|
tools | array of tools |
Lista narzędzi używanych przez asystenta do tego przebiegu. |
|
identyfikatory_plików
|
file_ids | array of fileIds |
Lista identyfikatorów plików asystenta używanego na potrzeby tego przebiegu. |
|
metadane
|
metadata | object |
Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć maksymalnie 512 znaków. |
|
tool_choice
|
tool_choice |
Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. "none" oznacza, że model nie wywoła żadnych narzędzi i zamiast tego generuje komunikat. "auto" oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określanie narzędzia takiego jak {'type': 'file_search'} lub {'type': 'function', 'function': {'name': 'my_function'}} wymusza wywołanie tego narzędzia przez model. |
|
|
max_prompt_tokens
|
max_prompt_tokens | number |
Maksymalna liczba tokenów monitów określonych do użycia w trakcie przebiegu. |
|
max_completion_tokens
|
max_completion_tokens | number |
Maksymalna liczba tokenów ukończenia określonych do użycia w trakcie przebiegu. |
|
użycie
|
usage | object |
Statystyki użycia związane z uruchomieniem. Ta wartość będzie mieć wartość null, jeśli przebieg nie znajduje się w stanie terminalu (np. in_progress, w kolejce). |
|
truncation_strategy
|
truncation_strategy | object |
Określa sposób obcinania wątku przed uruchomieniem. |
|
format_odpowiedzi
|
response_format | string |
Format, który musi zostać wygenerowany przez model. Zgodny z GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. |
getRunResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. |
|
obiekt
|
object | string |
Typ obiektu, który jest zawsze thread.run. |
|
utworzono_o
|
created_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia przebiegu. |
|
thread_id
|
thread_id | string |
Identyfikator wątku, który został wykonany w ramach tego przebiegu. |
|
assistant_id
|
assistant_id | string |
Identyfikator asystenta używanego do wykonywania tego przebiegu. |
|
stan
|
status | string |
Stan przebiegu, który można umieścić w kolejce, in_progress, requires_action, anulowanie, anulowanie, niepowodzenie, ukończenie lub wygaśnięcie. |
|
required_action
|
required_action | object |
Szczegółowe informacje na temat akcji wymaganej do kontynuowania przebiegu. Jeśli żadna akcja nie jest wymagana, będzie mieć wartość null. |
|
ostatni błąd
|
last_error | object |
Ostatni błąd skojarzony z tym przebiegiem. Wartość null będzie mieć wartość null, jeśli nie ma żadnych błędów. |
|
wygasa_o
|
expires_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla czasu wygaśnięcia przebiegu. |
|
started_at
|
started_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu uruchomienia przebiegu. |
|
anulowano_o
|
cancelled_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu anulowania przebiegu. |
|
nie powiodło się o
|
failed_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla czasu niepowodzenia uruchomienia. |
|
zakończono_o
|
completed_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu ukończenia przebiegu. |
|
model
|
model | string |
Nazwa wdrożenia modelu używana przez asystenta do tego przebiegu. |
|
instructions
|
instructions | string |
Instrukcje używane przez asystenta do tego przebiegu. |
|
narzędzia
|
tools | array of tools |
Lista narzędzi używanych przez asystenta do tego przebiegu. |
|
identyfikatory_plików
|
file_ids | array of fileIds |
Lista identyfikatorów plików asystenta używanego na potrzeby tego przebiegu. |
|
metadane
|
metadata | object |
Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć maksymalnie 512 znaków. |
|
tool_choice
|
tool_choice |
Określa, które narzędzie (jeśli istnieje) jest wywoływane przez model. "none" oznacza, że model nie wywoła żadnych narzędzi i zamiast tego generuje komunikat. "auto" oznacza, że model może wybierać między generowaniem komunikatu lub wywoływaniem narzędzia. Określanie narzędzia takiego jak {'type': 'file_search'} lub {'type': 'function', 'function': {'name': 'my_function'}} wymusza wywołanie tego narzędzia przez model. |
|
|
max_prompt_tokens
|
max_prompt_tokens | number |
Maksymalna liczba tokenów monitów określonych do użycia w trakcie przebiegu. |
|
max_completion_tokens
|
max_completion_tokens | number |
Maksymalna liczba tokenów ukończenia określonych do użycia w trakcie przebiegu. |
|
użycie
|
usage | object |
Statystyki użycia związane z uruchomieniem. Ta wartość będzie mieć wartość null, jeśli przebieg nie znajduje się w stanie terminalu (np. in_progress, w kolejce). |
|
truncation_strategy
|
truncation_strategy | object |
Określa sposób obcinania wątku przed uruchomieniem. |
|
format_odpowiedzi
|
response_format | string |
Format, który musi zostać wygenerowany przez model. Zgodny z GPT-4 Turbo i wszystkimi modelami GPT-3.5 Turbo od gpt-3.5-turbo-1106. |
listMessageResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
obiekt
|
object | string |
Szczegóły typu obiektu odpowiedzi |
|
dane
|
data | array of Data |
Lista komunikatów zwracanych przez usługę. |
|
first_id
|
first_id | string |
Szczegóły pierwszego identyfikatora |
|
last_id
|
last_id | string |
Szczegóły ostatniego identyfikatora |
|
zawiera_więcej
|
has_more | boolean |
Informuje, czy istnieje więcej agentów |
Dane
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API. |
|
obiekt
|
object | string |
Typ obiektu, który jest zawsze asystentem. |
|
utworzono_o
|
created_at | integer |
Sygnatura czasowa systemu Unix (w sekundach) dla momentu utworzenia asystenta. |
|
nazwa
|
name | string |
Nazwa asystenta. Maksymalna długość to 256 znaków. |
|
opis
|
description | string |
Opis asystenta. Maksymalna długość to 512 znaków. |
|
model
|
model | string |
Nazwa nazwy wdrożenia modelu do użycia. |
|
instructions
|
instructions | string |
Instrukcje systemowe używane przez asystenta. Maksymalna długość to 32768 znaków. |
|
narzędzia
|
tools | array of tools |
Lista narzędzi włączonych w asystencie. Może istnieć maksymalnie 128 narzędzi na asystenta. Narzędzia mogą być typami code_interpreter lub funkcji. Opis funkcji może mieć maksymalnie 1024 znaki. |
|
metadane
|
metadata | object |
Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Przydatne do przechowywania dodatkowych informacji w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć maksymalnie 512 znaków. |
|
temperatura
|
temperature | number |
Wartość domyślna to 1. Określa temperaturę próbkowania do użycia 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. |
|
top_p
|
top_p | number |
Wartość domyślna to 1. Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. |
|
format_odpowiedzi
|
response_format | object |
Określa format, który model musi wyświetlić. Ustawienie tego parametru na { "type": "json_object" } włącza tryb JSON, upewniając się, że komunikat jest prawidłowy w formacie JSON. |
|
tool_resources
|
tool_resources | object |
Zestaw zasobów używanych przez narzędzia asystenta. Zasoby są specyficzne dla typu narzędzia. Na przykład narzędzie code_interpreter wymaga listy identyfikatorów plików, a narzędzie file_search wymaga listy identyfikatorów magazynów wektorów. |
OpenAI.ServiceTier
Określa typ przetwarzania używany do obsługi żądania.
- Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone z warstwą usługi skonfigurowaną w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej.
- Jeśli zostanie ustawiona wartość "domyślna", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu.
- Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone przy użyciu odpowiedniej warstwy usługi. 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 .
Określa typ przetwarzania używany do obsługi żądania.
- Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone z warstwą usługi skonfigurowaną w ustawieniach Project. Jeśli nie skonfigurowano inaczej, Project będzie używać wartości domyślnej.
- Jeśli zostanie ustawiona wartość "domyślna", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu.
- Jeśli ustawiono wartość "flex" lub "priority", żądanie zostanie przetworzone przy użyciu odpowiedniej warstwy usługi. 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 .
OpenAI.Reasoning
Tylko modele serii o
Opcje konfiguracji dla modeli rozumowania.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nakład pracy
|
effort | string | |
|
podsumowanie
|
summary | string |
Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu.
|
|
generate_summary
|
generate_summary | string |
Przestarzałe: użyj Podsumowanie rozumowania wykonywanego przez model. Może to być przydatne do debugowania i zrozumienia procesu rozumowania modelu.
|
KonfiguracjaFormatuTekstuOdpowiedzi.OpenAI
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | OpenAI.ResponseTextFormatConfigurationType |
Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie Domyślny format to Niezalecane w przypadku modeli gpt-4o i nowszych: Włączenie trybu |
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 przewodniku Dotyczącym danych wyjściowych ze strukturą.
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ą.
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 przewodniku Dotyczącym danych wyjściowych ze strukturą.
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ą.
OpenAI.Tool
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | OpenAI.ToolType |
Narzędzie, które może służyć do generowania odpowiedzi. |
OpenAI.ToolType
Narzędzie, które może służyć do generowania odpowiedzi.
Narzędzie, które może służyć do generowania odpowiedzi.
OpenAI.Prompt
Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator szablonu monitu do użycia. |
|
wersja
|
version | string |
Opcjonalna wersja szablonu monitu. |
|
variables
|
variables | 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. |
OpenAI.Response
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
metadane
|
metadata | object |
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. |
|
temperatura
|
temperature | float |
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
|
top_p | float |
Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa. Ogólnie zalecamy zmienić to lub |
|
użytkownik
|
user | string |
Unikatowy identyfikator reprezentujący użytkownika końcowego, który może pomóc usłudze OpenAI w monitorowaniu i wykrywaniu nadużyć. Dowiedz się więcej. |
|
poziom usługi
|
service_tier | OpenAI.ServiceTier |
Określa typ przetwarzania używany do obsługi żądania.
Po ustawieniu parametru |
|
top_logprobs
|
top_logprobs | integer |
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. |
|
previous_response_id
|
previous_response_id | string |
Unikatowy identyfikator poprzedniej odpowiedzi na model. Użyj tego, aby utworzyć wielokrotne konwersacje. Dowiedz się więcej o stanie konwersacji. |
|
model
|
model | string |
Wdrożenie modelu do użycia na potrzeby tworzenia tej odpowiedzi. |
|
reasoning
|
reasoning | OpenAI.Reasoning |
Tylko modele serii o Opcje konfiguracji dla modeli rozumowania. |
|
tło
|
background | boolean |
Czy uruchomić odpowiedź modelu w tle. Dowiedz się więcej. |
|
max_output_tokens
|
max_output_tokens | integer |
Górna granica liczby tokenów, które można wygenerować dla odpowiedzi, w tym widoczne tokeny wyjściowe i tokeny rozumowania. |
|
max_tool_calls
|
max_tool_calls | integer |
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. |
|
format
|
text.format | OpenAI.ResponseTextFormatConfiguration | |
|
narzędzia
|
tools | array of OpenAI.Tool |
Tablica narzędzi, które model może wywołać podczas generowania odpowiedzi. Możesz określić, którego narzędzia użyć, ustawiając Dwie kategorie narzędzi, które można modelowi podać, to:
|
|
tool_choice
|
tool_choice |
W jaki sposób model powinien wybrać narzędzie (lub narzędzia), które ma być używane podczas generowania odpowiedzi. Zobacz parametr , |
|
|
monit
|
prompt | OpenAI.Prompt |
Odwołanie do szablonu monitu i jego zmiennych. Dowiedz się więcej. |
|
truncation
|
truncation | string |
Strategia obcinania, która ma być użyta dla odpowiedzi modelu.
|
|
id
|
id | string |
Unikatowy identyfikator tej odpowiedzi. |
|
obiekt
|
object | string |
Typ obiektu tego zasobu — zawsze ustawiony na |
|
stan
|
status | string |
Stan generowania odpowiedzi.
|
|
utworzono_o
|
created_at | unixtime |
Sygnatura czasowa systemu Unix (w sekundach) czasu utworzenia tej odpowiedzi. |
|
błąd
|
error | OpenAI.ResponseError |
Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi. |
|
powód
|
incomplete_details.reason | string |
Powód, dla którego odpowiedź jest niekompletna. |
|
We/Wy
|
output | array of OpenAI.ItemResource |
Tablica elementów zawartości wygenerowanych przez model.
|
|
instructions
|
instructions |
Komunikat systemu (lub dewelopera) wstawiony do kontekstu modelu. W przypadku używania wraz z |
|
|
output_text
|
output_text | string |
Właściwość przeznaczona tylko dla zestawu SDK, która zawiera zagregowane dane wyjściowe tekstu ze wszystkich elementów w tablicy |
|
użycie
|
usage | 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. |
|
wywołania_narzędzia_równoległe
|
parallel_tool_calls | boolean |
Czy zezwolić modelowi na równoległe uruchamianie wywołań narzędzi. |
|
id
|
conversation.id | string |
Identyfikator konwersacji, aby ustawić konwersację dla tej odpowiedzi. Jeśli zostanie podana wiadomość "utwórz nową konwersację", zostanie uruchomiona nowa konwersacja z tą odpowiedzią jako pierwsza wiadomość. |
|
agent
|
agent | AgentId |
OpenAI.ResponseError
Obiekt błędu zwracany, gdy model nie może wygenerować odpowiedzi.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | OpenAI.ResponseErrorCode |
Kod błędu odpowiedzi. |
|
komunikat
|
message | string |
Czytelny dla człowieka opis błędu. |
OpenAI.ResponseErrorCode
OpenAI.ItemResource
Element zawartości używany do generowania odpowiedzi.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | OpenAI.ItemType | |
|
id
|
id | string |
OpenAI.ItemType
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.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
input_tokens
|
input_tokens | integer |
Liczba tokenów wejściowych. |
|
cached_tokens
|
input_tokens_details.cached_tokens | integer |
Liczba tokenów pobranych z pamięci podręcznej. Więcej informacji na temat buforowania monitów. |
|
output_tokens
|
output_tokens | integer |
Liczba tokenów wyjściowych. |
|
tokeny_rozumowania
|
output_tokens_details.reasoning_tokens | integer |
Liczba tokenów rozumowania. |
|
total_tokens
|
total_tokens | integer |
Całkowita liczba użytych tokenów. |
Identyfikator agenta
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string | |
|
nazwa
|
name | string |
Nazwa agenta. |
|
wersja
|
version | string |
Identyfikator wersji agenta. |
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.
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
object |
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. |
narzędzia
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Lista narzędzi, które mogą być używane w przebiegu. |
fileIds
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Lista identyfikatorów plików, których można użyć w przebiegu. |
obiekt
Jest to typ 'obiekt'.
binarny
Jest to podstawowy typ danych "binary".