Microsoft Műhely

API-verzió: v1

Hitelesítés

Folyamat: implicit

Engedélyezési URL-cím:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök:

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

Agents

Ügynökök – ügynök létrehozása

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

Létrehozza az ügynököt.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview, , HostedAgents=V1PreviewWorkflowAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	AgentDefinition		Igen
└─ fajta	AgentKind		Igen
└─ rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	Az ügynököt azonosító egyedi név. A név az ügynök lekérésére/frissítésére/törlésére használható. - Alfanumerikus karakterekkel kell kezdődnie és végződnie, - Középen kötőjeleket tartalmazhat - Nem haladhatja meg a 63 karaktert. Korlátozások: maxLength: 63	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynökök listázása

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

Az összes ügynök listáját adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
kind	lekérdezés	No	karakterlánc Lehetséges értékek: prompt, hosted, , container_appworkflow	Ügynökök szűrése természetben. Ha nincs megadva, a rendszer minden ügynököt visszaad.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynök lekérése

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

Lekéri az ügynököt.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A lekérni kívánt ügynök neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – frissítési ügynök

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

Frissíti az ügynököt egy új verzió hozzáadásával, ha az ügynök definíciója módosul. Ha nincs változás, a meglévő ügynökverziót adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A lekérni kívánt ügynök neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview, , HostedAgents=V1PreviewWorkflowAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	AgentDefinition		Igen
└─ fajta	AgentKind		Igen
└─ rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynök törlése

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

Ügynök törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A törölni kívánt ügynök neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DeleteAgentResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynök frissítése jegyzékből

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

Az ügynök jegyzékből való frissítéséhez adjon hozzá egy új verziót, ha az ügynök definíciója módosul. Ha nincs változás, a meglévő ügynökverziót adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A frissíteni kívánt ügynök neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
manifest_id	karakterlánc	A jegyzékazonosító, amelyből importálni szeretné az ügynök verzióját.	Igen
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
parameter_values	objektum	A jegyzék bemenetei, amelyek teljes mértékben materializált ügynököt eredményeznek.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynökverzió létrehozása

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

Hozzon létre egy új ügynökverziót.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynököt azonosító egyedi név. A név az ügynök lekérésére/frissítésére/törlésére használható. - Alfanumerikus karakterekkel kell kezdődnie és végződnie, - Középen kötőjeleket tartalmazhat - Nem haladhatja meg a 63 karaktert.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview, , HostedAgents=V1PreviewWorkflowAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	AgentDefinition		Igen
└─ fajta	AgentKind		Igen
└─ rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentVersionObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynökverziók listázása

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

Egy ügynök verzióinak listáját adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A verziókat lekérni kívánt ügynök neve.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynökverzió lekérése

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

Egy ügynök egy adott verziójának lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A lekérni kívánt ügynök neve.
agent_version	elérési út	Igen	karakterlánc	A lekérni kívánt ügynök verziója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentVersionObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynökverzió törlése

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

Törli egy ügynök egy adott verzióját.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	A törölni kívánt ügynök neve.
agent_version	elérési út	Igen	karakterlánc	A törölni kívánt ügynök verziója
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DeleteAgentVersionResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynökverzió létrehozása jegyzékből

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

Hozzon létre egy új ügynökverziót egy jegyzékfájlból.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynököt azonosító egyedi név. A név az ügynök lekérésére/frissítésére/törlésére használható. - Alfanumerikus karakterekkel kell kezdődnie és végződnie, - Középen kötőjeleket tartalmazhat - Nem haladhatja meg a 63 karaktert.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
manifest_id	karakterlánc	A jegyzékazonosító, amelyből importálni szeretné az ügynök verzióját.	Igen
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
parameter_values	objektum	A jegyzék bemenetei, amelyek teljes mértékben materializált ügynököt eredményeznek.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentVersionObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynökök – ügynök létrehozása jegyzékből

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

Létrehoz egy ügynököt egy jegyzékből.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
manifest_id	karakterlánc	A jegyzékazonosító, amelyből importálni szeretné az ügynök verzióját.	Igen
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	Az ügynököt azonosító egyedi név. A név az ügynök lekérésére/frissítésére/törlésére használható. - Alfanumerikus karakterekkel kell kezdődnie és végződnie, - Középen kötőjeleket tartalmazhat - Nem haladhatja meg a 63 karaktert. Korlátozások: maxLength: 63	Igen
parameter_values	objektum	A jegyzék bemenetei, amelyek teljes mértékben materializált ügynököt eredményeznek.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók

Ügynöktárolók – ügynöktároló-műveletek listázása

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

Ügynök tárolóműveleteinek listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynöktároló-művelet lekérése

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

Egy ügynök tárolóműveletének állapotának lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
operation_id	elérési út	Igen	karakterlánc	A művelet azonosítója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentContainerOperationObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynöktároló lekérése

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

Tároló lekérése egy ügynök adott verziójához.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AgentContainerObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynökverziós tárolóműveletek listázása

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

Az ügynök egy adott verziójához tartozó tárolóműveletek listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynöktároló törlése

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

Az ügynök egy adott verziójához tartozó tároló törlése. Ha a tartály nem létezik, akkor a művelet no-oplesz. A művelet egy hosszú ideig futó művelet. A Azure REST API-k hosszú ideig futó műveleteinek tervezési irányelveit követve. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 202

Leírás: A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be.

Content-Type	Type	Leírás
application/json	AgentContainerOperationObject

Válaszfejlécek:

Header	Típus	Description
Művelet helye	karakterlánc

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynök tárolónaplóinak streamelése

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

A tárolóból szöveges adattömbökként streamelt tárolónapló-bejegyzés. Minden adattömb egy UTF-8 sztring, amely lehet egyszerű szöveges naplósor vagy JSON-formátumú naplóbejegyzés a streamelt tárolónapló típusától függően. Az ügyfeleknek átlátszatlan szövegként kell kezelniük az egyes adattömböket, és szükség esetén meg kell próbálniuk JSON-ként elemezni a naplózási követelmények alapján.

Rendszernaplók esetén: A formátum JSON a következő struktúrával: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Csatlakozás az eseménygyűjtőhöz...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"ReplicaName":null,"Msg":"Sikeresen csatlakozott az eseményekhez server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

A konzolnaplók esetében a formátum egyszerű szöveg, amelyet a tároló stdout/stderr fájlja bocsát ki. 2025-12-15T08:43:48.72656 Csatlakozás az "ügynök-tároló" tárolóhoz... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
kind	lekérdezés	No	karakterlánc Lehetséges értékek: console, system	a konzol a tároló stdout/stderr értékét adja vissza, a rendszer a tárolóalkalmazás eseményfolyamát adja vissza. alapértelmezett beállítások a konzolon
replica_name	lekérdezés	No	karakterlánc	Ha nincs megadva, a kiszolgáló kiválasztja a konzolnaplók első replikáját. Egy adott replika megcélzásához szükséges.
vég	lekérdezés	No	egész szám	A visszaadott záró vonalak száma. 1-300-ra kényszerítve. Alapértelmezett érték: 20
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynöktároló indítása

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

Indítsa el az ügynök egy adott verziójához tartozó tárolót. Ha a konténer már működik, akkor a művelet no-oplesz. A művelet egy hosszú ideig futó művelet. A Azure REST API-k hosszú ideig futó műveleteinek tervezési irányelveit követve. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
max_replicas	egész szám	A replikák maximális száma. Alapértelmezett érték: 1.	No	1
min_replicas	egész szám	A replikák minimális száma. Alapértelmezett érték: 1.	No	1

Responses

Állapotkód: 202

Leírás: A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be.

Content-Type	Type	Leírás
application/json	AgentContainerOperationObject

Válaszfejlécek:

Header	Típus	Description
Művelet helye	karakterlánc

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynöktároló leállítása

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

Az ügynök egy adott verziójához tartozó tároló leállítása. Ha a konténer nem működik, vagy már leállt, a művelet no-oplesz. A művelet egy hosszú ideig futó művelet. A Azure REST API-k hosszú ideig futó műveleteinek tervezési irányelveit követve. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 202

Leírás: A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be.

Content-Type	Type	Leírás
application/json	AgentContainerOperationObject

Válaszfejlécek:

Header	Típus	Description
Művelet helye	karakterlánc

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ügynöktárolók – ügynöktároló frissítése

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

Az ügynök egy adott verziójához tartozó tároló frissítése. Ha a konténer nem fut, a művelet no-oplesz. A művelet egy hosszú ideig futó művelet. A Azure REST API-k hosszú ideig futó műveleteinek tervezési irányelveit követve. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	elérési út	Igen	karakterlánc	Az ügynök neve.
agent_version	elérési út	Igen	karakterlánc	Az ügynök verziója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: ContainerAgents=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
max_replicas	egész szám	A replikák maximális száma.	No
min_replicas	egész szám	A replikák minimális száma.	No

Responses

Állapotkód: 202

Leírás: A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be.

Content-Type	Type	Leírás
application/json	AgentContainerOperationObject

Válaszfejlécek:

Header	Típus	Description
Művelet helye	karakterlánc

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Connections

Kapcsolatok – lista

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

A projekt összes kapcsolatának listázása a kapcsolat hitelesítő adatainak feltöltése nélkül

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
connectionType	lekérdezés	No	karakterlánc Lehetséges értékek: AzureOpenAI, AzureBlob, AzureStorageAccount, CognitiveSearch, CosmosDBApiKey, AppConfig, AppInsights, , , CustomKeysRemoteTool_Preview	Ilyen típusú kapcsolatok listázása
defaultConnection	lekérdezés	No	boolean	Alapértelmezett kapcsolatok listázása

Kérelem fejléce

Name	Szükséges	Típus	Description
x-ms-client-request-id	Téves	karakterlánc	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedConnection

Válaszfejlécek:

Header	Típus	Description
x-ms-client-request-id		A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kapcsolatok – lekérés

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

Kapcsolat lekérése név alapján, a kapcsolat hitelesítő adatainak feltöltése nélkül

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	A felhasználó által megadott kapcsolat rövid neve.

Kérelem fejléce

Name	Szükséges	Típus	Description
x-ms-client-request-id	Téves	karakterlánc	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Connection

Válaszfejlécek:

Header	Típus	Description
x-ms-client-request-id		A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kapcsolatok – hitelesítő adatok lekérése

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

Kapcsolat lekérése név alapján a kapcsolat hitelesítő adataival

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	A felhasználó által megadott kapcsolat rövid neve.

Kérelem fejléce

Name	Szükséges	Típus	Description
x-ms-client-request-id	Téves	karakterlánc	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Connection

Válaszfejlécek:

Header	Típus	Description
x-ms-client-request-id		A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Datasets

Adathalmazok – legfrissebbek listázása

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

Az egyes DatasetVersion legújabb verziójának listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedDatasetVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Adatkészletek – listaverziók

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

Az adott DatasetVersion összes verziójának listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedDatasetVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Adatkészletek – verzió lekérése

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

Szerezze be a DatasetVersion adott verzióját. A szolgáltatás 404 Nem található hibát ad vissza, ha a DatasetVersion nem létezik.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A lekérni kívánt DatasetVersion adott verzióazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DatasetVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Adathalmazok – verzió törlése

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

Törölje a DatasetVersion adott verzióját. A szolgáltatás 204 No Content értéket ad vissza, ha a DatasetVersion sikeresen törölve lett, vagy ha az DatasetVersion nem létezik.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A törölni kívánt DatasetVersion verziója.

Responses

Állapotkód: 204

Leírás: A kéréshez nincs elküldhető tartalom, de a fejlécek hasznosak lehetnek.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Adathalmazok – verzió létrehozása vagy frissítése

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

Új vagy meglévő DatasetVersion frissítése a megadott verzióazonosítóval

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A létrehozandó vagy frissíteni kívánt DatasetVersion adott verzióazonosítója.

Kérelem tartalma

Tartalomtípus: alkalmazás/merge-patch+json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	DatasetType	Szám az adatok típusának meghatározásához.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DatasetVersion

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	DatasetVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Adathalmazok – hitelesítő adatok lekérése

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

Kérje le az SAS-hitelesítő adatokat az adatkészlet-verzióhoz társított tárfiók eléréséhez.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A működtetni kívánt DatasetVersion adott verzióazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	AssetCredentialResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Adatkészletek – függőben lévő feltöltési verzió indítása

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

Új vagy függőben lévő adathalmaz feltöltése egy adott verzióhoz.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A működtetni kívánt DatasetVersion adott verzióazonosítója.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
connectionName	karakterlánc	Az ideiglenes SAS-jogkivonat létrehozásához használandó Azure Storage-fiók kapcsolatneve	No
pendingUploadId	karakterlánc	Ha nincs megadva PendingUploadId, a rendszer véletlenszerű GUID azonosítót használ.	No
pendingUploadType	felsorolás	A BlobReference az egyetlen támogatott típus. Lehetséges értékek: BlobReference	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PendingUploadResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Telepítések

Üzemelő példányok – lista

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

A projektben üzembe helyezett összes modell listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
modelPublisher	lekérdezés	No	karakterlánc	Modellkiadó a modellek szűréséhez
modelName	lekérdezés	No	karakterlánc	Modellnév (a közzétevő konkrét neve) a modellek szűréséhez
deploymentType	lekérdezés	No	karakterlánc Lehetséges értékek: ModelDeployment	A lista szűréséhez szükséges üzembe helyezés típusa

Kérelem fejléce

Name	Szükséges	Típus	Description
x-ms-client-request-id	Téves	karakterlánc	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedDeployment

Válaszfejlécek:

Header	Típus	Description
x-ms-client-request-id		A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Üzembe helyezés – lekérés

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

Telepített modell lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az üzembe helyezés neve

Kérelem fejléce

Name	Szükséges	Típus	Description
x-ms-client-request-id	Téves	karakterlánc	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Üzembe helyezés

Válaszfejlécek:

Header	Típus	Description
x-ms-client-request-id		A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési osztályozások

Értékelési osztályozások – lista

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

Kiértékelési osztályozások listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
inputName	lekérdezés	No	karakterlánc	Szűrés a kiértékelési bemeneti név alapján.
inputType	lekérdezés	No	karakterlánc	Szűrés osztályozási bemeneti típus szerint.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedEvaluationTaxonomy

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési osztályozások – get

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

Próbaidőszak lekérése név szerint.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluationTaxonomy

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési osztályozások – törlés

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

A kiértékelési osztályozás törlése név alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 204

Leírás: A kéréshez nincs elküldhető tartalom, de a fejlécek hasznosak lehetnek.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési osztályozások – létrehozás

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

Kiértékelési osztályozás létrehozása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	A kiértékelési osztályozás neve.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
properties	objektum	A kiértékelési osztályozás további tulajdonságai.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
taxonomyCategories	a TaxonomyCategory tömbje	Osztályozási kategóriák listája.	No
taxonomyInput	EvaluationTaxonomyInput	A kiértékelési taxonómia bemeneti konfigurációja.	Igen
└─ típus	EvaluationTaxonomyInputType	A kiértékelési osztályozás bemeneti típusa.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluationTaxonomy

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	EvaluationTaxonomy

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési osztályozások – frissítés

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

Kiértékelési osztályozás frissítése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	A kiértékelési osztályozás neve.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
properties	objektum	A kiértékelési osztályozás további tulajdonságai.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
taxonomyCategories	a TaxonomyCategory tömbje	Osztályozási kategóriák listája.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	A kiértékelési taxonómia bemeneti konfigurációja.	No
└─ típus	EvaluationTaxonomyInputType	A kiértékelési osztályozás bemeneti típusa.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluationTaxonomy

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési szabályok

Értékelési szabályok – lista

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

Az összes értékelési szabály listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
actionType	lekérdezés	No	karakterlánc Lehetséges értékek: continuousEvaluation, humanEvaluationPreview	Szűrés a kiértékelési szabály típusa szerint.
ügynöknév	lekérdezés	No	karakterlánc	Szűrés az ügynök neve alapján.
enabled	lekérdezés	No	boolean	Szűrjön az engedélyezett állapot alapján.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedEvaluationRule

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési szabályok – lekérés

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

Kiértékelési szabály lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	A kiértékelési szabály egyedi azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluationRule

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési szabályok – törlés

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

Kiértékelési szabály törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	A kiértékelési szabály egyedi azonosítója.

Responses

Állapotkód: 204

Leírás: A kéréshez nincs elküldhető tartalom, de a fejlécek hasznosak lehetnek.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelési szabályok – létrehozás vagy frissítés

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

Kiértékelési szabály létrehozása vagy frissítése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	A kiértékelési szabály egyedi azonosítója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	Téves	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	EvaluationRuleAction	Értékelési cselekvési modell.	Igen
└─ típus	EvaluationRuleActionType	Az értékelési művelet típusa.	Igen
leírás	karakterlánc	A kiértékelési szabály leírása.	No
displayName	karakterlánc	A kiértékelési szabály megjelenítendő neve.	No
enabled	boolean	Azt jelzi, hogy a kiértékelési szabály engedélyezve van-e. Alapértelmezett érték: true (igaz).	Igen
eventType	EvaluationRuleEventType	A kiértékelési szabály eseményének típusa.	Igen
szűrő	EvaluationRuleFilter	Kiértékelési szűrőmodell.	No
└─ ügynöknév	karakterlánc	Szűrés ügynöknév alapján.	Igen
id	sztring (írásvédett)	A kiértékelési szabály egyedi azonosítója.	Igen
rendszeradatok	objektum (írásvédett)	A kiértékelési szabály rendszer metaadatai.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluationRule

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	EvaluationRule

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Értékelők

Értékelők – a legújabb verziók listázása

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

Az egyes értékelők legújabb verziójának felsorolása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
típus	lekérdezés	No	karakterlánc Lehetséges értékek: builtin, , customall	Kiértékelők szűrése típus szerint. Lehetséges értékek: 'all', 'custom', 'builtin'.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, az alapértelmezett érték pedig 20.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedEvaluatorVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kiértékelők – verziók listázása

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

Sorolja fel az adott értékelő összes verzióját

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
típus	lekérdezés	No	karakterlánc Lehetséges értékek: builtin, , customall	Kiértékelők szűrése típus szerint. Lehetséges értékek: 'all', 'custom', 'builtin'.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, az alapértelmezett érték pedig 20.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedEvaluatorVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kiértékelők – verzió létrehozása

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

Új EvaluatorVersion létrehozása automatikusan növekményes verzióazonosítóval

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
categories	Az EvaluatorCategory tömbje	Az értékelő kategóriái	Igen
definíció	EvaluatorDefinition	Alapkiértékelő konfiguráció diszkriminátorral	Igen
└─ data_schema	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti adataihoz. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
└─ init_parameters	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti paramétereihez. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
└─ metrikák	objektum	Az értékelő által előállított kimeneti metrikák listája	No
└─ típus	EvaluatorDefinitionType	Az értékelő típusának meghatározása	Igen
leírás	karakterlánc	Az eszköz leírásának szövege.	No
display_name	karakterlánc	Megjelenítendő név az értékelő számára. Segít, ha az AI Foundry-ben könnyen megtalálod az értékelőt. Nem kell egyedinek lennie.	No
evaluator_type	EvaluatorType	Az értékelő típusa	Igen
metaadat	objektum	Metaadatok az értékelőről	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No

Responses

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	EvaluatorVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kiértékelők – verzió lekérése

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

Szerezze be az EvaluatorVersion adott verzióját. A szolgáltatás 404 Nem található hibaüzenetet ad vissza, ha az EvaluatorVersion nem létezik.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A lekérni kívánt EvaluatorVersion adott verzióazonosítója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluatorVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kiértékelők – verzió törlése

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

Törölje az EvaluatorVersion adott verzióját. A szolgáltatás 204 Nincs tartalom értéket ad vissza, ha az EvaluatorVersion sikeresen törölve lett, vagy ha az EvaluatorVersion nem létezik.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A törölni kívánt EvaluatorVersion verziója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 204

Leírás: A kéréshez nincs elküldhető tartalom, de a fejlécek hasznosak lehetnek.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Kiértékelők – verzió frissítése

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

Meglévő EvaluatorVersion frissítése a megadott verzióazonosítóval

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A frissítendő EvaluatorVersion verziója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Evaluations=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
categories	Az EvaluatorCategory tömbje	Az értékelő kategóriái	No
leírás	karakterlánc	Az eszköz leírásának szövege.	No
display_name	karakterlánc	Megjelenítendő név az értékelő számára. Segít, ha az AI Foundry-ben könnyen megtalálod az értékelőt. Nem kell egyedinek lennie.	No
metaadat	objektum	Metaadatok az értékelőről	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvaluatorVersion

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Indexes

Indexek – legújabb lista

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

Az egyes indexek legújabb verziójának listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedIndex

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Indexek – listaverziók

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

Az adott index összes verziójának listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedIndex

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Indexek – verzió lekérése

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

Az index adott verziójának lekérése. A szolgáltatás 404 Nem található hibát ad vissza, ha az index nem létezik.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A lekérni kívánt index adott verzióazonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Index

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Indexek – verzió törlése

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

Törölje az index adott verzióját. A szolgáltatás a 204 No Content értéket adja vissza, ha az indexet sikeresen törölték, vagy ha az index nem létezik.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A törölni kívánt index verziója.

Responses

Állapotkód: 204

Leírás: A kéréshez nincs elküldhető tartalom, de a fejlécek hasznosak lehetnek.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Indexek – verzió létrehozása vagy frissítése

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

Új vagy meglévő index frissítése a megadott verzióazonosítóval

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	Az erőforrás neve
verzió	elérési út	Igen	karakterlánc	A létrehozandó vagy frissítendő index adott verzióazonosítója.

Kérelem tartalma

Tartalomtípus: alkalmazás/merge-patch+json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	IndexTípus		Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Index

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	Index

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Insights

Elemzések – létrehozás

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

Elemzések létrehozása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Insights=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.
Ismételhetőség –Request-ID	Téves	karakterlánc	Egyedi, ügyfél által generált azonosító a kérések idempotenciájának biztosításához. Használja ugyanazt az azonosítót az újrapróbálkozásokhoz az ismétlődő kiértékelések elkerülése érdekében.
Ismételhetőség –First-Sent	Téves	karakterlánc	A kérés első kezdeményezésének időpontját jelző időbélyeg. Az idempotencia-vezérléshez az repeatability-request-id azonosítóval együtt használatos.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
displayName	karakterlánc	A megállapítás felhasználóbarát megjelenítendő neve.	Igen
id	sztring (írásvédett)	Az elemzési jelentés egyedi azonosítója.	Igen
metaadat	InsightsMetadata (írásvédett )	Metaadatok az elemzésekről.	Igen
└─ befejezve.	karakterlánc	Az elemzések befejezésének időbélyege.	No
└─ createdAt	karakterlánc	Az elemzések létrehozásának időbélyege.	Igen
kérelem	InsightRequest	Az elemzési jelentés kérése.	Igen
└─ típus	InsightType	A kérés típusa.	Igen
result	InsightResult (írásvédett)	A betekintések eredménye.	No
└─ típus	InsightType	Az elemzési eredmények típusa.	Igen
state	Azure. Core.Foundations.OperationState (írásvédett)	Az engedélyezett műveleti állapotokat leíró felsorolás.	Igen

Responses

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	Bepillantás

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Elemzések – lista

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

Az összes elemzést fordított időrendi sorrendben listázhatja (előbb a legújabb).

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
típus	lekérdezés	No	karakterlánc Lehetséges értékek: EvaluationRunClusterInsight, , AgentClusterInsightEvaluationComparison	Szűrés az elemzés típusa szerint.
evalId	lekérdezés	No	karakterlánc	Szűrés a kiértékelési azonosító alapján.
runId	lekérdezés	No	karakterlánc	Szűrés a kiértékelési futtatás azonosítója alapján.
ügynöknév	lekérdezés	No	karakterlánc	Szűrés az ügynök neve alapján.
includeCoordinates	lekérdezés	No	boolean	A vizualizáció koordinátáinak szerepeltetése a válaszban. Alapértelmezés szerint hamis.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Insights=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedInsight

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Elemzések – lekérés

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

Adjon meg egy konkrét megállapítást azonosító szerint.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	Az elemzési jelentés egyedi azonosítója.
includeCoordinates	lekérdezés	No	boolean	A vizualizáció koordinátáinak szerepeltetése a válaszban. Alapértelmezés szerint hamis.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Insights=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Bepillantás

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Memóriatárolók

Memóriatároló létrehozása

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

Hozzon létre egy memóriatárolót.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	MemoryStoreDefinition	A memóriatároló konfigurációinak alapdefiníciója.	Igen
└─ fajta	MemoryStoreKind	A memóriatároló típusa.	Igen
leírás	karakterlánc	A memóriatároló ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	A memóriatárolóhoz társítandó tetszőleges kulcs-érték metaadatok.	No
név	karakterlánc	A memóriatároló neve. Korlátozások: maxLength: 256	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	MemoryStoreObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Memóriatárolók listázása

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

Az összes memóriatároló listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Memóriatároló frissítése

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

Memóriatároló frissítése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A frissíteni kívánt memóriatároló neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	A memóriatároló ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	A memóriatárolóhoz társítandó tetszőleges kulcs-érték metaadatok.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	MemoryStoreObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Memóriatároló lekérése

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

Memóriatároló lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A lekérni kívánt memóriatároló neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	MemoryStoreObject

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Memóriatároló törlése

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

Memóriatároló törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A törölni kívánt memóriatároló neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DeleteMemoryStoreResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Frissítés eredményének lekérése

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

Szerezze be a memóriatároló frissítési eredményét.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A memóriatároló neve.
update_id	elérési út	Igen	karakterlánc	A memóriafrissítési művelet azonosítója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	MemoryStoreUpdateResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Hatókör-emlékek törlése

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

Törölje az adott hatókörhöz társított összes memóriát a memóriatárolóból.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A memóriatároló neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti a törölni kívánt emlékeket, például egy felhasználói azonosítót.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	MemoryStoreDeleteScopeResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Emlékek keresése

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

Releváns emlékek keresése egy memóriatárból a beszélgetési környezet alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A keresendő memóriatároló neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
items	OpenAI.InputItem tömb	Olyan elemek, amelyekhez releváns emlékeket kell keresni.	No
options	MemorySearchOptions	Memóriakeresési lehetőségek.	No
└─ max_memories	egész szám	A visszaadandó memóriaelemek maximális száma.	No
previous_search_id	karakterlánc	Az előző keresési kérelem egyedi azonosítója, amely lehetővé teszi a növekményes memóriakeresést onnan, ahol az utolsó művelet abbahagyta.	No
hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	MemoryStoreSearchResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Emlékek frissítése

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

Frissítse a memóriatárolót beszélgetési emlékekkel.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
név	elérési út	Igen	karakterlánc	A frissíteni kívánt memóriatároló neve.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: MemoryStores=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
items	OpenAI.InputItem tömb	Olyan beszélgetési elemek, amelyekből emlékeket nyerhet ki.	No
previous_update_id	karakterlánc	Az előző frissítési kérelem egyedi azonosítója, amely lehetővé teszi a növekményes memóriafrissítéseket, ahonnan az utolsó művelet abbahagyta.	No
hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen
update_delay	egész szám	Időtúllépési időszak a memóriafrissítés másodpercben történő feldolgozása előtt. Ha ebben az időszakban új frissítési kérelem érkezik, az megszakítja az aktuális kérést, és alaphelyzetbe állítja az időtúllépést. Állítsa a 0 értéket a frissítés késedelem nélküli azonnali aktiválásához. Alapértelmezés szerint 300 (5 perc).	No	300

Responses

Állapotkód: 202

Leírás: A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be.

Content-Type	Type	Leírás
application/json	MemoryStoreUpdateResponse

Válaszfejlécek:

Header	Típus	Description
Művelet helye	karakterlánc	A műveleti állapot figyelésének helye.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetések

Beszélgetés létrehozása

POST {endpoint}/openai/v1/conversations

Beszélgetés létrehozása.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
items	OpenAI.InputItem tömb		No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ConversationResource

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetések listázása

GET {endpoint}/openai/v1/conversations

Az összes beszélgetés listáját adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
agent_name	lekérdezés	No	karakterlánc	Szűrés ügynöknév alapján. Ha meg van adva, a rendszer csak a megadott ügynökhöz társított elemeket adja vissza.
agent_id	lekérdezés	No	karakterlánc	Szűrés ügynökazonosító szerint a formátumban name:version. Ha meg van adva, a rendszer csak a megadott ügynökazonosítóhoz társított elemeket adja vissza.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetés frissítése

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

Beszélgetés frissítése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	A frissíteni kívánt beszélgetés azonosítója.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ConversationResource

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetés lekérése

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

Lekéri a beszélgetést.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	A lekérni kívánt beszélgetés azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ConversationResource

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetés törlése

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

Beszélgetés törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	A törölni kívánt beszélgetés azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.DeletedConversationResource

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetési elemek létrehozása

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

Elemek létrehozása egy beszélgetésben a megadott azonosítóval.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	Annak a beszélgetésnek az azonosítója, amelyen létre kell hozni az elemet.
include	lekérdezés	No	tömb	További mezők, hogy szerepeljenek a válaszban. További információkért tekintse meg a include beszélgetési elemek felsorolásának paraméterét.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
items	OpenAI.Item tömbje	A beszélgetéshez hozzáadni kívánt elemek. Egyszerre legfeljebb 20 elemet adhat hozzá.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ConversationItemList

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetési elemek listázása

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

A megadott azonosítóval rendelkező beszélgetés összes elemének listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	Annak a beszélgetésnek az azonosítója, amelyen az elemeket fel kell sorolni.
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
item_type	lekérdezés	No	karakterlánc Lehetséges értékek: message, output_message, file_search_call, computer_call, computer_call_output, web_search_call, function_call, function_call_output, reasoning, compactionimage_generation_callcode_interpreter_call, local_shell_call, local_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_tools, , mcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Szűrés elemtípus szerint. Ha meg van adva, a rendszer csak a megadott típusú elemeket adja vissza.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetési elem lekérése

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

Egyetlen elem lekérése a megadott azonosítókkal folytatott beszélgetésből.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	Az elemet tartalmazó beszélgetés azonosítója.
item_id	elérési út	Igen	karakterlánc	A lekérni kívánt beszélgetési elem azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.OutputItem

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Beszélgetési elem törlése

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

Elem törlése a megadott azonosítókkal folytatott beszélgetésből.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	elérési út	Igen	karakterlánc	Annak a beszélgetésnek az azonosítója, amelyből az elemet törölni kell.
item_id	elérési út	Igen	karakterlánc	A törölni kívánt beszélgetési elem azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ConversationResource

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals

Értékelések – lista értékelések

GET {endpoint}/openai/v1/evals

Az összes értékelés listázása Egy projekt kiértékeléseinek listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Után	lekérdezés	No	karakterlánc	Az előző lapozási kérelem utolsó futtatásának azonosítója.
limit	lekérdezés	No	egész szám	Lekérendő műveletek száma.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	A futtatások időpont szerinti rendezése. Növekvő asc sorrendben vagy desc csökkenő sorrendben használható. Alapértelmezett érték: asc.
rendezés szerint	lekérdezés	No	karakterlánc Lehetséges értékek: created_at, updated_at	Az Evals rendelése a létrehozási idő vagy az utolsó frissítés időpontja szerint végezhető el. Használja a created_at-et a létrehozás időpontjához vagy a updated_at-et az utolsó frissítés időpontjához.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – eval létrehozása

POST {endpoint}/openai/v1/evals

Kiértékelés létrehozása: A modell teljesítményének teszteléséhez használható kiértékelési struktúra létrehozása. A kiértékelés egy tesztelési feltételek és egy adatforrás konfigurációja, amely meghatározza a kiértékelés során használt adatok sémáját. A kiértékelés létrehozása után futtathatja azt különböző modelleken és modellparamétereken. Számos osztályozót és adatforrást támogatunk. További információ:

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
adatforrás_konfiguráció	OpenAI.CreateEvalCustomDataSourceConfig vagy OpenAI.CreateEvalLogsDataSourceConfig vagy OpenAI.CreateEvalStoredCompletionsDataSourceConfig vagy AzureAIDataSourceConfig	A kiértékeléshez használt adatforrás konfigurációja. Meghatározza a kiértékelés során használt adatok sémáját.	Igen
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	Az értékelés neve.	No
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No
tesztelési_kritérium	OpenAI.EvalGraderLabelModel vagy OpenAI.EvalGraderStringCheck vagy OpenAI.EvalGraderTextSimilarity vagy OpenAI.EvalGraderPython vagy OpenAI.EvalGraderScoreModel vagy EvalGraderAzureAIEvaluator tömbje	Az osztályozók listája az összes értékelési futtatáshoz ebben a csoportban. Az osztályozók dupla kapcsos zárójelek jelölésével hivatkozhatnak az adatforrás változóira, például {{item.variable_name}}. A modell kimenetére való hivatkozáshoz használja a sample névteret (azaz). {{sample.output_text}}	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Eval

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – eval törlése

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

Értékelés törlése Kiértékelés törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A törölni kívánt értékelés azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DeleteEvalResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Értékelések – értékelés

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

Értékelés lekérése Értékelés lekérése azonosító alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A lekérni kívánt értékelés azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Eval

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – eval frissítése

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

Kiértékelés frissítése A kiértékelés bizonyos tulajdonságainak frissítése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A frissíteni kívánt értékelés azonosítója.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc		No
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Eval

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – listafuttatások

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

A kiértékelési futtatások listájának lekérése A kiértékeléshez szükséges futtatások listájának lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A futtatások lekéréséhez használt kiértékelési azonosító.
Után	lekérdezés	No	karakterlánc	Az előző lapozási kérelem utolsó futtatásának azonosítója.
limit	lekérdezés	No	egész szám	Lekérendő műveletek száma.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	A futtatások időpont szerinti rendezése. Növekvő asc sorrendben vagy desc csökkenő sorrendben használható. Alapértelmezett érték: asc.
állapot	lekérdezés	No	karakterlánc Lehetséges értékek: queued, in_progress, completed, canceled. failed A szűrő állapot szerint fut. Az egyik queued, in_progress, failed, , completedcanceled.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – eval run létrehozása

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

Kiértékelési futtatás létrehozása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A futtatás létrehozásához használt kiértékelési azonosító.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
adatforrás	OpenAI.CreateEvalJsonlRunDataSource vagy OpenAI.CreateEvalCompletionsRunDataSource vagy OpenAI.CreateEvalResponsesRunDataSource vagy EvalRunDataSource	A futtatás adatforrásának részletei.	Igen
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	A futtatás neve.	No
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvalRun

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – eval run törlése

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

Kiértékelési futtatás törlése: Eval-futtatás törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A futtatás törlésére vonatkozó kiértékelési azonosító.
run_id	elérési út	Igen	karakterlánc	A törölni kívánt futtatás azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DeleteEvalRunResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Értékelések – értékelési futás

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

Próbaidőszak lekérése Próbaidőszak lekérése azonosító alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A futtatások lekéréséhez használt kiértékelési azonosító.
run_id	elérési út	Igen	karakterlánc	A lekérni kívánt futtatás azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvalRun

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – az eval-futtatás megszakítása

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

A kiértékelési futtatás megszakítása Folyamatban lévő próbafuttatás megszakítása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	Annak a próbaverziónak az azonosítója, amelynek a futtatását le szeretné szakítani.
run_id	elérési út	Igen	karakterlánc	A megszakítandó futtatás azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvalRun

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – az eval run kimeneti elemeinek lekérése

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

Kiértékelési futtatás kimeneti elemeinek lekérése A kiértékelési futtatás kimeneti elemeinek listájának lekérése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc
run_id	elérési út	Igen	karakterlánc	A futtatás azonosítója a kimeneti elemek lekéréséhez.
Után	lekérdezés	No	karakterlánc	Az előző lapozási kérelem utolsó futtatásának azonosítója.
limit	lekérdezés	No	egész szám	Lekérendő műveletek száma.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	A futtatások időpont szerinti rendezése. Növekvő asc sorrendben vagy desc csökkenő sorrendben használható. Alapértelmezett érték: asc.
állapot	lekérdezés	No	karakterlánc Lehetséges értékek: fail, pass	Kimeneti elemek szűrése állapot szerint. Szűrés failed sikertelen kimenet alapján elemekkel, illetve pass a megadott kimeneti elemek alapján történő szűréshez.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Evals – eval run output item lekérése

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

Kiértékelési futtatás kimeneti elemének lekérése A kiértékelési futtatás kimeneti elemének lekérése azonosító alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	elérési út	Igen	karakterlánc	A futtatások lekéréséhez használt kiértékelési azonosító.
run_id	elérési út	Igen	karakterlánc	A lekérni kívánt futtatás azonosítója.
output_item_id	elérési út	Igen	karakterlánc	A lekérni kívánt kimeneti elem azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	EvalRunOutputItem

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Fine-Tuning

Finomhangolási feladat létrehozása

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

Létrehoz egy finomhangolási feladatot, amely megkezdi egy új modell létrehozását egy adott adatkészletből.

A válasz tartalmazza a lekért feladat részleteit, beleértve a feladat állapotát és a finomhangolt modellek nevét a befejezés után.

További információ a finomhangolásról

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
hiperparaméterek	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└─ köteg_méret	sztring vagy OpenAI.integer		No	kocsi
└─ tanulási_ráta_szorzó	sztring vagy OpenAI.numerikus		No
└─ n_epochs	sztring vagy OpenAI.integer		No	kocsi
Integrációk	Az OpenAI.CreateFineTuningJobRequestIntegrations tömbje	A finomhangolási feladathoz engedélyezendő integrációk listája.	No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
metódus	OpenAI.FineTuneMethod	A finomhangoláshoz használt módszer.	No
modell	string (lásd az érvényes modelleket alább)	A finomhangolandó modell neve. Kiválaszthatja a támogatott modellek.	Igen
seed	OpenAI.integer (null értékű)		No
Utótag	sztring (null értékű)	Egy legfeljebb 64 karakterből álló szöveg, amely hozzáadódik a finomhangolt modell nevéhez. Egy "custom-model-name" például suffix egy olyan modellnevet eredményezne, mint a ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Korlátozások: minLength: 1, maxLength: 64	No
képzési fájl	karakterlánc	Betanítási adatokat tartalmazó feltöltött fájl azonosítója. A fájl feltöltéséről a feltöltési fájlban olvashat. Az adatkészletet JSONL-fájlként kell formázni. Emellett fel kell töltenie a fájlt a célnak fine-tunemegfelelően. A fájl tartalmának különböznie kell attól függően, hogy a modell a csevegést, a befejezési formátumot vagy a finomhangolási módszert használja-e. További részletekért tekintse meg a finomhangolási útmutatót .	Igen
érvényesítési_fájl	sztring (null értékű)	Az érvényesítési adatokat tartalmazó feltöltött fájl azonosítója. Ha megadja ezt a fájlt, a rendszer az adatokat az ellenőrzés létrehozásához használja Metrikákat időszakosan a finomhangolás során. Ezek a metrikák a következő helyen tekinthetők meg: az eredményfájl finomhangolása. A betanított és az érvényesítési fájlokban nem lehetnek ugyanazok az adatok. Az adatkészletet JSONL-fájlként kell formázni. A fájlt a célnak fine-tunemegfelelően kell feltöltenie. További részletekért tekintse meg a finomhangolási útmutatót .	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.FineTuningJob

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Többoldalas finomhangolási feladatok listázása

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

A szervezet finomhangolási feladatainak listázása

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Után	lekérdezés	No	karakterlánc	Az előző lapozási kérelem utolsó feladatának azonosítója.
limit	lekérdezés	No	egész szám	A lekérendő finomhangolási feladatok száma.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Finomhangolási feladat lekérése

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

Információk a finomhangolási feladatról.

További információ a finomhangolásról

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finomhangoló_feladat_azonosító	elérési út	Igen	karakterlánc	A finomhangolási feladat azonosítója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.FineTuningJob

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Finomhangolási feladat megszakítása

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

Egy finomhangoló feladat azonnali megszakítása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finomhangoló_feladat_azonosító	elérési út	Igen	karakterlánc	A megszakítandó finomhangolási feladat azonosítója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.FineTuningJob

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Finomhangolási feladatok ellenőrzőpontjainak listázása

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

Ellenőrzőpontok listázása egy finomhangolási feladathoz.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finomhangoló_feladat_azonosító	elérési út	Igen	karakterlánc	A finomhangolási feladat azonosítója az ellenőrzőpontok lekéréséhez.
Után	lekérdezés	No	karakterlánc	Az előző lapozási kérelem utolsó ellenőrzőpont-azonosítójának azonosítója.
limit	lekérdezés	No	egész szám	Lekérdezhető ellenőrzőpontok száma.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Feladatesemények finomhangolásának listázása

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

Részletes állapotfrissítéseket kaphat egy finomhangolási feladathoz.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finomhangoló_feladat_azonosító	elérési út	Igen	karakterlánc	A finomhangolási feladat azonosítója, amely az események lekérésére szolgál.
Után	lekérdezés	No	karakterlánc	Az előző lapozási kérelem utolsó eseményének azonosítója.
limit	lekérdezés	No	egész szám	Lekérendő események száma.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.ListFineTuningJobEventsResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Finomhangolási feladat szüneteltetése

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

Egy futó finomhangoló feladat szüneteltetése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finomhangoló_feladat_azonosító	elérési út	Igen	karakterlánc	A szüneteltetni kívánt finomhangolási feladat azonosítója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.FineTuningJob

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Finomhangolási feladat folytatása

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

Szüneteltetett finomhangolású feladat folytatása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finomhangoló_feladat_azonosító	elérési út	Igen	karakterlánc	A finomhangolási feladat folytatásához szükséges azonosító.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.FineTuningJob

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Responses

Válasz létrehozása – válaszfolyam létrehozása

POST {endpoint}/openai/v1/responses

Létrehoz egy modellválaszt. Létrehoz egy modellválaszt (streamválasz).

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
háttér	logikai (null értékű)		No
beszélgetés	OpenAI.ConversationParam (null értékű)	A beszélgetés, amelyhez ez a válasz tartozik. A beszélgetés elemei előre fel vannak függve ehhez a válaszkéréshez input_items . A válaszból származó bemeneti elemek és kimeneti elemek a válasz befejezése után automatikusan hozzáadódnak ehhez a beszélgetéshez.	No
include	OpenAI.IncludeEnum tömb		No
bevitel	OpenAI.InputParam	A modell szöveg-, kép- vagy fájlbemenetei, amelyeket válasz létrehozásához használnak. Tudj meg többet: - Szöveges bemenetek és kimenetek - Képbemenetek - Fájlbemenetek - Beszélgetés állapota - Függvényhívás	No
instructions	sztring (null értékű)		No
max_output_tokens	OpenAI.integer (null értékű)		No
max_eszköz_hívások	OpenAI.integer (null értékű)		No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
párhuzamos_eszközhívások	logikai (null értékű)		No	True
previous_response_id	sztring (null értékű)		No
kér	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
reasoning	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
└─ összefoglaló generálása	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
└─ összegzés	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
szolgáltatási szint	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
tárol	logikai (null értékű)		No	True
adatfolyam	logikai (null értékű)		No
stream_options	OpenAI.ResponseStreamOptions (null értékű)	A streamelési válaszok beállításai. Ezt csak akkor állítsa be, ha be van állítva stream: true.	No
└─ include_obfuscation	boolean	Amikor igaz, a stream elhomályosítása engedélyezve lesz. Stream elhomályosítás hozzáad véletlenszerű karaktereket egy obfuscation olyan mezőre, amely a deltaesemények streamelésére szolgál normalizálja a hasznos adatméreteket bizonyos oldalcsatornás támadások mérsékléseként. Ezek az eltömítési mezők alapértelmezés szerint szerepelnek, de kis mennyiségű az adatfolyamra háruló többletterhelés. Beállíthatja include_obfuscation , hogy hamis a sávszélességre való optimalizáláshoz, ha megbízik a és az OpenAI API-t.	No
structured_inputs	objektum	A válasz strukturált bemenetei, amelyek részt vehetnek a parancssori sablon helyettesítésében vagy az eszköz argumentumkötéseiben.	No
hőmérséklet	OpenAI.numerikus (null értékű)		No	1
SMS	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
tool_choice	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
top_logprobs	OpenAI.integer (null értékű)		No
top_p	OpenAI.numerikus (null értékű)		No	1
truncation	felsorolás	Lehetséges értékek: auto, disabled	No
felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Válaszok listázása

GET {endpoint}/openai/v1/responses

Az összes válasz listáját adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.
agent_name	lekérdezés	No	karakterlánc	Szűrés ügynöknév alapján. Ha meg van adva, a rendszer csak a megadott ügynökhöz társított elemeket adja vissza.
agent_id	lekérdezés	No	karakterlánc	Szűrés ügynökazonosító szerint a formátumban name:version. Ha meg van adva, a rendszer csak a megadott ügynökazonosítóhoz társított elemeket adja vissza.
conversation_id	lekérdezés	No	karakterlánc	Szűrés beszélgetésazonosító szerint. Ha meg van adva, a rendszer csak a megadott beszélgetéshez társított válaszokat adja vissza.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Kompakt válaszbeszélgetés

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

Egy válaszbeszélgetés tömörítését eredményezi.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	OpenAI.InputItem sztringje vagy tömbje		No
instructions	sztring (null értékű)		No
modell	OpenAI.ModelIdsCompaction	A válasz létrehozásához használt modellazonosító, például gpt-5 vagy o3. Az OpenAI különböző képességekkel, teljesítményjellemzőkkel és árpontokkal rendelkező modellek széles választékát kínálja. Az elérhető modellek böngészéséhez és összehasonlításához tekintse meg a modellútmutatót .	Igen
previous_response_id	sztring (null értékű)		No

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.CompactResource

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Válasz lekérése – válaszfolyam lekérése

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

Lekéri a modell válaszát a megadott azonosító alapján. Lekéri a modellválaszt a megadott azonosítóval (streamelési válasz).

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	elérési út	Igen	karakterlánc
include[]	lekérdezés	No	tömb
adatfolyam	lekérdezés	No	boolean
starting_after	lekérdezés	No	egész szám

Kérelem fejléce

Name	Szükséges	Típus	Description
elfogad	Téves	karakterlánc Lehetséges értékek: text/event-stream

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Válasz törlése

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

Törli a modellválaszt.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	elérési út	Igen	karakterlánc	A törölni kívánt válasz azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	DeleteResponseResult

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Válasz megszakítása

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

Megszakítja a modellválaszt.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	elérési út	Igen	karakterlánc	A megszakítandó válasz azonosítója.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	OpenAI.Response

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Bemeneti elemek listázása

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

Egy adott válasz bemeneti elemeinek listáját adja vissza.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	elérési út	Igen	karakterlánc
limit	lekérdezés	No	egész szám	A visszaadandó objektumok számának korlátja. A korlát 1 és 100 közötti lehet, és a alapértelmezett értéke 20.
sorrend	lekérdezés	No	karakterlánc Lehetséges értékek: asc, desc	Rendezze a sorrendet az created_at objektumok időbélyege alapján. asc növekvő sorrendben ésdesc csökkenő sorrendben.
Után	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. after egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a a következő hívás az after=obj_foo függvényt is tartalmazhat a lista következő oldalának lekéréséhez.
előtt	lekérdezés	No	karakterlánc	Kurzor lapozáshoz. before egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot kap, amelyek közül az utolsó az obj_foo, a az ezt követő hívás a before=obj_foo függvényt is tartalmazhat a lista előző oldalának lekéréséhez.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	objektum	Az elemek kért listájának válaszadatai.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Redteams

Redteams – lista

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

Név szerint soroljon fel egy redteam-et.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: RedTeams=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedRedTeam

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Redteams -

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

Nevezze el a név alapján a redteam-et.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
név	elérési út	Igen	karakterlánc	A piros csapat futásának azonosítója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: RedTeams=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	RedTeam

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Redteams – létrehozás

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

Létrehoz egy újrafuttatást.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: RedTeams=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
applicationScenario	karakterlánc	Alkalmazásforgatókönyv a vörös csapatművelethez, amely esetspecifikus támadásokat hoz létre.	No
attackStrategies	Az AttackStrategy tömbje	A támadási stratégiák vagy a támadási stratégiák beágyazott listája.	No
displayName	karakterlánc	A vörös csapat futásának neve.	No
id	sztring (írásvédett)	A piros csapat futásának azonosítója.	Igen
numTurns	egész szám	Szimulációs kerekítések száma.	No
properties	objektum	Vörös csapat tulajdonságai. A címkéktől eltérően a tulajdonságok csak bővítmények. A hozzáadás után egy tulajdonság nem távolítható el.	No
riskCategories	A RiskCategory tömbje	A támadási célkitűzések létrehozásához szükséges kockázati kategóriák listája.	No
szimulációOnly	boolean	Csak szimuláció vagy szimuláció + kiértékelés. Alapértelmezett hamis, ha igaz, a vizsgálat nem kiértékelési eredményt ad ki.	No	Téves
állapot	sztring (írásvédett)	A vörös csapat állapota. Szolgáltatás szerint van beállítva, és írásvédett.	No
tags	objektum	Piros csapat címkéi. A tulajdonságoktól eltérően a címkék teljesen módosíthatók.	No
céladatbázis	TargetConfig	Absztrakt osztály a célkonfigurációhoz.	Igen
└─ típus	karakterlánc	A modellkonfiguráció típusa.	Igen

Responses

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	RedTeam

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Ütemterv

Ütemezések – lista

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

Az összes ütemezés listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
típus	lekérdezés	No	karakterlánc Lehetséges értékek: Evaluation, Insight	Szűrés az ütemezés típusa szerint.
enabled	lekérdezés	No	boolean	Szűrjön az engedélyezett állapot alapján.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Schedules=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedSchedule

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Ütemezések – törlés

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

Ütemezés törlése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	Az ütemezés azonosítója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Schedules=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 204

Leírás: A kéréshez nincs elküldhető tartalom, de a fejlécek hasznosak lehetnek.

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Ütemezések – lekérés

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

Ütemezés lekérése azonosító alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	Az ütemezés azonosítója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Schedules=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Schedule

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Ütemezések – létrehozás vagy frissítés

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

Műveletsablon létrehozása vagy frissítése.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	Az ütemezés azonosítója.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Schedules=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Kérelem tartalma

Tartalomtípus: alkalmazás/json

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ütemezés leírása.	No
displayName	karakterlánc	Az ütemezés neve.	No
enabled	boolean	Az ütemezés engedélyezett állapota.	Igen
id	sztring (írásvédett)	Az ütemezés azonosítója.	Igen
properties	objektum	Ütemezés tulajdonságai. A címkéktől eltérően a tulajdonságok csak bővítmények. A hozzáadás után egy tulajdonság nem távolítható el.	No
előfizetési állapot	ScheduleProvisioningStatus (írásvédett )	Kiépítési állapot ütemezése.	No
rendszeradatok	objektum (írásvédett)	Az erőforrás rendszer metaadatai.	Igen
tags	objektum	Ütemezés címkéi. A tulajdonságoktól eltérően a címkék teljesen módosíthatók.	No
feladat	ScheduleTask	Feladatmodell ütemezése.	Igen
└─ konfiguráció	objektum	A feladat konfigurációja.	No
└─ típus	ScheduleTaskType	A feladat típusa.	Igen
aktivál	Trigger	Az ütemezés eseményindítójának alapmodellje.	Igen
└─ típus	TriggerType	A ravasz típusa.	Igen

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	Schedule

Állapotkód: 201

Leírás: A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Content-Type	Type	Leírás
application/json	Schedule

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Ütemezések – listafuttatások

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

Az összes ütemezési futtatás listázása.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.
id	elérési út	Igen	karakterlánc	Az ütemezés azonosítója.
típus	lekérdezés	No	karakterlánc Lehetséges értékek: Evaluation, Insight	Szűrés az ütemezés típusa szerint.
enabled	lekérdezés	No	boolean	Szűrjön az engedélyezett állapot alapján.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Schedules=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	PagedScheduleRun

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	Azure. Core.Foundations.ErrorResponse

Válaszfejlécek:

Header	Típus	Description
x-ms-error-code	karakterlánc	Sztringhibakód, amely jelzi, hogy mi történt.

Ütemezések – futtatás

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

Ütemezés lekérése azonosító alapján.

URI-paraméterek

Name	In	Szükséges	Típus	Description
végpont	elérési út	Igen	karakterlánc	Foundry Project végpont az űrlapon "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Ha csak egy Project van az Foundry Hubban, vagy az alapértelmezett Project a központban használja az űrlapot "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	elérési út	Igen	karakterlánc	Az ütemezés egyedi azonosítója.
run_id	elérési út	Igen	karakterlánc	Az ütemezési futtatás egyedi azonosítója.
API-verzió	lekérdezés	Igen	karakterlánc	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Szükséges	Típus	Description
Foundry-Features	True	karakterlánc Lehetséges értékek: Schedules=V1Preview	Az előzetes verziójú műveletek vagy a megőrzött előzetes verziójú erőforrások módosításakor a funkciójelzőknek be kell jelentkezniük.

Responses

Állapotkód: 200

Leírás: A kérés sikeres volt.

Content-Type	Type	Leírás
application/json	ScheduleRun

Állapotkód: alapértelmezett

Leírás: Váratlan hibaválasz.

Content-Type	Type	Leírás
application/json	ApiErrorResponse

Components

A2APreviewTool

Az A2A protokollt megvalósító ügynök.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_card_path	karakterlánc	Az ügynökkártya elérési útja a base_url. Ha nincs megadva, az alapértelmezett érték /.well-known/agent-card.json	No
base_url	karakterlánc	Az ügynök alap URL-címe.	No
project_connection_id	karakterlánc	Az A2A-kiszolgáló project kapcsolatazonosítója. A kapcsolat az A2A-kiszolgálóhoz való csatlakozáshoz szükséges hitelesítési és egyéb kapcsolati adatokat tárolja.	No
típus	felsorolás	Az eszköz típusa. Mindig "a2a_preview. Lehetséges értékek: a2a_preview	Igen

AISearchIndexResource

AI Search Index erőforrás.

Name	Típus	Description	Szükséges	Alapértelmezett
szűrő	karakterlánc	keresési erőforrás szűrősztringje. További információt itt talál.	No
index_asset_id	karakterlánc	Keresési erőforrás objektumazonosítójának indexelése.	No
index_name	karakterlánc	Az ügynökhöz csatolt IndexResource indexének neve.	No
project_connection_id	karakterlánc	Indexkapcsolat azonosítója az ügynökhöz csatolt IndexResource-ban.	No
lekérdezés_típusa	AzureAISearchQueryType	Elérhető query types for Azure AI Keresés tool.	No
top_k	egész szám	A keresésből lekérni és a modellnek bemutatni kívánt dokumentumok száma.	No

AgentClusterInsightRequest

Betekintés az ügynökértékelési eredmények halmazába

Name	Típus	Description	Szükséges	Alapértelmezett
ügynöknév	karakterlánc	Az ügynök azonosítója.	Igen
modelConfiguration	InsightModelConfiguration	Az elemzés generálásához használt modell konfigurációja.	No
└─ modelDeploymentName	karakterlánc	A kiértékelendő modelltelepítés. Az üzembehelyezési nevet önmagában vagy a kapcsolat nevével {connectionName}/<modelDeploymentName>együtt fogadja el.	Igen
típus	felsorolás	A kérés típusa. Lehetséges értékek: AgentClusterInsight	Igen

AgentClusterInsightResult

Elemzések az ügynökfürt elemzéséből.

Name	Típus	Description	Szükséges	Alapértelmezett
clusterInsight	ClusterInsightResult	A klaszterelemzés elemzésének elemzése.	Igen
típus	felsorolás	Az elemzési eredmények típusa. Lehetséges értékek: AgentClusterInsight	Igen

AgentContainerObject

Az ügynök egy adott verziójának tárolójának részletei.

Name	Típus	Description	Szükséges	Alapértelmezett
tároló	ContainerDetails (írásvédett )	Részletes információk a tárolóról.	No
└─ health_state	karakterlánc	A tároló állapotának állapota.	Igen
└─ provisioning_error	karakterlánc	A tároló kiépítési hibája, ha van ilyen.	No
└─ provisioning_state	karakterlánc	A tároló kiépítési állapota.	Igen
└─ replikák	ContainerReplica tömbje	A tároló replikáinak listája.	Igen
└─ állapot	karakterlánc	A tároló állapota.	Igen
└─ updated_on	karakterlánc	A tároló utolsó frissítési ideje.	Igen
létrehozás_időpontja	karakterlánc	A tároló létrehozási ideje.	Igen
error_message	sztring (írásvédett)	A hibaüzenet, ha a tároló működése sikertelen volt, ha van ilyen.	No
id	sztring (írásvédett)	A tároló azonosítója.	No
max_replicas	egész szám	A tároló replikáinak maximális száma. Az alapértelmezett érték 1.	No
min_replicas	egész szám	A tároló replikáinak minimális száma. Az alapértelmezett érték 1.	No
objektum	felsorolás	Az objektum típusa, amely mindig "agent.container". Lehetséges értékek: agent.container	Igen
állapot	AgentContainerStatus (írásvédett)	Az ügynök egy adott verziójának tárolójának állapota.	Igen
updated_at	karakterlánc	A tároló utolsó frissítési ideje.	Igen

AgentContainerOperationError

A tárolóművelet hibaadatai, ha vannak ilyenek.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	karakterlánc	A tárolóművelet hibakódja, ha van ilyen.	Igen
üzenet	karakterlánc	A tárolóművelet hibaüzenete, ha van ilyen.	Igen
típus	karakterlánc	A tárolóművelet hibatípusa, ha van ilyen.	Igen

AgentContainerOperationObject

Az ügynök egy adott verziójának tárolóművelete.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_id	karakterlánc	Az ügynök azonosítója.	Igen
agent_version_id	karakterlánc	Az ügynök verziójának azonosítója.	Igen
tároló	AgentContainerObject	Az ügynök egy adott verziójának tárolójának részletei.	No
└─ tároló	ContainerDetails (írásvédett )	A tároló részletes adatai.	No
└─ létrehozva_dátum	sztring (írásvédett)	A tároló létrehozási ideje.	Igen
└─ error_message	sztring (írásvédett)	A hibaüzenet, ha a tároló működése sikertelen volt, ha van ilyen.	No
└─ azonosító	sztring (írásvédett)	A tároló azonosítója.	No
└─ max_replicas	egész szám	A tároló replikáinak maximális száma. Az alapértelmezett érték 1.	No
└─ min_replicas	egész szám	A tároló replikáinak minimális száma. Az alapértelmezett érték 1.	No
└─ objektum	felsorolás	Az objektum típusa, amely mindig "agent.container". Lehetséges értékek: agent.container	Igen
└─ állapot	AgentContainerStatus (írásvédett)	Az ügynök egy adott verziójának tárolójának állapota.	Igen
└─ updated_at	sztring (írásvédett)	A tároló utolsó frissítési ideje.	Igen
hiba	AgentContainerOperationError	A tárolóművelet hibaadatai, ha vannak ilyenek.	No
└─ kód	karakterlánc	A tárolóművelet hibakódja, ha van ilyen.	Igen
└─ üzenet	karakterlánc	A tárolóművelet hibaüzenete, ha van ilyen.	Igen
└─ típus	karakterlánc	A tárolóművelet hibatípusa, ha van ilyen.	Igen
id	karakterlánc	A tárolóművelet azonosítója. Ez az azonosító a rendszeren belül egyedi azonosító.	Igen
állapot	AgentContainerOperationStatus	Az ügynök egy adott verziójához tartozó tárolóművelet állapota.	Igen

AgentContainerOperationStatus

Az ügynök egy adott verziójához tartozó tárolóművelet állapota.

Property	Érték
Type	karakterlánc
Értékek	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Az ügynök egy adott verziójának tárolójának állapota.

Property	Érték
Type	karakterlánc
Értékek	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Az AgentDefinition diszkriminatív

Ez az összetevő a tulajdonságot kind használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Name	Típus	Description	Szükséges	Alapértelmezett
kind	AgentKind		Igen
rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
└─ rai_policy_name	karakterlánc	Az alkalmazandó RAI-szabályzat neve.	Igen

AgentKind

Property	Érték
Type	karakterlánc
Értékek	prompt hosted container_app workflow

AgentObject

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	Az ügynök egyedi azonosítója.	Igen
név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 63	Igen
objektum	felsorolás	Az objektum típusa, amely mindig "ügynök". Lehetséges értékek: agent	Igen
versions	objektum	Az ügynök legújabb verziója.	Igen
└─ legújabb	AgentVersionObject		Igen

AgentProtocol

Property	Érték
Type	karakterlánc
Értékek	activity_protocol responses

AgentReference

Name	Típus	Description	Szükséges	Alapértelmezett
név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
típus	felsorolás	Lehetséges értékek: agent_reference	Igen
verzió	karakterlánc	Az ügynök verzióazonosítója.	No

AgentTaxonomyInput

A kiértékelési osztályozás bemeneti konfigurációja, ha a bemenet típusa ügynök.

Name	Típus	Description	Szükséges	Alapértelmezett
riskCategories	A RiskCategory tömbje	Az értékelendő kockázati kategóriák listája.	Igen
céladatbázis	Cél	Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.	Igen
└─ típus	karakterlánc	A cél típusa.	Igen
típus	felsorolás	A kiértékelési osztályozás bemeneti típusa. Lehetséges értékek: agent	Igen

AgentTaxonomyInputUpdate

A kiértékelési osztályozás bemeneti konfigurációja, ha a bemenet típusa ügynök.

Name	Típus	Description	Szükséges	Alapértelmezett
riskCategories	A RiskCategory tömbje	Az értékelendő kockázati kategóriák listája.	No
céladatbázis	TargetUpdate	Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.	No
└─ típus	karakterlánc	A cél típusa.	Igen
típus	felsorolás	A kiértékelési osztályozás bemeneti típusa. Lehetséges értékek: agent	Igen

AgentVersionObject

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	Az ügynök létrehozásakor a Unix-időbélyeg (másodperc).	Igen
definíció	AgentDefinition		Igen
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
id	karakterlánc	Az ügynök verziójának egyedi azonosítója.	Igen
metaadat	objektum (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	Igen
név	karakterlánc	Az ügynök neve. A név az ügynök lekérésére/frissítésére/törlésére használható. Korlátozások: maxLength: 256	Igen
objektum	felsorolás	Az objektum típusa, amely mindig "agent.version". Lehetséges értékek: agent.version	Igen
verzió	karakterlánc	Az ügynök verzióazonosítója. Az ügynökök megváltoztathatatlanok, és minden frissítés új verziót hoz létre, miközben a név változatlan marad.	Igen

AgenticIdentityPreviewCredentials

Ügynöki identitás hitelesítő adatainak meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A hitelesítő adatok típusa Lehetséges értékek: AgenticIdentityToken_Preview	Igen

ApiErrorResponse

Hibaválasz API-hibák esetén.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	OpenAI.Error		Igen

ApiKey-hitelesítő adatok

API-kulcs hitelesítő adatainak meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
kulcs	sztring (írásvédett)	API-kulcs	No
típus	felsorolás	A hitelesítő adatok típusa Lehetséges értékek: ApiKey	Igen

AssetCredentialResponse

Egy blobra mutató hivatkozást jelöl használatra

Name	Típus	Description	Szükséges	Alapértelmezett
blobReference	BlobReference	Blob-hivatkozás részletei.	Igen
└─ blobUri	karakterlánc	Blob URI elérési útja az ügyfél számára adatok feltöltéséhez. Például: https://blob.windows.core.net/Container/Path	Igen
└─ hitelesítő adatok	SasCredential	Hitelesítő adatok a tárfiók eléréséhez.	Igen
└─ storageAccountArmId	karakterlánc	A használni kívánt tárfiók ARM-azonosítója.	Igen

Eszközazonosító

Mentett objektum azonosítója.

Típus: sztring

AttackStrategy

Támadási stratégiák.

Property	Érték
Leírás	Támadási stratégiák.
Type	karakterlánc
Értékek	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansi_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundations.Error

A hibaobjektum.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	karakterlánc	A kiszolgáló által definiált hibakódok egyike.	Igen
details	Azure tömbje. Core.Foundations.Error	A jelentett hibához vezető konkrét hibák részleteinek tömbje.	No
innererror	Azure. Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Azure REST API irányelvek szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ kód	karakterlánc	A kiszolgáló által definiált hibakódok egyike.	No
└─ belső hiba	Azure. Core.Foundations.InnerError	Belső hiba.	No
üzenet	karakterlánc	A hiba ember által olvasható ábrázolása.	Igen
céladatbázis	karakterlánc	A hiba célpontja.	No

Azure. Core.Foundations.ErrorResponse

Hibaadatokat tartalmazó válasz.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	Azure. Core.Foundations.Error	A hibaobjektum.	Igen
└─ kód	karakterlánc	A kiszolgáló által definiált hibakódok egyike.	Igen
└─ részletek	Azure tömbje. Core.Foundations.Error	A jelentett hibához vezető konkrét hibák részleteinek tömbje.	No
└─ belső hiba	Azure. Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.	No
└─ üzenet	karakterlánc	A hiba ember által olvasható ábrázolása.	Igen
└─ cél	karakterlánc	A hiba célpontja.	No

Azure. Core.Foundations.InnerError

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Azure REST API irányelvek szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	karakterlánc	A kiszolgáló által definiált hibakódok egyike.	No
innererror	Azure. Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Azure REST API irányelvek szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ kód	karakterlánc	A kiszolgáló által definiált hibakódok egyike.	No
└─ belső hiba	Azure. Core.Foundations.InnerError	Belső hiba.	No

Azure. Core.Foundations.OperationState

Az engedélyezett műveleti állapotokat leíró felsorolás.

Property	Érték
Leírás	Az engedélyezett műveleti állapotokat leíró felsorolás.
Type	karakterlánc
Értékek	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Univerzálisan egyedi azonosító

Típus: sztring

Formátum: uuid

AzureAIAgentTarget

Egy Azure AI ügynököt jelöl meg célpontot.

Name	Típus	Description	Szükséges	Alapértelmezett
név	karakterlánc	A Azure AI-ügynök egyedi azonosítója.	Igen
tool_descriptions	ToolDescription tömbje	Az ügynök mintavételezési viselkedésének szabályozására használt paraméterek a szöveg generálása során.	No
típus	felsorolás	A célpont típusa, mindig azure_ai_agent. Lehetséges értékek: azure_ai_agent	Igen
verzió	karakterlánc	A Azure AI-ügynök verziója.	No

AzureAIAgentTargetUpdate

Egy Azure AI ügynököt jelöl meg célpontot.

Name	Típus	Description	Szükséges	Alapértelmezett
név	karakterlánc	A Azure AI-ügynök egyedi azonosítója.	No
tool_descriptions	ToolDescription tömbje	Az ügynök mintavételezési viselkedésének szabályozására használt paraméterek a szöveg generálása során.	No
típus	felsorolás	A célpont típusa, mindig azure_ai_agent. Lehetséges értékek: azure_ai_agent	Igen
verzió	karakterlánc	A Azure AI-ügynök verziója.	No

AzureAIDataSourceConfig

Name	Típus	Description	Szükséges	Alapértelmezett
forgatókönyv	felsorolás	Adatséma-forgatókönyv. Lehetséges értékek: red_team, responses, , traces_previewsynthetic_data_gen_preview	Igen
séma	objektum	A futtatott adatforráselemek teljes JSON-sémája.	Igen
típus	felsorolás	Az objektum típusa, amely mindig azure_ai_source. Lehetséges értékek: azure_ai_source	Igen

AzureAIModelTarget

Egy célpontot képvisel, amely Azure AI modellt jelöl meg olyan műveletekhez, amelyek modell kiválasztását igényelnek.

Name	Típus	Description	Szükséges	Alapértelmezett
modell	karakterlánc	A Azure AI-modell egyedi azonosítója.	No
mintavételi_paraméterek	ModelSamplingParams	A nyelvi modell mintavételezési viselkedésének szabályozásához használt paraméterek készletét jelöli a szöveggenerálás során.	No
└─ max_completion_tokens (maximális befejezési tokenek)	egész szám	A befejezés során engedélyezett jogkivonatok maximális száma.	Igen
└─ mag	egész szám	A reprodukálhatóság véletlenszerű magja.	Igen
└─ hőmérséklet	szám	A mintavételezés hőmérsékleti paramétere.	Igen
└─ top_p	szám	A nukleusz mintavételezésének top-p paramétere.	Igen
típus	felsorolás	A célpont típusa, mindig azure_ai_model. Lehetséges értékek: azure_ai_model	Igen

AzureAIModelTargetUpdate

Egy célpontot képvisel, amely Azure AI modellt jelöl meg olyan műveletekhez, amelyek modell kiválasztását igényelnek.

Name	Típus	Description	Szükséges	Alapértelmezett
modell	karakterlánc	A Azure AI-modell egyedi azonosítója.	No
mintavételi_paraméterek	ModelSamplingParamsUpdate	A nyelvi modell mintavételezési viselkedésének szabályozásához használt paraméterek készletét jelöli a szöveggenerálás során.	No
└─ max_completion_tokens (maximális befejezési tokenek)	egész szám	A befejezés során engedélyezett jogkivonatok maximális száma.	No
└─ mag	egész szám	A reprodukálhatóság véletlenszerű magja.	No
└─ hőmérséklet	szám	A mintavételezés hőmérsékleti paramétere.	No
└─ top_p	szám	A nukleusz mintavételezésének top-p paramétere.	No
típus	felsorolás	A célpont típusa, mindig azure_ai_model. Lehetséges értékek: azure_ai_model	Igen

AzureAIResponsesEvalRunDataSource

A folyamatos kiértékelési forgatókönyvekre jellemző kiértékelési futtatások adatforrását jelöli.

Name	Típus	Description	Szükséges	Alapértelmezett
event_configuration_id	karakterlánc	A kiértékelési futtatáshoz társított eseménykonfiguráció neve.	Igen
item_generation_params	ResponseRetrievalItemGenerationParams	A válaszlekérési elem létrehozásának paramétereit jelöli.	Igen
└─ data_mapping	objektum	Leképezés a forrásmezőkről response_id mezőre, amely a csevegési előzmények lekéréséhez szükséges.	Igen
└─ max_num_turns	egész szám	A kiértékelendő csevegési előzmények maximális száma.	Igen
└─ forrás	OpenAI.EvalJsonlFileContentSource vagy OpenAI.EvalJsonlFileIdSource	Az a forrás, amelyből a JSONL-tartalom beolvasható.	Igen
└─ típus	felsorolás	Az elemgenerálási paraméterek típusa, mindig response_retrieval. Lehetséges értékek: response_retrieval	Igen
max_runs_hourly	egész szám	Az óránként engedélyezett kiértékelési futtatások maximális száma.	Igen
típus	felsorolás	Az adatforrás típusa, mindig azure_ai_responses. Lehetséges értékek: azure_ai_responses	Igen

AzureAISearchIndex keresőindex az Azure platformon

Azure AI Keresés indexdefiníció

Name	Típus	Description	Szükséges	Alapértelmezett
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	felsorolás	Index típusa Lehetséges értékek: AzureSearch	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

AzureAISearchIndexUpdate

Azure AI Keresés indexdefiníció

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	felsorolás	Index típusa Lehetséges értékek: AzureSearch	Igen

AzureAISearchQueryType

Elérhető query types for Azure AI Keresés tool.

Property	Érték
Leírás	Elérhető query types for Azure AI Keresés tool.
Type	karakterlánc
Értékek	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

Az Azure AI keresőeszközének bemeneti definíció információja, ahogyan azt az ügynök konfigurálásához használják.

Name	Típus	Description	Szükséges	Alapértelmezett
azure_ai_search	AzureAISearchToolResource	Az azure_ai_search eszköz által használt indexerőforrások készlete.	Igen
└─ indexek	az AISearchIndexResource tömbje	Az ügynökhöz csatolt indexek. Legfeljebb 1 index lehet az ügynökhöz csatolt erőforrás. Korlátozások: maxItems: 1	Igen
típus	felsorolás	Az objektum típusa, amely mindig "azure_ai_search". Lehetséges értékek: azure_ai_search	Igen

AzureAISearchToolResource

Az azure_ai_search eszköz által használt indexerőforrások készlete.

Name	Típus	Description	Szükséges	Alapértelmezett
Indexek	az AISearchIndexResource tömbje	Az ügynökhöz csatolt indexek. Legfeljebb 1 index lehet az ügynökhöz csatolt erőforrás.	Igen

AzureFunctionBinding

A storage üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.

Name	Típus	Description	Szükséges	Alapértelmezett
storage_queue	AzureFunctionStorageQueue	A storage üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.	Igen
└─ queue_name	karakterlánc	Egy Azure függvénytár-üzenetsor neve.	Igen
└─ queue_service_endpoint	karakterlánc	URI a Azure Storage Üzenetsor szolgáltatáshoz, amely lehetővé teszi az üzenetsorok manipulálását.	Igen
típus	felsorolás	A kötés típusa, amely mindig "storage_queue". Lehetséges értékek: storage_queue	Igen

AzureFunctionDefinition

Az Azure funkció definíciója.

Name	Típus	Description	Szükséges	Alapértelmezett
függvény	objektum	Az Azure-függvény és paramétereinek meghatározása.	Igen
└─ leírás	karakterlánc	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	No
└─ név	karakterlánc	A meghívandó függvény neve.	Igen
└─ paraméterek	objektum	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva.	Igen
input_binding	AzureFunctionBinding	A storage üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.	Igen
└─ storage_queue	AzureFunctionStorageQueue	Tárolási üzenetsor.	Igen
└─ típus	felsorolás	A kötés típusa, amely mindig "storage_queue". Lehetséges értékek: storage_queue	Igen
output_binding	AzureFunctionBinding	A storage üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.	Igen
└─ storage_queue	AzureFunctionStorageQueue	Tárolási üzenetsor.	Igen
└─ típus	felsorolás	A kötés típusa, amely mindig "storage_queue". Lehetséges értékek: storage_queue	Igen

AzureFunctionStorageQueue

A storage üzenetsor nevének és URI-jának megőrzésére szolgáló struktúra.

Name	Típus	Description	Szükséges	Alapértelmezett
queue_name	karakterlánc	Egy Azure függvénytár-üzenetsor neve.	Igen
queue_service_endpoint	karakterlánc	URI a Azure Storage Üzenetsor szolgáltatáshoz, amely lehetővé teszi az üzenetsorok manipulálását.	Igen

AzureFunctionTool

Az Azure Function Tool bemeneti definíció adatai, ahogyan azt az ügynök konfigurálásához használják.

Name	Típus	Description	Szükséges	Alapértelmezett
azure_function	AzureFunctionDefinition	Az Azure funkció definíciója.	Igen
└─ függvény	objektum	Az Azure-függvény és paramétereinek meghatározása.	Igen
└─ leírás	karakterlánc	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	No
└─ név	karakterlánc	A meghívandó függvény neve.	Igen
└─ paraméterek	objektum	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva.	Igen
└─ input_binding	AzureFunctionBinding	Bemeneti tárolási üzenetsor. Az üzenetsortár-eseményindító egy függvényt futtat, amikor az üzenetek hozzá lesznek adva.	Igen
└─ output_binding	AzureFunctionBinding	Kimeneti tárolási üzenetsor. A függvény a bemeneti elemek feldolgozásakor a kimenetet ebbe az üzenetsorba írja.	Igen
típus	felsorolás	Az objektum típusa, amely mindig "browser_automation". Lehetséges értékek: azure_function	Igen

AzureOpenAIModelConfiguration

Azure OpenAI-modell konfigurációját. Az API-verziót a szolgáltatás választja ki a modell lekérdezéséhez.

Name	Típus	Description	Szükséges	Alapértelmezett
modelDeploymentName	karakterlánc	Az AOAI-modell üzembehelyezési neve. Példa: gpt-4o, ha az AIServices vagy a kapcsolatalapú connection_name/deployment_name (pl. my-aoai-connection/gpt-4o).	Igen
típus	felsorolás	Lehetséges értékek: AzureOpenAIModel	Igen

Alap hitelesítő adatok

A kapcsolat hitelesítő adatainak alaposztálya

Az alap hitelesítő adatok diszkriminatívak

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
ApiKey	ApiKey-hitelesítő adatok
AAD	EntraID-hitelesítő adatok
CustomKeys	CustomCredential
SAS	SAS-hitelesítő adatok
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Name	Típus	Description	Szükséges	Alapértelmezett
típus	CredentialType (írásvédett )	A kapcsolat által használt hitelesítő adatok típusa	Igen

BingCustomSearchConfiguration

Egyéni keresési konfiguráció bing.

Name	Típus	Description	Szükséges	Alapértelmezett
count	egész szám	A bing API-válaszban visszaadandó keresési eredmények száma	No
freshness	karakterlánc	Keresési eredmények szűrése adott időtartomány szerint. Itt megtekintheti az elfogadott értékeket.	No
instance_name	karakterlánc	A konfigurációnak adott egyéni konfigurációs példány neve.	Igen
Piac	karakterlánc	Az a piac, ahonnan az eredmények származnak.	No
project_connection_id	karakterlánc	Project kapcsolatazonosító a bing-kereséssel való földeléshez	Igen
set_lang	karakterlánc	A felhasználói felületi sztringekhez a Bing API meghívásakor használandó nyelv.	No

BingCustomSearchPreviewTool

Az ügynök konfigurálásához használt Bing egyéni keresőeszköz bemeneti definíciós információi.

Name	Típus	Description	Szükséges	Alapértelmezett
bing_custom_search_preview	BingCustomSearchToolParameters	Az bing egyéni keresési eszköz paraméterei.	Igen
└─ search_configurations	A BingCustomSearchConfiguration tömbje	Az eszközhöz csatolt project kapcsolatok. Legfeljebb 1 kapcsolat lehet erőforrást csatolja az eszközhöz. Korlátozások: maxItems: 1	Igen
típus	felsorolás	Az objektumtípus, ami mindig 'bing_custom_search_preview'. Lehetséges értékek: bing_custom_search_preview	Igen

BingCustomSearchToolParameters

Az bing egyéni keresési eszköz paraméterei.

Name	Típus	Description	Szükséges	Alapértelmezett
search_configurations	A BingCustomSearchConfiguration tömbje	Az eszközhöz csatolt project kapcsolatok. Legfeljebb 1 kapcsolat lehet erőforrást csatolja az eszközhöz.	Igen

BingGroundingSearchConfiguration

Keresési konfiguráció a Bing Földeléshez

Name	Típus	Description	Szükséges	Alapértelmezett
count	egész szám	A bing API-válaszban visszaadandó keresési eredmények száma	No
freshness	karakterlánc	Keresési eredmények szűrése adott időtartomány szerint. Itt megtekintheti az elfogadott értékeket.	No
Piac	karakterlánc	Az a piac, ahonnan az eredmények származnak.	No
project_connection_id	karakterlánc	Project kapcsolatazonosító a bing-kereséssel való földeléshez	Igen
set_lang	karakterlánc	A felhasználói felületi sztringekhez a Bing API meghívásakor használandó nyelv.	No

BingGroundingSearchToolParameters

A bing keresőeszköz paramétereinek meghatározása.

Name	Típus	Description	Szükséges	Alapértelmezett
search_configurations	A BingGroundingSearchConfiguration tömbje	Az eszközhöz csatolt keresési konfigurációk. Legfeljebb 1 lehet az eszközhöz csatolt keresési konfigurációs erőforrás.	Igen

BingGroundingTool

Az ügynök konfigurálásához használt bing földi keresőeszköz bemeneti definíciós információi.

Name	Típus	Description	Szükséges	Alapértelmezett
bing_grounding	BingGroundingSearchToolParameters	A bing keresőeszköz paramétereinek meghatározása.	Igen
└─ search_configurations	A BingGroundingSearchConfiguration tömbje	Az eszközhöz csatolt keresési konfigurációk. Legfeljebb 1 lehet az eszközhöz csatolt keresési konfigurációs erőforrás. Korlátozások: maxItems: 1	Igen
típus	felsorolás	Az objektum típusa, amely mindig "bing_grounding". Lehetséges értékek: bing_grounding	Igen

BlobReference

Blob-hivatkozás részletei.

Name	Típus	Description	Szükséges	Alapértelmezett
blobUri	karakterlánc	Blob URI elérési útja az ügyfél számára adatok feltöltéséhez. Például: https://blob.windows.core.net/Container/Path	Igen
hitelesítő adat	SasCredential	SAS hitelesítő adatok meghatározása	Igen
└─ sasUri	sztring (írásvédett)	SAS uri	Igen
└─ típus	felsorolás	Hitelesítő adatok típusa Lehetséges értékek: SAS	Igen
storageAccountArmId	karakterlánc	A használni kívánt tárfiók ARM-azonosítója.	Igen

BrowserAutomationPreviewTool

A böngészőautomatizálási eszköz bemeneti definíciós adatai az ügynök konfigurálásához használt módon.

Name	Típus	Description	Szükséges	Alapértelmezett
browser_automation_preview	BrowserAutomationToolParameters	A böngészőautomatizálási eszköz bemeneti paramétereinek meghatározása.	Igen
└─ kapcsolat	BrowserAutomationToolConnectionParameters	A Browser Automation Eszközhöz társított projektkapcsolati paraméterek.	Igen
típus	felsorolás	Az objektumtípus, ami mindig 'browser_automation_preview'. Lehetséges értékek: browser_automation_preview	Igen

BrowserAutomationToolConnectionParameters

A böngészőautomatizálási eszköz által használt kapcsolat bemeneti paramétereinek meghatározása.

Name	Típus	Description	Szükséges	Alapértelmezett
project_connection_id	karakterlánc	A Azure Playwright-erőforráshoz való projektkapcsolat azonosítója.	Igen

BrowserAutomationToolParameters

A böngészőautomatizálási eszköz bemeneti paramétereinek meghatározása.

Name	Típus	Description	Szükséges	Alapértelmezett
kapcsolat	BrowserAutomationToolConnectionParameters	A böngészőautomatizálási eszköz által használt kapcsolat bemeneti paramétereinek meghatározása.	Igen
└─ project_connection_id	karakterlánc	A Azure Playwright-erőforráshoz való projektkapcsolat azonosítója.	Igen

CaptureStructuredOutputsTool

Eszköz a strukturált kimenetek rögzítésére

Name	Típus	Description	Szükséges	Alapértelmezett
outputs	StructuredOutputDefinition	Az ügynök által létrehozható strukturált kimenet.	Igen
└─ leírás	karakterlánc	A kibocsátandó kimenet leírása. A modell arra használja, hogy meghatározza, mikor kell kibocsátani a kimenetet.	Igen
└─ név	karakterlánc	A strukturált kimenet neve.	Igen
└─ séma	objektum	A strukturált kimenet JSON-sémája.	Igen
└─ szigorú	logikai (null értékű)	A szigorú ellenőrzés kényszerítése. Alapértelmezett true.	Igen
típus	felsorolás	Az eszköz típusa. Mindig capture_structured_outputs. Lehetséges értékek: capture_structured_outputs	Igen

ChartCoordinate

Az elemzési diagram koordinátái.

Name	Típus	Description	Szükséges	Alapértelmezett
size	egész szám	A diagramelem mérete.	Igen
x	egész szám	X tengely koordinátája.	Igen
y	egész szám	Y tengely koordinátája.	Igen

ChatSummaryMemoryItem

A beszélgetésekből kinyert összefoglalót tartalmazó memóriaelem.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	karakterlánc	Az emlék tartalma.	Igen
kind	felsorolás	A memóriaelem típusa. Lehetséges értékek: chat_summary	Igen
memory_id	karakterlánc	A memóriaelem egyedi azonosítója.	Igen
hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen
updated_at	egész szám	A memóriaelem utolsó frissítési ideje.	Igen

ClusterInsightResult

A klaszterelemzés elemzésének elemzése.

Name	Típus	Description	Szükséges	Alapértelmezett
clusters	Az InsightCluster tömbje	Az elemzésekben azonosított fürtök listája.	Igen
Koordináták	objektum	Az azonosítók nem kötelező leképezése 2D koordinátákra, amelyeket az UX használ a vizualizációhoz. A térképkulcsok sztringazonosítók (például fürtazonosító vagy mintaazonosító) és az értékek a 2D diagramon való megjelenítés koordinátái és vizualizációméretei. Ez a tulajdonság csak akkor jelenik meg, ha az ügyfél nem kér koordinátákat (például lekérdezési paraméterként való includeCoordinates=true átadással). Példa: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> A koordináták csak ügyféloldali vizualizációra szolgálnak, és nem a canonical insights eredményeinek módosítása.	No
összegzés	InsightSummary	A hibaklaszter elemzésének összefoglalása.	Igen
└─ metódus	karakterlánc	Fürtözéshez használt módszer.	Igen
└─ sampleCount	egész szám	Az elemzett minták teljes száma.	Igen
└─ uniqueClusterCount	egész szám	Egyedi fürtök teljes száma.	Igen
└─ uniqueSubclusterCount	egész szám	Egyedi alcluster-címkék teljes száma.	Igen
└─ használat	ClusterTokenUsage	Jogkivonat-használat fürtelemzés végrehajtása közben	Igen

ClusterTokenUsage

Jogkivonat-használat fürtelemzéshez

Name	Típus	Description	Szükséges	Alapértelmezett
inputTokenUsage	egész szám	bemeneti jogkivonat használata	Igen
outputTokenUsage	egész szám	kimeneti jogkivonat használata	Igen
totalTokenUsage	egész szám	teljes jogkivonat-használat	Igen

CodeBasedEvaluatorDefinition

Kód alapú kiértékelő definíció python kóddal

Name	Típus	Description	Szükséges	Alapértelmezett
code_text	karakterlánc	Beágyazott kódszöveg a kiértékelőhöz	Igen
data_schema	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti adataihoz. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
init_parameters	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti paramétereihez. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
metrikák	objektum	Az értékelő által előállított kimeneti metrikák listája	No
típus	felsorolás	Lehetséges értékek: code	Igen

CompletionMessageToolCallChunk

Eszközhívás részletei egy üzenetben.

Name	Típus	Description	Szükséges	Alapértelmezett
függvény	FunctionToolCall	Egy függvényeszköz hívásának részletei.	No
└─ érvek	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre.	Igen
└─ név	karakterlánc	A meghívandó függvény neve.	Igen
id	karakterlánc	Az eszközhívás azonosítója.	Igen
típus	felsorolás	Az eszközhívás típusa, amely mindig "függvény". Lehetséges értékek: function	Igen

Kapcsolat

Válasz a listából és a kapcsolatok lekérése műveletek

Name	Típus	Description	Szükséges	Alapértelmezett
azonosító adatok	Alap hitelesítő adatok (írásvédett )	A kapcsolat hitelesítő adatainak alaposztálya	Igen
└─ típus	CredentialType (írásvédett )	A kapcsolat által használt hitelesítő adatok típusa	Igen
id	sztring (írásvédett)	A szolgáltatás által létrehozott kapcsolat egyedi azonosítója	Igen
isDefault	logikai (írásvédett)	Azt jelzi, hogy a kapcsolat a típus alapértelmezett kapcsolataként van-e megjelölve	Igen
metaadat	objektum (írásvédett)	A kapcsolat metaadatai	Igen
név	sztring (írásvédett)	A felhasználó által megadott kapcsolat rövid neve.	Igen
céladatbázis	sztring (írásvédett)	A szolgáltatáshoz használandó kapcsolati URL-cím	Igen
típus	ConnectionType (írásvédett)	A kapcsolat típusa (vagy kategóriája)	Igen

ConnectionType

A kapcsolat típusa (vagy kategóriája)

Property	Érték
Leírás	A kapcsolat típusa (vagy kategóriája)
Type	karakterlánc
Értékek	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

A tárolóalkalmazás-ügynök definíciója.

Name	Típus	Description	Szükséges	Alapértelmezett
container_app_resource_id	karakterlánc	Az ügynököt üzemeltető Azure tárolóalkalmazás erőforrás-azonosítója. Nem módosítható a verziók között.	Igen
container_protocol_versions	A ProtocolVersionRecord tömbje	Azok a protokollok, amelyeket az ügynök támogat a tárolók bejövő kommunikációjában.	Igen
ingress_subdomain_suffix	karakterlánc	Az alkalmazás altartományára alkalmazandó utótag, amikor bejövő forgalmat küld az ügynöknek. Ez lehet címke (például "---current"), egy adott változat (például "--0000001"), vagy üres lehet a tárolóalkalmazás alapértelmezett végpontjának használatához.	Igen
kind	felsorolás	Lehetséges értékek: container_app	Igen
rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
└─ rai_policy_name	karakterlánc	Az alkalmazandó RAI-szabályzat neve.	Igen

ContainerDetails

Részletes információk a tárolóról.

Name	Típus	Description	Szükséges	Alapértelmezett
health_state	karakterlánc	A tároló állapotának állapota.	Igen
provisioning_error	karakterlánc	A tároló kiépítési hibája, ha van ilyen.	No
provisioning_state	karakterlánc	A tároló kiépítési állapota.	Igen
replicas	ContainerReplica tömbje	A tároló replikáinak listája.	Igen
state	karakterlánc	A tároló állapota.	Igen
updated_on	karakterlánc	A tároló utolsó frissítési ideje.	Igen

ContainerLogKind

A tárolóból streamelendő naplók típusa.

Property	Érték
Type	karakterlánc
Értékek	console system

ContainerReplica

Információ egy tárolóreplikáról.

Name	Típus	Description	Szükséges	Alapértelmezett
container_state	karakterlánc	A replika tárolóállapota.	Igen
név	karakterlánc	A replika neve.	Igen
state	karakterlánc	A replika állapota.	Igen

ContinuousEvaluationRuleAction

Értékelési szabály művelet a folyamatos értékeléshez.

Name	Típus	Description	Szükséges	Alapértelmezett
evalId	karakterlánc	Eval Id a folyamatos kiértékelési futtatások hozzáadásához.	Igen
maxHourlyRuns	egész szám	Az óránként engedélyezett kiértékelési futtatások maximális száma.	No
típus	felsorolás	Lehetséges értékek: continuousEvaluation	Igen

CosmosDBIndex

CosmosDB vektortár index definíciója

Name	Típus	Description	Szükséges	Alapértelmezett
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	felsorolás	Index típusa Lehetséges értékek: CosmosDBNoSqlVectorStore	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

CosmosDBIndexUpdate

CosmosDB vektortár index definíciója

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	felsorolás	Index típusa Lehetséges értékek: CosmosDBNoSqlVectorStore	Igen

CreateAgentFromManifestRequest

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
manifest_id	karakterlánc	A jegyzékazonosító, amelyből importálni szeretné az ügynök verzióját.	Igen
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	Az ügynököt azonosító egyedi név. A név az ügynök lekérésére/frissítésére/törlésére használható. - Alfanumerikus karakterekkel kell kezdődnie és végződnie, - Középen kötőjeleket tartalmazhat - Nem haladhatja meg a 63 karaktert. Korlátozások: maxLength: 63	Igen
parameter_values	objektum	A jegyzék bemenetei, amelyek teljes mértékben materializált ügynököt eredményeznek.	Igen

CreateAgentRequest

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	AgentDefinition		Igen
└─ fajta	AgentKind		Igen
└─ rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	Az ügynököt azonosító egyedi név. A név az ügynök lekérésére/frissítésére/törlésére használható. - Alfanumerikus karakterekkel kell kezdődnie és végződnie, - Középen kötőjeleket tartalmazhat - Nem haladhatja meg a 63 karaktert. Korlátozások: maxLength: 63	Igen

CreateAgentVersionFromManifestRequest

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
manifest_id	karakterlánc	A jegyzékazonosító, amelyből importálni szeretné az ügynök verzióját.	Igen
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
parameter_values	objektum	A jegyzék bemenetei, amelyek teljes mértékben materializált ügynököt eredményeznek.	Igen

CreateAgentVersionRequest

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	AgentDefinition		Igen
└─ fajta	AgentKind		Igen
└─ rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No

Értékelési kérés létrehozása

Name	Típus	Description	Szükséges	Alapértelmezett
adatforrás_konfiguráció	OpenAI.CreateEvalCustomDataSourceConfig vagy OpenAI.CreateEvalLogsDataSourceConfig vagy OpenAI.CreateEvalStoredCompletionsDataSourceConfig vagy AzureAIDataSourceConfig	A kiértékeléshez használt adatforrás konfigurációja. Meghatározza a kiértékelés során használt adatok sémáját.	Igen
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	Az értékelés neve.	No
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No
tesztelési_kritérium	OpenAI.EvalGraderLabelModel vagy OpenAI.EvalGraderStringCheck vagy OpenAI.EvalGraderTextSimilarity vagy OpenAI.EvalGraderPython vagy OpenAI.EvalGraderScoreModel vagy EvalGraderAzureAIEvaluator tömbje	Az osztályozók listája az összes értékelési futtatáshoz ebben a csoportban. Az osztályozók dupla kapcsos zárójelek jelölésével hivatkozhatnak az adatforrás változóira, például {{item.variable_name}}. A modell kimenetére való hivatkozáshoz használja a sample névteret (azaz). {{sample.output_text}}	Igen

CreateEvalRunRequest

Name	Típus	Description	Szükséges	Alapértelmezett
adatforrás	OpenAI.CreateEvalJsonlRunDataSource vagy OpenAI.CreateEvalCompletionsRunDataSource vagy OpenAI.CreateEvalResponsesRunDataSource vagy EvalRunDataSource	A futtatás adatforrásának részletei.	Igen
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc	A futtatás neve.	No
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No

CredentialType

A kapcsolat által használt hitelesítő adatok típusa

Property	Érték
Leírás	A kapcsolat által használt hitelesítő adatok típusa
Type	karakterlánc
Értékek	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Cron alapú trigger.

Name	Típus	Description	Szükséges	Alapértelmezett
endTime	karakterlánc	A cron-ütemezés befejezési időpontja ISO 8601 formátumban.	No
kifejezés	karakterlánc	Az ütemezés gyakoriságát meghatározó cron-kifejezés.	Igen
startTime	karakterlánc	A cron ütemezés kezdési időpontja ISO 8601 formátumban.	No
timeZone	karakterlánc	A cron ütemezés időzónája.	No	egyezményes világidő
típus	felsorolás	Lehetséges értékek: Cron	Igen

CustomCredential

Egyéni hitelesítő adatok definíciója

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A hitelesítő adatok típusa Lehetséges értékek: CustomKeys	Igen

Ez az objektum a következő típusú további tulajdonságokat is elfogadja: sztring

DailyRecurrenceSchedule

Napi ismétlődési ütemterv.

Name	Típus	Description	Szükséges	Alapértelmezett
hours	egész szám tömbje	Órák az ismétlődési ütemezéshez.	Igen
típus	felsorolás	Napi ismétlődés típusa. Lehetséges értékek: Daily	Igen

DataSourceConfig

Alaposztály diszkriminatív támogatással rendelkező adatforrások futtatásához.

A DataSourceConfig diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema

Name	Típus	Description	Szükséges	Alapértelmezett
séma	objektum	A futtatott adatforráselemek teljes JSON-sémája.	Igen
típus	karakterlánc	Az adatforrástípus diszkriminatív.	Igen

DatasetType

Szám az adatok típusának meghatározásához.

Property	Érték
Leírás	Szám az adatok típusának meghatározásához.
Type	karakterlánc
Értékek	uri_file uri_folder

DatasetVersion

DatasetVersion definíció

A DatasetVersion diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Típus	Description	Szükséges	Alapértelmezett
connectionName	karakterlánc	A Azure Storage fiókkapcsolat neve. Kötelező, ha a startPendingUploadVersion nem lett meghívva az adatkészlet létrehozása előtt	No
dataUri	karakterlánc	Az adatok URI-ja (példa) Korlátozások: minLength: 1, minta: [a-zA-Z0-9_]	Igen
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
isReference	logikai (írásvédett)	Azt jelzi, hogy az adathalmaz rendelkezik-e a tárolóra mutató hivatkozással, vagy az adathalmaz maga kezeli a tárterületet. Ha igaz, a mögöttes adatok nem törlődnek az adathalmaz verziójának törlésekor	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	DatasetType	Szám az adatok típusának meghatározásához.	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

DatasetVersionUpdate

DatasetVersion definíció

A DatasetVersionUpdate diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	DatasetType	Szám az adatok típusának meghatározásához.	Igen

DayOfWeek

A hét napjai az ismétlődési ütemtervhez.

Property	Érték
Leírás	A hét napjai az ismétlődési ütemtervhez.
Type	karakterlánc
Értékek	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Törölt ügynökobjektum

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean	Azt jelzi, hogy az ügynök sikeresen törölve lett-e.	Igen
név	karakterlánc	Az ügynök neve.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "agent.deleted". Lehetséges értékek: agent.deleted	Igen

DeleteAgentVersionResponse

Törölt ügynökverzió objektum

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean	Azt jelzi, hogy az ügynök sikeresen törölve lett-e.	Igen
név	karakterlánc	Az ügynök neve.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "agent.version.deleted". Lehetséges értékek: agent.version.deleted	Igen
verzió	karakterlánc	Az ügynök verzióazonosítója.	Igen

DeleteEvalResponse

Törölt kiértékelési objektum

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean	Azt jelzi, hogy az eval sikeresen törölve lett-e.	Igen
eval_id	karakterlánc	az eval azonosítóját.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "eval.deleted". Lehetséges értékek: eval.deleted	Igen

DeleteEvalRunResponse

Törölt kiértékelési futtatási objektum.

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean	Azt jelzi, hogy az eval sikeresen törölve lett-e.	No
objektum	felsorolás	Az objektum típusa. Mindig "eval.deleted". Lehetséges értékek: eval.deleted	No
run_id	karakterlánc	az eval azonosítóját.	No

DeleteMemoryStoreResponse

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean	Azt jelzi, hogy a memóriatároló sikeresen törölve lett-e.	Igen
név	karakterlánc	A memóriatároló neve.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "memory_store.deleted". Lehetséges értékek: memory_store.deleted	Igen

DeleteResponseResult

A törlési válasz művelet eredménye.

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	felsorolás	Mindig igaz értéket ad vissza Lehetséges értékek: True	Igen
id	karakterlánc	A művelet azonosítója.	Igen
objektum	felsorolás	Mindig a "válasz" értéket adja vissza. Lehetséges értékek: response	Igen

Telepítés

Modell üzembe helyezési definíciója

Diszkriminatív üzembe helyezés

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
ModelDeployment	ModelDeployment

Name	Típus	Description	Szükséges	Alapértelmezett
név	sztring (írásvédett)	Az üzembe helyezés neve	Igen
típus	DeploymentType		Igen

DeploymentType

Property	Érték
Type	karakterlánc
Értékek	ModelDeployment

EntraID-hitelesítő adatok

Entra ID hitelesítő adatok definíciója

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A hitelesítő adatok típusa Lehetséges értékek: AAD	Igen

Értékelés

Eval objektum adatforráskonfigurációval és tesztelési feltételekkel. Az Eval az LLM-integrációhoz szükséges feladatokat jelöli. Lájk:

• A csevegőrobot minőségének javítása
• Megtudhatja, milyen jól kezeli a csevegőrobot az ügyfélszolgálatot
• Nézze meg, hogy az o4-mini jobb-e az én felhasználási esetemben, mint a gpt-4o.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	Az eval létrehozásának Unix időbélyege (másodpercekben).	Igen
által készített	karakterlánc	a futtatás létrehozójának neve.	No
adatforrás_konfiguráció	OpenAI.CreateEvalCustomDataSourceConfig vagy OpenAI.CreateEvalLogsDataSourceConfig vagy OpenAI.CreateEvalStoredCompletionsDataSourceConfig vagy AzureAIDataSourceConfig	A kiértékelési futtatásokban használt adatforrások konfigurálása.	Igen
id	karakterlánc	A kiértékelés egyedi azonosítója.	Igen
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	Igen
modified_at	egész szám		No
név	karakterlánc	Az értékelés neve.	Igen
objektum	felsorolás	Az objektum típusa. Lehetséges értékek: eval	Igen
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No
tesztelési_kritérium	OpenAI.EvalGraderLabelModel vagy OpenAI.EvalGraderStringCheck vagy OpenAI.EvalGraderTextSimilarity vagy OpenAI.EvalGraderPython vagy OpenAI.EvalGraderScoreModel vagy EvalGraderAzureAIEvaluator tömbje	A tesztelési feltételek listája.	Igen

EvalCsvFileIdSource

A kiértékelési adatok forrásaként használt feltöltött CSV-fájlra mutató hivatkozást jelöl.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A feltöltött CSV-fájl azonosítója.	Igen
típus	felsorolás	A forrás típusa, mindig file_id. Lehetséges értékek: file_id	Igen

EvalCsvRunDataSource

CSV-adatforrást jelöl a kiértékelési futtatásokhoz.

Name	Típus	Description	Szükséges	Alapértelmezett
adatforrás	EvalCsvFileIdSource	A kiértékelési adatok forrásaként használt feltöltött CSV-fájlra mutató hivatkozást jelöl.	Igen
└─ azonosító	karakterlánc	A feltöltött CSV-fájl azonosítója.	Igen
└─ típus	felsorolás	A forrás típusa, mindig file_id. Lehetséges értékek: file_id	Igen
típus	felsorolás	Az adatforrás típusa, mindig csv. Lehetséges értékek: csv	Igen

EvalGraderAzureAIEvaluator

Name	Típus	Description	Szükséges	Alapértelmezett
adatleképezés	objektum	A kiértékeléshez használni kívánt modell. Támogatnia kell a strukturált kimeneteket.	No
evaluator_name	karakterlánc	Az értékelő neve.	Igen
evaluator_version	karakterlánc	A kiértékelő verziója. A legújabb verzió, ha nincs megadva.	No
initialization_parameters	objektum	A kiértékelés inicializálási paraméterei. Támogatnia kell a strukturált kimeneteket.	No
név	karakterlánc	Az osztályozó neve.	Igen
típus	felsorolás	Az objektum típusa, amely mindig azure_ai_evaluator. Lehetséges értékek: azure_ai_evaluator	Igen

EvalResult

Az értékelés eredménye.

Name	Típus	Description	Szükséges	Alapértelmezett
név	karakterlánc	az ellenőrzés neve	Igen
át lett adva	boolean	azt jelzi, hogy az ellenőrzés sikeres vagy sikertelen volt-e	Igen
pont	szám	pont	Igen
típus	karakterlánc	az ellenőrzés típusa	Igen

EvalRun

Egy kiértékelési futtatásnak megfelelő séma.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	Unix időbélyeg (másodpercben) a kiértékelési futtatás létrehozásakor.	Igen
által készített	karakterlánc	a futtatás létrehozójának neve.	No
adatforrás	OpenAI.CreateEvalJsonlRunDataSource vagy OpenAI.CreateEvalCompletionsRunDataSource vagy OpenAI.CreateEvalResponsesRunDataSource vagy EvalRunDataSource	Információ a futtatás adatforrásáról.	Igen
hiba	OpenAI.EvalApiError	Az Eval API hibaválaszát képviselő objektum.	Igen
eval_id	karakterlánc	A társított értékelés azonosítója.	Igen
id	karakterlánc	A kiértékelési futtatás egyedi azonosítója.	Igen
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	Igen
modell	karakterlánc	A kiértékelt modell, ha van.	Igen
modified_at	egész szám		No
név	karakterlánc	A kiértékelési futtatás neve.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "eval.run". Lehetséges értékek: eval.run	Igen
modellenkénti felhasználás	Az OpenAI.EvalRunPerModelUsage tömbje	A kiértékelési futtatás során az egyes modellek használati statisztikái.	Igen
tesztelési kritériumok eredményei	Az OpenAI.EvalRunPerTestingCriteriaResults tömbje	A kiértékelési futtatás során alkalmazott tesztelési feltételek szerinti eredmények.	Igen
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No
report_url	karakterlánc	A renderelt kiértékelési jelentés URL-címe a felhasználói felület irányítópultján.	Igen
eredmények száma	OpenAI.EvalRunResultCounts		Igen
└─ hiba történt	OpenAI.integer		Igen
└─ nem sikerült	OpenAI.integer		Igen
└─ átment	OpenAI.integer		Igen
└─ összesen	OpenAI.integer		Igen
állapot	karakterlánc	A kiértékelési futtatás állapota.	Igen

EvalRunDataSource

Alaposztály diszkriminatív támogatással rendelkező adatforrások futtatásához.

Diszkriminatív az EvalRunDataSource esetében

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	TargetCompletionEvalRunDataSource
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

Name	Típus	Description	Szükséges	Alapértelmezett
típus	karakterlánc	Az adatforrástípus diszkriminatív.	Igen

EvalRunOutputItem

Egy kiértékelési futtatási kimeneti elemet képviselő séma.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	Unix időbélyeg (másodpercben) a kiértékelési futtatás létrehozásakor.	Igen
adattár_elem	objektum	A bemeneti adatforráselem részletei.	Igen
adatforrás_elem_azonosító	OpenAI.integer		Igen
eval_id	karakterlánc	A kiértékelési csoport azonosítója.	Igen
id	karakterlánc	A kiértékelési futtatás kimeneti elemének egyedi azonosítója.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "eval.run.output_item". Lehetséges értékek: eval.run.output_item	Igen
results	az EvalRunOutputItemResult tömbje	A kimeneti elem osztályozói eredményeinek listája.	Igen
run_id	karakterlánc	A kimeneti elemhez társított kiértékelési futtatás azonosítója.	Igen
minta	OpenAI.EvalRunOutputItemSample		Igen
└─ hiba	OpenAI.EvalApiError	Az Eval API hibaválaszát képviselő objektum.	Igen
└─ befejezés_ok	karakterlánc		Igen
└─ bemenet	az EvalRunOutputItemSampleInput tömbje		Igen
└─ max_completion_tokens (maximális befejezési tokenek)	OpenAI.integer		Igen
└─ modell	karakterlánc		Igen
└─ kimenet	az EvalRunOutputItemSampleOutput tömbje		Igen
└─ mag	OpenAI.integer		Igen
└─ hőmérséklet	OpenAI.numerikus		Igen
└─ top_p	OpenAI.numerikus		Igen
└─ használat	OpenAI.EvalRunOutputItemSampleUsage		Igen
állapot	karakterlánc	A kiértékelési futtatás állapota.	Igen

EvalRunOutputItemResult

Egyetlen osztályozó eredménye egy kiértékelési futtatási kimeneti elemhez.

Name	Típus	Description	Szükséges	Alapértelmezett
címke	karakterlánc	A tesztfeltételek metrikájával társított címke (pl. "pass", "fail", "good", "bad").	No
metrika	karakterlánc	A metrika neve (pl. "fluency", "f1_score").	No
név	karakterlánc	Az osztályozó neve.	Igen
át lett adva	boolean	Azt jelzi, hogy az osztályozó passznak tekintette-e a kimenetet.	Igen
properties	objektum	További részletek a tesztfeltételek metrikájáról.	No
ok	karakterlánc	A tesztfeltételek metrikájának oka.	No
minta	objektum (null értékű)	Az osztályozó által előállított választható minta- vagy köztes adatok.	No
pont	OpenAI.numerikus		Igen
küszöb	szám	A tesztelési feltételek sikerességének/sikertelenségének meghatározására használt küszöbérték, ha numerikus.	No
típus	karakterlánc	Az osztályozó típusa (például "string-check-grader").	No

Ez az objektum további tulajdonságokat is elfogad.

EvalRunOutputItemSampleInput

Üzenet a kiértékelési futtatás során.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	karakterlánc		Igen
szerepkör	karakterlánc		Igen
tool_calls	a CompletionMessageToolCallChunk tömbje	Eszközhívások az üzenetben, ha vannak ilyenek.	Igen

EvalRunOutputItemSampleOutput

Üzenet a kiértékelési futtatás során.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	karakterlánc		No
szerepkör	karakterlánc		No
tool_calls	a CompletionMessageToolCallChunk tömbje	Eszközhívások az üzenetben, ha vannak ilyenek.	Igen

EvalRunResultCompareItem

A kezelés metrikus összehasonlítása a kiindulási értékkel.

Name	Típus	Description	Szükséges	Alapértelmezett
deltaEstimate	szám	A kezelés és az alapkonfiguráció becsült különbsége.	Igen
pValue	szám	A kezelési hatás P-értéke.	Igen
treatmentEffect	TreatmentEffectType	Kezelés hatásának típusa.	Igen
treatmentRunId	karakterlánc	A kezelés futásazonosítója.	Igen
kezelésRunSummary	EvalRunResultSummary	Egy metrika összegző statisztikája egy kiértékelési futtatásban.	Igen
└─ átlag	szám	A metrika átlagos értéke a kiértékelési futtatás során.	Igen
└─ runId	karakterlánc	A kiértékelési futtatási azonosító.	Igen
└─ sampleCount	egész szám	A kiértékelési futtatásban lévő minták száma.	Igen
└─ standardDeviation	szám	A metrika szórása a kiértékelési futtatás során.	Igen

EvalRunResultComparison

A kezelés összehasonlítási eredményei a kiindulási értékhez viszonyíthatók.

Name	Típus	Description	Szükséges	Alapértelmezett
baselineRunSummary	EvalRunResultSummary	Egy metrika összegző statisztikája egy kiértékelési futtatásban.	Igen
└─ átlag	szám	A metrika átlagos értéke a kiértékelési futtatás során.	Igen
└─ runId	karakterlánc	A kiértékelési futtatási azonosító.	Igen
└─ sampleCount	egész szám	A kiértékelési futtatásban lévő minták száma.	Igen
└─ standardDeviation	szám	A metrika szórása a kiértékelési futtatás során.	Igen
compareItems	az EvalRunResultCompareItem tömbje	Az egyes kezelési eredmények összehasonlítási eredményeinek listája.	Igen
Értékelő	karakterlánc	A tesztelési feltételek kiértékelőjének neve.	Igen
metrika	karakterlánc	A metrika kiértékelése folyamatban van.	Igen
testingCriteria	karakterlánc	A tesztelési feltételek neve.	Igen

EvalRunResultSummary

Egy metrika összegző statisztikája egy kiértékelési futtatásban.

Name	Típus	Description	Szükséges	Alapértelmezett
átlagos	szám	A metrika átlagos értéke a kiértékelési futtatás során.	Igen
runId	karakterlánc	A kiértékelési futtatási azonosító.	Igen
sampleCount	egész szám	A kiértékelési futtatásban lévő minták száma.	Igen
standardDeviation	szám	A metrika szórása a kiértékelési futtatás során.	Igen

EvaluationComparisonInsightRequest

Értékelési összehasonlító kérelem

Name	Típus	Description	Szükséges	Alapértelmezett
baselineRunId	karakterlánc	Az összehasonlítás alapkonfigurációs futtatási azonosítója.	Igen
evalId	karakterlánc	A kiértékelés azonosítója.	Igen
treatmentRunIds	sztringtömb	Az összehasonlításhoz használt kezelési azonosítók listája.	Igen
típus	felsorolás	A kérés típusa. Lehetséges értékek: EvaluationComparison	Igen

EvaluationComparisonInsightResult

Elemzések az értékelési összehasonlításból.

Name	Típus	Description	Szükséges	Alapértelmezett
Összehasonlítás	EvalRunResultComparison tömbje	Az egyes kezelések összehasonlítási eredményei az alapkonfigurációhoz képest futnak.	Igen
metódus	karakterlánc	Az összehasonlításhoz használt statisztikai módszer.	Igen
típus	felsorolás	Az elemzési eredmények típusa. Lehetséges értékek: EvaluationComparison	Igen

EvaluationResultSample

Minta az értékelési eredményből.

Name	Típus	Description	Szükséges	Alapértelmezett
correlationInfo	objektum	Információ az elemzési minta korrelációjáról.	Igen
evaluationResult	EvalResult	Az értékelés eredménye.	Igen
└─ név	karakterlánc	az ellenőrzés neve	Igen
└─ átment	boolean	azt jelzi, hogy az ellenőrzés sikeres vagy sikertelen volt-e	Igen
└─ pontszám	szám	pont	Igen
└─ típus	karakterlánc	az ellenőrzés típusa	Igen
features	objektum	Az adatok további szűrését segítő funkciók az UX-ben.	Igen
id	karakterlánc	Az elemzési minta egyedi azonosítója.	Igen
típus	felsorolás	Kiértékelési eredmény mintatípusa Lehetséges értékek: EvaluationResultSample	Igen

Értékelési szabály

Kiértékelési szabály modell.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	EvaluationRuleAction	Értékelési cselekvési modell.	Igen
└─ típus	EvaluationRuleActionType	Az értékelési művelet típusa.	Igen
leírás	karakterlánc	A kiértékelési szabály leírása.	No
displayName	karakterlánc	A kiértékelési szabály megjelenítendő neve.	No
enabled	boolean	Azt jelzi, hogy a kiértékelési szabály engedélyezve van-e. Alapértelmezett érték: true (igaz).	Igen
eventType	EvaluationRuleEventType	A kiértékelési szabály eseményének típusa.	Igen
szűrő	EvaluationRuleFilter	Kiértékelési szűrőmodell.	No
└─ ügynöknév	karakterlánc	Szűrés ügynöknév alapján.	Igen
id	sztring (írásvédett)	A kiértékelési szabály egyedi azonosítója.	Igen
rendszeradatok	objektum (írásvédett)	A kiértékelési szabály rendszer metaadatai.	Igen

EvaluationRuleAction

Értékelési cselekvési modell.

A EvaluationRuleAction diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Name	Típus	Description	Szükséges	Alapértelmezett
típus	EvaluationRuleActionType	Az értékelési művelet típusa.	Igen

EvaluationRuleActionType

Az értékelési művelet típusa.

Property	Érték
Leírás	Az értékelési művelet típusa.
Type	karakterlánc
Értékek	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

A kiértékelési szabály eseményének típusa.

Property	Érték
Leírás	A kiértékelési szabály eseményének típusa.
Type	karakterlánc
Értékek	responseCompleted manual

EvaluationRuleFilter

Kiértékelési szűrőmodell.

Name	Típus	Description	Szükséges	Alapértelmezett
ügynöknév	karakterlánc	Szűrés ügynöknév alapján.	Igen

EvaluationRunClusterInsightRequest

Betekintés az értékelési eredmények halmazába

Name	Típus	Description	Szükséges	Alapértelmezett
evalId	karakterlánc	Az elemzések kiértékelési azonosítója.	Igen
modelConfiguration	InsightModelConfiguration	Az elemzés generálásához használt modell konfigurációja.	No
└─ modelDeploymentName	karakterlánc	A kiértékelendő modelltelepítés. Az üzembehelyezési nevet önmagában vagy a kapcsolat nevével {connectionName}/<modelDeploymentName>együtt fogadja el.	Igen
runIds	sztringtömb	A kiértékelési futtatási azonosítók listája az elemzésekhez.	Igen
típus	felsorolás	Az elemzési kérelem típusa. Lehetséges értékek: EvaluationRunClusterInsight	Igen

EvaluationRunClusterInsightResult

A kiértékelésből származó elemzések fürtelemzést futtatnak.

Name	Típus	Description	Szükséges	Alapértelmezett
clusterInsight	ClusterInsightResult	A klaszterelemzés elemzésének elemzése.	Igen
típus	felsorolás	Az elemzési eredmények típusa. Lehetséges értékek: EvaluationRunClusterInsight	Igen

EvaluationScheduleTask

Az ütemezés kiértékelési feladata.

Name	Típus	Description	Szükséges	Alapértelmezett
konfiguráció	objektum	A feladat konfigurációja.	No
evalId	karakterlánc	A kiértékelési csoport azonosítója.	Igen
evalRun	objektum	A kiértékelés hasznos adatokat futtat.	Igen
típus	felsorolás	Lehetséges értékek: Evaluation	Igen

EvaluationTaxonomy

Értékelési taxonómia meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
properties	objektum	A kiértékelési osztályozás további tulajdonságai.	No
taxonomyCategories	a TaxonomyCategory tömbje	Osztályozási kategóriák listája.	No
taxonomyInput	EvaluationTaxonomyInput	A kiértékelési taxonómia bemeneti konfigurációja.	Igen
└─ típus	EvaluationTaxonomyInputType	A kiértékelési osztályozás bemeneti típusa.	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

EvaluationTaxonomyCreateOrUpdate

Értékelési taxonómia meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
properties	objektum	A kiértékelési osztályozás további tulajdonságai.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
taxonomyCategories	a TaxonomyCategory tömbje	Osztályozási kategóriák listája.	No
taxonomyInput	EvaluationTaxonomyInput	A kiértékelési taxonómia bemeneti konfigurációja.	Igen
└─ típus	EvaluationTaxonomyInputType	A kiértékelési osztályozás bemeneti típusa.	Igen

EvaluationTaxonomyInput

A kiértékelési taxonómia bemeneti konfigurációja.

A EvaluationTaxonomyInput diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
agent	AgentTaxonomyInput

Name	Típus	Description	Szükséges	Alapértelmezett
típus	EvaluationTaxonomyInputType	A kiértékelési taxonómiai bemenet típusa.	Igen

EvaluationTaxonomyInputType

A kiértékelési taxonómiai bemenet típusa.

Property	Érték
Leírás	A kiértékelési taxonómiai bemenet típusa.
Type	karakterlánc
Értékek	agent policy

EvaluationTaxonomyInputUpdate

A kiértékelési taxonómia bemeneti konfigurációja.

A EvaluationTaxonomyInputUpdate diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
agent	AgentTaxonomyInputUpdate

Name	Típus	Description	Szükséges	Alapértelmezett
típus	EvaluationTaxonomyInputType	A kiértékelési taxonómiai bemenet típusa.	Igen

EvaluationTaxonomyUpdate

Értékelési taxonómia meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
properties	objektum	A kiértékelési osztályozás további tulajdonságai.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
taxonomyCategories	a TaxonomyCategory tömbje	Osztályozási kategóriák listája.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	A kiértékelési taxonómia bemeneti konfigurációja.	No
└─ típus	EvaluationTaxonomyInputType	A kiértékelési osztályozás bemeneti típusa.	Igen

EvaluatorCategory

Az értékelő kategóriája

Property	Érték
Leírás	Az értékelő kategóriája
Type	karakterlánc
Értékek	quality safety agents

EvaluatorDefinition

Alapkiértékelő konfiguráció diszkriminátorral

A EvaluatorDefinition diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Típus	Description	Szükséges	Alapértelmezett
data_schema	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti adataihoz. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
init_parameters	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti paramétereihez. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
metrikák	objektum	Az értékelő által előállított kimeneti metrikák listája	No
típus	EvaluatorDefinitionType	Az értékelő típusának meghatározása	Igen

EvaluatorDefinitionType

Az értékelő típusának meghatározása

Property	Érték
Leírás	Az értékelő típusának meghatározása
Type	karakterlánc
Értékek	prompt code prompt_and_code service openai_graders

EvaluatorMetric

Értékelői metrika

Name	Típus	Description	Szükséges	Alapértelmezett
desirable_direction	EvaluatorMetricDirection	A metrika iránya, amely azt jelzi, hogy a magasabb érték jobb, az alacsonyabb érték jobb vagy semleges	No
is_primary	boolean	Azt jelzi, hogy ez a metrika elsődleges-e több metrika esetén.	No
max_value	szám	A metrika maximális értéke. Ha nincs megadva, akkor a rendszer azt feltételezi, hogy nem kötött.	No
min_value	szám	A metrika minimális értéke	No
típus	EvaluatorMetricType	Az értékelő típusa	No

EvaluatorMetricDirection

A metrika iránya, amely azt jelzi, hogy a magasabb érték jobb, az alacsonyabb érték jobb vagy semleges

Property	Érték
Leírás	A metrika iránya, amely azt jelzi, hogy a magasabb érték jobb, az alacsonyabb érték jobb vagy semleges
Type	karakterlánc
Értékek	increase decrease neutral

EvaluatorMetricType

Az értékelő típusa

Property	Érték
Leírás	Az értékelő típusa
Type	karakterlánc
Értékek	ordinal continuous boolean

EvaluatorType

Az értékelő típusa

Property	Érték
Leírás	Az értékelő típusa
Type	karakterlánc
Értékek	builtin custom

EvaluatorVersion

Értékelő meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
categories	Az EvaluatorCategory tömbje	Az értékelő kategóriái	Igen
létrehozás_időpontja	sztring (írásvédett)	Az értékelő létrehozásának dátuma/időpontja	Igen
által készített	sztring (írásvédett)	Az értékelő megalkotója	Igen
definíció	EvaluatorDefinition	Alapkiértékelő konfiguráció diszkriminátorral	Igen
└─ data_schema	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti adataihoz. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
└─ init_parameters	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti paramétereihez. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
└─ metrikák	objektum	Az értékelő által előállított kimeneti metrikák listája	No
└─ típus	EvaluatorDefinitionType	Az értékelő típusának meghatározása	Igen
display_name	karakterlánc	Megjelenítendő név az értékelő számára. Segít, ha az AI Foundry-ben könnyen megtalálod az értékelőt. Nem kell egyedinek lennie.	No
evaluator_type	EvaluatorType	Az értékelő típusa	Igen
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
metaadat	objektum	Metaadatok az értékelőről	No
modified_at	sztring (írásvédett)	Az értékelő utolsó módosításának dátuma/időpontja	Igen
név	sztring (írásvédett)	Az erőforrás neve	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

EvaluatorVersionCreate

Értékelő meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
categories	Az EvaluatorCategory tömbje	Az értékelő kategóriái	Igen
definíció	EvaluatorDefinition	Alapkiértékelő konfiguráció diszkriminátorral	Igen
└─ data_schema	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti adataihoz. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
└─ init_parameters	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti paramétereihez. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
└─ metrikák	objektum	Az értékelő által előállított kimeneti metrikák listája	No
└─ típus	EvaluatorDefinitionType	Az értékelő típusának meghatározása	Igen
leírás	karakterlánc	Az eszköz leírásának szövege.	No
display_name	karakterlánc	Megjelenítendő név az értékelő számára. Segít, ha az AI Foundry-ben könnyen megtalálod az értékelőt. Nem kell egyedinek lennie.	No
evaluator_type	EvaluatorType	Az értékelő típusa	Igen
metaadat	objektum	Metaadatok az értékelőről	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No

EvaluatorVersionUpdate

Értékelő meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
categories	Az EvaluatorCategory tömbje	Az értékelő kategóriái	No
leírás	karakterlánc	Az eszköz leírásának szövege.	No
display_name	karakterlánc	Megjelenítendő név az értékelő számára. Segít, ha az AI Foundry-ben könnyen megtalálod az értékelőt. Nem kell egyedinek lennie.	No
metaadat	objektum	Metaadatok az értékelőről	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No

FabricDataAgentToolParameters

A hálóadatügynök eszköz paraméterei.

Name	Típus	Description	Szükséges	Alapértelmezett
project_connections	a ToolProjectConnection tömbje	Az eszközhöz csatolt project kapcsolatok. Legfeljebb 1 kapcsolat lehet erőforrást csatolja az eszközhöz.	No

FileDatasetVersion

FileDatasetVersion definíció

Name	Típus	Description	Szükséges	Alapértelmezett
connectionName	karakterlánc	A Azure Storage fiókkapcsolat neve. Kötelező, ha a startPendingUploadVersion nem lett meghívva az adatkészlet létrehozása előtt	No
dataUri	karakterlánc	Az adatok URI-ja (példa) Korlátozások: minLength: 1, minta: [a-zA-Z0-9_]	Igen
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
isReference	logikai (írásvédett)	Azt jelzi, hogy az adathalmaz rendelkezik-e a tárolóra mutató hivatkozással, vagy az adathalmaz maga kezeli a tárterületet. Ha igaz, a mögöttes adatok nem törlődnek az adathalmaz verziójának törlésekor	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	felsorolás	Adathalmaz típusa Lehetséges értékek: uri_file	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

FileDatasetVersionUpdate

FileDatasetVersion definíció

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	felsorolás	Adathalmaz típusa Lehetséges értékek: uri_file	Igen

FolderDatasetVersion

FileDatasetVersion definíció

Name	Típus	Description	Szükséges	Alapértelmezett
connectionName	karakterlánc	A Azure Storage fiókkapcsolat neve. Kötelező, ha a startPendingUploadVersion nem lett meghívva az adatkészlet létrehozása előtt	No
dataUri	karakterlánc	Az adatok URI-ja (példa) Korlátozások: minLength: 1, minta: [a-zA-Z0-9_]	Igen
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
isReference	logikai (írásvédett)	Azt jelzi, hogy az adathalmaz rendelkezik-e a tárolóra mutató hivatkozással, vagy az adathalmaz maga kezeli a tárterületet. Ha igaz, a mögöttes adatok nem törlődnek az adathalmaz verziójának törlésekor	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	felsorolás	Adathalmaz típusa Lehetséges értékek: uri_folder	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

FolderDatasetVersionUpdate

FileDatasetVersion definíció

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	felsorolás	Adathalmaz típusa Lehetséges értékek: uri_folder	Igen

FunctionToolCall

Egy függvényeszköz hívásának részletei.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	A függvény meghívására használható argumentumok, amelyeket a modell JSON formátumban hoz létre.	Igen
név	karakterlánc	A meghívandó függvény neve.	Igen

HostedAgentDefinition

Az üzemeltetett ügynök definíciója.

Name	Típus	Description	Szükséges	Alapértelmezett
container_protocol_versions	A ProtocolVersionRecord tömbje	Azok a protokollok, amelyeket az ügynök támogat a tárolók bejövő kommunikációjában.	Igen
cpu	karakterlánc	Az üzemeltetett ügynök CPU-konfigurációja.	Igen
environment_variables	objektum	Az üzemeltetett ügynök tárolójában beállítandó környezeti változók.	No
kép	karakterlánc	Az ügynök képazonosítója, amely a rendszerképalapú üzemeltetett ügynökökre vonatkozik.	No
kind	felsorolás	Lehetséges értékek: hosted	Igen
memória	karakterlánc	Az üzemeltetett ügynök memóriakonfigurációja.	Igen
rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
└─ rai_policy_name	karakterlánc	Az alkalmazandó RAI-szabályzat neve.	Igen
tools	Az OpenAI.Tool tömbje	Az üzemeltetett ügynök modellje által meghívott eszközök tömbje a válasz generálása közben. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja.	No

HourlyRecurrenceSchedule

Óránkénti ismétlődési ütemterv.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: Hourly	Igen

HumanEvaluationPreviewRuleAction

Értékelési szabály cselekvés az emberi értékeléshez.

Name	Típus	Description	Szükséges	Alapértelmezett
templateId	Eszközazonosító	Mentett objektum azonosítója.	Igen
típus	felsorolás	Lehetséges értékek: humanEvaluationPreview	Igen

Index

Indexerőforrás-definíció

Az index diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Típus	Description	Szükséges	Alapértelmezett
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	IndexTípus		Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

IndexTípus

Property	Érték
Type	karakterlánc
Értékek	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Indexerőforrás-definíció

Az IndexUpdate diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	IndexTípus		Igen

Elemzések

A fürtelemzések választörzse.

Name	Típus	Description	Szükséges	Alapértelmezett
displayName	karakterlánc	A megállapítás felhasználóbarát megjelenítendő neve.	Igen
id	sztring (írásvédett)	Az elemzési jelentés egyedi azonosítója.	Igen
metaadat	InsightsMetadata (írásvédett )	Metaadatok az elemzésekről.	Igen
└─ befejezve.	karakterlánc	Az elemzések befejezésének időbélyege.	No
└─ createdAt	karakterlánc	Az elemzések létrehozásának időbélyege.	Igen
kérelem	InsightRequest	Az elemzési jelentés kérése.	Igen
└─ típus	InsightType	A kérés típusa.	Igen
result	InsightResult (írásvédett)	A betekintések eredménye.	No
└─ típus	InsightType	Az elemzési eredmények típusa.	Igen
state	Azure. Core.Foundations.OperationState (írásvédett)	Az engedélyezett műveleti állapotokat leíró felsorolás.	Igen

InsightCluster

Elemzési minták csoportja.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az elemzési fürt leírása.	Igen
id	karakterlánc	Az elemzőfürt azonosítója.	Igen
címke	karakterlánc	A fürt címkéje	Igen
Minták	Az InsightSample tömbje	A fürthöz tartozó minták listája. Üres, ha a minták alclusterek részét képezik.	No
subClusters	Az InsightCluster tömbje	A fürtben található alclusterek listája. Üres, ha nincsenek alclusterek.	No
Javaslat	karakterlánc	Javaslat a fürthöz	Igen
suggestionTitle	karakterlánc	A fürtre vonatkozó javaslat címe	Igen
weight	egész szám	Az elemzőfürt súlya. Ez a fürtben lévő minták számát jelzi.	Igen

InsightModelConfiguration

Az elemzés generálásához használt modell konfigurációja.

Name	Típus	Description	Szükséges	Alapértelmezett
modelDeploymentName	karakterlánc	A kiértékelendő modelltelepítés. Az üzembehelyezési nevet önmagában vagy a kapcsolat nevével {connectionName}/<modelDeploymentName>együtt fogadja el.	Igen

InsightRequest

Az elemzési jelentés kérése.

Az InsightRequest diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Name	Típus	Description	Szükséges	Alapértelmezett
típus	InsightType	A betekintés kérése.	Igen

InsightResult

A betekintések eredménye.

Az InsightResult diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Típus	Description	Szükséges	Alapértelmezett
típus	InsightType	A betekintés kérése.	Igen

InsightSample

Minta az elemzésből.

Az InsightSample diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
EvaluationResultSample	EvaluationResultSample

Name	Típus	Description	Szükséges	Alapértelmezett
correlationInfo	objektum	Információ az elemzési minta korrelációjáról.	Igen
features	objektum	Az adatok további szűrését segítő funkciók az UX-ben.	Igen
id	karakterlánc	Az elemzési minta egyedi azonosítója.	Igen
típus	SampleType	Az elemzéshez használt minta típusa.	Igen

InsightScheduleTask

Betekintési feladat az ütemezéshez.

Name	Típus	Description	Szükséges	Alapértelmezett
konfiguráció	objektum	A feladat konfigurációja.	No
betekintés	Bepillantás	A fürtelemzések választörzse.	Igen
└─ displayName	karakterlánc	A megállapítás felhasználóbarát megjelenítendő neve.	Igen
└─ azonosító	sztring (írásvédett)	Az elemzési jelentés egyedi azonosítója.	Igen
└─ metaadatok	InsightsMetadata (írásvédett )	Az elemzési jelentés metaadatai.	Igen
└─ kérés	InsightRequest	Az elemzési elemzés kérése.	Igen
└─ eredmény	InsightResult (írásvédett)	Az elemzési jelentés eredménye.	No
└─ állapot	Azure. Core.Foundations.OperationState (írásvédett)	Az elemzések aktuális állapota.	Igen
típus	felsorolás	Lehetséges értékek: Insight	Igen

InsightSummary

A hibaklaszter elemzésének összefoglalása.

Name	Típus	Description	Szükséges	Alapértelmezett
metódus	karakterlánc	Fürtözéshez használt módszer.	Igen
sampleCount	egész szám	Az elemzett minták teljes száma.	Igen
uniqueClusterCount	egész szám	Egyedi fürtök teljes száma.	Igen
uniqueSubclusterCount	egész szám	Egyedi alcluster-címkék teljes száma.	Igen
felhasználás	ClusterTokenUsage	Jogkivonat-használat fürtelemzéshez	Igen
└─ inputTokenUsage	egész szám	bemeneti jogkivonat használata	Igen
└─ outputTokenUsage	egész szám	kimeneti jogkivonat használata	Igen
└─ totalTokenUsage	egész szám	teljes jogkivonat-használat	Igen

InsightType

A betekintés kérése.

Property	Érték
Leírás	A betekintés kérése.
Type	karakterlánc
Értékek	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metaadatok az elemzésekről.

Name	Típus	Description	Szükséges	Alapértelmezett
completedAt	karakterlánc	Az elemzések befejezésének időbélyege.	No
createdAt	karakterlánc	Az elemzések létrehozásának időbélyege.	Igen

ItemGenerationParams

Az elemlétrehozási műveletek vezérléséhez használt paraméterek készletét jelöli.

Az ItemGenerationParams diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Name	Típus	Description	Szükséges	Alapértelmezett
típus	ItemGenerationParamsType	A piros csoportelem-létrehozás paramétereinek típusai.	Igen

ItemGenerationParamsType

A piros csoportelem-létrehozás paramétereinek típusai.

Property	Érték
Leírás	A piros csoportelem-létrehozás paramétereinek típusai.
Type	karakterlánc
Értékek	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Felügyelt Azure AI Keresés indexdefiníció

Name	Típus	Description	Szükséges	Alapértelmezett
id	sztring (írásvédett)	Eszközazonosító, az eszköz egyedi azonosítója	No
név	sztring (írásvédett)	Az erőforrás neve	Igen
típus	felsorolás	Index típusa Lehetséges értékek: ManagedAzureSearch	Igen
verzió	sztring (írásvédett)	Az erőforrás verziója	Igen

ManagedAzureAISearchIndexUpdate

Felügyelt Azure AI Keresés indexdefiníció

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz leírásának szövege.	No
tags	objektum	Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők.	No
típus	felsorolás	Index típusa Lehetséges értékek: ManagedAzureSearch	Igen

MemoryItem

A memóriatárolóban tárolt egyetlen memóriaelem, amely tartalmat és metaadatokat tartalmaz.

A MemoryItem diszkriminatív

Ez az összetevő a tulajdonságot kind használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	karakterlánc	Az emlék tartalma.	Igen
kind	MemoryItemKind	Memóriaelem típusa.	Igen
memory_id	karakterlánc	A memóriaelem egyedi azonosítója.	Igen
hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen
updated_at	egész szám	A memóriaelem utolsó frissítési ideje.	Igen

MemoryItemKind

Memóriaelem típusa.

Property	Érték
Leírás	Memóriaelem típusa.
Type	karakterlánc
Értékek	user_profile chat_summary

MemoryOperation

Egy memóriaelemen végrehajtott egyetlen memóriaműveletet (létrehozás, frissítés vagy törlés) jelöl.

Name	Típus	Description	Szükséges	Alapértelmezett
kind	MemoryOperationKind	Memória művelet típusa.	Igen
memory_item	MemoryItem	A memóriatárolóban tárolt egyetlen memóriaelem, amely tartalmat és metaadatokat tartalmaz.	Igen
└─ tartalom	karakterlánc	Az emlék tartalma.	Igen
└─ fajta	MemoryItemKind	A memóriaelem típusa.	Igen
└─ memory_id	karakterlánc	A memóriaelem egyedi azonosítója.	Igen
└─ hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen
└─ updated_at	egész szám	A memóriaelem utolsó frissítési ideje.	Igen

MemoryOperationKind

Memória művelet típusa.

Property	Érték
Leírás	Memória művelet típusa.
Type	karakterlánc
Értékek	create update delete

MemorySearchItem

A memóriakeresésből beolvasott memóriaelem.

Name	Típus	Description	Szükséges	Alapértelmezett
memory_item	MemoryItem	A memóriatárolóban tárolt egyetlen memóriaelem, amely tartalmat és metaadatokat tartalmaz.	Igen
└─ tartalom	karakterlánc	Az emlék tartalma.	Igen
└─ fajta	MemoryItemKind	A memóriaelem típusa.	Igen
└─ memory_id	karakterlánc	A memóriaelem egyedi azonosítója.	Igen
└─ hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen
└─ updated_at	egész szám	A memóriaelem utolsó frissítési ideje.	Igen

MemorySearchOptions

Memóriakeresési lehetőségek.

Name	Típus	Description	Szükséges	Alapértelmezett
max_memories	egész szám	A visszaadandó memóriaelemek maximális száma.	No

MemorySearchPreviewTool

Eszköz az emlékek integrálására az ágensbe.

Name	Típus	Description	Szükséges	Alapértelmezett
memory_store_name	karakterlánc	A használni kívánt memóriatároló neve.	Igen
hatókör	karakterlánc	A memóriák csoportosítására és elkülönítésére használt névtér, például egy felhasználói azonosító. Korlátozza, hogy mely emlékek hívhatók vissza vagy frissíthetők. Speciális változó {{$userId}} használatával hatókört adhat a memóriáknak az aktuálisan bejelentkezett felhasználóra.	Igen
search_options	MemorySearchOptions	Memóriakeresési lehetőségek.	No
└─ max_memories	egész szám	A visszaadandó memóriaelemek maximális száma.	No
típus	felsorolás	Az eszköz típusa. Mindig memory_search_preview. Lehetséges értékek: memory_search_preview	Igen
update_delay	egész szám	Inaktivitás utáni memóriák frissítése előtt várni kell (másodperc). Alapértelmezett 300.	No	300

MemorySearchToolCallItemParam

Name	Típus	Description	Szükséges	Alapértelmezett
results	a MemorySearchItem tömbje	A memóriakeresésből visszaadott eredmények.	No
típus	felsorolás	Lehetséges értékek: memory_search_call	Igen

MemorySearchToolCallItemResource

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
results	a MemorySearchItem tömbje	A memóriakeresésből visszaadott eredmények.	No
állapot	felsorolás	A memóriakereső eszköz hívásának állapota. Az egyikin_progress searching, , completedincomplete vagy failed, Lehetséges értékek: in_progress, searching, completed, incompletefailed	Igen
típus	felsorolás	Lehetséges értékek: memory_search_call	Igen

MemoryStoreDefaultDefinition

Alapértelmezett memóriatároló-implementáció.

Name	Típus	Description	Szükséges	Alapértelmezett
chat_model	karakterlánc	A memóriafeldolgozáshoz használt csevegés-befejezési modell üzembe helyezésének neve vagy azonosítója.	Igen
embedding_model	karakterlánc	A memóriafeldolgozáshoz használt beágyazási modell üzembe helyezésének neve vagy azonosítója.	Igen
kind	felsorolás	A memóriatároló típusa. Lehetséges értékek: default	Igen
options	MemoryStoreDefaultOptions	Alapértelmezett memóriatároló-konfigurációk.	No
└─ chat_summary_enabled	boolean	A csevegés összegzésének kinyerése és storage engedélyezése. Alapértelmezett érték: true (igaz).	Igen	True
└─ user_profile_details	karakterlánc	A kinyerendő és tárolandó felhasználói profilinformációk meghatározott kategóriái vagy típusai.	No
└─ user_profile_enabled	boolean	A felhasználói profilok kinyerésének és storage engedélyezése. Alapértelmezett érték: true (igaz).	Igen	True

MemoryStoreDefaultOptions

Alapértelmezett memóriatároló-konfigurációk.

Name	Típus	Description	Szükséges	Alapértelmezett
chat_summary_enabled	boolean	A csevegés összegzésének kinyerése és storage engedélyezése. Alapértelmezett érték: true (igaz).	Igen	True
user_profile_details	karakterlánc	A kinyerendő és tárolandó felhasználói profilinformációk meghatározott kategóriái vagy típusai.	No
user_profile_enabled	boolean	A felhasználói profilok kinyerésének és storage engedélyezése. Alapértelmezett érték: true (igaz).	Igen	True

MemoryStoreDefinition

A memóriatároló konfigurációinak alapdefiníciója.

A MemoryStoreDefinition diszkriminatív

Ez az összetevő a tulajdonságot kind használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
default	MemoryStoreDefaultDefinition

Name	Típus	Description	Szükséges	Alapértelmezett
kind	MemoryStoreKind	A használni kívánt memóriatároló-implementáció típusa.	Igen

MemoryStoreDeleteScopeResponse

Válasz a memória hatókörből való törlésére.

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean	A törlési művelet sikeres volt-e.	Igen
név	karakterlánc	A memóriatároló neve.	Igen
objektum	felsorolás	Az objektum típusa. Mindig "memory_store.scope.deleted". Lehetséges értékek: memory_store.scope.deleted	Igen
hatókör	karakterlánc	Az a hatókör, amelyből az emlékek törlődtek.	Igen

MemoryStoreKind

A használni kívánt memóriatároló-implementáció típusa.

Property	Érték
Leírás	A használni kívánt memóriatároló-implementáció típusa.
Type	karakterlánc
Értékek	default

MemoryStoreObject

Memóriatároló, amely képes tárolni és visszakeresni a felhasználói emlékeket.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	A unix időbélyeg (másodperc) a memóriatároló létrehozásakor.	Igen
definíció	MemoryStoreDefinition	A memóriatároló konfigurációinak alapdefiníciója.	Igen
└─ fajta	MemoryStoreKind	A memóriatároló típusa.	Igen
leírás	karakterlánc	A memóriatároló ember által olvasható leírása. Korlátozások: maxLength: 512	No
id	karakterlánc	A memóriatároló egyedi azonosítója.	Igen
metaadat	objektum	A memóriatárolóhoz társítandó tetszőleges kulcs-érték metaadatok.	No
név	karakterlánc	A memóriatároló neve. Korlátozások: maxLength: 256	Igen
objektum	felsorolás	Az objektum típusa, amely mindig "memory_store". Lehetséges értékek: memory_store	Igen
updated_at	egész szám	A Memóriatároló utolsó frissítésének Unix-időbélyege (másodperc).	Igen

MemoryStoreOperationUsage

Memóriatárolási művelet használati statisztikái.

Name	Típus	Description	Szükséges	Alapértelmezett
embedding_tokens	egész szám	A beágyazási jogkivonatok száma.	Igen
input_tokens	OpenAI.integer		Igen
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Igen
└─ tárolt tokenek	OpenAI.integer		Igen
output_tokens	OpenAI.integer		Igen
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Igen
└─ érvelési tokenek	OpenAI.integer		Igen
total_tokens	OpenAI.integer		Igen

MemoryStoreSearchResponse

Memóriakeresési válasz.

Name	Típus	Description	Szükséges	Alapértelmezett
Emlékek	a MemorySearchItem tömbje	A keresési művelet során talált kapcsolódó memóriaelemek.	Igen
search_id	karakterlánc	A keresési kérelem egyedi azonosítója. Használja ezt az értéket previous_search_id a későbbi kérésekben növekményes keresésekhez.	Igen
felhasználás	MemoryStoreOperationUsage	Memóriatárolási művelet használati statisztikái.	Igen
└─ embedding_tokens	egész szám	A beágyazási jogkivonatok száma.	Igen
└─ bemeneti_tokének	OpenAI.integer	A bemeneti tokenek száma.	Igen
└─ bemeneti_tokén_részletek	OpenAI.ResponseUsageInputTokensDetails	A bemeneti tokenek részletes lebontása.	Igen
└─ kimeneti_tokenek	OpenAI.integer	A kimeneti tokenek száma.	Igen
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	A kimeneti tokenek részletes elemzése.	Igen
└─ összes_tokenek	OpenAI.integer	A felhasznált tokenek teljes száma.	Igen

MemoryStoreUpdateCompletedResult

Memóriafrissítés eredménye.

Name	Típus	Description	Szükséges	Alapértelmezett
memory_operations	a MemoryOperation tömbje	A frissítés során végrehajtott egyéni memóriaműveletek listája.	Igen
felhasználás	MemoryStoreOperationUsage	Memóriatárolási művelet használati statisztikái.	Igen
└─ embedding_tokens	egész szám	A beágyazási jogkivonatok száma.	Igen
└─ bemeneti_tokének	OpenAI.integer	A bemeneti tokenek száma.	Igen
└─ bemeneti_tokén_részletek	OpenAI.ResponseUsageInputTokensDetails	A bemeneti tokenek részletes lebontása.	Igen
└─ kimeneti_tokenek	OpenAI.integer	A kimeneti tokenek száma.	Igen
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	A kimeneti tokenek részletes elemzése.	Igen
└─ összes_tokenek	OpenAI.integer	A felhasznált tokenek teljes száma.	Igen

MemoryStoreUpdateResponse

A memóriatároló frissítési műveletének állapotát adja meg.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	OpenAI.Error		No
└─ additionalInfo	objektum		No
└─ kód	sztring (null értékű)		Igen
└─ debugInfo	objektum		No
└─ részletek	OpenAI.Error tömb		No
└─ üzenet	karakterlánc		Igen
└─ param	sztring (null értékű)		No
└─ típus	karakterlánc		No
result	MemoryStoreUpdateCompletedResult	Memóriafrissítés eredménye.	No
└─ memory_operations	a MemoryOperation tömbje	A frissítés során végrehajtott egyéni memóriaműveletek listája.	Igen
└─ használat	MemoryStoreOperationUsage	A memóriafrissítési művelethez társított használati statisztikák.	Igen
állapot	MemoryStoreUpdateStatus	A memóriatároló frissítési műveletének állapota.	Igen
superseded_by	karakterlánc	A művelet update_id felülírta a "felülírt" állapot.	No
update_id	karakterlánc	A frissítési kérelem egyedi azonosítója. Használja ezt az értéket previous_update_id a későbbi kérésekben a növekményes frissítések végrehajtásához.	Igen

MemoryStoreUpdateStatus

A memóriatároló frissítési műveletének állapota.

Property	Érték
Type	karakterlánc
Értékek	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

A Microsoft Fabric eszköz bemeneti definíció információja, amelyet egy ügynök konfigurálásához használnak.

Name	Típus	Description	Szükséges	Alapértelmezett
fabric_dataagent_preview	FabricDataAgentToolParameters	A hálóadatügynök eszköz paraméterei.	Igen
└─ project_connections	a ToolProjectConnection tömbje	Az eszközhöz csatolt project kapcsolatok. Legfeljebb 1 kapcsolat lehet erőforrást csatolja az eszközhöz. Korlátozások: maxItems: 1	No
típus	felsorolás	Az objektumtípus, ami mindig 'fabric_dataagent_preview'. Lehetséges értékek: fabric_dataagent_preview	Igen

Modell telepítés

Modell üzembe helyezési definíciója

Name	Típus	Description	Szükséges	Alapértelmezett
capabilities	objektum (írásvédett)	Az üzembe helyezett modell képességei	Igen
connectionName	sztring (írásvédett)	Annak a kapcsolatnak a neve, amelyből az üzembe helyezés származik	No
modelName	sztring (írásvédett)	az üzembe helyezett modell Publisher-specifikus neve	Igen
modelPublisher	sztring (írásvédett)	Az üzembe helyezett modell közzétevőjének neve	Igen
modellverzió	sztring (írásvédett)	az üzembe helyezett modell Publisher-specifikus verziója	Igen
név	sztring (írásvédett)	Az üzembe helyezés neve	Igen
sku	Termékváltozat (csak olvasható)	Termékváltozat adatai	Igen
└─ kapacitás	egész szám	Termékváltozat kapacitása	Igen
└─ család	karakterlánc	Termékváltozatcsalád	Igen
└─ név	karakterlánc	Termékváltozat neve	Igen
└─ méret	karakterlánc	Termékváltozat mérete	Igen
└─ szint	karakterlánc	Termékváltozat szintje	Igen
típus	felsorolás	Az üzembe helyezés típusa Lehetséges értékek: ModelDeployment	Igen

ModelSamplingParams

A nyelvi modell mintavételezési viselkedésének szabályozásához használt paraméterek készletét jelöli a szöveggenerálás során.

Name	Típus	Description	Szükséges	Alapértelmezett
max_completion_tokens	egész szám	A befejezés során engedélyezett jogkivonatok maximális száma.	Igen
seed	egész szám	A reprodukálhatóság véletlenszerű magja.	Igen
hőmérséklet	szám	A mintavételezés hőmérsékleti paramétere.	Igen
top_p	szám	A nukleusz mintavételezésének top-p paramétere.	Igen

ModelSamplingParamsUpdate

A nyelvi modell mintavételezési viselkedésének szabályozásához használt paraméterek készletét jelöli a szöveggenerálás során.

Name	Típus	Description	Szükséges	Alapértelmezett
max_completion_tokens	egész szám	A befejezés során engedélyezett jogkivonatok maximális száma.	No
seed	egész szám	A reprodukálhatóság véletlenszerű magja.	No
hőmérséklet	szám	A mintavételezés hőmérsékleti paramétere.	No
top_p	szám	A nukleusz mintavételezésének top-p paramétere.	No

MonthlyRecurrenceSchedule

Havi ismétlődési ütemterv.

Name	Típus	Description	Szükséges	Alapértelmezett
daysOfMonth	egész szám tömbje	Az ismétlődési ütemezés hónapjának napjai.	Igen
típus	felsorolás	Havi ismétlődés típusa. Lehetséges értékek: Monthly	Igen

NoAuthenticationCredentials

Hitelesítést nem igénylő hitelesítő adatok

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A hitelesítő adatok típusa Lehetséges értékek: None	Igen

OAuthConsentRequestOutputItem

A szolgáltatás kérése a felhasználótól OAuth-hozzájárulás végrehajtására.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
consent_link	karakterlánc	A felhasználó által az OAuth-hozzájárulás végrehajtásához használható hivatkozás.	Igen
id	karakterlánc		Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
szerver_címke	karakterlánc	Az OAuth-hozzájárulási kérelem kiszolgálócímkéje.	Igen
típus	felsorolás	Lehetséges értékek: oauth_consent_request	Igen

OneTimeTrigger

Egyszeri trigger.

Name	Típus	Description	Szükséges	Alapértelmezett
timeZone	karakterlánc	Az egyszeri eseményindító időzónája.	No	egyezményes világidő
triggerAt	karakterlánc	Az egyszeri eseményindító dátuma és időpontja ISO 8601 formátumban.	Igen
típus	felsorolás	Lehetséges értékek: OneTime	Igen

OpenAI.Annotation

Egy széljegyzet, amely a kimeneti szöveg spanjára vonatkozik.

Az OpenAI.Annotation diszkriminátor

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.AnnotationType		Igen

OpenAI.AnnotationType

Property	Érték
Type	karakterlánc
Értékek	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

Property	Érték
Type	karakterlánc
Értékek	completed failed

OpenAI.ApplyPatchCallOutputStatusParam

Apply_patch eszközhívás kimeneteihez jelentett eredményértékek.

Property	Érték
Type	karakterlánc
Értékek	completed failed

OpenAI.ApplyPatchCallStatus

Property	Érték
Type	karakterlánc
Értékek	in_progress completed

OpenAI.ApplyPatchCallStatusParam

Apply_patch eszközhívásokhoz jelentett állapotértékek.

Property	Érték
Type	karakterlánc
Értékek	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

A fájl apply_patch eszközzel történő létrehozását leíró utasítás.

Name	Típus	Description	Szükséges	Alapértelmezett
Diff	karakterlánc	Alkalmazni kívánt Diff.	Igen
elérési út	karakterlánc	A létrehozandó fájl elérési útja.	Igen
típus	felsorolás	Hozzon létre egy új fájlt a megadott diff használatával. Lehetséges értékek: create_file	Igen

OpenAI.ApplyPatchCreateFileOperationParam

Útmutató új fájl létrehozásához a apply_patch eszközzel.

Name	Típus	Description	Szükséges	Alapértelmezett
Diff	karakterlánc	Egységesített tartalom, amelyet a fájl létrehozásakor alkalmazni kell. Korlátozások: maxLength: 10485760	Igen
elérési út	karakterlánc	A munkaterület gyökeréhez képest létrehozandó fájl elérési útja. Korlátozások: minLength: 1	Igen
típus	felsorolás	A művelet típusa. Mindig create_file. Lehetséges értékek: create_file	Igen

OpenAI.ApplyPatchDeleteFileOperation

A fájlok apply_patch eszközzel történő törlését leíró utasítások.

Name	Típus	Description	Szükséges	Alapértelmezett
elérési út	karakterlánc	A törölni kívánt fájl elérési útja.	Igen
típus	felsorolás	Törölje a megadott fájlt. Lehetséges értékek: delete_file	Igen

OpenAI.ApplyPatchDeleteFileOperationParam

Utasítások meglévő fájlok apply_patch eszközzel történő törléséhez.

Name	Típus	Description	Szükséges	Alapértelmezett
elérési út	karakterlánc	A törölni kívánt fájl elérési útja a munkaterület gyökeréhez viszonyítva. Korlátozások: minLength: 1	Igen
típus	felsorolás	A művelet típusa. Mindig delete_file. Lehetséges értékek: delete_file	Igen

OpenAI.ApplyPatchFileOperation

A apply_patch keresztül alkalmazott create_file, delete_file vagy update_file műveletek egyike.

Az OpenAI.ApplyPatchFileOperation diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ApplyPatchFileOperationType		Igen

OpenAI.ApplyPatchFileOperationType

Property	Érték
Type	karakterlánc
Értékek	create_file delete_file update_file

OpenAI.ApplyPatchOperationParam

A apply_patch eszközhöz kapott create_file, delete_file vagy update_file műveletek egyike.

Az OpenAI.ApplyPatchOperationParam diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ApplyPatchOperationParamType		Igen

OpenAI.ApplyPatchOperationParamType

Property	Érték
Type	karakterlánc
Értékek	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

Lehetővé teszi, hogy az asszisztens egységes diffek használatával hozzon létre, töröljön vagy frissítsen fájlokat.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Az eszköz típusa. Mindig apply_patch. Lehetséges értékek: apply_patch	Igen

OpenAI.ApplyPatchUpdateFileOperation

A fájlok apply_patch eszközzel történő frissítését leíró utasítás.

Name	Típus	Description	Szükséges	Alapértelmezett
Diff	karakterlánc	Alkalmazni kívánt Diff.	Igen
elérési út	karakterlánc	A frissíteni kívánt fájl elérési útja.	Igen
típus	felsorolás	Frissítsen egy meglévő fájlt a megadott diff fájllal. Lehetséges értékek: update_file	Igen

OpenAI.ApplyPatchUpdateFileOperationParam

Utasítások meglévő fájlok apply_patch eszközzel történő frissítéséhez.

Name	Típus	Description	Szükséges	Alapértelmezett
Diff	karakterlánc	A meglévő fájlra alkalmazandó egységesített diff tartalom. Korlátozások: maxLength: 10485760	Igen
elérési út	karakterlánc	A munkaterület gyökeréhez képest frissíteni kívánt fájl elérési útja. Korlátozások: minLength: 1	Igen
típus	felsorolás	A művelet típusa. Mindig update_file. Lehetséges értékek: update_file	Igen

OpenAI.ApproximateLocation

Name	Típus	Description	Szükséges	Alapértelmezett
Város	sztring (null értékű)		No
ország	sztring (null értékű)		No
régió	sztring (null értékű)		No
timezone	sztring (null értékű)		No
típus	felsorolás	A hely közelítésének típusa. Mindig approximate. Lehetséges értékek: approximate	Igen

OpenAI.ChatCompletionTool

A válasz létrehozásához használható függvényeszköz.

Name	Típus	Description	Szükséges	Alapértelmezett
függvény	OpenAI.FunctionObject		Igen
típus	felsorolás	Az eszköz típusa. Jelenleg csak function támogatott. Lehetséges értékek: function	Igen

OpenAI.ChatModel

Property	Érték
Type	karakterlánc
Értékek	gpt-5.2 gpt-5.2-2025-12-11 gpt-5.2-chat-latest gpt-5.2-pro gpt-5.2-pro-2025-12-11 gpt-5.1 gpt-5.1-2025-11-13 gpt-5.1-codex gpt-5.1-mini gpt-5.1-chat-latest gpt-5 gpt-5-mini gpt-5-nano gpt-5-2025-08-07 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest gpt-4.1 gpt-4.1-mini gpt-4.1-nano gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o4-mini o4-mini-2025-04-16 o3 o3-2025-04-16 o3-mini o3-mini-2025-01-31 o1 o1-2024-12-17 o1-preview o1-preview-2024-09-12 o1-mini o1-mini-2024-09-12 gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-2024-05-13 gpt-4o-audio-preview gpt-4o-audio-preview-2024-10-01 gpt-4o-audio-preview-2024-12-17 gpt-4o-audio-preview-2025-06-03 gpt-4o-mini-audio-preview gpt-4o-mini-audio-preview-2024-12-17 gpt-4o-search-preview gpt-4o-mini-search-preview gpt-4o-search-preview-2025-03-11 gpt-4o-mini-search-preview-2025-03-11 chatgpt-4o-latest codex-mini-latest gpt-4o-mini gpt-4o-mini-2024-07-18 gpt-4-turbo gpt-4-turbo-2024-04-09 gpt-4-0125-preview gpt-4-turbo-preview gpt-4-1106-preview gpt-4-vision-preview gpt-4 gpt-4-0314 gpt-4-0613 gpt-4-32k gpt-4-32k-0314 gpt-4-32k-0613 gpt-3.5-turbo gpt-3.5-turbo-16k gpt-3.5-turbo-0301 gpt-3.5-turbo-0613 gpt-3.5-turbo-1106 gpt-3.5-turbo-0125 gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Property	Érték
Type	karakterlánc
Értékek	left right wheel back forward

OpenAI.ClickParam

Kattintási művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
gomb	OpenAI.ClickButtonType		Igen
típus	felsorolás	Megadja az esemény típusát. Kattintási művelet esetén ez a tulajdonság mindig click. Lehetséges értékek: click	Igen
x	OpenAI.integer		Igen
y	OpenAI.integer		Igen

OpenAI.CodeInterpreterContainerAuto

Kódértelmező-tároló konfigurálása. Ha szeretné, adja meg a fájlok azonosítóit a kód futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
fájl_azonosítók	sztringtömb	A feltöltött fájlok opcionális listája, amely a kód számára elérhetővé teszi őket.	No
memóriahatár	OpenAI.ContainerMemoryLimit (null értékű)		No
típus	felsorolás	Mindig auto. Lehetséges értékek: auto	Igen

OpenAI.CodeInterpreterOutputImage

A kódértelmező képkimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A kimenet típusa. Mindig image. Lehetséges értékek: image	Igen
url	karakterlánc	A kódértelmező képkimenetének URL-címe.	Igen

OpenAI.CodeInterpreterOutputLogs

A naplók kimenete a kódértelmezőtől származik.

Name	Típus	Description	Szükséges	Alapértelmezett
naplók	karakterlánc	A naplók kimenete a kódértelmezőtől származik.	Igen
típus	felsorolás	A kimenet típusa. Mindig logs. Lehetséges értékek: logs	Igen

OpenAI.CodeInterpreterTool

Egy Python-kódot futtató eszköz, amely segít a kérdésre adott válasz létrehozásában.

Name	Típus	Description	Szükséges	Alapértelmezett
tároló	sztring vagy OpenAI.CodeInterpreterContainerAuto	A kódértelmező tárolója. Lehet tárolóazonosító vagy objektum, amely megadja a feltöltött fájlazonosítókat, hogy elérhetővé tegyék a kódot, valamint egy nem kötelező memory_limit beállítás. Ha nincs megadva, a szolgáltatás automatikusan feltételezi.	No
típus	felsorolás	A kódértelmező eszköz típusa. Mindig code_interpreter. Lehetséges értékek: code_interpreter	Igen

OpenAI.CompactResource

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	Unix időbélyeg (másodpercben) a tömörített beszélgetés létrehozásakor.	Igen
id	karakterlánc	A tömörített válasz egyedi azonosítója.	Igen
objektum	felsorolás	Az objektum típusa. Mindig response.compaction. Lehetséges értékek: response.compaction	Igen
kimenet	OpenAI.OutputItem tömb	A kimeneti elemek tömörített listája. Ez az összes felhasználói üzenet listája, amelyet egyetlen tömörítési elem követ.	Igen
felhasználás	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	Igen
└─ bemeneti_tokének	OpenAI.integer	A bemeneti tokenek száma.	Igen
└─ bemeneti_tokén_részletek	OpenAI.ResponseUsageInputTokensDetails	A bemeneti tokenek részletes lebontása.	Igen
└─ kimeneti_tokenek	OpenAI.integer	A kimeneti tokenek száma.	Igen
└─ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	A kimeneti tokenek részletes elemzése.	Igen
└─ összes_tokenek	OpenAI.integer	A felhasznált tokenek teljes száma.	Igen

OpenAI.CompactResponseMethodPublicBody

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	OpenAI.InputItem sztringje vagy tömbje		No
instructions	sztring (null értékű)		No
modell	OpenAI.ModelIdsCompaction	A válasz létrehozásához használt modellazonosító, például gpt-5 vagy o3. Az OpenAI különböző képességekkel, teljesítményjellemzőkkel és árpontokkal rendelkező modellek széles választékát kínálja. Az elérhető modellek böngészéséhez és összehasonlításához tekintse meg a modellútmutatót .	Igen
previous_response_id	sztring (null értékű)		No

OpenAI.ÖsszehasonlítóSzűrő

Egy szűrő, amellyel egy megadott attribútumkulcsot egy adott értékhez hasonlíthat egy meghatározott összehasonlító művelettel.

Name	Típus	Description	Szükséges	Alapértelmezett
kulcs	karakterlánc	Az a kulcs, amelyhez az értéket viszonyítjuk.	Igen
típus	felsorolás	Az összehasonlító operátort adja meg: eq, ne, gt, gte, ltlte, , in. nin - eq:Egyenlő - ne: nem egyenlő - gt: nagyobb, mint - gte: nagyobb vagy egyenlő - lt: kisebb, mint - lte: kisebb vagy egyenlő - in: in - nin: nincs beadva Lehetséges értékek: eq, ne, gt, gte, ltlte	Igen
value	sztring vagy OpenAI.numerikus vagy logikai érték vagy OpenAI.ComparisonFilterValueItems tömb	Az attribútumkulcshoz viszonyítandó érték; sztring-, szám- vagy logikai típusokat támogat.	Igen

OpenAI.ComparisonFilterValueItems

Típus: sztring vagy OpenAI.numerikus

OpenAI.CompoundFilter

Több szűrő kombinálása a and vagy or használatával.

Name	Típus	Description	Szükséges	Alapértelmezett
filters	OpenAI.ComparisonFilter vagy objektum tömbje	Az egyesítendő szűrők tömbje. Az elemek lehetnek ComparisonFilter vagy CompoundFilter.	Igen
típus	felsorolás	Művelet típusa: and vagy or. Lehetséges értékek: and, or	Igen

OpenAI.ComputerAction

Diszkriminátor az OpenAI.ComputerAction számára

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
click	OpenAI.ClickParam
double_click	OpenAI.DoubleClickAction
drag	OpenAI.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.Screenshot
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ComputerActionType		Igen

OpenAI.ComputerActionType

Property	Érték
Type	karakterlánc
Értékek	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

A számítógép hívásának függőben lévő biztonsági ellenőrzése.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	sztring (null értékű)		No
id	karakterlánc	A függőben lévő biztonsági ellenőrzés azonosítója.	Igen
üzenet	sztring (null értékű)		No

OpenAI.ComputerEnvironment

Property	Érték
Type	karakterlánc
Értékek	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Képernyőkép egy számítógépről.

Name	Típus	Description	Szükséges	Alapértelmezett
fájl_azonosító	sztring (null értékű)		Igen
image_url	karakterlánc		Igen
típus	felsorolás	Megadja az esemény típusát. A számítógép képernyőképe esetén ez a tulajdonság mindig a következőre computer_screenshotvan állítva: . Lehetséges értékek: computer_screenshot	Igen

OpenAI.ComputerScreenshotImage

A számítógép-használati eszközzel használt képernyőkép.

Name	Típus	Description	Szükséges	Alapértelmezett
fájl_azonosító	karakterlánc	A képernyőképet tartalmazó feltöltött fájl azonosítója.	No
image_url	karakterlánc	A képernyőkép URL-címe.	No
típus	felsorolás	Megadja az esemény típusát. A számítógép képernyőképe esetén ez a tulajdonság a következő: mindig computer_screenshot-ra van állítva. Lehetséges értékek: computer_screenshot	Igen

OpenAI.ComputerUsePreviewTool

Egy virtuális számítógépet vezérlő eszköz.

Name	Típus	Description	Szükséges	Alapértelmezett
kijelző_magasság	OpenAI.integer		Igen
kijelző szélessége	OpenAI.integer		Igen
környezet	OpenAI.ComputerEnvironment		Igen
típus	felsorolás	A számítógép-használati eszköz típusa. Mindig computer_use_preview. Lehetséges értékek: computer_use_preview	Igen

OpenAI.ContainerFileCitationBody

Egy modellválasz létrehozásához használt tárolófájl idézete.

Name	Típus	Description	Szükséges	Alapértelmezett
container_id	karakterlánc	A tárolófájl azonosítója.	Igen
end_index	OpenAI.integer		Igen
fájl_azonosító	karakterlánc	A fájl azonosítója.	Igen
filename	karakterlánc	Az idézett tárolófájl fájlneve.	Igen
start_index	OpenAI.integer		Igen
típus	felsorolás	A tárolófájl-idézet típusa. Mindig container_file_citation. Lehetséges értékek: container_file_citation	Igen

OpenAI.ContainerMemoryLimit

Property	Érték
Type	karakterlánc
Értékek	1g 4g 16g 64g

OpenAI.ConversationItem

Egy beszélgetés egyetlen eleme. A lehetséges típusok halmaza megegyezik a outputVálasz objektum típusával.

Diszkriminatív az OpenAI.ConversationItem esetében

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ConversationItemType		Igen

OpenAI.ConversationItemApplyPatchToolCall

Eszközhívás, amely fájldiffeket alkalmaz fájlok létrehozásával, törlésével vagy frissítésével.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszközhívást létrehozó entitás azonosítója.	No
id	karakterlánc	Az apply patch tool call egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
művelet	OpenAI.ApplyPatchFileOperation	A apply_patch keresztül alkalmazott create_file, delete_file vagy update_file műveletek egyike.	Igen
└─ típus	OpenAI.ApplyPatchFileOperationType		Igen
állapot	OpenAI.ApplyPatchCallStatus		Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call. Lehetséges értékek: apply_patch_call	Igen

OpenAI.ConversationItemApplyPatchToolCallOutput

Az apply patch tool call által kibocsátott kimenet.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszköz kimenetét létrehozó entitás azonosítója.	No
id	karakterlánc	Az apply patch tool call output egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
kimenet	sztring (null értékű)		No
állapot	OpenAI.ApplyPatchCallOutputStatus		Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call_output. Lehetséges értékek: apply_patch_call_output	Igen

OpenAI.ConversationItemCodeInterpreterToolCall

Eszközhívás a kód futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	sztring (null értékű)		Igen
container_id	karakterlánc	A kód futtatásához használt tároló azonosítója.	Igen
id	karakterlánc	A kódértelmező eszköz hívásának egyedi azonosítója.	Igen
outputs	OpenAI.CodeInterpreterOutputLogs vagy OpenAI.CodeInterpreterOutputImage tömb		Igen
állapot	felsorolás	A kódértelmező eszköz hívásának állapota. Az érvényes értékek a következőkin_progress: , completed, incompleteinterpretingés failed. Lehetséges értékek: in_progress, completed, incomplete, interpretingfailed	Igen
típus	felsorolás	A kódértelmező eszköz hívásának típusa. Mindig code_interpreter_call. Lehetséges értékek: code_interpreter_call	Igen

OpenAI.ConversationItemComputerToolCall

Eszközhívás egy számítógép által használt eszközhöz. További információt a számítógép használati útmutatójában talál.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.ComputerAction		Igen
call_id	karakterlánc	Az eszközhívás kimenettel történő megválaszolásakor használt azonosító.	Igen
id	karakterlánc	A számítógép-hívás egyedi azonosítója.	Igen
pending_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	A számítógépes hívás függőben lévő biztonsági ellenőrzései.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A számítógép hívásának típusa. Mindig computer_call. Lehetséges értékek: computer_call	Igen

OpenAI.ConversationItemComputerToolCallOutputResource

Name	Típus	Description	Szükséges	Alapértelmezett
acknowledged_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	Az API által jelentett és elismert biztonsági ellenőrzések, amelyeket a fejlesztő.	No
call_id	karakterlánc	A kimenetet előállító számítógép-eszközhívás azonosítója.	Igen
id	karakterlánc	A számítógép eszköz hívási kimenetének azonosítója.	No
kimenet	OpenAI.ComputerScreenshotImage	A számítógép-használati eszközzel használt képernyőkép.	Igen
állapot	felsorolás	Az üzenetbemenet állapota. Az egyik in_progress, completed, vagy incomplete. A bemeneti elemek API-val való visszaadásakor ki lesz töltve. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A számítógép eszköz hívási kimenetének típusa. Mindig computer_call_output. Lehetséges értékek: computer_call_output	Igen

OpenAI.ConversationItemCustomToolCall

A modell által létrehozott egyéni eszköz hívása.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	Az egyéni eszközhívás eszközhívás kimenetére való leképezéséhez használt azonosító.	Igen
id	karakterlánc	Az egyéni eszköz hívásának egyedi azonosítója az OpenAI platformon.	No
bevitel	karakterlánc	A modell által létrehozott egyéni eszközhívás bemenete.	Igen
név	karakterlánc	A meghívandó egyéni eszköz neve.	Igen
típus	felsorolás	Az egyéni eszközhívás típusa. Mindig custom_tool_call. Lehetséges értékek: custom_tool_call	Igen

OpenAI.ConversationItemCustomToolCallOutput

A kódból származó egyéni eszközhívás kimenete, amelyet a rendszer visszaküld a modellnek.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	Az egyéni eszköz híváskimenetének egyéni eszközhíváshoz való leképezéséhez használt hívásazonosító.	Igen
id	karakterlánc	Az egyéni eszköz híváskimenetének egyedi azonosítója az OpenAI platformon.	No
kimenet	Az OpenAI.FunctionAndCustomToolCallOutput sztringje vagy tömbje	A kód által létrehozott egyéni eszközhívás kimenete. Lehet sztring vagy kimeneti tartalomlista.	Igen
típus	felsorolás	Az egyéni eszköz hívási kimenetének típusa. Mindig custom_tool_call_output. Lehetséges értékek: custom_tool_call_output	Igen

OpenAI.ConversationItemFileSearchToolCall

Egy fájlkereső eszköz hívásának eredményei. További információt a fájlkeresési útmutatóban talál.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A fájlkereső eszköz hívásának egyedi azonosítója.	Igen
queries	sztringtömb	A fájlok kereséséhez használt lekérdezések.	Igen
results	Az OpenAI.FileSearchToolCallResults tömbje		No
állapot	felsorolás	A fájlkereső eszköz hívásának állapota. Az egyikin_progress searching, incomplete vagy failed, Lehetséges értékek: in_progress, searching, completed, incompletefailed	Igen
típus	felsorolás	A fájlkereső eszköz hívásának típusa. Mindig file_search_call. Lehetséges értékek: file_search_call	Igen

OpenAI.ConversationItemFunctionShellCall

Egy eszközhívás, amely egy vagy több rendszerhéjparancsot hajt végre egy felügyelt környezetben.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.FunctionShellAction	Rendszerhéjparancs végrehajtása.	Igen
└─ parancsok	sztringtömb		Igen
└─ max_output_length	OpenAI.integer (null értékű)		Igen
└─ timeout_ms	OpenAI.integer (null értékű)		Igen
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszközhívást létrehozó entitás azonosítója.	No
id	karakterlánc	A rendszerhéj-eszköz hívásának egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
állapot	OpenAI.LocalShellCallStatus		Igen
típus	felsorolás	Az elem típusa. Mindig shell_call. Lehetséges értékek: shell_call	Igen

OpenAI.ConversationItemFunctionShellCallOutput

A rendszerhéjeszköz által kibocsátott hívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az elemet létrehozó szereplő azonosítója.	No
id	karakterlánc	A rendszerhéj-hívás kimenetének egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
max_output_length	OpenAI.integer (null értékű)		Igen
kimenet	Az OpenAI.FunctionShellCallOutputContent tömbje	A rendszerhéjhívás kimeneti tartalmának tömbje	Igen
típus	felsorolás	A rendszerhéj-hívás kimenetének típusa. Mindig shell_call_output. Lehetséges értékek: shell_call_output	Igen

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívási kimenetének egyedi azonosítója. Az elem kitöltve API-val adja vissza.	No
kimenet	Az OpenAI.FunctionAndCustomToolCallOutput sztringje vagy tömbje	A kód által generált függvényhívás kimenete. Lehet sztring vagy kimeneti tartalomlista.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényhívó eszköz kimenetének típusa. Mindig function_call_output. Lehetséges értékek: function_call_output	Igen

OpenAI.ConversationItemFunctionToolCallResource

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	A függvénynek átadni kívánt argumentumok JSON-sztringje.	Igen
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívásának egyedi azonosítója.	No
név	karakterlánc	A futtatni kívánt függvény neve.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényeszköz hívásának típusa. Mindig function_call. Lehetséges értékek: function_call	Igen

OpenAI.ConversationItemImageGenToolCall

A modell által küldött képgenerálási kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A képgenerálási hívás egyedi azonosítója.	Igen
result	sztring (null értékű)		Igen
állapot	felsorolás	A képgenerálási hívás állapota. Lehetséges értékek: in_progress, completed, , generatingfailed	Igen
típus	felsorolás	A képgenerálási hívás típusa. Mindig image_generation_call. Lehetséges értékek: image_generation_call	Igen

OpenAI.ConversationItemList

Beszélgetési elemek listája.

Name	Típus	Description	Szükséges	Alapértelmezett
adat	OpenAI.ConversationItem tömb	A beszélgetési elemek listája.	Igen
first_id	karakterlánc	A lista első elemének azonosítója.	Igen
van_még	boolean	Hogy vannak-e további elemek.	Igen
last_id	karakterlánc	A lista utolsó elemének azonosítója.	Igen
objektum	felsorolás	A visszaadott objektum típusának a következőnek kell lennie list: . Lehetséges értékek: list	Igen

OpenAI.ConversationItemLocalShellToolCall

Egy eszközhívás egy parancs a helyi parancssoron való futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.LocalShellExecAction	Futtasson egy rendszerhéjparancsot a kiszolgálón.	Igen
call_id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
id	karakterlánc	A helyi rendszerhéj-hívás egyedi azonosítója.	Igen
állapot	felsorolás	A helyi rendszerhéj-hívás állapota. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A helyi rendszerhéj-hívás típusa. Mindig local_shell_call. Lehetséges értékek: local_shell_call	Igen

OpenAI.ConversationItemLocalShellToolCallOutput

Helyi rendszerhéj-eszközhívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
kimenet	karakterlánc	A helyi shell-eszközhívás kimenetének JSON karakterlánca.	Igen
állapot	felsorolás	Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A helyi rendszerhéj-eszköz híváskimenetének típusa. Mindig local_shell_call_output. Lehetséges értékek: local_shell_call_output	Igen

OpenAI.ConversationItemMcpApprovalRequest

Az eszköz meghívásának emberi jóváhagyásához irányuló kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	Az eszközhöz tartozó argumentumok JSON-sztringje.	Igen
id	karakterlánc	A jóváhagyási kérelem egyedi azonosítója.	Igen
név	karakterlánc	A futtatni kívánt eszköz neve.	Igen
szerver_címke	karakterlánc	A kérelmet küldő MCP-kiszolgáló címkéje.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_approval_request. Lehetséges értékek: mcp_approval_request	Igen

OpenAI.ConversationItemMcpApprovalResponseResource

Válasz mcp jóváhagyási kérelemre.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	karakterlánc	A megválaszolt jóváhagyási kérelem azonosítója.	Igen
approve	boolean	A kérelem jóváhagyása.	Igen
id	karakterlánc	A jóváhagyási válasz egyedi azonosítója	Igen
ok	sztring (null értékű)		No
típus	felsorolás	Az elem típusa. Mindig mcp_approval_response. Lehetséges értékek: mcp_approval_response	Igen

OpenAI.ConversationItemMcpListTools

Az MCP-kiszolgálón elérhető eszközök listája.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	sztring (null értékű)		No
id	karakterlánc	A lista egyedi azonosítója.	Igen
szerver_címke	karakterlánc	Az MCP-kiszolgáló címkéje.	Igen
tools	Az OpenAI.MCPListToolsTool tömbje	A kiszolgálón elérhető eszközök.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_list_tools. Lehetséges értékek: mcp_list_tools	Igen

OpenAI.ConversationItemMcpToolCall

Eszköz meghívása egy MCP-kiszolgálón.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	sztring (null értékű)		No
arguments	karakterlánc	Az eszköznek átadott argumentumok JSON-sztringje.	Igen
hiba	sztring (null értékű)		No
id	karakterlánc	Az eszközhívás egyedi azonosítója.	Igen
név	karakterlánc	A futtatott eszköz neve.	Igen
kimenet	sztring (null értékű)		No
szerver_címke	karakterlánc	Az eszközt futtató MCP-kiszolgáló címkéje.	Igen
állapot	OpenAI.MCPToolCallStatus		No
típus	felsorolás	Az elem típusa. Mindig mcp_call. Lehetséges értékek: mcp_call	Igen

OpenAI.ConversationItemMessage

Üzenet a modellbe vagy a modellből.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	Az OpenAI.MessageContent tömbje	Az üzenet tartalma	Igen
id	karakterlánc	Az üzenet egyedi azonosítója.	Igen
szerepkör	OpenAI.MessageRole		Igen
állapot	OpenAI.MessageStatus		Igen
típus	felsorolás	Az üzenet típusa. Mindig messageértékre van állítva. Lehetséges értékek: message	Igen

OpenAI.ConversationItemReasoningItem

Az érvelési modell által a válasz létrehozásakor használt gondolatlánc leírása. Ha manuálisan input, mindenképpen vegye fel ezeket az elemeket a Válasz API-ba a beszélgetés későbbi fordulataihoz.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	OpenAI.ReasoningTextContent tömb	Szöveges tartalom érvelése.	No
encrypted_content	sztring (null értékű)		No
id	karakterlánc	Az érvelési tartalom egyedi azonosítója.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
összegzés	OpenAI.Summary tömb	Az összegző tartalom indoklása.	Igen
típus	felsorolás	Az objektum típusa. Mindig reasoning. Lehetséges értékek: reasoning	Igen

OpenAI.ConversationItemType

Property	Érték
Type	karakterlánc
Értékek	message function_call function_call_output file_search_call web_search_call image_generation_call computer_call computer_call_output reasoning code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Egy webes keresőeszköz hívásának eredményei. További információért tekintse meg a webes keresési útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.WebSearchActionSearch vagy OpenAI.WebSearchActionOpenPage vagy OpenAI.WebSearchActionFind	A webes keresési hívásban végrehajtott konkrét műveletet leíró objektum. A modell webes használatáról (keresés, open_page, keresés) szóló részletes információkat tartalmaz.	Igen
id	karakterlánc	A webes keresőeszköz hívásának egyedi azonosítója.	Igen
állapot	felsorolás	A webes keresőeszköz hívásának állapota. Lehetséges értékek: in_progress, searching, , completedfailed	Igen
típus	felsorolás	A webes keresőeszköz hívásának típusa. Mindig web_search_call. Lehetséges értékek: web_search_call	Igen

OpenAI.ConversationParam

A beszélgetés, amelyhez ez a válasz tartozik. A beszélgetés elemei előre fel vannak függve ehhez a válaszkéréshez input_items . A válaszból származó bemeneti elemek és kimeneti elemek a válasz befejezése után automatikusan hozzáadódnak ehhez a beszélgetéshez.

Típus: sztring vagy OpenAI.ConversationParam-2

A beszélgetés, amelyhez ez a válasz tartozik. A beszélgetés elemei előre fel vannak függve ehhez a válaszkéréshez input_items . A válaszból származó bemeneti elemek és kimeneti elemek a válasz befejezése után automatikusan hozzáadódnak ehhez a beszélgetéshez.

OpenAI.ConversationParam-2

A beszélgetés, amelyhez ez a válasz tartozik.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A beszélgetés egyedi azonosítója.	Igen

OpenAI.ConversationReference

A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A válaszhoz társított beszélgetés egyedi azonosítója.	Igen

OpenAI.ConversationResource

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	A beszélgetés létrehozásának időpontja másodpercben mérve a Unix-korszak óta.	Igen
id	karakterlánc	A beszélgetés egyedi azonosítója.	Igen
metaadat	OpenAI.Metadata	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	Igen
objektum	felsorolás	Az objektum típusa, amely mindig conversation. Lehetséges értékek: conversation	Igen

OpenAI.CreateChatCompletionRequestResponseFormat

Egy objektum, amely megadja a modell által kiadandó formátumot. A strukturált kimeneteket engedélyező { "type": "json_schema", "json_schema": {...} } beállítás, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. További információ a Strukturált kimenetek útmutatóban. { "type": "json_object" } A régebbi JSON mód engedélyezése, amely biztosítja, hogy a modell által generált üzenet érvényes JSON-ként legyen létrehozva. Az azt támogató modelleknél előnyben részesítik a használatot json_schema .

Az OpenAI.CreateChatCompletionRequestResponseFormat diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.CreateChatCompletionRequestResponseFormatType		Igen

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON-objektum válaszformátuma. Egy régebbi módszer JSON-válaszok létrehozására. A használatát json_schema az azt támogató modellek esetében javasoljuk. Vegye figyelembe, hogy a modell nem hoz létre JSON-t, hacsak egy rendszer vagy felhasználói üzenet nem utasítja erre.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A definiált válaszformátum típusa. Mindig json_object. Lehetséges értékek: json_object	Igen

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Alapértelmezett válaszformátum. Szöveges válaszok létrehozására szolgál.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A definiált válaszformátum típusa. Mindig text. Lehetséges értékek: text	Igen

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Érték
Type	karakterlánc
Értékek	text json_schema json_object

OpenAI.CreateConversationBody

Name	Típus	Description	Szükséges	Alapértelmezett
items	OpenAI.InputItem tömb		No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No

OpenAI.CreateEvalCompletionsRunDataSource

Egy modell mintavételezési konfigurációját leíró CompletionsRunDataSource objektum.

Name	Típus	Description	Szükséges	Alapértelmezett
bemeneti_üzenetek	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate vagy OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Modellből történő mintavételezéshez használatos. Meghatározza a modellbe továbbított üzenetek struktúráját. Hivatkozhat egy előre összeállított pályára (azaz), vagy egy sablonra, item.input_trajectoryamely változó hivatkozásokat tartalmaz a item névtérre.	No
modell	karakterlánc	A befejezések létrehozásához használandó modell neve (pl. "o3-mini").	No
mintavételi_paraméterek	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
adatforrás	OpenAI.EvalJsonlFileContentSource vagy OpenAI.EvalJsonlFileIdSource vagy OpenAI.EvalStoredCompletionsSource	Meghatározza, hogy mi tölti fel a item névteret a futtatás adatforrásában.	Igen
típus	felsorolás	A futtatási adatforrás típusa. Mindig completions. Lehetséges értékek: completions	Igen

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Típus	Description	Szükséges	Alapértelmezett
item_reference	karakterlánc		Igen
típus	felsorolás	Lehetséges értékek: item_reference	Igen

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Típus	Description	Szükséges	Alapértelmezett
sablon	OpenAI.EasyInputMessage vagy OpenAI.EvalItem tömb		Igen
típus	felsorolás	Lehetséges értékek: template	Igen

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Típus	Description	Szükséges	Alapértelmezett
max_completion_tokens	OpenAI.integer		No
érvelési erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
válasz_formátum	OpenAI.ResponseFormatText vagy OpenAI.ResponseFormatJsonSchema vagy OpenAI.ResponseFormatJsonObject		No
seed	OpenAI.integer		No	42
hőmérséklet	OpenAI.numerikus		No	1
tools	Az OpenAI.ChatCompletionTool tömbje		No
top_p	OpenAI.numerikus		No	1

OpenAI.CreateEvalCustomDataSourceConfig

CustomDataSourceConfig objektum, amely meghatározza a kiértékeléshez használt adatforrás sémáját. Ez a séma határozza meg a következő adatok alakját:

• Tesztelési kritériumok meghatározására használják.
• Milyen adatokra van szükség egy futtatás létrehozásakor?

Name	Típus	Description	Szükséges	Alapértelmezett
minta séma bevonása	boolean	Elvárja-e az eval, hogy te feltöltsd a mintanévteret (azaz az adatforrásból származó válaszok generálásával)	No
tétel séma	objektum	Az adatforrás minden sorához tartozó json-séma.	Igen
típus	felsorolás	Az adatforrás típusa. Mindig custom. Lehetséges értékek: custom	Igen

OpenAI.CreateEvalJsonlRunDataSource

Egy JsonlRunDataSource objektum, amely egy JSONL-fájlt ad meg, amely megfelel az evalnak

Name	Típus	Description	Szükséges	Alapértelmezett
adatforrás	OpenAI.EvalJsonlFileContentSource vagy OpenAI.EvalJsonlFileIdSource	Meghatározza, hogy mi tölti fel a item névteret az adatforrásban.	Igen
típus	felsorolás	Az adatforrás típusa. Mindig jsonl. Lehetséges értékek: jsonl	Igen

OpenAI.CreateEvalLogsDataSourceConfig

Adatforrás-konfiguráció, amely megadja a naplók lekérdezésének metaadat-tulajdonságát. Ez általában metaadatok, például usecase=chatbot vagy prompt-version=v2, stb.

Name	Típus	Description	Szükséges	Alapértelmezett
metaadat	objektum	Metaadatszűrők a naplók adatforrásához.	No
típus	felsorolás	Az adatforrás típusa. Mindig logs. Lehetséges értékek: logs	Igen

OpenAI.CreateEvalResponsesRunDataSource

Egy modell mintavételezési konfigurációját leíró ResponsesRunDataSource objektum.

Name	Típus	Description	Szükséges	Alapértelmezett
bemeneti_üzenetek	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate vagy OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Modellből történő mintavételezéshez használatos. Meghatározza a modellbe továbbított üzenetek struktúráját. Hivatkozhat egy előre összeállított pályára (azaz), vagy egy sablonra, item.input_trajectoryamely változó hivatkozásokat tartalmaz a item névtérre.	No
modell	karakterlánc	A befejezések létrehozásához használandó modell neve (pl. "o3-mini").	No
mintavételi_paraméterek	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
adatforrás	OpenAI.EvalJsonlFileContentSource vagy OpenAI.EvalJsonlFileIdSource vagy OpenAI.EvalResponsesSource	Meghatározza, hogy mi tölti fel a item névteret a futtatás adatforrásában.	Igen
típus	felsorolás	A futtatási adatforrás típusa. Mindig responses. Lehetséges értékek: responses	Igen

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Típus	Description	Szükséges	Alapértelmezett
item_reference	karakterlánc		Igen
típus	felsorolás	Lehetséges értékek: item_reference	Igen

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Típus	Description	Szükséges	Alapértelmezett
sablon	objektumtömb vagy OpenAI.EvalItem		Igen
típus	felsorolás	Lehetséges értékek: template	Igen

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Típus	Description	Szükséges	Alapértelmezett
max_completion_tokens	OpenAI.integer		No
érvelési erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
seed	OpenAI.integer		No	42
hőmérséklet	OpenAI.numerikus		No	1
SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	Az OpenAI.Tool tömbje		No
top_p	OpenAI.numerikus		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Típus	Description	Szükséges	Alapértelmezett
format	OpenAI.TextResponseFormatConfiguration	Egy objektum, amely megadja a modell által kiadandó formátumot. A konfigurálás { "type": "json_schema" } lehetővé teszi a strukturált kimeneteket, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. Tudjon meg többet itt: Az alapértelmezett formátum { "type": "text" } nem nyújt további beállításokat. *Nem ajánlott gpt-4o és újabb modellek esetén:** Beállítás a { "type": "json_object" } régebbi JSON módot engedélyezi. biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Az json_schema használata az azt támogató modellek esetében előnyben részesítik.	No

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

A LogsDataSourceConfig helyett elavult.

Name	Típus	Description	Szükséges	Alapértelmezett
metaadat	objektum	Metaadatszűrők a tárolt befejezési adatforráshoz.	No
típus	felsorolás	Az adatforrás típusa. Mindig stored_completions. Lehetséges értékek: stored_completions	Igen

OpenAI.CreateFineTuningJobRequest

Érvényes modellek:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Típus	Description	Szükséges	Alapértelmezett
hiperparaméterek	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└─ köteg_méret	sztring vagy OpenAI.integer		No	kocsi
└─ tanulási_ráta_szorzó	sztring vagy OpenAI.numerikus		No
└─ n_epochs	sztring vagy OpenAI.integer		No	kocsi
Integrációk	Az OpenAI.CreateFineTuningJobRequestIntegrations tömbje	A finomhangolási feladathoz engedélyezendő integrációk listája.	No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
metódus	OpenAI.FineTuneMethod	A finomhangoláshoz használt módszer.	No
modell	string (lásd az érvényes modelleket alább)	A finomhangolandó modell neve. Kiválaszthatja a támogatott modellek.	Igen
seed	OpenAI.integer (null értékű)		No
Utótag	sztring (null értékű)	Egy legfeljebb 64 karakterből álló szöveg, amely hozzáadódik a finomhangolt modell nevéhez. Egy "custom-model-name" például suffix egy olyan modellnevet eredményezne, mint a ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Korlátozások: minLength: 1, maxLength: 64	No
képzési fájl	karakterlánc	Betanítási adatokat tartalmazó feltöltött fájl azonosítója. A fájl feltöltéséről a feltöltési fájlban olvashat. Az adatkészletet JSONL-fájlként kell formázni. Emellett fel kell töltenie a fájlt a célnak fine-tunemegfelelően. A fájl tartalmának különböznie kell attól függően, hogy a modell a csevegést, a befejezési formátumot vagy a finomhangolási módszert használja-e. További részletekért tekintse meg a finomhangolási útmutatót .	Igen
érvényesítési_fájl	sztring (null értékű)	Az érvényesítési adatokat tartalmazó feltöltött fájl azonosítója. Ha megadja ezt a fájlt, a rendszer az adatokat az ellenőrzés létrehozásához használja Metrikákat időszakosan a finomhangolás során. Ezek a metrikák a következő helyen tekinthetők meg: az eredményfájl finomhangolása. A betanított és az érvényesítési fájlokban nem lehetnek ugyanazok az adatok. Az adatkészletet JSONL-fájlként kell formázni. A fájlt a célnak fine-tunemegfelelően kell feltöltenie. További részletekért tekintse meg a finomhangolási útmutatót .	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Típus	Description	Szükséges	Alapértelmezett
köteg_méret	sztring vagy OpenAI.integer		No
tanulási_ráta_sokszorozó	sztring vagy OpenAI.numerikus		No
épocha száma	sztring vagy OpenAI.integer		No

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: wandb	Igen
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Igen

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Típus	Description	Szükséges	Alapértelmezett
egyed	sztring (null értékű)		No
név	sztring (null értékű)		No
projekt	karakterlánc		Igen
tags	sztringtömb		No

OpenAI.CreateResponseStreamingResponse

Típus: OpenAI.ResponseAudioDeltaEvent vagy OpenAI.ResponseAudioTranscriptDeltaEvent vagy OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent vagy OpenAI.ResponseCodeInterpreterCallInProgressEvent vagy OpenAI.ResponseCodeInterpreterCallInterpretingEvent vagy OpenAI.ResponseContentPartAddedEvent vagy OpenAI.ResponseCreatedEvent vagy OpenAI.ResponseErrorEvent vagy OpenAI.ResponseFileSearchCallInProgressEvent vagy OpenAI.ResponseFileSearchCallSearchingEvent vagy OpenAI.ResponseFunctionCallArgumentsDeltaEvent vagy OpenAI.ResponseInProgressEvent vagy OpenAI.ResponseFailed Event vagy OpenAI.ResponseIncompleteEvent vagy OpenAI.ResponseOutputItemAddedEvent vagy OpenAI.ResponseReasoningSummaryPartAddedEvent vagy OpenAI.ResponseReasoningSummaryTextDeltaEvent vagy OpenAI.ResponseReasoningTextDeltaEvent vagy OpenAI.ResponseRefusalDeltaEvent vagy OpenAI.ResponseTextDeltaEvent vagy OpenAI.ResponseWebSearchCallInProgressEvent vagy OpenAI.ResponseWebSearchCallSearchingEvent vagy OpenAI.ResponseImageGenCallGeneratingEvent vagy OpenAI.ResponseImageGenCallInProgressEvent vagy OpenAI.ResponseImageGenCallPartialImageEvent vagy OpenAI.ResponseMCPCallArgumentsDeltaEvent vagy OpenAI.ResponseMCPCallFailedEvent vagy OpenAI.ResponseMCPCallInProgressEvent vagy OpenAI.ResponseMCPListToolsFailedEvent vagy OpenAI.ResponseMCPListToolsInProgressEvent vagy OpenAI.ResponseOutputTextAnnotationAddedEvent vagy OpenAI.ResponseQueuedEvent vagy OpenAI.ResponseCustomToolCallInputDeltaEvent vagy OpenAI.ResponseAudioDoneEvent vagy OpenAI.ResponseAudioTranscriptDoneEvent vagy OpenAI.ResponseCodeInterpreterCallCodeDoneEvent vagy OpenAI.ResponseCodeInterpreterCallCompletedEvent vagy OpenAI.ResponseCompletedEvent vagy OpenAI.ResponseCompletedEvent vagy OpenAI.ResponseContentPartDoneEvent vagy OpenAI.ResponseFileSearchCallCompletedEvent vagy OpenAI.ResponseFunctionCallArgumentsDoneEvent vagy OpenAI.ResponseOutputItemDoneEvent vagy OpenAI.ResponseReasoningSummaryPartDoneEvent vagy OpenAI.ResponseReasoningSummaryTextDoneEvent vagy OpenAI.ResponseReasoningTextDoneEvent vagy OpenAI.ResponseRefusalDoneEvent vagy OpenAI. ResponseTextDoneEvent vagy OpenAI.ResponseWebSearchCallCompletedEvent vagy OpenAI.ResponseImageGenCallCompletedEvent vagy OpenAI.ResponseMCPCallArgumentsDoneEvent vagy OpenAI.ResponseMCPCallCompletedEvent vagy OpenAI.ResponseMCPListToolsCompletedEvent vagy OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

A felhasználó által definiált nyelvhelyesség.

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	karakterlánc	A nyelvhelyességi definíció.	Igen
Szintaxis	OpenAI.GrammarSyntax1		Igen
típus	felsorolás	Nyelvtani formátum. Mindig grammar. Lehetséges értékek: grammar	Igen

OpenAI.CustomTextFormatParam

Nem korlátozott szabad formátumú szöveg.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Nem korlátozott szövegformátum. Mindig text. Lehetséges értékek: text	Igen

OpenAI.CustomToolParam

Egyéni eszköz, amely egy megadott formátum használatával dolgozza fel a bemenetet. További információ az egyéni eszközökről

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az egyéni eszköz opcionális leírása, amely további kontextust biztosít.	No
format	OpenAI.CustomToolParamFormat	Az egyéni eszköz bemeneti formátuma. Az alapértelmezett érték nem korlátozott szöveg.	No
└─ típus	OpenAI.CustomToolParamFormatType		Igen
név	karakterlánc	Az egyéni eszköz neve, amely az eszközhívásokban való azonosításra szolgál.	Igen
típus	felsorolás	Az egyéni eszköz típusa. Mindig custom. Lehetséges értékek: custom	Igen

OpenAI.CustomToolParamFormat

Az egyéni eszköz bemeneti formátuma. Az alapértelmezett érték nem korlátozott szöveg.

Az OpenAI.CustomToolParamFormat diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.CustomToolParamFormatType		Igen

OpenAI.CustomToolParamFormatType

Property	Érték
Type	karakterlánc
Értékek	text grammar

OpenAI.DeletedConversationResource

Name	Típus	Description	Szükséges	Alapértelmezett
törölt	boolean		Igen
id	karakterlánc		Igen
objektum	felsorolás	Lehetséges értékek: conversation.deleted	Igen

OpenAI.DetailEnum

Property	Érték
Type	karakterlánc
Értékek	low high auto

OpenAI.DoubleClickAction

Dupla kattintásos művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Megadja az esemény típusát. Dupla kattintásos művelet esetén ez a tulajdonság mindig a következőre double_clickvan állítva: . Lehetséges értékek: double_click	Igen
x	OpenAI.integer		Igen
y	OpenAI.integer		Igen

OpenAI.Drag

Húzási művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
elérési út	Az OpenAI.DragPoint tömbje	A húzási művelet útvonalát jelképező koordináták tömbje. A koordináták tömbként jelennek meg objektumok, pl. <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>	Igen
típus	felsorolás	Megadja az esemény típusát. Húzó művelet esetén ez a tulajdonság mindig drag-ra van állítva. Lehetséges értékek: drag	Igen

OpenAI.DragPoint

Egy x/y koordináta-pár, pl. . { x: 100, y: 200 }

Name	Típus	Description	Szükséges	Alapértelmezett
x	OpenAI.integer		Igen
y	OpenAI.integer		Igen

OpenAI.EasyInputMessage

A modell üzenetbemenete egy szerepkörrel, amely a hierarchiát követő utasításokat jelzi. A developer vagy system szerepkörrel megadott utasítások elsőbbséget élveznek a user szerepkörrel megadott utasításokkal szemben. A szerepkörrel rendelkező assistant üzeneteket feltételezzük, hogy a modell a korábbi interakciók során hozta létre.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	sztring vagy OpenAI.InputMessageContentList	A modell szöveg-, kép- vagy hangbemenete, amelyet válasz létrehozására használnak. A korábbi asszisztensi válaszokat is tartalmazhatja.	Igen
szerepkör	felsorolás	Az üzenetbemenet szerepe. Az egyik user, assistant, systemvagy developer. Lehetséges értékek: user, assistant, , systemdeveloper	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	Az üzenetbemenet típusa. Mindig message. Lehetséges értékek: message	Igen

OpenAI.Error

Name	Típus	Description	Szükséges	Alapértelmezett
továbbiInformáció	objektum		No
kód	sztring (null értékű)		Igen
debugInfo	objektum		No
details	OpenAI.Error tömb		No
üzenet	karakterlánc		Igen
param	sztring (null értékű)		No
típus	karakterlánc		No

OpenAI.EvalApiError

Az Eval API hibaválaszát képviselő objektum.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	karakterlánc	A hibakód.	Igen
üzenet	karakterlánc	A hibaüzenet.	Igen

OpenAI.EvalGraderLabelModel

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	OpenAI.EvalItem tömb		Igen
labels	sztringtömb	A kiértékelés egyes elemeihez hozzárendelendő címkék.	Igen
modell	karakterlánc	A kiértékeléshez használni kívánt modell. Támogatnia kell a strukturált kimeneteket.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
áthaladó címkék	sztringtömb	Az átmenő eredményt jelző címkék. Címkék részhalmazának kell lennie.	Igen
típus	felsorolás	Az objektum típusa, amely mindig label_model. Lehetséges értékek: label_model	Igen

OpenAI.EvalGraderPython

Name	Típus	Description	Szükséges	Alapértelmezett
kép_címke	karakterlánc	A Python-szkripthez használandó képcímke.	No
név	karakterlánc	Az osztályozó neve.	Igen
küszöbértéket elér	OpenAI.numerikus		No
adatforrás	karakterlánc	A Python-szkript forráskódja.	Igen
típus	felsorolás	Az objektum típusa, amely mindig python. Lehetséges értékek: python	Igen

OpenAI.EvalGraderScoreModel

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	OpenAI.EvalItem tömb	Az osztályozó által kiértékelt bemeneti üzenetek. Támogatja a szöveg, a kimeneti szöveg, a bemeneti kép és a bemeneti hangtartalomblokkok használatát, és sablonsztringeket is tartalmazhat.	Igen
modell	karakterlánc	A kiértékeléshez használni kívánt modell.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
küszöbértéket elér	OpenAI.numerikus		No
tartomány	OpenAI.numerikus tömb	A pontszám tartománya. Alapértelmezett érték: [0, 1].	No
mintavételi_paraméterek	OpenAI.EvalGraderScoreModelSamplingParams		No
└─ max_completions_tokens	OpenAI.integer (null értékű)		No
└─ érvelési_erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
└─ mag	OpenAI.integer (null értékű)		No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
típus	felsorolás	Az objektum típusa, amely mindig score_model. Lehetséges értékek: score_model	Igen

OpenAI.EvalGraderScoreModelSamplingParams

Name	Típus	Description	Szükséges	Alapértelmezett
max_completions_tokens	OpenAI.integer (null értékű)		No
érvelési erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
seed	OpenAI.integer (null értékű)		No
hőmérséklet	OpenAI.numerikus (null értékű)		No
top_p	OpenAI.numerikus (null értékű)		No	1

OpenAI.EvalGraderStringCheck

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	karakterlánc	A bemeneti szöveg. Ilyenek lehetnek a sablonszövegek.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
művelet	felsorolás	A végrehajtandó karakterláncellenőrzési művelet. Egyik eq, ne, like vagy ilike. Lehetséges értékek: eq, ne, , likeilike	Igen
hivatkozás	karakterlánc	A referenciaszöveg. Ilyenek lehetnek a sablonszövegek.	Igen
típus	felsorolás	Az objektum típusa, amely mindig string_check. Lehetséges értékek: string_check	Igen

OpenAI.EvalGraderTextSimilarity

Name	Típus	Description	Szükséges	Alapértelmezett
értékelési mutató	felsorolás	A használni kívánt értékelési metrika. Az egyik cosine, fuzzy_match, bleu gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, rouge_5 vagy rouge_l. Lehetséges értékek: cosine, fuzzy_match, bleu, gleu, meteorrouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l	Igen
bevitel	karakterlánc	Az osztályozás alatt álló szöveg.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
küszöbértéket elér	OpenAI.numerikus		Igen
hivatkozás	karakterlánc	A szöveg, amelyet osztályozásra használnak.	Igen
típus	felsorolás	Az osztályozó típusa. Lehetséges értékek: text_similarity	Igen

OpenAI.EvalItem

A modell üzenetbemenete egy szerepkörrel, amely a hierarchiát követő utasításokat jelzi. A developer vagy system szerepkörrel megadott utasítások elsőbbséget élveznek a user szerepkörrel megadott utasításokkal szemben. A szerepkörrel rendelkező assistant üzeneteket feltételezzük, hogy a modell a korábbi interakciók során hozta létre.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	OpenAI.EvalItemContent	A modell bemenetei sablonsztringeket tartalmazhatnak. Támogatja a szöveget, a kimeneti szöveget, a bemeneti képeket és a bemeneti hangokat egyetlen elemként vagy elemtömbként.	Igen
szerepkör	felsorolás	Az üzenetbemenet szerepe. Az egyik user, assistant, systemvagy developer. Lehetséges értékek: user, assistant, , systemdeveloper	Igen
típus	felsorolás	Az üzenetbemenet típusa. Mindig message. Lehetséges értékek: message	No

OpenAI.EvalItemContent

A modell bemenetei sablonsztringeket tartalmazhatnak. Támogatja a szöveget, a kimeneti szöveget, a bemeneti képeket és a bemeneti hangokat egyetlen elemként vagy elemtömbként.

Típus: OpenAI.EvalItemContentItem vagy OpenAI.EvalItemContentArray

A modell bemenetei sablonsztringeket tartalmazhatnak. Támogatja a szöveget, a kimeneti szöveget, a bemeneti képeket és a bemeneti hangokat egyetlen elemként vagy elemtömbként.

OpenAI.EvalItemContentArray

A bemenetek listája, amelyek mindegyike lehet bemeneti szöveg, kimeneti szöveg, bemeneti kép vagy bemeneti hangobjektum.

Tömb:OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Egyetlen tartalomelem: bemeneti szöveg, kimeneti szöveg, bemeneti kép vagy bemeneti hang.

Típus: OpenAI.EvalItemContentText vagy OpenAI.EvalItemContentItemObject

Egyetlen tartalomelem: bemeneti szöveg, kimeneti szöveg, bemeneti kép vagy bemeneti hang.

OpenAI.EvalItemContentItemObject

Egyetlen tartalomelem: bemeneti szöveg, kimeneti szöveg, bemeneti kép vagy bemeneti hang.

Az OpenAI.EvalItemContentItemObject diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.EvalItemContentItemObjectType		Igen

OpenAI.EvalItemContentItemObjectInputTextContent

A modell szöveges bemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges bemenete.	Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_text. Lehetséges értékek: input_text	Igen

OpenAI.EvalItemContentItemObjectType

Property	Érték
Type	karakterlánc
Értékek	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

A modell szöveges kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges kimenete.	Igen
típus	felsorolás	A kimeneti szöveg típusa. Mindig output_text. Lehetséges értékek: output_text	Igen

OpenAI.EvalItemContentText

A modell szöveges bemenete.

Típus: sztring

OpenAI.EvalItemInputImage

Az EvalItem-tartalomtömbökben használt képbemeneti blokk.

Name	Típus	Description	Szükséges	Alapértelmezett
detail	karakterlánc	A modellnek küldendő kép részletességi szintje. Az egyik high, low, vagy auto. Alapértelmezett érték: auto.	No
image_url	karakterlánc	A képbemenet URL-címe.	Igen
típus	felsorolás	A képbemenet típusa. Mindig input_image. Lehetséges értékek: input_image	Igen

OpenAI.EvalJsonlFileContentSource

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	Az OpenAI.EvalJsonlFileContentSourceContent tömbje	A jsonl-fájl tartalma.	Igen
típus	felsorolás	A jsonl-forrás típusa. Mindig file_content. Lehetséges értékek: file_content	Igen

OpenAI.EvalJsonlFileContentSourceContent

Name	Típus	Description	Szükséges	Alapértelmezett
elem	objektum		Igen
minta	objektum		No

OpenAI.EvalJsonlFileIdSource

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A fájl azonosítója.	Igen
típus	felsorolás	A jsonl-forrás típusa. Mindig file_id. Lehetséges értékek: file_id	Igen

OpenAI.EvalResponsesSource

Egy futtatott adatforrás-konfigurációt leíró EvalResponsesSource-objektum.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozva_utána	OpenAI.integer (null értékű)		No
létrehozva_előtt	OpenAI.integer (null értékű)		No
utasítások_keresése	sztring (null értékű)		No
metaadat	objektum (null értékű)		No
modell	sztring (null értékű)		No
érvelési erőfeszítés	OpenAI.ReasoningEffort (null értékű)	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
hőmérséklet	OpenAI.numerikus (null értékű)		No
tools	sztringtömb		No
top_p	OpenAI.numerikus (null értékű)		No
típus	felsorolás	A futtatási adatforrás típusa. Mindig responses. Lehetséges értékek: responses	Igen
users	sztringtömb		No

OpenAI.EvalRunOutputItemSample

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	OpenAI.EvalApiError	Az Eval API hibaválaszát képviselő objektum.	Igen
befejezési_ok	karakterlánc		Igen
bevitel	az EvalRunOutputItemSampleInput tömbje		Igen
max_completion_tokens	OpenAI.integer		Igen
modell	karakterlánc		Igen
kimenet	az EvalRunOutputItemSampleOutput tömbje		Igen
seed	OpenAI.integer		Igen
hőmérséklet	OpenAI.numerikus		Igen
top_p	OpenAI.numerikus		Igen
felhasználás	OpenAI.EvalRunOutputItemSampleUsage		Igen

OpenAI.EvalRunOutputItemSampleUsage

Name	Típus	Description	Szükséges	Alapértelmezett
cached_tokens	OpenAI.integer		Igen
completion_tokens	OpenAI.integer		Igen
prompt_tokens	OpenAI.integer		Igen
total_tokens	OpenAI.integer		Igen

OpenAI.EvalRunPerModelUsage

Name	Típus	Description	Szükséges	Alapértelmezett
cached_tokens	OpenAI.integer		Igen
completion_tokens	OpenAI.integer		Igen
invocation_count	OpenAI.integer		Igen
model_name	karakterlánc		Igen
prompt_tokens	OpenAI.integer		Igen
total_tokens	OpenAI.integer		Igen

OpenAI.EvalRunPerTestingCriteriaResults

Name	Típus	Description	Szükséges	Alapértelmezett
sikertelen	OpenAI.integer		Igen
át lett adva	OpenAI.integer		Igen
tesztelési_kritérium	karakterlánc		Igen

OpenAI.EvalRunResultCounts

Name	Típus	Description	Szükséges	Alapértelmezett
hiba történt	OpenAI.integer		Igen
sikertelen	OpenAI.integer		Igen
át lett adva	OpenAI.integer		Igen
Teljes	OpenAI.integer		Igen

OpenAI.EvalStoredCompletionsSource

Egy szűrőkészletet leíró StoredCompletionsRunDataSource-konfiguráció

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozva_utána	OpenAI.integer (null értékű)		No
létrehozva_előtt	OpenAI.integer (null értékű)		No
limit	OpenAI.integer (null értékű)		No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
modell	sztring (null értékű)		No
típus	felsorolás	A forrás típusa. Mindig stored_completions. Lehetséges értékek: stored_completions	Igen

OpenAI.FileCitationBody

Egy fájl hivatkozása

Name	Típus	Description	Szükséges	Alapértelmezett
fájl_azonosító	karakterlánc	A fájl azonosítója.	Igen
filename	karakterlánc	Az idézett fájl fájlneve.	Igen
index	OpenAI.integer		Igen
típus	felsorolás	A fájl idézetének típusa. Mindig file_citation. Lehetséges értékek: file_citation	Igen

OpenAI.FilePath

Egy fájl elérési útja.

Name	Típus	Description	Szükséges	Alapértelmezett
fájl_azonosító	karakterlánc	A fájl azonosítója.	Igen
index	OpenAI.integer		Igen
típus	felsorolás	A fájl elérési útjának típusa. Mindig file_path. Lehetséges értékek: file_path	Igen

OpenAI.FileSearchTool

Egy eszköz, amely a feltöltött fájlokból származó releváns tartalmakat keresi.

Name	Típus	Description	Szükséges	Alapértelmezett
filters	OpenAI.Filters (null értékű)		No
max_eredmények_száma	OpenAI.integer		No
rangsorolási_opciók	OpenAI.RankingOptions		No
└─ hybrid_search	OpenAI.HybridSearchOptions	Súlyok, amelyek szabályozzák, hogy a fúziós rangsor hogyan egyensúlyozza a szemantikai beágyazási egyezéseket a ritka kulcsszóegyezésekkel szemben, ha engedélyezve van a hibrid keresés.	No
└─ rangsoroló	OpenAI.RankerVersionType	A fájlkereséshez használni kívánt rangsoroló.	No
└─ pontszám küszöbérték	OpenAI.numerikus	A fájlkeresés pontszámküszöbe, 0 és 1 közötti szám. Az 1-hez közelebbi számok csak a legrelevánsabb eredményeket próbálják visszaadni, de kevesebb eredményt adnak vissza.	No
típus	felsorolás	A fájlkereső eszköz típusa. Mindig file_search. Lehetséges értékek: file_search	Igen
vektor_áruház_azonosítók	sztringtömb	A keresendő vektortárak azonosítói.	Igen

OpenAI.FileSearchToolCallResults

Name	Típus	Description	Szükséges	Alapértelmezett
attributes	OpenAI.VectorStoreFileAttributes (nullable)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok sztringek legfeljebb 64 karakter hosszúságú. Az értékek legfeljebb sztringek hosszúsága 512 karakter, logikai vagy szám.	No
fájl_azonosító	karakterlánc		No
filename	karakterlánc		No
pont	szám		No
SMS	karakterlánc		No

OpenAI.Szűrők

Típus: OpenAI.ComparisonFilter vagy OpenAI.CompoundFilter

OpenAI.FineTuneDPO Hiperparaméterek

A DPO finomhangolási feladatához használt hiperparaméterek.

Name	Típus	Description	Szükséges	Alapértelmezett
köteg_méret	sztring vagy OpenAI.integer	Példák száma az egyes kötegekben. A nagyobb kötegméret azt jelenti, hogy a modellparaméterek ritkábban, de alacsonyabb varianciával frissülnek.	No
bétaverzió	sztring vagy OpenAI.numerikus	A DPO metódus bétaértéke. A magasabb bétaérték növeli a szabályzat és a referenciamodell közötti büntetés súlyát.	No
tanulási_ráta_sokszorozó	sztring vagy OpenAI.numerikus	A tanulási sebesség skálázási tényezője. A túlillesztés elkerülése érdekében hasznos lehet a kisebb tanulási arány.	No
épocha száma	sztring vagy OpenAI.integer	A modell betanításához szükséges epochák száma. A korszak egy teljes ciklusra utal a betanítási adathalmazon keresztül.	No

OpenAI.FineTuneDPOMethod

A DPO finomhangolási módszerének konfigurálása.

Name	Típus	Description	Szükséges	Alapértelmezett
hiperparaméterek	OpenAI.FineTuneDPO Hiperparaméterek	A DPO finomhangolási feladatához használt hiperparaméterek.	No

OpenAI.FineTuneMethod

A finomhangoláshoz használt módszer.

Name	Típus	Description	Szükséges	Alapértelmezett
dpo	OpenAI.FineTuneDPOMethod	A DPO finomhangolási módszerének konfigurálása.	No
megerősítés	OpenAI.FineTuneReinforcementMethod	A megerősítés finomhangolási módszerének konfigurálása.	No
felügyelt	OpenAI.FineTuneSupervisedMethod	A felügyelt finomhangolási módszer konfigurálása.	No
típus	felsorolás	A metódus típusa. supervised vagy dpo vagy reinforcement. Lehetséges értékek: supervised, , dporeinforcement	Igen

OpenAI.FineTuneReinforcementHyperparameters

A megerősítés finomhangolási feladatához használt hiperparaméterek.

Name	Típus	Description	Szükséges	Alapértelmezett
köteg_méret	sztring vagy OpenAI.integer	Példák száma az egyes kötegekben. A nagyobb kötegméret azt jelenti, hogy a modellparaméterek ritkábban, de alacsonyabb varianciával frissülnek.	No
számítsd_ki_a_szorzót	sztring vagy OpenAI.numerikus	Szorzó a betanítás során a keresési terület feltárásához használt számítási mennyiségről.	No
eval_interval	sztring vagy OpenAI.integer	A kiértékelési futtatások közötti betanítási lépések száma.	No
értékelési_minták	sztring vagy OpenAI.integer	A betanítási lépésenként létrehozandó kiértékelési minták száma.	No
tanulási_ráta_sokszorozó	sztring vagy OpenAI.numerikus	A tanulási sebesség skálázási tényezője. A túlillesztés elkerülése érdekében hasznos lehet a kisebb tanulási arány.	No
épocha száma	sztring vagy OpenAI.integer	A modell betanításához szükséges epochák száma. A korszak egy teljes ciklusra utal a betanítási adathalmazon keresztül.	No
érvelési erőfeszítés	felsorolás	Az érvelési munka szintje. Lehetséges értékek: default, low, , mediumhigh	No

OpenAI.FineTuneReinforcementMethod

A megerősítés finomhangolási módszerének konfigurálása.

Name	Típus	Description	Szükséges	Alapértelmezett
útgyalu	OpenAI.GraderStringCheck vagy OpenAI.GraderTextSimilarity vagy OpenAI.GraderPython vagy OpenAI.GraderScoreModel vagy OpenAI.GraderMulti	A finomhangolási feladathoz használt osztályozó.	Igen
hiperparaméterek	OpenAI.FineTuneReinforcementHyperparameters	A megerősítés finomhangolási feladatához használt hiperparaméterek.	No

OpenAI.FineTuneFelügyeltHiperparaméterek

A finomhangolási feladathoz használt hiperparaméterek.

Name	Típus	Description	Szükséges	Alapértelmezett
köteg_méret	sztring vagy OpenAI.integer	Példák száma az egyes kötegekben. A nagyobb kötegméret azt jelenti, hogy a modellparaméterek ritkábban, de alacsonyabb varianciával frissülnek.	No
tanulási_ráta_sokszorozó	sztring vagy OpenAI.numerikus	A tanulási sebesség skálázási tényezője. A túlillesztés elkerülése érdekében hasznos lehet a kisebb tanulási arány.	No
épocha száma	sztring vagy OpenAI.integer	A modell betanításához szükséges epochák száma. A korszak egy teljes ciklusra utal a betanítási adathalmazon keresztül.	No

OpenAI.FineTuneSupervisedMethod

A felügyelt finomhangolási módszer konfigurálása.

Name	Típus	Description	Szükséges	Alapértelmezett
hiperparaméterek	OpenAI.FineTuneSupervisedHyperparameters	A finomhangolási feladathoz használt hiperparaméterek.	No

OpenAI.FineTuningIntegration

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A finomhangolási feladathoz engedélyezve lévő integráció típusa Lehetséges értékek: wandb	Igen
wandb	OpenAI.FineTuningIntegrationWandb		Igen
└─ entitás	sztring (null értékű)		No
└─ név	sztring (null értékű)		No
└─ projekt	karakterlánc		Igen
└─ címkék	sztringtömb		No

OpenAI.FineTuningIntegrationWandb

Name	Típus	Description	Szükséges	Alapértelmezett
egyed	sztring (null értékű)		No
név	sztring (null értékű)		No
projekt	karakterlánc		Igen
tags	sztringtömb		No

OpenAI.FineTuningJob

Az fine_tuning.job objektum egy finomhangolási feladatot jelöl, amelyet az API-val hoztak létre.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	A Unix időbélyege (másodpercben) a finomhangolási feladat létrehozásakor.	Igen
hiba	OpenAI.FineTuningJobError (null értékű)		Igen
└─ kód	karakterlánc		Igen
└─ üzenet	karakterlánc		Igen
└─ param	sztring (null értékű)		Igen
Várható befejezés	egész szám		No
finomhangolt_model	sztring (null értékű)		Igen
befejezve_ekkor	egész szám		Igen
hiperparaméterek	OpenAI.FineTuningJobHyperparameters		Igen
└─ köteg_méret	sztring vagy OpenAI.integer		No	kocsi
└─ tanulási_ráta_szorzó	sztring vagy OpenAI.numerikus		No
└─ n_epochs	sztring vagy OpenAI.integer		No	kocsi
id	karakterlánc	Az API-végpontokban hivatkozható objektumazonosító.	Igen
Integrációk	Az OpenAI.FineTuningIntegration tömbje		No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
metódus	OpenAI.FineTuneMethod	A finomhangoláshoz használt módszer.	No
modell	karakterlánc	A finomhangolt alapmodell.	Igen
objektum	felsorolás	Az objektum típusa, amely mindig "fine_tuning.job". Lehetséges értékek: fine_tuning.job	Igen
szervezet_azonosító	karakterlánc	A szervezet, amely a finomhangolási feladatot birtokolja.	Igen
eredményfájlok	sztringtömb	A finomhangolási feladat összesített eredményfájl-azonosítója(i). Az eredményeket a Files API-val is lekérheti.	Igen
seed	OpenAI.integer		Igen
állapot	felsorolás	A finomhangolási feladat aktuális állapota, amely lehet validating_files, queued, , running, succeededfailedvagy cancelled. Lehetséges értékek: validating_files, queued, running, succeeded, failedcancelled	Igen
betanított_tokének	OpenAI.integer (null értékű)		Igen
képzési fájl	karakterlánc	A betanításhoz használt fájlazonosító. A betanítási adatokat a Files API-val is lekérheti.	Igen
érvényesítési_fájl	sztring (null értékű)		Igen

OpenAI.FineTuningJobCheckpoint

Az fine_tuning.job.checkpoint objektum egy használatra kész finomhangolási feladat modell ellenőrzőpontját jelöli.

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	Az ellenőrzőpont létrehozásának unix-időbélyege (másodpercben).	Igen
fine_tuned_model_ellenőrzési_pont	karakterlánc	A létrehozott finomhangolt ellenőrzőpont-modell neve.	Igen
finomhangoló_feladat_azonosító	karakterlánc	Annak a finomhangolási feladatnak a neve, amelyből az ellenőrzőpont létre lett hozva.	Igen
id	karakterlánc	Az ellenőrzőpont azonosítója, amelyre az API-végpontok hivatkozhatnak.	Igen
metrikák	OpenAI.FineTuningJobCheckpointMetrics		Igen
└─ teljes_érvényes_veszteség	OpenAI.numerikus		No
└─ teljes érvényes átlagos token pontosság	OpenAI.numerikus		No
└─ lépés	OpenAI.numerikus		No
└─ edzési veszteség	OpenAI.numerikus		No
└─ tanít_mean_token_accuracy	OpenAI.numerikus		No
└─ érvényességi veszteség	OpenAI.numerikus		No
└─ érvényesített_átlagos_token_pontosság	OpenAI.numerikus		No
objektum	felsorolás	Az objektum típusa, amely mindig "fine_tuning.job.checkpoint". Lehetséges értékek: fine_tuning.job.checkpoint	Igen
lépés_szám	OpenAI.integer		Igen

OpenAI.FineTuningJobCheckpointMetrics

Name	Típus	Description	Szükséges	Alapértelmezett
full_valid_loss	OpenAI.numerikus		No
full_valid_mean_token_accuracy	OpenAI.numerikus		No
lépés	OpenAI.numerikus		No
train_loss	OpenAI.numerikus		No
train_mean_token_accuracy	OpenAI.numerikus		No
valid_loss	OpenAI.numerikus		No
valid_mean_token_accuracy	OpenAI.numerikus		No

OpenAI.FineTuningJobError

Name	Típus	Description	Szükséges	Alapértelmezett
kód	karakterlánc		Igen
üzenet	karakterlánc		Igen
param	sztring (null értékű)		Igen

OpenAI.FineTuningJobEvent

Feladat eseményobjektumának finomhangolása

Name	Típus	Description	Szükséges	Alapértelmezett
létrehozás_időpontja	egész szám	A Unix időbélyege (másodpercben) a finomhangolási feladat létrehozásakor.	Igen
adat	OpenAI.FineTuningJobEventData		No
id	karakterlánc	Az objektumazonosító.	Igen
szint	felsorolás	Az esemény naplószintje. Lehetséges értékek: info, , warnerror	Igen
üzenet	karakterlánc	Az esemény üzenete.	Igen
objektum	felsorolás	Az objektum típusa, amely mindig "fine_tuning.job.event". Lehetséges értékek: fine_tuning.job.event	Igen
típus	felsorolás	Az esemény típusa. Lehetséges értékek: message, metrics	No

OpenAI.FineTuningJobEventData

Típus: objektum

OpenAI.FineTuningJobHyperparameters

Name	Típus	Description	Szükséges	Alapértelmezett
köteg_méret	sztring vagy OpenAI.integer		No
tanulási_ráta_sokszorozó	sztring vagy OpenAI.numerikus		No
épocha száma	sztring vagy OpenAI.integer		No

OpenAI.FunctionAndCustomToolCallOutput

Az OpenAI.FunctionAndCustomToolCallOutput diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.FunctionAndCustomToolCallOutputType		Igen

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

A modell fájlbemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
file_data	karakterlánc	A modellnek küldendő fájl tartalma.	No
fájl_azonosító	sztring (null értékű)		No
file_url	karakterlánc	A modellnek küldendő fájl URL-címe.	No
filename	karakterlánc	A modellnek küldendő fájl neve.	No
típus	felsorolás	A bemeneti elem típusa. Mindig input_file. Lehetséges értékek: input_file	Igen

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Képbevitel a modellhez. Ismerje meg a képbemeneteket.

Name	Típus	Description	Szükséges	Alapértelmezett
detail	OpenAI.ImageDetail		Igen
fájl_azonosító	sztring (null értékű)		No
image_url	karakterlánc		No
típus	felsorolás	A bemeneti elem típusa. Mindig input_image. Lehetséges értékek: input_image	Igen

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

A modell szöveges bemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges bemenete.	Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_text. Lehetséges értékek: input_text	Igen

OpenAI.FunctionAndCustomToolCallOutputType

Property	Érték
Type	karakterlánc
Értékek	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Property	Érték
Type	karakterlánc
Értékek	in_progress completed incomplete

OpenAI.FunctionObject

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	No
név	karakterlánc	A meghívandó függvény neve. A-z, A-Z, 0-9, vagy aláhúzásjeleket és kötőjeleket kell tartalmaznia, legfeljebb 64 hosszúságúak.	Igen
parameters	OpenAI.FunctionParameters	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást . Az kihagyás parameters üres paraméterlistával rendelkező függvényt határoz meg.	No
szigorú	logikai (null értékű)		No

OpenAI.FunctionParameters

A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva. Példákért tekintse meg az útmutatót és a formátum dokumentációját ismertető JSON-sémahivatkozást . Az kihagyás parameters üres paraméterlistával rendelkező függvényt határoz meg.

Típus: objektum

OpenAI.FunctionShellAction

Rendszerhéjparancs végrehajtása.

Name	Típus	Description	Szükséges	Alapértelmezett
commands	sztringtömb		Igen
max_output_length	OpenAI.integer (null értékű)		Igen
időkorlát_ms	OpenAI.integer (null értékű)		Igen

OpenAI.FunctionShellActionParam

A rendszerhéj-eszköz hívásának futtatását leíró parancsok és korlátozások.

Name	Típus	Description	Szükséges	Alapértelmezett
commands	sztringtömb	Rendszerhéjparancsok a végrehajtási környezet futtatásához.	Igen
max_output_length	OpenAI.integer (null értékű)		No
időkorlát_ms	OpenAI.integer (null értékű)		No

OpenAI.FunctionShellCallItemStatus

A rendszerhéjeszköz-hívásokhoz jelentett állapotértékek.

Property	Érték
Type	karakterlánc
Értékek	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

A rendszerhéj-eszköz által kibocsátott kimenet hívásának tartalma.

Name	Típus	Description	Szükséges	Alapértelmezett
által készített	karakterlánc	Az elemet létrehozó szereplő azonosítója.	No
eredmény	OpenAI.FunctionShellCallOutputOutcome	Kilépési kimenetet (kilépési kóddal) vagy időtúllépési kimenetet jelöl egy rendszerhéjhívás kimeneti adattömbhöz.	Igen
└─ típus	OpenAI.FunctionShellCallOutputOutcomeType		Igen
stderr	karakterlánc	A rögzített szabványos hibakimenet.	Igen
stdout	karakterlánc	A rögzített standard kimenet.	Igen

OpenAI.FunctionShellCallOutputContentParam

Rögzített stdout és stderr a rendszerhéj eszköz hívás kimenetének egy részére vonatkozóan.

Name	Típus	Description	Szükséges	Alapértelmezett
eredmény	OpenAI.FunctionShellCallOutputOutcomeParam	A rendszerhéj-híváshoz társított kilépési vagy időtúllépési eredmény.	Igen
└─ típus	OpenAI.FunctionShellCallOutputOutcomeParamType		Igen
stderr	karakterlánc	Rögzített stderr-kimenet a rendszerhéj-híváshoz. Korlátozások: maxLength: 10485760	Igen
stdout	karakterlánc	Rögzített stdout kimenet a rendszerhéj-híváshoz. Korlátozások: maxLength: 10485760	Igen

OpenAI.FunctionShellCallOutputExitOutcome

Azt jelzi, hogy a rendszerhéjparancsok befejeződött, és visszaadott egy kilépési kódot.

Name	Típus	Description	Szükséges	Alapértelmezett
exit_code	OpenAI.integer		Igen
típus	felsorolás	Az eredmény típusa. Mindig exit. Lehetséges értékek: exit	Igen

OpenAI.FunctionShellCallOutputExitOutcomeParam

Azt jelzi, hogy a rendszerhéjparancsok befejeződött, és visszaadott egy kilépési kódot.

Name	Típus	Description	Szükséges	Alapértelmezett
exit_code	OpenAI.integer		Igen
típus	felsorolás	Az eredmény típusa. Mindig exit. Lehetséges értékek: exit	Igen

OpenAI.FunctionShellCallOutputOutcome

Kilépési kimenetet (kilépési kóddal) vagy időtúllépési kimenetet jelöl egy rendszerhéjhívás kimeneti adattömbhöz.

Az OpenAI.FunctionShellCallOutputOutcome diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.FunctionShellCallOutputOutcomeType		Igen

OpenAI.FunctionShellCallOutputOutcomeParam

A rendszerhéj-híváshoz társított kilépési vagy időtúllépési eredmény.

Az OpenAI.FunctionShellCallOutputOutcomeParam diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.FunctionShellCallOutputOutcomeParamType		Igen

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Érték
Type	karakterlánc
Értékek	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Property	Érték
Type	karakterlánc
Értékek	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Azt jelzi, hogy a rendszerhéjhívás túllépte a konfigurált időkorlátot.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Az eredmény típusa. Mindig timeout. Lehetséges értékek: timeout	Igen

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Azt jelzi, hogy a rendszerhéjhívás túllépte a konfigurált időkorlátot.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Az eredmény típusa. Mindig timeout. Lehetséges értékek: timeout	Igen

OpenAI.FunctionShellToolParam

Olyan eszköz, amely lehetővé teszi a modell számára a rendszerhéjparancsok végrehajtását.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A rendszerhéjeszköz típusa. Mindig shell. Lehetséges értékek: shell	Igen

OpenAI.FunctionTool

Egy függvényt határoz meg a saját kódjában, amelyből a modell meghívható.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	sztring (null értékű)		No
név	karakterlánc	A meghívandó függvény neve.	Igen
parameters	objektum (null értékű)		Igen
szigorú	logikai (null értékű)		Igen
típus	felsorolás	A függvényeszköz típusa. Mindig function. Lehetséges értékek: function	Igen

OpenAI.GraderLabelModel

LabelModelGrader objektum, amely egy modellt használ címkék hozzárendeléséhez a kiértékelés minden eleméhez.

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	OpenAI.EvalItem tömb		Igen
labels	sztringtömb	A kiértékelés egyes elemeihez hozzárendelendő címkék.	Igen
modell	karakterlánc	A kiértékeléshez használni kívánt modell. Támogatnia kell a strukturált kimeneteket.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
áthaladó címkék	sztringtömb	Az átmenő eredményt jelző címkék. Címkék részhalmazának kell lennie.	Igen
típus	felsorolás	Az objektum típusa, amely mindig label_model. Lehetséges értékek: label_model	Igen

OpenAI.GraderMulti

A MultiGrader objektum több osztályozó kimenetét kombinálja egyetlen pontszám létrehozásához.

Name	Típus	Description	Szükséges	Alapértelmezett
kimenet_számítás	karakterlánc	Egy képlet, amely a kimenetet osztályozó eredmények alapján számítja ki.	Igen
Földgyaluk	OpenAI.GraderStringCheck vagy OpenAI.GraderTextSimilarity vagy OpenAI.GraderPython vagy OpenAI.GraderScoreModel vagy OpenAI.GraderLabelModel		Igen
név	karakterlánc	Az osztályozó neve.	Igen
típus	felsorolás	Az objektum típusa, amely mindig multi. Lehetséges értékek: multi	Igen

OpenAI.GraderPython

PythonGrader-objektum, amely python-szkriptet futtat a bemeneten.

Name	Típus	Description	Szükséges	Alapértelmezett
kép_címke	karakterlánc	A Python-szkripthez használandó képcímke.	No
név	karakterlánc	Az osztályozó neve.	Igen
adatforrás	karakterlánc	A Python-szkript forráskódja.	Igen
típus	felsorolás	Az objektum típusa, amely mindig python. Lehetséges értékek: python	Igen

OpenAI.GraderScoreModel

ScoreModelGrader-objektum, amely egy modellt használ egy pontszám bemenethez való hozzárendeléséhez.

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	OpenAI.EvalItem tömb	Az osztályozó által kiértékelt bemeneti üzenetek. Támogatja a szöveg, a kimeneti szöveg, a bemeneti kép és a bemeneti hangtartalomblokkok használatát, és sablonsztringeket is tartalmazhat.	Igen
modell	karakterlánc	A kiértékeléshez használni kívánt modell.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
tartomány	OpenAI.numerikus tömb	A pontszám tartománya. Alapértelmezett érték: [0, 1].	No
mintavételi_paraméterek	OpenAI.EvalGraderScoreModelSamplingParams		No
└─ max_completions_tokens	OpenAI.integer (null értékű)		No
└─ érvelési_erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
└─ mag	OpenAI.integer (null értékű)		No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
típus	felsorolás	Az objektum típusa, amely mindig score_model. Lehetséges értékek: score_model	Igen

OpenAI.GraderStringCheck

StringCheckGrader objektum, amely egy megadott művelettel végez sztring-összehasonlítást a bemenet és a hivatkozás között.

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	karakterlánc	A bemeneti szöveg. Ilyenek lehetnek a sablonszövegek.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
művelet	felsorolás	A végrehajtandó karakterláncellenőrzési művelet. Egyik eq, ne, like vagy ilike. Lehetséges értékek: eq, ne, , likeilike	Igen
hivatkozás	karakterlánc	A referenciaszöveg. Ilyenek lehetnek a sablonszövegek.	Igen
típus	felsorolás	Az objektum típusa, amely mindig string_check. Lehetséges értékek: string_check	Igen

OpenAI.GraderTextSimilarity

TextSimilarityGrader objektum, amely hasonlósági metrikák alapján osztályozza a szöveget.

Name	Típus	Description	Szükséges	Alapértelmezett
értékelési mutató	felsorolás	A használni kívánt értékelési metrika. Az egyik cosine, fuzzy_match, bleu gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, rouge_5 vagy rouge_l. Lehetséges értékek: cosine, fuzzy_match, bleu, gleu, meteorrouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l	Igen
bevitel	karakterlánc	Az osztályozás alatt álló szöveg.	Igen
név	karakterlánc	Az osztályozó neve.	Igen
hivatkozás	karakterlánc	A szöveg, amelyet osztályozásra használnak.	Igen
típus	felsorolás	Az osztályozó típusa. Lehetséges értékek: text_similarity	Igen

OpenAI.GrammarSyntax1

Property	Érték
Type	karakterlánc
Értékek	lark regex

OpenAI.HybridSearchOptions

Name	Típus	Description	Szükséges	Alapértelmezett
embedding_weight	OpenAI.numerikus		Igen
text_weight	OpenAI.numerikus		Igen

OpenAI.ImageDetail

Property	Érték
Type	karakterlánc
Értékek	low high auto

OpenAI.ImageGenTool

Egy eszköz, amely képeket hoz létre a GPT-képmodellek használatával.

Érvényes modellek:

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

Name	Típus	Description	Szükséges	Alapértelmezett
háttér	felsorolás	A létrehozott kép háttértípusa. Az egyiktransparent opaque, vagy auto. Alapértelmezett: auto. Lehetséges értékek: transparent, , opaqueauto	No
bevitel_hűség	OpenAI.InputFidelity (null értékű)	Szabályozhatja, hogy a modell mennyi erőfeszítést fog tenni a bemeneti képek stílusának és jellemzőinek, különösen az arcfunkcióknak megfelelően. Ez a paraméter csak a következőhöz gpt-image-1támogatott: . Nem támogatott a következőhöz gpt-image-1-mini: . Támogatja high és low. Alapértelmezett érték: low.	No
bemeneti_képfedő	OpenAI.ImageGenToolInputImageMask		No
└─ fájl_azonosító	karakterlánc		No
└─ image_url	karakterlánc		No
modell	string (lásd az érvényes modelleket alább)		No
Moderálás	felsorolás	A létrehozott rendszerkép moderálási szintje. Alapértelmezett: auto. Lehetséges értékek: auto, low	No
kimeneti tömörítés	OpenAI.integer		No	100
kimeneti_formátum	felsorolás	A létrehozott kép kimeneti formátuma. Az egyik png, webp, vagy jpeg. Alapértelmezett: png. Lehetséges értékek: png, , webpjpeg	No
részleges_képek	OpenAI.integer		No
minőség	felsorolás	A létrehozott rendszerkép minősége. Az egyik low, medium, high vagy auto. Alapértelmezett: auto. Lehetséges értékek: low, medium, , highauto	No
size	felsorolás	A létrehozott kép mérete. Az egyik 1024x1024, 1024x1536 1536x1024, vagy auto. Alapértelmezett: auto. Lehetséges értékek: 1024x1024, 1024x1536, , 1536x1024auto	No
típus	felsorolás	A képgenerálási eszköz típusa. Mindig image_generation. Lehetséges értékek: image_generation	Igen

OpenAI.ImageGenToolInputImageMask

Name	Típus	Description	Szükséges	Alapértelmezett
fájl_azonosító	karakterlánc		No
image_url	karakterlánc		No

OpenAI.IncludeEnum

Adja meg a modell válaszában felvenni kívánt további kimeneti adatokat. Jelenleg támogatott értékek:

• web_search_call.action.sources: Adja meg a webes keresőeszköz hívásának forrásait.
• code_interpreter_call.outputs: Tartalmazza a Python-kódvégrehajtás kimeneteit a kódértelmező eszköz híváselemeiben.
• computer_call_output.output.image_url: Kép URL-címeinek belefoglalása a számítógép hívás kimenetéből.
• file_search_call.results: Adja meg a fájlkereső eszköz hívásának keresési eredményeit.
• message.input_image.image_url: Kép URL-címeinek belefoglalása a bemeneti üzenetből.
• message.output_text.logprobs: Mellékelje a naplóprobokat segédüzenetekkel.
• reasoning.encrypted_content: Az érvelési tokenek titkosított verzióját tartalmazza az érvelési tételek kimenetében. Ez lehetővé teszi az érvelési elemek használatát többfordulós beszélgetésekben a Válaszok API állapot nélküli használata esetén (például amikor a store paraméter értéke false, vagy amikor egy szervezet regisztrálva van a nulla adatmegőrzési programban).

Property	Érték
Leírás	Adja meg a modell válaszában felvenni kívánt további kimeneti adatokat. Jelenleg támogatott értékek:

• web_search_call.action.sources: Adja meg a webes keresőeszköz hívásának forrásait.
• code_interpreter_call.outputs: Tartalmazza a Python-kódvégrehajtás kimeneteit a kódértelmező eszköz híváselemeiben.
• computer_call_output.output.image_url: Kép URL-címeinek belefoglalása a számítógép hívás kimenetéből.
• file_search_call.results: Adja meg a fájlkereső eszköz hívásának keresési eredményeit.
• message.input_image.image_url: Kép URL-címeinek belefoglalása a bemeneti üzenetből.
• message.output_text.logprobs: Mellékelje a naplóprobokat segédüzenetekkel.
• reasoning.encrypted_content: Az érvelési tokenek titkosított verzióját tartalmazza az érvelési tételek kimenetében. Ez lehetővé teszi az érvelési elemek használatát többfordulós beszélgetésekben a Válaszok API állapot nélküli használata esetén (például amikor a store paraméter értéke false, vagy amikor egy szervezet regisztrálva van a nulla adatmegőrzési programban). | | Típus | sztring | | Értékek | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

Egy audiobemenet a modellhez.

Name	Típus	Description	Szükséges	Alapértelmezett
input_audio	OpenAI.InputAudioInputAudio		Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_audio. Lehetséges értékek: input_audio	Igen

OpenAI.InputAudioInputAudio

Name	Típus	Description	Szükséges	Alapértelmezett
adat	karakterlánc		Igen
format	felsorolás	Lehetséges értékek: mp3, wav	Igen

OpenAI.InputContent

Az OpenAI.InputContent diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.InputContentType		Igen

OpenAI.InputContentInputFileContent

A modell fájlbemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
file_data	karakterlánc	A modellnek küldendő fájl tartalma.	No
fájl_azonosító	sztring (null értékű)		No
file_url	karakterlánc	A modellnek küldendő fájl URL-címe.	No
filename	karakterlánc	A modellnek küldendő fájl neve.	No
típus	felsorolás	A bemeneti elem típusa. Mindig input_file. Lehetséges értékek: input_file	Igen

OpenAI.InputContentInputImageContent

Képbevitel a modellhez. Ismerje meg a képbemeneteket.

Name	Típus	Description	Szükséges	Alapértelmezett
detail	OpenAI.ImageDetail		Igen
fájl_azonosító	sztring (null értékű)		No
image_url	karakterlánc		No
típus	felsorolás	A bemeneti elem típusa. Mindig input_image. Lehetséges értékek: input_image	Igen

OpenAI.InputContentInputTextContent

A modell szöveges bemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges bemenete.	Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_text. Lehetséges értékek: input_text	Igen

OpenAI.InputContentType

Property	Érték
Type	karakterlánc
Értékek	input_text input_image input_file

OpenAI.InputFidelity

Szabályozhatja, hogy a modell mennyi erőfeszítést fog tenni a bemeneti képek stílusának és jellemzőinek, különösen az arcfunkcióknak megfelelően. Ez a paraméter csak a következőhöz gpt-image-1támogatott: . Nem támogatott a következőhöz gpt-image-1-mini: . Támogatja high és low. Alapértelmezett érték: low.

Property	Érték
Type	karakterlánc
Értékek	high low

OpenAI.InputFileContent

A modell fájlbemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
file_data	karakterlánc	A modellnek küldendő fájl tartalma.	No
fájl_azonosító	sztring (null értékű)		No
file_url	karakterlánc	A modellnek küldendő fájl URL-címe.	No
filename	karakterlánc	A modellnek küldendő fájl neve.	No
típus	felsorolás	A bemeneti elem típusa. Mindig input_file. Lehetséges értékek: input_file	Igen

OpenAI.InputFileContentParam

A modell fájlbemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
file_data	sztring (null értékű)		No
fájl_azonosító	sztring (null értékű)		No
file_url	karakterlánc		No
filename	sztring (null értékű)		No
típus	felsorolás	A bemeneti elem típusa. Mindig input_file. Lehetséges értékek: input_file	Igen

OpenAI.InputImageContent

Képbevitel a modellhez. Ismerje meg a képbemeneteket.

Name	Típus	Description	Szükséges	Alapértelmezett
detail	OpenAI.ImageDetail		Igen
fájl_azonosító	sztring (null értékű)		No
image_url	karakterlánc		No
típus	felsorolás	A bemeneti elem típusa. Mindig input_image. Lehetséges értékek: input_image	Igen

OpenAI.InputImageContentParamAutoParam

Képbevitel a modellhez. Tudnivalók a képbemenetekről

Name	Típus	Description	Szükséges	Alapértelmezett
detail	OpenAI.DetailEnum (null értékű)		No
fájl_azonosító	sztring (null értékű)		No
image_url	karakterlánc		No
típus	felsorolás	A bemeneti elem típusa. Mindig input_image. Lehetséges értékek: input_image	Igen

OpenAI.InputItem

A modell által létrehozandó válasz kontextusának egy részét képviselő elem. Tartalmazhat szöveget, képeket és hangbemeneteket, valamint korábbi asszisztensi válaszokat és eszközhívási kimeneteket.

Az OpenAI.InputItem diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
message	OpenAI.EasyInputMessage
item_reference	OpenAI.ItemReferenceParam
output_message	OpenAI.InputItemOutputMessage
file_search_call	OpenAI.InputItemFileSearchToolCall
computer_call	OpenAI.InputItemComputerToolCall
computer_call_output	OpenAI.InputItemComputerCallOutputItemParam
web_search_call	OpenAI.InputItemWebSearchToolCall
function_call	OpenAI.InputItemFunctionToolCall
function_call_output	OpenAI.InputItemFunctionCallOutputItemParam
reasoning	OpenAI.InputItemReasoningItem
compaction	OpenAI.InputItemCompactionSummaryItemParam
image_generation_call	OpenAI.InputItemImageGenToolCall
code_interpreter_call	OpenAI.InputItemCodeInterpreterToolCall
local_shell_call	OpenAI.InputItemLocalShellToolCall
local_shell_call_output	OpenAI.InputItemLocalShellToolCallOutput
shell_call	OpenAI.InputItemFunctionShellCallItemParam
shell_call_output	OpenAI.InputItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.InputItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.InputItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.InputItemMcpListTools
mcp_approval_request	OpenAI.InputItemMcpApprovalRequest
mcp_approval_response	OpenAI.InputItemMcpApprovalResponse
mcp_call	OpenAI.InputItemMcpToolCall
custom_tool_call_output	OpenAI.InputItemCustomToolCallOutput
custom_tool_call	OpenAI.InputItemCustomToolCall

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.InputItemType		Igen

OpenAI.InputItemApplyPatchToolCallItemParam

Eszközhívás, amely a fájlok diff patchek használatával történő létrehozására, törlésére vagy frissítésére irányuló kérést jelöl.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
művelet	OpenAI.ApplyPatchOperationParam	A apply_patch eszközhöz kapott create_file, delete_file vagy update_file műveletek egyike.	Igen
└─ típus	OpenAI.ApplyPatchOperationParamType		Igen
állapot	OpenAI.ApplyPatchCallStatusParam	Apply_patch eszközhívásokhoz jelentett állapotértékek.	Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call. Lehetséges értékek: apply_patch_call	Igen

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Az alkalmazásjavító eszköz hívása által kibocsátott streamelt kimenet.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
kimenet	sztring (null értékű)		No
állapot	OpenAI.ApplyPatchCallOutputStatusParam	Apply_patch eszközhívás kimeneteihez jelentett eredményértékek.	Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call_output. Lehetséges értékek: apply_patch_call_output	Igen

OpenAI.InputItemCodeInterpreterToolCall

Eszközhívás a kód futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	sztring (null értékű)		Igen
container_id	karakterlánc	A kód futtatásához használt tároló azonosítója.	Igen
id	karakterlánc	A kódértelmező eszköz hívásának egyedi azonosítója.	Igen
outputs	OpenAI.CodeInterpreterOutputLogs vagy OpenAI.CodeInterpreterOutputImage tömb		Igen
állapot	felsorolás	A kódértelmező eszköz hívásának állapota. Az érvényes értékek a következőkin_progress: , completed, incompleteinterpretingés failed. Lehetséges értékek: in_progress, completed, incomplete, interpretingfailed	Igen
típus	felsorolás	A kódértelmező eszköz hívásának típusa. Mindig code_interpreter_call. Lehetséges értékek: code_interpreter_call	Igen

OpenAI.InputItemCompactionSummaryItemParam

Az API által létrehozott tömörítési v1/responses/compactelem.

Name	Típus	Description	Szükséges	Alapértelmezett
encrypted_content	karakterlánc	A tömörítési összegzés titkosított tartalma. Korlátozások: maxLength: 10485760	Igen
id	sztring (null értékű)		No
típus	felsorolás	Az elem típusa. Mindig compaction. Lehetséges értékek: compaction	Igen

OpenAI.InputItemComputerCallOutputItemParam

Egy számítógépes eszköz hívásának kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
acknowledged_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje		No
call_id	karakterlánc	A kimenetet előállító számítógép-eszközhívás azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
kimenet	OpenAI.ComputerScreenshotImage	A számítógép-használati eszközzel használt képernyőkép.	Igen
állapot	OpenAI.FunctionCallItemStatus (null értékű)		No
típus	felsorolás	A számítógép eszköz hívási kimenetének típusa. Mindig computer_call_output. Lehetséges értékek: computer_call_output	Igen

OpenAI.InputItemComputerToolCall

Eszközhívás egy számítógép által használt eszközhöz. További információt a számítógép használati útmutatójában talál.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.ComputerAction		Igen
call_id	karakterlánc	Az eszközhívás kimenettel történő megválaszolásakor használt azonosító.	Igen
id	karakterlánc	A számítógép-hívás egyedi azonosítója.	Igen
pending_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	A számítógépes hívás függőben lévő biztonsági ellenőrzései.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A számítógép hívásának típusa. Mindig computer_call. Lehetséges értékek: computer_call	Igen

OpenAI.InputItemCustomToolCall

A modell által létrehozott egyéni eszköz hívása.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	Az egyéni eszközhívás eszközhívás kimenetére való leképezéséhez használt azonosító.	Igen
id	karakterlánc	Az egyéni eszköz hívásának egyedi azonosítója az OpenAI platformon.	No
bevitel	karakterlánc	A modell által létrehozott egyéni eszközhívás bemenete.	Igen
név	karakterlánc	A meghívandó egyéni eszköz neve.	Igen
típus	felsorolás	Az egyéni eszközhívás típusa. Mindig custom_tool_call. Lehetséges értékek: custom_tool_call	Igen

OpenAI.InputItemCustomToolCallOutput

A kódból származó egyéni eszközhívás kimenete, amelyet a rendszer visszaküld a modellnek.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	Az egyéni eszköz híváskimenetének egyéni eszközhíváshoz való leképezéséhez használt hívásazonosító.	Igen
id	karakterlánc	Az egyéni eszköz híváskimenetének egyedi azonosítója az OpenAI platformon.	No
kimenet	Az OpenAI.FunctionAndCustomToolCallOutput sztringje vagy tömbje	A kód által létrehozott egyéni eszközhívás kimenete. Lehet sztring vagy kimeneti tartalomlista.	Igen
típus	felsorolás	Az egyéni eszköz hívási kimenetének típusa. Mindig custom_tool_call_output. Lehetséges értékek: custom_tool_call_output	Igen

OpenAI.InputItemFileSearchToolCall

Egy fájlkereső eszköz hívásának eredményei. További információt a fájlkeresési útmutatóban talál.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A fájlkereső eszköz hívásának egyedi azonosítója.	Igen
queries	sztringtömb	A fájlok kereséséhez használt lekérdezések.	Igen
results	Az OpenAI.FileSearchToolCallResults tömbje		No
állapot	felsorolás	A fájlkereső eszköz hívásának állapota. Az egyikin_progress searching, incomplete vagy failed, Lehetséges értékek: in_progress, searching, completed, incompletefailed	Igen
típus	felsorolás	A fájlkereső eszköz hívásának típusa. Mindig file_search_call. Lehetséges értékek: file_search_call	Igen

OpenAI.InputItemFunctionCallOutputItemParam

A függvény eszköz hívásának kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
kimenet	OpenAI.InputTextContentParam vagy OpenAI.InputImageContentParamAutoParam vagy OpenAI.InputFileContentParam sztringje vagy tömbje	A függvényeszköz hívásának szövege, képe vagy fájlkimenete.	Igen
állapot	OpenAI.FunctionCallItemStatus (null értékű)		No
típus	felsorolás	A függvényhívó eszköz kimenetének típusa. Mindig function_call_output. Lehetséges értékek: function_call_output	Igen

OpenAI.InputItemFunctionShellCallItemParam

Egy vagy több rendszerhéjparancs végrehajtására irányuló kérést képviselő eszköz.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.FunctionShellActionParam	A rendszerhéj-eszköz hívásának futtatását leíró parancsok és korlátozások.	Igen
└─ parancsok	sztringtömb	Rendszerhéjparancsok a végrehajtási környezet futtatásához.	Igen
└─ max_output_length	OpenAI.integer (null értékű)		No
└─ timeout_ms	OpenAI.integer (null értékű)		No
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
állapot	OpenAI.FunctionShellCallItemStatus (nullable)	A rendszerhéjeszköz-hívásokhoz jelentett állapotértékek.	No
típus	felsorolás	Az elem típusa. Mindig shell_call. Lehetséges értékek: shell_call	Igen

OpenAI.InputItemFunctionShellCallOutputItemParam

A rendszerhéjeszköz-hívás által kibocsátott streamelt kimeneti elemek.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
max_output_length	OpenAI.integer (null értékű)		No
kimenet	Az OpenAI.FunctionShellCallOutputContentParam tömbje	Rögzített adattömbök a stdout és stderr kimenet, valamint a kapcsolódó eredmények.	Igen
típus	felsorolás	Az elem típusa. Mindig shell_call_output. Lehetséges értékek: shell_call_output	Igen

OpenAI.InputItemFunctionToolCall

Egy függvény futtatására szolgáló eszközhívás. További információért tekintse meg a függvényhívási útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	A függvénynek átadni kívánt argumentumok JSON-sztringje.	Igen
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívásának egyedi azonosítója.	No
név	karakterlánc	A futtatni kívánt függvény neve.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényeszköz hívásának típusa. Mindig function_call. Lehetséges értékek: function_call	Igen

OpenAI.InputItemImageGenToolCall

A modell által küldött képgenerálási kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A képgenerálási hívás egyedi azonosítója.	Igen
result	sztring (null értékű)		Igen
állapot	felsorolás	A képgenerálási hívás állapota. Lehetséges értékek: in_progress, completed, , generatingfailed	Igen
típus	felsorolás	A képgenerálási hívás típusa. Mindig image_generation_call. Lehetséges értékek: image_generation_call	Igen

OpenAI.InputItemLocalShellToolCall

Egy eszközhívás egy parancs a helyi parancssoron való futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.LocalShellExecAction	Futtasson egy rendszerhéjparancsot a kiszolgálón.	Igen
call_id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
id	karakterlánc	A helyi rendszerhéj-hívás egyedi azonosítója.	Igen
állapot	felsorolás	A helyi rendszerhéj-hívás állapota. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A helyi rendszerhéj-hívás típusa. Mindig local_shell_call. Lehetséges értékek: local_shell_call	Igen

OpenAI.InputItemLocalShellToolCallOutput

Helyi rendszerhéj-eszközhívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
kimenet	karakterlánc	A helyi shell-eszközhívás kimenetének JSON karakterlánca.	Igen
állapot	felsorolás	Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A helyi rendszerhéj-eszköz híváskimenetének típusa. Mindig local_shell_call_output. Lehetséges értékek: local_shell_call_output	Igen

OpenAI.InputItemMcpApprovalRequest

Az eszköz meghívásának emberi jóváhagyásához irányuló kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	Az eszközhöz tartozó argumentumok JSON-sztringje.	Igen
id	karakterlánc	A jóváhagyási kérelem egyedi azonosítója.	Igen
név	karakterlánc	A futtatni kívánt eszköz neve.	Igen
szerver_címke	karakterlánc	A kérelmet küldő MCP-kiszolgáló címkéje.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_approval_request. Lehetséges értékek: mcp_approval_request	Igen

OpenAI.InputItemMcpApprovalResponse

Válasz mcp jóváhagyási kérelemre.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	karakterlánc	A megválaszolt jóváhagyási kérelem azonosítója.	Igen
approve	boolean	A kérelem jóváhagyása.	Igen
id	sztring (null értékű)		No
ok	sztring (null értékű)		No
típus	felsorolás	Az elem típusa. Mindig mcp_approval_response. Lehetséges értékek: mcp_approval_response	Igen

OpenAI.InputItemMcpListTools

Az MCP-kiszolgálón elérhető eszközök listája.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	sztring (null értékű)		No
id	karakterlánc	A lista egyedi azonosítója.	Igen
szerver_címke	karakterlánc	Az MCP-kiszolgáló címkéje.	Igen
tools	Az OpenAI.MCPListToolsTool tömbje	A kiszolgálón elérhető eszközök.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_list_tools. Lehetséges értékek: mcp_list_tools	Igen

OpenAI.InputItemMcpToolCall

Eszköz meghívása egy MCP-kiszolgálón.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	sztring (null értékű)		No
arguments	karakterlánc	Az eszköznek átadott argumentumok JSON-sztringje.	Igen
hiba	sztring (null értékű)		No
id	karakterlánc	Az eszközhívás egyedi azonosítója.	Igen
név	karakterlánc	A futtatott eszköz neve.	Igen
kimenet	sztring (null értékű)		No
szerver_címke	karakterlánc	Az eszközt futtató MCP-kiszolgáló címkéje.	Igen
állapot	OpenAI.MCPToolCallStatus		No
típus	felsorolás	Az elem típusa. Mindig mcp_call. Lehetséges értékek: mcp_call	Igen

OpenAI.InputItemOutputMessage

A modell kimeneti üzenete.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	Az OpenAI.OutputMessageContent tömbje	A kimeneti üzenet tartalma.	Igen
id	karakterlánc	A kimeneti üzenet egyedi azonosítója.	Igen
szerepkör	felsorolás	A kimeneti üzenet szerepe. Mindig assistant. Lehetséges értékek: assistant	Igen
állapot	felsorolás	Az üzenetbemenet állapota. Az egyik in_progress, completed, vagy incomplete. A bemeneti elemek API-val való visszaadásakor ki lesz töltve. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A kimeneti üzenet típusa. Mindig message. Lehetséges értékek: output_message	Igen

OpenAI.InputItemReasoningItem

Az érvelési modell által a válasz létrehozásakor használt gondolatlánc leírása. Ha manuálisan input, mindenképpen vegye fel ezeket az elemeket a Válasz API-ba a beszélgetés későbbi fordulataihoz.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	OpenAI.ReasoningTextContent tömb	Szöveges tartalom érvelése.	No
encrypted_content	sztring (null értékű)		No
id	karakterlánc	Az érvelési tartalom egyedi azonosítója.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
összegzés	OpenAI.Summary tömb	Az összegző tartalom indoklása.	Igen
típus	felsorolás	Az objektum típusa. Mindig reasoning. Lehetséges értékek: reasoning	Igen

OpenAI.InputItemType

Property	Érték
Type	karakterlánc
Értékek	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call_output custom_tool_call item_reference

OpenAI.InputItemWebSearchToolCall

Egy webes keresőeszköz hívásának eredményei. További információért tekintse meg a webes keresési útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.WebSearchActionSearch vagy OpenAI.WebSearchActionOpenPage vagy OpenAI.WebSearchActionFind	A webes keresési hívásban végrehajtott konkrét műveletet leíró objektum. A modell webes használatáról (keresés, open_page, keresés) szóló részletes információkat tartalmaz.	Igen
id	karakterlánc	A webes keresőeszköz hívásának egyedi azonosítója.	Igen
állapot	felsorolás	A webes keresőeszköz hívásának állapota. Lehetséges értékek: in_progress, searching, , completedfailed	Igen
típus	felsorolás	A webes keresőeszköz hívásának típusa. Mindig web_search_call. Lehetséges értékek: web_search_call	Igen

OpenAI.InputMessage

A modell üzenetbemenete egy szerepkörrel, amely a hierarchiát követő utasításokat jelzi. A developer vagy system szerepkörrel megadott utasítások elsőbbséget élveznek a user szerepkörrel megadott utasításokkal szemben.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	OpenAI.InputMessageContentList	A modell egy vagy több bemeneti elemének listája, amely különböző tartalmakat tartalmaz types.	Igen
szerepkör	felsorolás	Az üzenetbemenet szerepe. Az egyik user, system, vagy developer. Lehetséges értékek: user, , systemdeveloper	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	Az üzenetbemenet típusa. Mindig messageértékre van állítva. Lehetséges értékek: message	Igen

OpenAI.InputMessageContentList

A modell egy vagy több bemeneti elemének listája, amely különböző tartalomtípusokat tartalmaz.

Tömb:OpenAI.InputContent

OpenAI.InputMessageResource

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	OpenAI.InputMessageContentList	A modell egy vagy több bemeneti elemének listája, amely különböző tartalmakat tartalmaz types.	Igen
id	karakterlánc	Az üzenetbemenet egyedi azonosítója.	Igen
szerepkör	felsorolás	Az üzenetbemenet szerepe. Az egyik user, system, vagy developer. Lehetséges értékek: user, , systemdeveloper	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	Az üzenetbemenet típusa. Mindig messageértékre van állítva. Lehetséges értékek: message	Igen

OpenAI.InputParam

A modell szöveg-, kép- vagy fájlbemenetei, amelyeket válasz létrehozásához használnak. Tudj meg többet:

• Szöveges bemenetek és kimenetek
• Képbemenetek
• Fájlbemenetek
• Beszélgetés állapota
• Funkcióhívás

Típus: Az OpenAI.InputItem sztringje vagy tömbje

A modell szöveg-, kép- vagy fájlbemenetei, amelyeket válasz létrehozásához használnak. Tudj meg többet:

• Szöveges bemenetek és kimenetek
• Képbemenetek
• Fájlbemenetek
• Beszélgetés állapota
• Funkcióhívás

OpenAI.InputTextContent

A modell szöveges bemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges bemenete.	Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_text. Lehetséges értékek: input_text	Igen

OpenAI.InputTextContentParam

A modell szöveges bemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges bemenete. Korlátozások: maxLength: 10485760	Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_text. Lehetséges értékek: input_text	Igen

OpenAI.Item

A válasz létrehozásához használt tartalomelem.

Az OpenAI.Item diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
memory_search_call	MemorySearchToolCallItemParam
message	OpenAI.InputMessage
output_message	OpenAI.ItemOutputMessage
file_search_call	OpenAI.ItemFileSearchToolCall
computer_call	OpenAI.ItemComputerToolCall
computer_call_output	OpenAI.ItemComputerCallOutputItemParam
web_search_call	OpenAI.ItemWebSearchToolCall
function_call	OpenAI.ItemFunctionToolCall
function_call_output	OpenAI.ItemFunctionCallOutputItemParam
reasoning	OpenAI.ItemReasoningItem
compaction	OpenAI.ItemCompactionSummaryItemParam
image_generation_call	OpenAI.ItemImageGenToolCall
code_interpreter_call	OpenAI.ItemCodeInterpreterToolCall
local_shell_call	OpenAI.ItemLocalShellToolCall
local_shell_call_output	OpenAI.ItemLocalShellToolCallOutput
shell_call	OpenAI.ItemFunctionShellCallItemParam
shell_call_output	OpenAI.ItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.ItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.ItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.ItemMcpListTools
mcp_approval_request	OpenAI.ItemMcpApprovalRequest
mcp_approval_response	OpenAI.ItemMcpApprovalResponse
mcp_call	OpenAI.ItemMcpToolCall
custom_tool_call_output	OpenAI.ItemCustomToolCallOutput
custom_tool_call	OpenAI.ItemCustomToolCall

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ItemType		Igen

OpenAI.ItemApplyPatchToolCallItemParam

Eszközhívás, amely a fájlok diff patchek használatával történő létrehozására, törlésére vagy frissítésére irányuló kérést jelöl.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
művelet	OpenAI.ApplyPatchOperationParam	A apply_patch eszközhöz kapott create_file, delete_file vagy update_file műveletek egyike.	Igen
└─ típus	OpenAI.ApplyPatchOperationParamType		Igen
állapot	OpenAI.ApplyPatchCallStatusParam	Apply_patch eszközhívásokhoz jelentett állapotértékek.	Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call. Lehetséges értékek: apply_patch_call	Igen

OpenAI.ItemApplyPatchToolCallOutputItemParam

Az alkalmazásjavító eszköz hívása által kibocsátott streamelt kimenet.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
kimenet	sztring (null értékű)		No
állapot	OpenAI.ApplyPatchCallOutputStatusParam	Apply_patch eszközhívás kimeneteihez jelentett eredményértékek.	Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call_output. Lehetséges értékek: apply_patch_call_output	Igen

OpenAI.ItemCodeInterpreterToolCall

Eszközhívás a kód futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	sztring (null értékű)		Igen
container_id	karakterlánc	A kód futtatásához használt tároló azonosítója.	Igen
id	karakterlánc	A kódértelmező eszköz hívásának egyedi azonosítója.	Igen
outputs	OpenAI.CodeInterpreterOutputLogs vagy OpenAI.CodeInterpreterOutputImage tömb		Igen
állapot	felsorolás	A kódértelmező eszköz hívásának állapota. Az érvényes értékek a következőkin_progress: , completed, incompleteinterpretingés failed. Lehetséges értékek: in_progress, completed, incomplete, interpretingfailed	Igen
típus	felsorolás	A kódértelmező eszköz hívásának típusa. Mindig code_interpreter_call. Lehetséges értékek: code_interpreter_call	Igen

OpenAI.ItemCompactionSummaryItemParam

Az API által létrehozott tömörítési v1/responses/compactelem.

Name	Típus	Description	Szükséges	Alapértelmezett
encrypted_content	karakterlánc	A tömörítési összegzés titkosított tartalma. Korlátozások: maxLength: 10485760	Igen
id	sztring (null értékű)		No
típus	felsorolás	Az elem típusa. Mindig compaction. Lehetséges értékek: compaction	Igen

OpenAI.ItemComputerCallOutputItemParam

Egy számítógépes eszköz hívásának kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
acknowledged_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje		No
call_id	karakterlánc	A kimenetet előállító számítógép-eszközhívás azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
kimenet	OpenAI.ComputerScreenshotImage	A számítógép-használati eszközzel használt képernyőkép.	Igen
állapot	OpenAI.FunctionCallItemStatus (null értékű)		No
típus	felsorolás	A számítógép eszköz hívási kimenetének típusa. Mindig computer_call_output. Lehetséges értékek: computer_call_output	Igen

OpenAI.ItemComputerToolCall

Eszközhívás egy számítógép által használt eszközhöz. További információt a számítógép használati útmutatójában talál.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.ComputerAction		Igen
call_id	karakterlánc	Az eszközhívás kimenettel történő megválaszolásakor használt azonosító.	Igen
id	karakterlánc	A számítógép-hívás egyedi azonosítója.	Igen
pending_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	A számítógépes hívás függőben lévő biztonsági ellenőrzései.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A számítógép hívásának típusa. Mindig computer_call. Lehetséges értékek: computer_call	Igen

OpenAI.ItemCustomToolCall

A modell által létrehozott egyéni eszköz hívása.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	Az egyéni eszközhívás eszközhívás kimenetére való leképezéséhez használt azonosító.	Igen
id	karakterlánc	Az egyéni eszköz hívásának egyedi azonosítója az OpenAI platformon.	No
bevitel	karakterlánc	A modell által létrehozott egyéni eszközhívás bemenete.	Igen
név	karakterlánc	A meghívandó egyéni eszköz neve.	Igen
típus	felsorolás	Az egyéni eszközhívás típusa. Mindig custom_tool_call. Lehetséges értékek: custom_tool_call	Igen

OpenAI.ItemCustomToolCallOutput

A kódból származó egyéni eszközhívás kimenete, amelyet a rendszer visszaküld a modellnek.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	Az egyéni eszköz híváskimenetének egyéni eszközhíváshoz való leképezéséhez használt hívásazonosító.	Igen
id	karakterlánc	Az egyéni eszköz híváskimenetének egyedi azonosítója az OpenAI platformon.	No
kimenet	Az OpenAI.FunctionAndCustomToolCallOutput sztringje vagy tömbje	A kód által létrehozott egyéni eszközhívás kimenete. Lehet sztring vagy kimeneti tartalomlista.	Igen
típus	felsorolás	Az egyéni eszköz hívási kimenetének típusa. Mindig custom_tool_call_output. Lehetséges értékek: custom_tool_call_output	Igen

OpenAI.ItemFileSearchToolCall

Egy fájlkereső eszköz hívásának eredményei. További információt a fájlkeresési útmutatóban talál.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A fájlkereső eszköz hívásának egyedi azonosítója.	Igen
queries	sztringtömb	A fájlok kereséséhez használt lekérdezések.	Igen
results	Az OpenAI.FileSearchToolCallResults tömbje		No
állapot	felsorolás	A fájlkereső eszköz hívásának állapota. Az egyikin_progress searching, incomplete vagy failed, Lehetséges értékek: in_progress, searching, completed, incompletefailed	Igen
típus	felsorolás	A fájlkereső eszköz hívásának típusa. Mindig file_search_call. Lehetséges értékek: file_search_call	Igen

OpenAI.ItemFunctionCallOutputItemParam

A függvény eszköz hívásának kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
kimenet	OpenAI.InputTextContentParam vagy OpenAI.InputImageContentParamAutoParam vagy OpenAI.InputFileContentParam sztringje vagy tömbje	A függvényeszköz hívásának szövege, képe vagy fájlkimenete.	Igen
állapot	OpenAI.FunctionCallItemStatus (null értékű)		No
típus	felsorolás	A függvényhívó eszköz kimenetének típusa. Mindig function_call_output. Lehetséges értékek: function_call_output	Igen

OpenAI.ItemFunctionShellCallItemParam

Egy vagy több rendszerhéjparancs végrehajtására irányuló kérést képviselő eszköz.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.FunctionShellActionParam	A rendszerhéj-eszköz hívásának futtatását leíró parancsok és korlátozások.	Igen
└─ parancsok	sztringtömb	Rendszerhéjparancsok a végrehajtási környezet futtatásához.	Igen
└─ max_output_length	OpenAI.integer (null értékű)		No
└─ timeout_ms	OpenAI.integer (null értékű)		No
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
állapot	OpenAI.FunctionShellCallItemStatus (nullable)	A rendszerhéjeszköz-hívásokhoz jelentett állapotértékek.	No
típus	felsorolás	Az elem típusa. Mindig shell_call. Lehetséges értékek: shell_call	Igen

OpenAI.ItemFunctionShellCallOutputItemParam

A rendszerhéjeszköz-hívás által kibocsátott streamelt kimeneti elemek.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója. Korlátozások: minLength: 1, maxLength: 64	Igen
id	sztring (null értékű)		No
max_output_length	OpenAI.integer (null értékű)		No
kimenet	Az OpenAI.FunctionShellCallOutputContentParam tömbje	Rögzített adattömbök a stdout és stderr kimenet, valamint a kapcsolódó eredmények.	Igen
típus	felsorolás	Az elem típusa. Mindig shell_call_output. Lehetséges értékek: shell_call_output	Igen

OpenAI.ItemFunctionToolCall

Egy függvény futtatására szolgáló eszközhívás. További információért tekintse meg a függvényhívási útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	A függvénynek átadni kívánt argumentumok JSON-sztringje.	Igen
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívásának egyedi azonosítója.	No
név	karakterlánc	A futtatni kívánt függvény neve.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényeszköz hívásának típusa. Mindig function_call. Lehetséges értékek: function_call	Igen

OpenAI.ItemImageGenToolCall

A modell által küldött képgenerálási kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A képgenerálási hívás egyedi azonosítója.	Igen
result	sztring (null értékű)		Igen
állapot	felsorolás	A képgenerálási hívás állapota. Lehetséges értékek: in_progress, completed, , generatingfailed	Igen
típus	felsorolás	A képgenerálási hívás típusa. Mindig image_generation_call. Lehetséges értékek: image_generation_call	Igen

OpenAI.ItemLocalShellToolCall

Egy eszközhívás egy parancs a helyi parancssoron való futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.LocalShellExecAction	Futtasson egy rendszerhéjparancsot a kiszolgálón.	Igen
call_id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
id	karakterlánc	A helyi rendszerhéj-hívás egyedi azonosítója.	Igen
állapot	felsorolás	A helyi rendszerhéj-hívás állapota. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A helyi rendszerhéj-hívás típusa. Mindig local_shell_call. Lehetséges értékek: local_shell_call	Igen

OpenAI.ItemLocalShellToolCallOutput

Helyi rendszerhéj-eszközhívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
kimenet	karakterlánc	A helyi shell-eszközhívás kimenetének JSON karakterlánca.	Igen
állapot	felsorolás	Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A helyi rendszerhéj-eszköz híváskimenetének típusa. Mindig local_shell_call_output. Lehetséges értékek: local_shell_call_output	Igen

OpenAI.ItemMcpApprovalRequest

Az eszköz meghívásának emberi jóváhagyásához irányuló kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	Az eszközhöz tartozó argumentumok JSON-sztringje.	Igen
id	karakterlánc	A jóváhagyási kérelem egyedi azonosítója.	Igen
név	karakterlánc	A futtatni kívánt eszköz neve.	Igen
szerver_címke	karakterlánc	A kérelmet küldő MCP-kiszolgáló címkéje.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_approval_request. Lehetséges értékek: mcp_approval_request	Igen

OpenAI.ItemMcpApprovalResponse

Válasz mcp jóváhagyási kérelemre.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	karakterlánc	A megválaszolt jóváhagyási kérelem azonosítója.	Igen
approve	boolean	A kérelem jóváhagyása.	Igen
id	sztring (null értékű)		No
ok	sztring (null értékű)		No
típus	felsorolás	Az elem típusa. Mindig mcp_approval_response. Lehetséges értékek: mcp_approval_response	Igen

OpenAI.ItemMcpListTools

Az MCP-kiszolgálón elérhető eszközök listája.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	sztring (null értékű)		No
id	karakterlánc	A lista egyedi azonosítója.	Igen
szerver_címke	karakterlánc	Az MCP-kiszolgáló címkéje.	Igen
tools	Az OpenAI.MCPListToolsTool tömbje	A kiszolgálón elérhető eszközök.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_list_tools. Lehetséges értékek: mcp_list_tools	Igen

OpenAI.ItemMcpToolCall

Eszköz meghívása egy MCP-kiszolgálón.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	sztring (null értékű)		No
arguments	karakterlánc	Az eszköznek átadott argumentumok JSON-sztringje.	Igen
hiba	sztring (null értékű)		No
id	karakterlánc	Az eszközhívás egyedi azonosítója.	Igen
név	karakterlánc	A futtatott eszköz neve.	Igen
kimenet	sztring (null értékű)		No
szerver_címke	karakterlánc	Az eszközt futtató MCP-kiszolgáló címkéje.	Igen
állapot	OpenAI.MCPToolCallStatus		No
típus	felsorolás	Az elem típusa. Mindig mcp_call. Lehetséges értékek: mcp_call	Igen

OpenAI.ItemOutputMessage

A modell kimeneti üzenete.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	Az OpenAI.OutputMessageContent tömbje	A kimeneti üzenet tartalma.	Igen
id	karakterlánc	A kimeneti üzenet egyedi azonosítója.	Igen
szerepkör	felsorolás	A kimeneti üzenet szerepe. Mindig assistant. Lehetséges értékek: assistant	Igen
állapot	felsorolás	Az üzenetbemenet állapota. Az egyik in_progress, completed, vagy incomplete. A bemeneti elemek API-val való visszaadásakor ki lesz töltve. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A kimeneti üzenet típusa. Mindig message. Lehetséges értékek: output_message	Igen

OpenAI.ItemReasoningItem

Az érvelési modell által a válasz létrehozásakor használt gondolatlánc leírása. Ha manuálisan input, mindenképpen vegye fel ezeket az elemeket a Válasz API-ba a beszélgetés későbbi fordulataihoz.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	OpenAI.ReasoningTextContent tömb	Szöveges tartalom érvelése.	No
encrypted_content	sztring (null értékű)		No
id	karakterlánc	Az érvelési tartalom egyedi azonosítója.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
összegzés	OpenAI.Summary tömb	Az összegző tartalom indoklása.	Igen
típus	felsorolás	Az objektum típusa. Mindig reasoning. Lehetséges értékek: reasoning	Igen

OpenAI.ItemReferenceParam

Egy hivatkozásra váró elem belső azonosítója.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A hivatkozni kívánt elem azonosítója.	Igen
típus	felsorolás	A hivatkozni kívánt elem típusa. Mindig item_reference. Lehetséges értékek: item_reference	Igen

OpenAI.ItemResource

A válasz létrehozásához használt tartalomelem.

Az OpenAI.ItemResource Diszkriminátor

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
message	OpenAI.InputMessageResource
output_message	OpenAI.ItemResourceOutputMessage
file_search_call	OpenAI.ItemResourceFileSearchToolCall
computer_call	OpenAI.ItemResourceComputerToolCall
computer_call_output	OpenAI.ItemResourceComputerToolCallOutputResource
web_search_call	OpenAI.ItemResourceWebSearchToolCall
function_call	OpenAI.ItemResourceFunctionToolCallResource
function_call_output	OpenAI.ItemResourceFunctionToolCallOutputResource
image_generation_call	OpenAI.ItemResourceImageGenToolCall
code_interpreter_call	OpenAI.ItemResourceCodeInterpreterToolCall
local_shell_call	OpenAI.ItemResourceLocalShellToolCall
local_shell_call_output	OpenAI.ItemResourceLocalShellToolCallOutput
shell_call	OpenAI.ItemResourceFunctionShellCall
shell_call_output	OpenAI.ItemResourceFunctionShellCallOutput
apply_patch_call	OpenAI.ItemResourceApplyPatchToolCall
apply_patch_call_output	OpenAI.ItemResourceApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ItemResourceMcpListTools
mcp_approval_request	OpenAI.ItemResourceMcpApprovalRequest
mcp_approval_response	OpenAI.ItemResourceMcpApprovalResponseResource
mcp_call	OpenAI.ItemResourceMcpToolCall

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ItemResourceType		Igen

OpenAI.ItemResourceApplyPatchToolCall

Eszközhívás, amely fájldiffeket alkalmaz fájlok létrehozásával, törlésével vagy frissítésével.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszközhívást létrehozó entitás azonosítója.	No
id	karakterlánc	Az apply patch tool call egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
művelet	OpenAI.ApplyPatchFileOperation	A apply_patch keresztül alkalmazott create_file, delete_file vagy update_file műveletek egyike.	Igen
└─ típus	OpenAI.ApplyPatchFileOperationType		Igen
állapot	OpenAI.ApplyPatchCallStatus		Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call. Lehetséges értékek: apply_patch_call	Igen

OpenAI.ItemResourceApplyPatchToolCallOutput

Az apply patch tool call által kibocsátott kimenet.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszköz kimenetét létrehozó entitás azonosítója.	No
id	karakterlánc	Az apply patch tool call output egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
kimenet	sztring (null értékű)		No
állapot	OpenAI.ApplyPatchCallOutputStatus		Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call_output. Lehetséges értékek: apply_patch_call_output	Igen

OpenAI.ItemResourceCodeInterpreterToolCall

Eszközhívás a kód futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	sztring (null értékű)		Igen
container_id	karakterlánc	A kód futtatásához használt tároló azonosítója.	Igen
id	karakterlánc	A kódértelmező eszköz hívásának egyedi azonosítója.	Igen
outputs	OpenAI.CodeInterpreterOutputLogs vagy OpenAI.CodeInterpreterOutputImage tömb		Igen
állapot	felsorolás	A kódértelmező eszköz hívásának állapota. Az érvényes értékek a következőkin_progress: , completed, incompleteinterpretingés failed. Lehetséges értékek: in_progress, completed, incomplete, interpretingfailed	Igen
típus	felsorolás	A kódértelmező eszköz hívásának típusa. Mindig code_interpreter_call. Lehetséges értékek: code_interpreter_call	Igen

OpenAI.ItemResourceComputerToolCall

Eszközhívás egy számítógép által használt eszközhöz. További információt a számítógép használati útmutatójában talál.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.ComputerAction		Igen
call_id	karakterlánc	Az eszközhívás kimenettel történő megválaszolásakor használt azonosító.	Igen
id	karakterlánc	A számítógép-hívás egyedi azonosítója.	Igen
pending_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	A számítógépes hívás függőben lévő biztonsági ellenőrzései.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A számítógép hívásának típusa. Mindig computer_call. Lehetséges értékek: computer_call	Igen

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Típus	Description	Szükséges	Alapértelmezett
acknowledged_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	Az API által jelentett és elismert biztonsági ellenőrzések, amelyeket a fejlesztő.	No
call_id	karakterlánc	A kimenetet előállító számítógép-eszközhívás azonosítója.	Igen
id	karakterlánc	A számítógép eszköz hívási kimenetének azonosítója.	No
kimenet	OpenAI.ComputerScreenshotImage	A számítógép-használati eszközzel használt képernyőkép.	Igen
állapot	felsorolás	Az üzenetbemenet állapota. Az egyik in_progress, completed, vagy incomplete. A bemeneti elemek API-val való visszaadásakor ki lesz töltve. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A számítógép eszköz hívási kimenetének típusa. Mindig computer_call_output. Lehetséges értékek: computer_call_output	Igen

OpenAI.ItemResourceFileSearchToolCall

Egy fájlkereső eszköz hívásának eredményei. További információt a fájlkeresési útmutatóban talál.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A fájlkereső eszköz hívásának egyedi azonosítója.	Igen
queries	sztringtömb	A fájlok kereséséhez használt lekérdezések.	Igen
results	Az OpenAI.FileSearchToolCallResults tömbje		No
állapot	felsorolás	A fájlkereső eszköz hívásának állapota. Az egyikin_progress searching, incomplete vagy failed, Lehetséges értékek: in_progress, searching, completed, incompletefailed	Igen
típus	felsorolás	A fájlkereső eszköz hívásának típusa. Mindig file_search_call. Lehetséges értékek: file_search_call	Igen

OpenAI.ItemResourceFunctionShellCall

Egy eszközhívás, amely egy vagy több rendszerhéjparancsot hajt végre egy felügyelt környezetben.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.FunctionShellAction	Rendszerhéjparancs végrehajtása.	Igen
└─ parancsok	sztringtömb		Igen
└─ max_output_length	OpenAI.integer (null értékű)		Igen
└─ timeout_ms	OpenAI.integer (null értékű)		Igen
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszközhívást létrehozó entitás azonosítója.	No
id	karakterlánc	A rendszerhéj-eszköz hívásának egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
állapot	OpenAI.LocalShellCallStatus		Igen
típus	felsorolás	Az elem típusa. Mindig shell_call. Lehetséges értékek: shell_call	Igen

OpenAI.ItemResourceFunctionShellCallOutput

A rendszerhéjeszköz által kibocsátott hívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az elemet létrehozó szereplő azonosítója.	No
id	karakterlánc	A rendszerhéj-hívás kimenetének egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
max_output_length	OpenAI.integer (null értékű)		Igen
kimenet	Az OpenAI.FunctionShellCallOutputContent tömbje	A rendszerhéjhívás kimeneti tartalmának tömbje	Igen
típus	felsorolás	A rendszerhéj-hívás kimenetének típusa. Mindig shell_call_output. Lehetséges értékek: shell_call_output	Igen

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Típus	Description	Szükséges	Alapértelmezett
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívási kimenetének egyedi azonosítója. Az elem kitöltve API-val adja vissza.	No
kimenet	Az OpenAI.FunctionAndCustomToolCallOutput sztringje vagy tömbje	A kód által generált függvényhívás kimenete. Lehet sztring vagy kimeneti tartalomlista.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényhívó eszköz kimenetének típusa. Mindig function_call_output. Lehetséges értékek: function_call_output	Igen

OpenAI.ItemResourceFunctionToolCallResource

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	A függvénynek átadni kívánt argumentumok JSON-sztringje.	Igen
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívásának egyedi azonosítója.	No
név	karakterlánc	A futtatni kívánt függvény neve.	Igen
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényeszköz hívásának típusa. Mindig function_call. Lehetséges értékek: function_call	Igen

OpenAI.ItemResourceImageGenToolCall

A modell által küldött képgenerálási kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A képgenerálási hívás egyedi azonosítója.	Igen
result	sztring (null értékű)		Igen
állapot	felsorolás	A képgenerálási hívás állapota. Lehetséges értékek: in_progress, completed, , generatingfailed	Igen
típus	felsorolás	A képgenerálási hívás típusa. Mindig image_generation_call. Lehetséges értékek: image_generation_call	Igen

OpenAI.ItemResourceLocalShellToolCall

Egy eszközhívás egy parancs a helyi parancssoron való futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.LocalShellExecAction	Futtasson egy rendszerhéjparancsot a kiszolgálón.	Igen
call_id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
id	karakterlánc	A helyi rendszerhéj-hívás egyedi azonosítója.	Igen
állapot	felsorolás	A helyi rendszerhéj-hívás állapota. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A helyi rendszerhéj-hívás típusa. Mindig local_shell_call. Lehetséges értékek: local_shell_call	Igen

OpenAI.ItemResourceLocalShellToolCallOutput

Helyi rendszerhéj-eszközhívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
kimenet	karakterlánc	A helyi shell-eszközhívás kimenetének JSON karakterlánca.	Igen
állapot	felsorolás	Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A helyi rendszerhéj-eszköz híváskimenetének típusa. Mindig local_shell_call_output. Lehetséges értékek: local_shell_call_output	Igen

OpenAI.ItemResourceMcpApprovalRequest

Az eszköz meghívásának emberi jóváhagyásához irányuló kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	Az eszközhöz tartozó argumentumok JSON-sztringje.	Igen
id	karakterlánc	A jóváhagyási kérelem egyedi azonosítója.	Igen
név	karakterlánc	A futtatni kívánt eszköz neve.	Igen
szerver_címke	karakterlánc	A kérelmet küldő MCP-kiszolgáló címkéje.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_approval_request. Lehetséges értékek: mcp_approval_request	Igen

OpenAI.ItemResourceMcpApprovalResponseResource

Válasz mcp jóváhagyási kérelemre.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	karakterlánc	A megválaszolt jóváhagyási kérelem azonosítója.	Igen
approve	boolean	A kérelem jóváhagyása.	Igen
id	karakterlánc	A jóváhagyási válasz egyedi azonosítója	Igen
ok	sztring (null értékű)		No
típus	felsorolás	Az elem típusa. Mindig mcp_approval_response. Lehetséges értékek: mcp_approval_response	Igen

OpenAI.ItemResourceMcpListTools

Az MCP-kiszolgálón elérhető eszközök listája.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	sztring (null értékű)		No
id	karakterlánc	A lista egyedi azonosítója.	Igen
szerver_címke	karakterlánc	Az MCP-kiszolgáló címkéje.	Igen
tools	Az OpenAI.MCPListToolsTool tömbje	A kiszolgálón elérhető eszközök.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_list_tools. Lehetséges értékek: mcp_list_tools	Igen

OpenAI.ItemResourceMcpToolCall

Eszköz meghívása egy MCP-kiszolgálón.

Name	Típus	Description	Szükséges	Alapértelmezett
approval_request_id	sztring (null értékű)		No
arguments	karakterlánc	Az eszköznek átadott argumentumok JSON-sztringje.	Igen
hiba	sztring (null értékű)		No
id	karakterlánc	Az eszközhívás egyedi azonosítója.	Igen
név	karakterlánc	A futtatott eszköz neve.	Igen
kimenet	sztring (null értékű)		No
szerver_címke	karakterlánc	Az eszközt futtató MCP-kiszolgáló címkéje.	Igen
állapot	OpenAI.MCPToolCallStatus		No
típus	felsorolás	Az elem típusa. Mindig mcp_call. Lehetséges értékek: mcp_call	Igen

OpenAI.ItemResourceOutputMessage

A modell kimeneti üzenete.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	Az OpenAI.OutputMessageContent tömbje	A kimeneti üzenet tartalma.	Igen
id	karakterlánc	A kimeneti üzenet egyedi azonosítója.	Igen
szerepkör	felsorolás	A kimeneti üzenet szerepe. Mindig assistant. Lehetséges értékek: assistant	Igen
állapot	felsorolás	Az üzenetbemenet állapota. Az egyik in_progress, completed, vagy incomplete. A bemeneti elemek API-val való visszaadásakor ki lesz töltve. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A kimeneti üzenet típusa. Mindig message. Lehetséges értékek: output_message	Igen

OpenAI.ItemResourceType

Property	Érték
Type	karakterlánc
Értékek	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemResourceWebSearchToolCall

Egy webes keresőeszköz hívásának eredményei. További információért tekintse meg a webes keresési útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.WebSearchActionSearch vagy OpenAI.WebSearchActionOpenPage vagy OpenAI.WebSearchActionFind	A webes keresési hívásban végrehajtott konkrét műveletet leíró objektum. A modell webes használatáról (keresés, open_page, keresés) szóló részletes információkat tartalmaz.	Igen
id	karakterlánc	A webes keresőeszköz hívásának egyedi azonosítója.	Igen
állapot	felsorolás	A webes keresőeszköz hívásának állapota. Lehetséges értékek: in_progress, searching, , completedfailed	Igen
típus	felsorolás	A webes keresőeszköz hívásának típusa. Mindig web_search_call. Lehetséges értékek: web_search_call	Igen

OpenAI.ItemType

Property	Érték
Type	karakterlánc
Értékek	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call_output custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

Egy webes keresőeszköz hívásának eredményei. További információért tekintse meg a webes keresési útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.WebSearchActionSearch vagy OpenAI.WebSearchActionOpenPage vagy OpenAI.WebSearchActionFind	A webes keresési hívásban végrehajtott konkrét műveletet leíró objektum. A modell webes használatáról (keresés, open_page, keresés) szóló részletes információkat tartalmaz.	Igen
id	karakterlánc	A webes keresőeszköz hívásának egyedi azonosítója.	Igen
állapot	felsorolás	A webes keresőeszköz hívásának állapota. Lehetséges értékek: in_progress, searching, , completedfailed	Igen
típus	felsorolás	A webes keresőeszköz hívásának típusa. Mindig web_search_call. Lehetséges értékek: web_search_call	Igen

OpenAI.KeyPressAction

A modell által végrehajtandó kulcsnyomások gyűjteménye.

Name	Típus	Description	Szükséges	Alapértelmezett
keys	sztringtömb	A modell által kért lenyomandó kulcsok kombinációja. Ez egy sztringtömb, amelyek mindegyike egy-egy kulcsot jelöl.	Igen
típus	felsorolás	Megadja az esemény típusát. Kulcsnyomásos művelet esetén ez a tulajdonság mindig a következőre keypressvan állítva: . Lehetséges értékek: keypress	Igen

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Típus	Description	Szükséges	Alapértelmezett
adat	Az OpenAI.FineTuningJobCheckpoint tömbje		Igen
first_id	sztring (null értékű)		No
van_még	boolean		Igen
last_id	sztring (null értékű)		No
objektum	felsorolás	Lehetséges értékek: list	Igen

OpenAI.ListFineTuningJobEventsResponse

Name	Típus	Description	Szükséges	Alapértelmezett
adat	Az OpenAI.FineTuningJobEvent tömbje		Igen
van_még	boolean		Igen
objektum	felsorolás	Lehetséges értékek: list	Igen

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Típus	Description	Szükséges	Alapértelmezett
adat	Az OpenAI.FineTuningJob tömbje		Igen
van_még	boolean		Igen
objektum	felsorolás	Lehetséges értékek: list	Igen

OpenAI.LocalShellCallStatus

Property	Érték
Type	karakterlánc
Értékek	in_progress completed incomplete

OpenAI.LocalShellExecAction

Futtasson egy rendszerhéjparancsot a kiszolgálón.

Name	Típus	Description	Szükséges	Alapértelmezett
command	sztringtömb	A futtatandó parancs.	Igen
Környezet	objektum	A parancshoz beállítandó környezeti változók.	Igen
időkorlát_ms	OpenAI.integer (null értékű)		No
típus	felsorolás	A helyi shell művelet típusa. Mindig exec. Lehetséges értékek: exec	Igen
felhasználó	sztring (null értékű)		No
working_directory	sztring (null értékű)		No

OpenAI.LocalShellToolParam

Olyan eszköz, amely lehetővé teszi a modell számára a rendszerhéjparancsok helyi környezetben való végrehajtását.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A helyi shell eszköz típusa. Mindig local_shell. Lehetséges értékek: local_shell	Igen

OpenAI.LogProb

Egy token logaritmikus valószínűsége.

Name	Típus	Description	Szükséges	Alapértelmezett
bytes	OpenAI.integer tömbje		Igen
logprob	OpenAI.numerikus		Igen
kód	karakterlánc		Igen
top_logprobs	OpenAI.TopLogProb tömb		Igen

OpenAI.MCPListToolsTool

McP-kiszolgálón elérhető eszköz.

Name	Típus	Description	Szükséges	Alapértelmezett
annotations	OpenAI.MCPListToolsToolAnnotations (nullable)		No
leírás	sztring (null értékű)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Igen
név	karakterlánc	Az eszköz neve.	Igen

OpenAI.MCPListToolsToolAnnotations

Típus: objektum

OpenAI.MCPListToolsToolInputSchema

Típus: objektum

OpenAI.MCPTool

Adja meg a modellnek a távoli Model Context Protocol (MCP) kiszolgálókon keresztül a további eszközökhöz való hozzáférést. További információ az MCP-ről.

Name	Típus	Description	Szükséges	Alapértelmezett
engedélyezett eszközök	sztringtömb vagy OpenAI.MCPToolFilter		No
engedélyezés	karakterlánc	OAuth hozzáférési jogkivonat, amely távoli MCP-kiszolgálóval is használható egyéni MCP-kiszolgáló URL-címével vagy szolgáltatás-összekötővel. Alkalmazása kezelnie kell az OAuth engedélyezési folyamatot, és itt kell megadnia a jogkivonatot.	No
connector_id	felsorolás	A szolgáltatás-összekötők azonosítója, például a ChatGPT-ben elérhetőek. Az egyik server_url vagy connector_id meg kell adni. További információ a szolgáltatásról összekötők itt. Jelenleg támogatott connector_id értékek: -Dropbox: connector_dropbox -Gmail: connector_gmail - Google Naptár: connector_googlecalendar - Google Drive: connector_googledrive - Microsoft Teams:connector_microsoftteams - Outlook Naptár: connector_outlookcalendar - Outlook e-mail: connector_outlookemail -Sharepoint: connector_sharepoint Lehetséges értékek: connector_dropbox, connector_gmail, connector_googlecalendar, connector_googledrive, connector_microsoftteams, connector_outlookcalendar, connector_outlookemailconnector_sharepoint	No
headers	objektum (null értékű)		No
project_connection_id	karakterlánc	Az MCP-kiszolgáló project kapcsolatazonosítója. A kapcsolat tárolja az MCP-kiszolgálóhoz való csatlakozáshoz szükséges hitelesítési és egyéb kapcsolati adatokat.	No
jóváhagyás_szükséges	objektum (lásd az alábbi érvényes modelleket)		No
server_description	karakterlánc	Az MCP-kiszolgáló opcionális leírása, amely további kontextust biztosít.	No
szerver_címke	karakterlánc	Az MCP-kiszolgáló címkéje, amely az eszközhívásokban való azonosításra szolgál.	Igen
szerver URL	karakterlánc	Az MCP-kiszolgáló URL-címe. Az egyiknek server_url vagy connector_id meg kell adni.	No
típus	felsorolás	Az MCP eszköz típusa. Mindig mcp. Lehetséges értékek: mcp	Igen

OpenAI.MCPToolCallStatus

Property	Érték
Type	karakterlánc
Értékek	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

Szűrőobjektum, amely meghatározza, hogy mely eszközök engedélyezettek.

Name	Típus	Description	Szükséges	Alapértelmezett
read_only	boolean	Azt jelzi, hogy egy eszköz módosítja-e az adatokat, vagy írásvédett. Ha Az MCP-kiszolgáló a readOnlyHint( ez megfelel a szűrőnek.	No
tool_names	sztringtömb	Az engedélyezett eszköznevek listája.	No

OpenAI.MCPToolRequireApproval

Name	Típus	Description	Szükséges	Alapértelmezett
mindig	OpenAI.MCPToolFilter	Szűrőobjektum, amely meghatározza, hogy mely eszközök engedélyezettek.	No
soha	OpenAI.MCPToolFilter	Szűrőobjektum, amely meghatározza, hogy mely eszközök engedélyezettek.	No

OpenAI.MessageContent

Egy bemeneti vagy kimeneti elemet alkotó tartalomrész.

Az OpenAI.MessageContent diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
text	OpenAI.TextContent
summary_text	OpenAI.SummaryTextContent
computer_screenshot	OpenAI.ComputerScreenshotContent
input_text	OpenAI.MessageContentInputTextContent
output_text	OpenAI.MessageContentOutputTextContent
reasoning_text	OpenAI.MessageContentReasoningTextContent
refusal	OpenAI.MessageContentRefusalContent
input_image	OpenAI.MessageContentInputImageContent
input_file	OpenAI.MessageContentInputFileContent

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.MessageContentType		Igen

OpenAI.MessageContentInputFileContent

A modell fájlbemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
file_data	karakterlánc	A modellnek küldendő fájl tartalma.	No
fájl_azonosító	sztring (null értékű)		No
file_url	karakterlánc	A modellnek küldendő fájl URL-címe.	No
filename	karakterlánc	A modellnek küldendő fájl neve.	No
típus	felsorolás	A bemeneti elem típusa. Mindig input_file. Lehetséges értékek: input_file	Igen

OpenAI.MessageContentInputImageContent

Képbevitel a modellhez. Ismerje meg a képbemeneteket.

Name	Típus	Description	Szükséges	Alapértelmezett
detail	OpenAI.ImageDetail		Igen
fájl_azonosító	sztring (null értékű)		No
image_url	karakterlánc		No
típus	felsorolás	A bemeneti elem típusa. Mindig input_image. Lehetséges értékek: input_image	Igen

OpenAI.MessageContentInputTextContent

A modell szöveges bemenete.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell szöveges bemenete.	Igen
típus	felsorolás	A bemeneti elem típusa. Mindig input_text. Lehetséges értékek: input_text	Igen

OpenAI.MessageContentOutputTextContent

A modell szöveges kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
annotations	OpenAI.Annotation tömb	A szövegkimenet széljegyzetei.	Igen
logprobs	OpenAI.LogProb tömb		No
SMS	karakterlánc	A modell szöveges kimenete.	Igen
típus	felsorolás	A kimeneti szöveg típusa. Mindig output_text. Lehetséges értékek: output_text	Igen

OpenAI.MessageContentReasoningTextContent

A modell szövegének érvelése.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell érvelési szövege.	Igen
típus	felsorolás	Az érvelési szöveg típusa. Mindig reasoning_text. Lehetséges értékek: reasoning_text	Igen

OpenAI.MessageContentRefusalContent

A modell elutasítása.

Name	Típus	Description	Szükséges	Alapértelmezett
visszautasítás	karakterlánc	A modell elutasítási magyarázata.	Igen
típus	felsorolás	Az elutasítás típusa. Mindig refusal. Lehetséges értékek: refusal	Igen

OpenAI.MessageContentType

Property	Érték
Type	karakterlánc
Értékek	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Property	Érték
Type	karakterlánc
Értékek	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Property	Érték
Type	karakterlánc
Értékek	in_progress completed incomplete

OpenAI.Metadata

Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektum további információinak strukturált formátumban való tárolásához, valamint az api-val vagy az irányítópulton keresztüli objektumok lekérdezéséhez. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.

Típus: objektum

OpenAI.ModelIdsCompaction

A válasz létrehozásához használt modellazonosító, például gpt-5 vagy o3. Az OpenAI különböző képességekkel, teljesítményjellemzőkkel és árpontokkal rendelkező modellek széles választékát kínálja. Az elérhető modellek böngészéséhez és összehasonlításához tekintse meg a modellútmutatót .

Típus: OpenAI.ModelIdsResponses vagy sztring

A válasz létrehozásához használt modellazonosító, például gpt-5 vagy o3. Az OpenAI különböző képességekkel, teljesítményjellemzőkkel és árpontokkal rendelkező modellek széles választékát kínálja. Az elérhető modellek böngészéséhez és összehasonlításához tekintse meg a modellútmutatót .

OpenAI.ModelIdsResponses

Property	Érték
Type	karakterlánc
Értékek	o1-pro o1-pro-2025-03-19 o3-pro o3-pro-2025-06-10 o3-deep-research o3-deep-research-2025-06-26 o4-mini-deep-research o4-mini-deep-research-2025-06-26 computer-use-preview computer-use-preview-2025-03-11 gpt-5-codex gpt-5-pro gpt-5-pro-2025-10-06 gpt-5.1-codex-max

OpenAI.ModelIdsShared

Típus: sztring vagy OpenAI.ChatModel

OpenAI.Move

Egérmozgatási művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Megadja az esemény típusát. Áthelyezési művelet esetén ez a tulajdonság mindig move-ra van állítva. Lehetséges értékek: move	Igen
x	OpenAI.integer		Igen
y	OpenAI.integer		Igen

OpenAI.OutputContent

Az OpenAI.OutputContent diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent
reasoning_text	OpenAI.OutputContentReasoningTextContent

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.OutputContentType		Igen

OpenAI.OutputContentOutputTextContent

A modell szöveges kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
annotations	OpenAI.Annotation tömb	A szövegkimenet széljegyzetei.	Igen
logprobs	OpenAI.LogProb tömb		No
SMS	karakterlánc	A modell szöveges kimenete.	Igen
típus	felsorolás	A kimeneti szöveg típusa. Mindig output_text. Lehetséges értékek: output_text	Igen

OpenAI.OutputContentReasoningTextContent

A modell szövegének érvelése.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell érvelési szövege.	Igen
típus	felsorolás	Az érvelési szöveg típusa. Mindig reasoning_text. Lehetséges értékek: reasoning_text	Igen

OpenAI.OutputContentRefusalContent

A modell elutasítása.

Name	Típus	Description	Szükséges	Alapértelmezett
visszautasítás	karakterlánc	A modell elutasítási magyarázata.	Igen
típus	felsorolás	Az elutasítás típusa. Mindig refusal. Lehetséges értékek: refusal	Igen

OpenAI.OutputContentType

Property	Érték
Type	karakterlánc
Értékek	output_text refusal reasoning_text

OpenAI.OutputItem

Az OpenAI.OutputItem diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
structured_outputs	StructuredOutputsOutputItem
workflow_action	WorkflowActionOutputItem
oauth_consent_request	OAuthConsentRequestOutputItem
memory_search_call	MemorySearchToolCallItemResource
output_message	OpenAI.OutputItemOutputMessage
file_search_call	OpenAI.OutputItemFileSearchToolCall
function_call	OpenAI.OutputItemFunctionToolCall
web_search_call	OpenAI.OutputItemWebSearchToolCall
computer_call	OpenAI.OutputItemComputerToolCall
reasoning	OpenAI.OutputItemReasoningItem
compaction	OpenAI.OutputItemCompactionBody
image_generation_call	OpenAI.OutputItemImageGenToolCall
code_interpreter_call	OpenAI.OutputItemCodeInterpreterToolCall
local_shell_call	OpenAI.OutputItemLocalShellToolCall
shell_call	OpenAI.OutputItemFunctionShellCall
shell_call_output	OpenAI.OutputItemFunctionShellCallOutput
apply_patch_call	OpenAI.OutputItemApplyPatchToolCall
apply_patch_call_output	OpenAI.OutputItemApplyPatchToolCallOutput
mcp_call	OpenAI.OutputItemMcpToolCall
mcp_list_tools	OpenAI.OutputItemMcpListTools
mcp_approval_request	OpenAI.OutputItemMcpApprovalRequest
custom_tool_call	OpenAI.OutputItemCustomToolCall

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
típus	OpenAI.OutputItemType		Igen

OpenAI.OutputItemApplyPatchToolCall

Eszközhívás, amely fájldiffeket alkalmaz fájlok létrehozásával, törlésével vagy frissítésével.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszközhívást létrehozó entitás azonosítója.	No
id	karakterlánc	Az apply patch tool call egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
művelet	OpenAI.ApplyPatchFileOperation	A apply_patch keresztül alkalmazott create_file, delete_file vagy update_file műveletek egyike.	Igen
└─ típus	OpenAI.ApplyPatchFileOperationType		Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	OpenAI.ApplyPatchCallStatus		Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call. Lehetséges értékek: apply_patch_call	Igen

OpenAI.OutputItemApplyPatchToolCallOutput

Az apply patch tool call által kibocsátott kimenet.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	A modell által generált javításeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszköz kimenetét létrehozó entitás azonosítója.	No
id	karakterlánc	Az apply patch tool call output egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
kimenet	sztring (null értékű)		No
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	OpenAI.ApplyPatchCallOutputStatus		Igen
típus	felsorolás	Az elem típusa. Mindig apply_patch_call_output. Lehetséges értékek: apply_patch_call_output	Igen

OpenAI.OutputItemCodeInterpreterToolCall

Eszközhívás a kód futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
kód	sztring (null értékű)		Igen
container_id	karakterlánc	A kód futtatásához használt tároló azonosítója.	Igen
id	karakterlánc	A kódértelmező eszköz hívásának egyedi azonosítója.	Igen
outputs	OpenAI.CodeInterpreterOutputLogs vagy OpenAI.CodeInterpreterOutputImage tömb		Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	A kódértelmező eszköz hívásának állapota. Az érvényes értékek a következőkin_progress: , completed, incompleteinterpretingés failed. Lehetséges értékek: in_progress, completed, incomplete, interpretingfailed	Igen
típus	felsorolás	A kódértelmező eszköz hívásának típusa. Mindig code_interpreter_call. Lehetséges értékek: code_interpreter_call	Igen

OpenAI.OutputItemCompactionBody

Az API által létrehozott tömörítési v1/responses/compactelem.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
által készített	karakterlánc	Az elemet létrehozó szereplő azonosítója.	No
encrypted_content	karakterlánc	A tömörítés által létrehozott titkosított tartalom.	Igen
id	karakterlánc	A tömörítési elem egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
típus	felsorolás	Az elem típusa. Mindig compaction. Lehetséges értékek: compaction	Igen

OpenAI.OutputItemComputerToolCall

Eszközhívás egy számítógép által használt eszközhöz. További információt a számítógép használati útmutatójában talál.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.ComputerAction		Igen
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	Az eszközhívás kimenettel történő megválaszolásakor használt azonosító.	Igen
id	karakterlánc	A számítógép-hívás egyedi azonosítója.	Igen
pending_safety_checks	Az OpenAI.ComputerCallSafetyCheckParam tömbje	A számítógépes hívás függőben lévő biztonsági ellenőrzései.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A számítógép hívásának típusa. Mindig computer_call. Lehetséges értékek: computer_call	Igen

OpenAI.OutputItemCustomToolCall

A modell által létrehozott egyéni eszköz hívása.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	Az egyéni eszközhívás eszközhívás kimenetére való leképezéséhez használt azonosító.	Igen
id	karakterlánc	Az egyéni eszköz hívásának egyedi azonosítója az OpenAI platformon.	No
bevitel	karakterlánc	A modell által létrehozott egyéni eszközhívás bemenete.	Igen
név	karakterlánc	A meghívandó egyéni eszköz neve.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
típus	felsorolás	Az egyéni eszközhívás típusa. Mindig custom_tool_call. Lehetséges értékek: custom_tool_call	Igen

OpenAI.OutputItemFileSearchToolCall

Egy fájlkereső eszköz hívásának eredményei. További információt a fájlkeresési útmutatóban talál.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
id	karakterlánc	A fájlkereső eszköz hívásának egyedi azonosítója.	Igen
queries	sztringtömb	A fájlok kereséséhez használt lekérdezések.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
results	Az OpenAI.FileSearchToolCallResults tömbje		No
állapot	felsorolás	A fájlkereső eszköz hívásának állapota. Az egyikin_progress searching, incomplete vagy failed, Lehetséges értékek: in_progress, searching, completed, incompletefailed	Igen
típus	felsorolás	A fájlkereső eszköz hívásának típusa. Mindig file_search_call. Lehetséges értékek: file_search_call	Igen

OpenAI.OutputItemFunctionShellCall

Egy eszközhívás, amely egy vagy több rendszerhéjparancsot hajt végre egy felügyelt környezetben.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.FunctionShellAction	Rendszerhéjparancs végrehajtása.	Igen
└─ parancsok	sztringtömb		Igen
└─ max_output_length	OpenAI.integer (null értékű)		Igen
└─ timeout_ms	OpenAI.integer (null értékű)		Igen
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az eszközhívást létrehozó entitás azonosítója.	No
id	karakterlánc	A rendszerhéj-eszköz hívásának egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	OpenAI.LocalShellCallStatus		Igen
típus	felsorolás	Az elem típusa. Mindig shell_call. Lehetséges értékek: shell_call	Igen

OpenAI.OutputItemFunctionShellCallOutput

A rendszerhéjeszköz által kibocsátott hívás kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	A modell által generált rendszerhéjeszköz-hívás egyedi azonosítója.	Igen
által készített	karakterlánc	Az elemet létrehozó szereplő azonosítója.	No
id	karakterlánc	A rendszerhéj-hívás kimenetének egyedi azonosítója. Amikor ezt az elemet egy API-n keresztül visszaadják, ki van töltve.	Igen
max_output_length	OpenAI.integer (null értékű)		Igen
kimenet	Az OpenAI.FunctionShellCallOutputContent tömbje	A rendszerhéjhívás kimeneti tartalmának tömbje	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
típus	felsorolás	A rendszerhéj-hívás kimenetének típusa. Mindig shell_call_output. Lehetséges értékek: shell_call_output	Igen

OpenAI.OutputItemFunctionToolCall

Egy függvény futtatására szolgáló eszközhívás. További információért tekintse meg a függvényhívási útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
arguments	karakterlánc	A függvénynek átadni kívánt argumentumok JSON-sztringje.	Igen
call_id	karakterlánc	A modell által generált függvényeszköz-hívás egyedi azonosítója.	Igen
id	karakterlánc	A függvényeszköz hívásának egyedi azonosítója.	No
név	karakterlánc	A futtatni kívánt függvény neve.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
típus	felsorolás	A függvényeszköz hívásának típusa. Mindig function_call. Lehetséges értékek: function_call	Igen

OpenAI.OutputItemImageGenToolCall

A modell által küldött képgenerálási kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
id	karakterlánc	A képgenerálási hívás egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
result	sztring (null értékű)		Igen
állapot	felsorolás	A képgenerálási hívás állapota. Lehetséges értékek: in_progress, completed, , generatingfailed	Igen
típus	felsorolás	A képgenerálási hívás típusa. Mindig image_generation_call. Lehetséges értékek: image_generation_call	Igen

OpenAI.OutputItemLocalShellToolCall

Egy eszközhívás egy parancs a helyi parancssoron való futtatásához.

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.LocalShellExecAction	Futtasson egy rendszerhéjparancsot a kiszolgálón.	Igen
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
call_id	karakterlánc	A modell által generált helyi shell eszközhívás egyedi azonosítója.	Igen
id	karakterlánc	A helyi rendszerhéj-hívás egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	A helyi rendszerhéj-hívás állapota. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A helyi rendszerhéj-hívás típusa. Mindig local_shell_call. Lehetséges értékek: local_shell_call	Igen

OpenAI.OutputItemMcpApprovalRequest

Az eszköz meghívásának emberi jóváhagyásához irányuló kérés.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
arguments	karakterlánc	Az eszközhöz tartozó argumentumok JSON-sztringje.	Igen
id	karakterlánc	A jóváhagyási kérelem egyedi azonosítója.	Igen
név	karakterlánc	A futtatni kívánt eszköz neve.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
szerver_címke	karakterlánc	A kérelmet küldő MCP-kiszolgáló címkéje.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_approval_request. Lehetséges értékek: mcp_approval_request	Igen

OpenAI.OutputItemMcpListTools

Az MCP-kiszolgálón elérhető eszközök listája.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
hiba	sztring (null értékű)		No
id	karakterlánc	A lista egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
szerver_címke	karakterlánc	Az MCP-kiszolgáló címkéje.	Igen
tools	Az OpenAI.MCPListToolsTool tömbje	A kiszolgálón elérhető eszközök.	Igen
típus	felsorolás	Az elem típusa. Mindig mcp_list_tools. Lehetséges értékek: mcp_list_tools	Igen

OpenAI.OutputItemMcpToolCall

Eszköz meghívása egy MCP-kiszolgálón.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
approval_request_id	sztring (null értékű)		No
arguments	karakterlánc	Az eszköznek átadott argumentumok JSON-sztringje.	Igen
hiba	sztring (null értékű)		No
id	karakterlánc	Az eszközhívás egyedi azonosítója.	Igen
név	karakterlánc	A futtatott eszköz neve.	Igen
kimenet	sztring (null értékű)		No
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
szerver_címke	karakterlánc	Az eszközt futtató MCP-kiszolgáló címkéje.	Igen
állapot	OpenAI.MCPToolCallStatus		No
típus	felsorolás	Az elem típusa. Mindig mcp_call. Lehetséges értékek: mcp_call	Igen

OpenAI.OutputItemOutputMessage

A modell kimeneti üzenete.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
tartalom	Az OpenAI.OutputMessageContent tömbje	A kimeneti üzenet tartalma.	Igen
id	karakterlánc	A kimeneti üzenet egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
szerepkör	felsorolás	A kimeneti üzenet szerepe. Mindig assistant. Lehetséges értékek: assistant	Igen
állapot	felsorolás	Az üzenetbemenet állapota. Az egyik in_progress, completed, vagy incomplete. A bemeneti elemek API-val való visszaadásakor ki lesz töltve. Lehetséges értékek: in_progress, , completedincomplete	Igen
típus	felsorolás	A kimeneti üzenet típusa. Mindig message. Lehetséges értékek: output_message	Igen

OpenAI.OutputItemReasoningItem

Az érvelési modell által a válasz létrehozásakor használt gondolatlánc leírása. Ha manuálisan input, mindenképpen vegye fel ezeket az elemeket a Válasz API-ba a beszélgetés későbbi fordulataihoz.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
tartalom	OpenAI.ReasoningTextContent tömb	Szöveges tartalom érvelése.	No
encrypted_content	sztring (null értékű)		No
id	karakterlánc	Az érvelési tartalom egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	Az elem állapota. Az egyik in_progress, completed, vagy incomplete. Az elemek akkor vannak kitöltve, amikor az API-n keresztül visszaadásra kerülnek. Lehetséges értékek: in_progress, , completedincomplete	No
összegzés	OpenAI.Summary tömb	Az összegző tartalom indoklása.	Igen
típus	felsorolás	Az objektum típusa. Mindig reasoning. Lehetséges értékek: reasoning	Igen

OpenAI.OutputItemType

Property	Érték
Type	karakterlánc
Értékek	output_message file_search_call function_call web_search_call computer_call reasoning compaction image_generation_call code_interpreter_call local_shell_call shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_call mcp_list_tools mcp_approval_request custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.OutputItemWebSearchToolCall

Egy webes keresőeszköz hívásának eredményei. További információért tekintse meg a webes keresési útmutatót .

Name	Típus	Description	Szükséges	Alapértelmezett
művelet	OpenAI.WebSearchActionSearch vagy OpenAI.WebSearchActionOpenPage vagy OpenAI.WebSearchActionFind	A webes keresési hívásban végrehajtott konkrét műveletet leíró objektum. A modell webes használatáról (keresés, open_page, keresés) szóló részletes információkat tartalmaz.	Igen
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
id	karakterlánc	A webes keresőeszköz hívásának egyedi azonosítója.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	A webes keresőeszköz hívásának állapota. Lehetséges értékek: in_progress, searching, , completedfailed	Igen
típus	felsorolás	A webes keresőeszköz hívásának típusa. Mindig web_search_call. Lehetséges értékek: web_search_call	Igen

OpenAI.OutputMessageContent

Az OpenAI.OutputMessageContent diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.OutputMessageContentType		Igen

OpenAI.OutputMessageContentOutputTextContent

A modell szöveges kimenete.

Name	Típus	Description	Szükséges	Alapértelmezett
annotations	OpenAI.Annotation tömb	A szövegkimenet széljegyzetei.	Igen
logprobs	OpenAI.LogProb tömb		No
SMS	karakterlánc	A modell szöveges kimenete.	Igen
típus	felsorolás	A kimeneti szöveg típusa. Mindig output_text. Lehetséges értékek: output_text	Igen

OpenAI.OutputMessageContentRefusalContent

A modell elutasítása.

Name	Típus	Description	Szükséges	Alapértelmezett
visszautasítás	karakterlánc	A modell elutasítási magyarázata.	Igen
típus	felsorolás	Az elutasítás típusa. Mindig refusal. Lehetséges értékek: refusal	Igen

OpenAI.OutputMessageContentType

Property	Érték
Type	karakterlánc
Értékek	output_text refusal

OpenAI.Prompt

Hivatkozás egy parancssori sablonra és annak változóira. További információ.

Name	Típus	Description	Szükséges	Alapértelmezett
id	karakterlánc	A használni kívánt parancssori sablon egyedi azonosítója.	Igen
variables	OpenAI.ResponsePromptVariables (null értékű)	Választható értéktérkép, amelyet a változók helyettesítésére használhat a rendszerében. haladéktalan. A helyettesítési értékek lehetnek karakterláncok vagy mások Válaszbeviteli típusok, például képek vagy fájlok.	No
verzió	sztring (null értékű)		No

OpenAI.RankerVersionType

Property	Érték
Type	karakterlánc
Értékek	auto default-2024-11-15

OpenAI.RankingOptions

Name	Típus	Description	Szükséges	Alapértelmezett
hybrid_search	OpenAI.HybridSearchOptions		No
└─ embedding_weight	OpenAI.numerikus	A beágyazás súlya a kölcsönös rangsor fúzióban.	Igen
└─ text_weight	OpenAI.numerikus	A szöveg súlya a kölcsönös rangsor fúziójában.	Igen
rangsoroló	OpenAI.RankerVersionType		No
pontszám_küszöb	OpenAI.numerikus		No

OpenAI.Reasoning

csak gpt-5 és o-sorozatú modellek Az érvelési modellek konfigurációs beállításai.

Name	Típus	Description	Szükséges	Alapértelmezett
effort	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
generate_summary	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
összegzés	felsorolás	Lehetséges értékek: auto, , concisedetailed	No

OpenAI.ReasoningEffort

Korlátozza az érvelési modellek erőfeszítését. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Az érvelési erőfeszítések csökkentése gyorsabb válaszokat és kevesebb token használatát eredményezheti az érvelés során.

• gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak.
• Minden modell alapértelmezés szerint gpt-5.1 az érvelési medium munka, és nem támogatja none.
• A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket.
• xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.

Property	Érték
Type	karakterlánc
Nullable	Igen
Értékek	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

A modell szövegének érvelése.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell érvelési szövege.	Igen
típus	felsorolás	Az érvelési szöveg típusa. Mindig reasoning_text. Lehetséges értékek: reasoning_text	Igen

OpenAI.Response

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference (null értékű)		Igen
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
háttér	logikai (null értékű)		No
befejezve	egész szám		No
beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ azonosító	karakterlánc	A válaszhoz társított beszélgetés egyedi azonosítója.	Igen
létrehozás_időpontja	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ kód	OpenAI.ResponseErrorCode	A válasz hibakódja.	Igen
└─ üzenet	karakterlánc	A hiba ember által olvasható leírása.	Igen
id	karakterlánc	A válasz egyedi azonosítója.	Igen
incomplete_details	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ ok	felsorolás	Lehetséges értékek: max_output_tokens, content_filter	No
instructions	OpenAI.InputItem sztringje vagy tömbje		Igen
max_output_tokens	OpenAI.integer (null értékű)		No
max_eszköz_hívások	OpenAI.integer (null értékű)		No
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
output_text	sztring (null értékű)		No
párhuzamos_eszközhívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
previous_response_id	sztring (null értékű)		No
kér	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
reasoning	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
└─ összefoglaló generálása	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
└─ összegzés	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
szolgáltatási szint	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
hőmérséklet	OpenAI.numerikus (null értékű)		No	1
SMS	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
tool_choice	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
top_logprobs	OpenAI.integer (null értékű)		No
top_p	OpenAI.numerikus (null értékű)		No	1
truncation	felsorolás	Lehetséges értékek: auto, disabled	No
felhasználás	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No

OpenAI.ResponseAudioDeltaEvent

Részleges hangválasz esetén kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	A Base64 kódolású válasz hangbájtjainak egy darabja.	Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.audio.delta. Lehetséges értékek: response.audio.delta	Igen

OpenAI.ResponseAudioDoneEvent

A hangválasz befejezésekor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.audio.done. Lehetséges értékek: response.audio.done	Igen

OpenAI.ResponseAudioTranscriptDeltaEvent

Részleges hangátirat esetén kerül kibocsátásra.

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	A hangválasz részleges átirata.	Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.audio.transcript.delta. Lehetséges értékek: response.audio.transcript.delta	Igen

OpenAI.ResponseAudioTranscriptDoneEvent

A teljes hangátirat befejezésekor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.audio.transcript.done. Lehetséges értékek: response.audio.transcript.done	Igen

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Ki lesz bocsátva, ha a kódértelmező egy részleges kódrészletet streamel.

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	A kódértelmező által streamelt részleges kódrészlet.	Igen
item_id	karakterlánc	A kódértelmező eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.code_interpreter_call_code.delta. Lehetséges értékek: response.code_interpreter_call_code.delta	Igen

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Kibocsátva, ha a kódrészletet a kódértelmező véglegesíti.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	karakterlánc	A kódértelmező végső kódrészletének kimenete.	Igen
item_id	karakterlánc	A kódértelmező eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.code_interpreter_call_code.done. Lehetséges értékek: response.code_interpreter_call_code.done	Igen

OpenAI.ResponseCodeInterpreterCallCompletedEvent

A kódértelmező hívásának befejezésekor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A kódértelmező eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.code_interpreter_call.completed. Lehetséges értékek: response.code_interpreter_call.completed	Igen

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Kibocsátva, amikor a kódértelmező hívása folyamatban van.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A kódértelmező eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.code_interpreter_call.in_progress. Lehetséges értékek: response.code_interpreter_call.in_progress	Igen

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Kibocsátva, ha a kódértelmező aktívan értelmezi a kódrészletet.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A kódértelmező eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.code_interpreter_call.interpreting. Lehetséges értékek: response.code_interpreter_call.interpreting	Igen

OpenAI.ResponseCompletedEvent

A modell válaszának befejezésekor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
response	OpenAI.Response		Igen
└─ agent_reference	AgentReference (null értékű)	A válaszhoz használt ügynök	Igen
└─ háttér	logikai (null értékű)		No
└─ completed_at	egész szám (null értékű)		No
└─ beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ létrehozva_dátum	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
└─ hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ azonosító	karakterlánc	A válasz egyedi azonosítója.	Igen
└─ hiányos_részletek	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ utasítások	OpenAI.InputItem karakterlánca vagy tömbje (null értékű)		Igen
maximális_kimeneti_jegyek	OpenAI.integer (null értékű)		No
└─ max_tool_calls - eszköz maximális hívások száma	OpenAI.integer (null értékű)		No
└─ metaadatok	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
└─ modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
└─ objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
└─ kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
└─ kimeneti_szöveg	sztring (null értékű)		No
└─ párhuzamos_eszköz_hívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
└─ előző_válasz_azonosító	sztring (null értékű)		No
└─ parancssor	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
└─ prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
└─ prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
└─ érvelés	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
└─ service_tier	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
└─ állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No	1
└─ szöveg	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
└─ eszközválasztás	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
└─ eszközök	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
└─ top_logprobs (legnagyobb valószínűségi logaritmusok)	OpenAI.integer (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
└─ levágás	felsorolás	Lehetséges értékek: auto, disabled	No
└─ használat	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
└─ felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.completed. Lehetséges értékek: response.completed	Igen

OpenAI.ResponseContentPartAddedEvent

Új tartalomrész hozzáadásakor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelybe a tartalomrészt hozzáadták.	Igen
output_index	OpenAI.integer		Igen
part	OpenAI.OutputContent		Igen
└─ típus	OpenAI.OutputContentType		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.content_part.added. Lehetséges értékek: response.content_part.added	Igen

OpenAI.ResponseContentPartDoneEvent

Kibocsátva, amikor egy tartalomrész elkészül.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelybe a tartalomrészt hozzáadták.	Igen
output_index	OpenAI.integer		Igen
part	OpenAI.OutputContent		Igen
└─ típus	OpenAI.OutputContentType		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.content_part.done. Lehetséges értékek: response.content_part.done	Igen

OpenAI.ResponseCreatedEvent

A válasz létrehozásakor kibocsátott esemény.

Name	Típus	Description	Szükséges	Alapértelmezett
response	OpenAI.Response		Igen
└─ agent_reference	AgentReference (null értékű)	A válaszhoz használt ügynök	Igen
└─ háttér	logikai (null értékű)		No
└─ completed_at	egész szám (null értékű)		No
└─ beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ létrehozva_dátum	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
└─ hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ azonosító	karakterlánc	A válasz egyedi azonosítója.	Igen
└─ hiányos_részletek	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ utasítások	OpenAI.InputItem karakterlánca vagy tömbje (null értékű)		Igen
maximális_kimeneti_jegyek	OpenAI.integer (null értékű)		No
└─ max_tool_calls - eszköz maximális hívások száma	OpenAI.integer (null értékű)		No
└─ metaadatok	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
└─ modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
└─ objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
└─ kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
└─ kimeneti_szöveg	sztring (null értékű)		No
└─ párhuzamos_eszköz_hívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
└─ előző_válasz_azonosító	sztring (null értékű)		No
└─ parancssor	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
└─ prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
└─ prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
└─ érvelés	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
└─ service_tier	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
└─ állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No	1
└─ szöveg	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
└─ eszközválasztás	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
└─ eszközök	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
└─ top_logprobs (legnagyobb valószínűségi logaritmusok)	OpenAI.integer (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
└─ levágás	felsorolás	Lehetséges értékek: auto, disabled	No
└─ használat	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
└─ felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.created. Lehetséges értékek: response.created	Igen

OpenAI.ResponseCustomToolCallInputDeltaEvent

Az egyéni eszközhívás bemenetéhez tartozó változás (részleges frissítés) eseménye.

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	Az egyéni eszközhívás növekményes bemeneti adatai (delta).	Igen
item_id	karakterlánc	Az eseményhez társított API-elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az eseménytípus azonosítója. Lehetséges értékek: response.custom_tool_call_input.delta	Igen

OpenAI.ResponseCustomToolCallInputDoneEvent

Az egyéni eszközhívás bemenetét jelző esemény befejeződött.

Name	Típus	Description	Szükséges	Alapértelmezett
bevitel	karakterlánc	Az egyéni eszközhívás teljes bemeneti adatai.	Igen
item_id	karakterlánc	Az eseményhez társított API-elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az eseménytípus azonosítója. Lehetséges értékek: response.custom_tool_call_input.done	Igen

OpenAI.ResponseError

Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	OpenAI.ResponseErrorCode	A válasz hibakódja.	Igen
üzenet	karakterlánc	A hiba ember által olvasható leírása.	Igen

OpenAI.ResponseErrorCode

A válasz hibakódja.

Property	Érték
Type	karakterlánc
Értékek	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

Hiba esetén kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
kód	sztring (null értékű)		Igen
üzenet	karakterlánc	A hibaüzenet.	Igen
param	sztring (null értékű)		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig error. Lehetséges értékek: error	Igen

OpenAI.ResponseFailedEvent

Olyan esemény, amely akkor lesz kibocsátva, ha egy válasz meghiúsul.

Name	Típus	Description	Szükséges	Alapértelmezett
response	OpenAI.Response		Igen
└─ agent_reference	AgentReference (null értékű)	A válaszhoz használt ügynök	Igen
└─ háttér	logikai (null értékű)		No
└─ completed_at	egész szám (null értékű)		No
└─ beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ létrehozva_dátum	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
└─ hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ azonosító	karakterlánc	A válasz egyedi azonosítója.	Igen
└─ hiányos_részletek	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ utasítások	OpenAI.InputItem karakterlánca vagy tömbje (null értékű)		Igen
maximális_kimeneti_jegyek	OpenAI.integer (null értékű)		No
└─ max_tool_calls - eszköz maximális hívások száma	OpenAI.integer (null értékű)		No
└─ metaadatok	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
└─ modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
└─ objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
└─ kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
└─ kimeneti_szöveg	sztring (null értékű)		No
└─ párhuzamos_eszköz_hívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
└─ előző_válasz_azonosító	sztring (null értékű)		No
└─ parancssor	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
└─ prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
└─ prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
└─ érvelés	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
└─ service_tier	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
└─ állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No	1
└─ szöveg	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
└─ eszközválasztás	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
└─ eszközök	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
└─ top_logprobs (legnagyobb valószínűségi logaritmusok)	OpenAI.integer (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
└─ levágás	felsorolás	Lehetséges értékek: auto, disabled	No
└─ használat	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
└─ felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.failed. Lehetséges értékek: response.failed	Igen

OpenAI.ResponseFileSearchCallCompletedEvent

A fájlkeresési hívás befejezésekor (találatok) kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelyet a fájlkeresési hívás kezdeményez.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.file_search_call.completed. Lehetséges értékek: response.file_search_call.completed	Igen

OpenAI.ResponseFileSearchCallInProgressEvent

Fájlkeresési hívás indításakor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelyet a fájlkeresési hívás kezdeményez.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.file_search_call.in_progress. Lehetséges értékek: response.file_search_call.in_progress	Igen

OpenAI.ResponseFileSearchCallSearchingEvent

Ki van adva, amikor egy fájlkeresés éppen keres.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelyet a fájlkeresési hívás kezdeményez.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.file_search_call.searching. Lehetséges értékek: response.file_search_call.searching	Igen

OpenAI.ResponseFormatJsonObject

JSON-objektum válaszformátuma. Egy régebbi módszer JSON-válaszok létrehozására. A használatát json_schema az azt támogató modellek esetében javasoljuk. Vegye figyelembe, hogy a modell nem hoz létre JSON-t, hacsak egy rendszer vagy felhasználói üzenet nem utasítja erre.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A definiált válaszformátum típusa. Mindig json_object. Lehetséges értékek: json_object	Igen

OpenAI.ResponseFormatJsonSchema

JSON-séma válaszformátuma. Strukturált JSON-válaszok létrehozására szolgál. További információ a strukturált kimenetekről.

Name	Típus	Description	Szükséges	Alapértelmezett
JSON séma	OpenAI.ResponseFormatJsonSchemaJsonSchema		Igen
└─ leírás	karakterlánc		No
└─ név	karakterlánc		Igen
└─ séma	OpenAI.ResponseFormatJsonSchemaSchema	A válaszformátum sémája, amely JSON-sémaobjektumként van leírva. Itt megtudhatja, hogyan hozhat létre JSON-sémákat.	No
└─ szigorú	logikai (null értékű)		No
típus	felsorolás	A definiált válaszformátum típusa. Mindig json_schema. Lehetséges értékek: json_schema	Igen

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc		No
név	karakterlánc		Igen
séma	OpenAI.ResponseFormatJsonSchemaSchema	A válaszformátum sémája, amely JSON-sémaobjektumként van leírva. Itt megtudhatja, hogyan hozhat létre JSON-sémákat.	No
szigorú	logikai (null értékű)		No

OpenAI.ResponseFormatJsonSchemaSchema

A válaszformátum sémája, amely JSON-sémaobjektumként van leírva. Itt megtudhatja, hogyan hozhat létre JSON-sémákat.

Típus: objektum

OpenAI.ResponseFormatText

Alapértelmezett válaszformátum. Szöveges válaszok létrehozására szolgál.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A definiált válaszformátum típusa. Mindig text. Lehetséges értékek: text	Igen

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Részleges függvényhívási paraméterek változásának esetén kibocsátást generál.

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	A függvényhívás argumentumaihoz hozzáadott delta érték.	Igen
item_id	karakterlánc	A kimeneti elem azon azonosítója, amelyhez hozzáadódik a függvényhívási argumentumok delta értéke.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.function_call_arguments.delta. Lehetséges értékek: response.function_call_arguments.delta	Igen

OpenAI.ResponseFunctionCallArgumentsDoneEvent

A függvényhívási argumentumok véglegesítésekor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	A függvényhívás argumentumai.	Igen
item_id	karakterlánc	Az elem azonosítója.	Igen
név	karakterlánc	A rendezvény neve, amit elneveztek.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Lehetséges értékek: response.function_call_arguments.done	Igen

OpenAI.ResponseImageGenCallCompletedEvent

A rendszerképgenerálási eszköz hívásának befejezése után a végleges kép elérhetővé válik.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A feldolgozandó képgenerálási elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.image_generation_call.completed". Lehetséges értékek: response.image_generation_call.completed	Igen

OpenAI.ResponseImageGenCallGeneratingEvent

Kibocsátva, ha egy képgenerálási eszköz hívása aktívan létrehoz egy képet (köztes állapot).

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A feldolgozandó képgenerálási elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.image_generation_call.generating". Lehetséges értékek: response.image_generation_call.generating	Igen

OpenAI.ResponseImageGenCallInProgressEvent

Kibocsátásra kerül, amikor egy képgeneráló eszköz hívása folyamatban van.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A feldolgozandó képgenerálási elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig „response.image_generation_call.in_progress”. Lehetséges értékek: response.image_generation_call.in_progress	Igen

OpenAI.ResponseImageGenCallPartialImageEvent

Kibocsátva, ha részleges kép érhető el a képgenerálási streamelés során.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A feldolgozandó képgenerálási elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
partial_image_b64	karakterlánc	Base64 kódolású részleges képadatok, képként való megjelenítésre alkalmas.	Igen
partial_image_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.image_generation_call.partial_image". Lehetséges értékek: response.image_generation_call.partial_image	Igen

OpenAI.ResponseInProgressEvent

Kiadva, amíg a válasz folyamatban van.

Name	Típus	Description	Szükséges	Alapértelmezett
response	OpenAI.Response		Igen
└─ agent_reference	AgentReference (null értékű)	A válaszhoz használt ügynök	Igen
└─ háttér	logikai (null értékű)		No
└─ completed_at	egész szám (null értékű)		No
└─ beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ létrehozva_dátum	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
└─ hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ azonosító	karakterlánc	A válasz egyedi azonosítója.	Igen
└─ hiányos_részletek	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ utasítások	OpenAI.InputItem karakterlánca vagy tömbje (null értékű)		Igen
maximális_kimeneti_jegyek	OpenAI.integer (null értékű)		No
└─ max_tool_calls - eszköz maximális hívások száma	OpenAI.integer (null értékű)		No
└─ metaadatok	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
└─ modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
└─ objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
└─ kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
└─ kimeneti_szöveg	sztring (null értékű)		No
└─ párhuzamos_eszköz_hívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
└─ előző_válasz_azonosító	sztring (null értékű)		No
└─ parancssor	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
└─ prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
└─ prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
└─ érvelés	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
└─ service_tier	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
└─ állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No	1
└─ szöveg	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
└─ eszközválasztás	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
└─ eszközök	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
└─ top_logprobs (legnagyobb valószínűségi logaritmusok)	OpenAI.integer (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
└─ levágás	felsorolás	Lehetséges értékek: auto, disabled	No
└─ használat	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
└─ felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.in_progress. Lehetséges értékek: response.in_progress	Igen

OpenAI.ResponseIncompleteDetails

Name	Típus	Description	Szükséges	Alapértelmezett
ok	felsorolás	Lehetséges értékek: max_output_tokens, content_filter	No

OpenAI.ResponseIncompleteEvent

Olyan esemény, amely akkor lesz kibocsátva, ha egy válasz befejezetlenként fejeződik be.

Name	Típus	Description	Szükséges	Alapértelmezett
response	OpenAI.Response		Igen
└─ agent_reference	AgentReference (null értékű)	A válaszhoz használt ügynök	Igen
└─ háttér	logikai (null értékű)		No
└─ completed_at	egész szám (null értékű)		No
└─ beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ létrehozva_dátum	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
└─ hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ azonosító	karakterlánc	A válasz egyedi azonosítója.	Igen
└─ hiányos_részletek	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ utasítások	OpenAI.InputItem karakterlánca vagy tömbje (null értékű)		Igen
maximális_kimeneti_jegyek	OpenAI.integer (null értékű)		No
└─ max_tool_calls - eszköz maximális hívások száma	OpenAI.integer (null értékű)		No
└─ metaadatok	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
└─ modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
└─ objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
└─ kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
└─ kimeneti_szöveg	sztring (null értékű)		No
└─ párhuzamos_eszköz_hívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
└─ előző_válasz_azonosító	sztring (null értékű)		No
└─ parancssor	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
└─ prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
└─ prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
└─ érvelés	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
└─ service_tier	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
└─ állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No	1
└─ szöveg	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
└─ eszközválasztás	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
└─ eszközök	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
└─ top_logprobs (legnagyobb valószínűségi logaritmusok)	OpenAI.integer (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
└─ levágás	felsorolás	Lehetséges értékek: auto, disabled	No
└─ használat	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
└─ felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.incomplete. Lehetséges értékek: response.incomplete	Igen

OpenAI.ResponseLogProb

A logprob az a logaritmikus valószínűség, amelyet a modell hozzárendel egy adott token előállításához a sorozat adott helyén. A kevésbé negatív (magasabb) logprob értékek nagyobb modellbizalmat jeleznek ebben a jogkivonat-választásban.

Name	Típus	Description	Szükséges	Alapértelmezett
logprob	OpenAI.numerikus		Igen
kód	karakterlánc	Lehetséges szöveges jogkivonat.	Igen
top_logprobs	OpenAI.ResponseLogProbTopLogprobs tömb	A 20 legnagyobb valószínűséggel használt token naplózási valószínűsége.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Típus	Description	Szükséges	Alapértelmezett
logprob	OpenAI.numerikus		No
kód	karakterlánc		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Kibocsátott jelzés, amikor egy MCP-eszköz hívásának argumentumai módosulnak (részleges frissítés).

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	Egy JSON-sztring, amely az MCP eszközhívás argumentumainak részleges frissítését tartalmazza.	Igen
item_id	karakterlánc	A feldolgozandó MCP-eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.mcp_call_arguments.delta". Lehetséges értékek: response.mcp_call_arguments.delta	Igen

OpenAI.ResponseMCPCallArgumentsDoneEvent

Az MCP-eszközhívás argumentumainak véglegesítésekor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
arguments	karakterlánc	Az MCP eszközhívás véglegesített argumentumait tartalmazó JSON-sztring.	Igen
item_id	karakterlánc	A feldolgozandó MCP-eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.mcp_call_arguments.done". Lehetséges értékek: response.mcp_call_arguments.done	Igen

OpenAI.ResponseMCPCallCompletedEvent

A rendszer akkor bocsátja ki, ha egy MCP-eszköz hívása sikeresen befejeződött.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A befejezett MCP-eszközhívási elem azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.mcp_call.completed". Lehetséges értékek: response.mcp_call.completed	Igen

OpenAI.ResponseMCPCallFailedEvent

Kibocsátva, ha egy MCP-eszköz hívása meghiúsult.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A sikertelen MCP-eszközhívási elem azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.mcp_call.failed". Lehetséges értékek: response.mcp_call.failed	Igen

OpenAI.ResponseMCPCallInProgressEvent

Kibocsátva, ha egy MCP-eszköz hívása folyamatban van.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A feldolgozandó MCP-eszköz híváselemének egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.mcp_call.in_progress". Lehetséges értékek: response.mcp_call.in_progress	Igen

OpenAI.ResponseMCPListToolsCompletedEvent

A rendszer az elérhető MCP-eszközök sikeres lekérése után bocsátja ki.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Az mcp eszköz hívási elemének azonosítója, amely ezt a kimenetet hozta létre.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.mcp_list_tools.completed". Lehetséges értékek: response.mcp_list_tools.completed	Igen

OpenAI.ResponseMCPListToolsFailedEvent

Ki lett bocsátva, ha az elérhető MCP-eszközök listázására tett kísérlet meghiúsult.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A sikertelen MCP-eszközhívási elem azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig „response.mcp_list_tools.failed”. Lehetséges értékek: response.mcp_list_tools.failed	Igen

OpenAI.ResponseMCPListToolsInProgressEvent

Kibocsátva, amikor a rendszer az elérhető MCP-eszközök listájának lekérése folyamatban van.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A feldolgozandó MCP-eszköz híváselemének azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig a "response.mcp_list_tools.in_progress". Lehetséges értékek: response.mcp_list_tools.in_progress	Igen

OpenAI.ResponseOutputItemAddedEvent

Új kimeneti elem hozzáadásakor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
elem	OpenAI.OutputItem		Igen
└─ agent_reference	AgentReference	Az elemet létrehozó ügynök.	No
└─ response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
└─ típus	OpenAI.OutputItemType		Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.output_item.added. Lehetséges értékek: response.output_item.added	Igen

OpenAI.ResponseOutputItemDoneEvent

Kibocsátva, ha a kimeneti elem készként van megjelölve.

Name	Típus	Description	Szükséges	Alapértelmezett
elem	OpenAI.OutputItem		Igen
└─ agent_reference	AgentReference	Az elemet létrehozó ügynök.	No
└─ response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
└─ típus	OpenAI.OutputItemType		Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.output_item.done. Lehetséges értékek: response.output_item.done	Igen

OpenAI.ResponseOutputTextAnnotationAddedEvent

Kibocsátva, ha a kimeneti szöveges tartalomhoz széljegyzetet ad hozzá.

Name	Típus	Description	Szükséges	Alapértelmezett
jegyzet	OpenAI.Annotation	Egy széljegyzet, amely a kimeneti szöveg spanjára vonatkozik.	Igen
└─ típus	OpenAI.AnnotationType		Igen
annotation_index	OpenAI.integer		Igen
content_index	OpenAI.integer		Igen
item_id	karakterlánc	Annak az elemnek az egyedi azonosítója, amelyhez a megjegyzés hozzá van adva.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig "response.output_text.annotation.added". Lehetséges értékek: response.output_text.annotation.added	Igen

OpenAI.ResponsePromptVariables

A változók helyett választható értéktérkép a parancssorban. A helyettesítési értékek lehetnek sztringek vagy más válasz típusú bemenetek, például képek vagy fájlok.

Típus: objektum

OpenAI.ResponseQueuedEvent

A válasz várólistára helyezése és a feldolgozásra váró válasz küldése.

Name	Típus	Description	Szükséges	Alapértelmezett
response	OpenAI.Response		Igen
└─ agent_reference	AgentReference (null értékű)	A válaszhoz használt ügynök	Igen
└─ háttér	logikai (null értékű)		No
└─ completed_at	egész szám (null értékű)		No
└─ beszélgetés	OpenAI.ConversationReference (null értékű)	A beszélgetés, amelyhez ez a válasz tartozott. A válaszból származó bemeneti elemek és kimeneti elemek automatikusan hozzáadva lettek ehhez a beszélgetéshez.	No
└─ létrehozva_dátum	egész szám	Unix időbélyeg (másodpercben) a válasz létrehozásának időpontjáról.	Igen
└─ hiba	OpenAI.ResponseError (null értékű)	Hibaobjektum, amely akkor jelenik meg, ha a modell nem tud választ létrehozni.	Igen
└─ azonosító	karakterlánc	A válasz egyedi azonosítója.	Igen
└─ hiányos_részletek	OpenAI.ResponseIncompleteDetails (null értékű)		Igen
└─ utasítások	OpenAI.InputItem karakterlánca vagy tömbje (null értékű)		Igen
maximális_kimeneti_jegyek	OpenAI.integer (null értékű)		No
└─ max_tool_calls - eszköz maximális hívások száma	OpenAI.integer (null értékű)		No
└─ metaadatok	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
└─ modell	karakterlánc	A válasz létrehozásához használandó modelltelepítés.	No
└─ objektum	felsorolás	Az erőforrás objektumtípusa – mindig a következőre responsevan állítva: . Lehetséges értékek: response	Igen
└─ kimenet	OpenAI.OutputItem tömb	A modell által létrehozott tartalomelemek tömbje. - A tömb elemeinek output hossza és sorrendje függ a modell válaszára. - Ahelyett, hogy hozzáférnénk a tömb output első eleméhez feltéve, hogy ez egy assistant üzenet, amely a következő által létrehozott tartalmat tartalmazza: Érdemes lehet használni a output_text tulajdonságot a modellnél, ahol SDK-kban támogatott.	Igen
└─ kimeneti_szöveg	sztring (null értékű)		No
└─ párhuzamos_eszköz_hívások	boolean	Lehetővé teszi-e a modell számára az eszközhívások párhuzamos futtatását.	Igen	True
└─ előző_válasz_azonosító	sztring (null értékű)		No
└─ parancssor	OpenAI.Prompt	Hivatkozás egy parancssori sablonra és annak változóira. További információ.	No
└─ prompt_cache_key	karakterlánc	Az OpenAI a hasonló kérések válaszainak gyorsítótárazásához használja a gyorsítótár-találatok arányának optimalizálásához. Lecseréli a user mezőt. További információ.	No
└─ prompt_cache_retention	felsorolás	Lehetséges értékek: in-memory, 24h	No
└─ érvelés	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ safety_identifier	karakterlánc	Egy stabil azonosító, amely segít észlelni az alkalmazás azon felhasználóit, amelyek megsérthetik az OpenAI használati szabályzatait. Az azonosítóknak olyan sztringnek kell lenniük, amely egyedileg azonosítja az egyes felhasználókat. Javasoljuk, hogy kivonatozza a felhasználónevét vagy e-mail-címét, hogy ne küldjön nekünk azonosító adatokat. További információ.	No
└─ service_tier	OpenAI.ServiceTier	Megadja a kérés kiszolgálásához használt feldolgozási típust. - Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításaiban konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni. - Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel. - Ha "flex" vagy "prioritás" értékre van állítva, a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva. - Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.	No
└─ állapot	felsorolás	A válaszgenerálás állapota. Az egyik completed, failed in_progress, cancelled,, queued vagy incomplete. Lehetséges értékek: completed, failed, in_progress, cancelled, queuedincomplete	No
└─ hőmérséklet	OpenAI.numerikus (null értékű)		No	1
└─ szöveg	OpenAI.ResponseTextParam	A modell szöveges válaszának konfigurációs beállításai. Lehet egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet: - Szöveges bemenetek és kimenetek - Strukturált kimenetek	No
└─ eszközválasztás	OpenAI.ToolChoiceOptions vagy OpenAI.ToolChoiceParam		No
└─ eszközök	OpenAI.ToolsArray	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk: - Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a a modell képességei, például a webes keresés vagy fájlkeresést. További információ beépített eszközök. - MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon keresztül vagy előre definiált összekötők, például a Google Drive és a SharePoint. További információ MCP-eszközök. - Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, lehetővé teszi a modell számára, hogy erősen beírt argumentumokkal hívja meg a saját kódját és kimenetek. További információ függvényhívás. Használhatja egyéni eszközök a saját kód meghívásához.	No
└─ top_logprobs (legnagyobb valószínűségi logaritmusok)	OpenAI.integer (null értékű)		No
└─ top_p	OpenAI.numerikus (null értékű)		No	1
└─ levágás	felsorolás	Lehetséges értékek: auto, disabled	No
└─ használat	OpenAI.ResponseUsage	Tokenek használati adatait jelöli, beleértve a bemeneti tokeneket, a kimeneti tokeneket. a kimeneti jogkivonatok és a felhasznált összes jogkivonat lebontása.	No
└─ felhasználó	sztring (elavult)	Ezt a mezőt felváltja safety_identifier az and prompt_cache_key. A gyorsítótárazási optimalizálás fenntartása helyett használja prompt_cache_key . A végfelhasználók stabil azonosítója. A gyorsítótár-találatok arányának növeléséhez használható a hasonló kérések jobb gyűjtőbe helyezésével, valamint az OpenAI-nak a visszaélések észlelésében és megelőzésében. További információ.	No
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig „response.queued”. Lehetséges értékek: response.queued	Igen

OpenAI.ResponseReasoningSummaryPartAddedEvent

Új érvelési összefoglaló rész hozzáadásakor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Annak az elemnek az azonosítója, amelyhez ez az összefoglaló rész hozzá van rendelve.	Igen
output_index	OpenAI.integer		Igen
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Igen
└─ szöveg	karakterlánc		Igen
└─ típus	felsorolás	Lehetséges értékek: summary_text	Igen
sequence_number	OpenAI.integer		Igen
summary_index	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.reasoning_summary_part.added. Lehetséges értékek: response.reasoning_summary_part.added	Igen

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc		Igen
típus	felsorolás	Lehetséges értékek: summary_text	Igen

OpenAI.ResponseReasoningSummaryPartDoneEvent

Az indokolás összefoglaló részének befejezésekor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Annak az elemnek az azonosítója, amelyhez ez az összefoglaló rész hozzá van rendelve.	Igen
output_index	OpenAI.integer		Igen
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Igen
└─ szöveg	karakterlánc		Igen
└─ típus	felsorolás	Lehetséges értékek: summary_text	Igen
sequence_number	OpenAI.integer		Igen
summary_index	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.reasoning_summary_part.done. Lehetséges értékek: response.reasoning_summary_part.done	Igen

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc		Igen
típus	felsorolás	Lehetséges értékek: summary_text	Igen

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Kibocsátva, ha a rendszer hozzáad egy eltérést egy érvelési összefoglaló szöveghez.

Name	Típus	Description	Szükséges	Alapértelmezett
delta	karakterlánc	Az összegzéshez hozzáadott szöveg módosítása.	Igen
item_id	karakterlánc	Annak az elemnek az azonosítója, amelyhez az összefoglaló szöveg különbözete hozzá van rendelve.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
summary_index	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.reasoning_summary_text.delta. Lehetséges értékek: response.reasoning_summary_text.delta	Igen

OpenAI.ResponseReasoningSummaryTextDoneEvent

Az érvelés összegzési szövegének befejezésekor ki lesz bocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	Annak az elemnek az azonosítója, amelyhez az összefoglaló szöveg társítva van.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
summary_index	OpenAI.integer		Igen
SMS	karakterlánc	A befejezett érvelés összegzésének teljes szövege.	Igen
típus	felsorolás	Az esemény típusa. Mindig response.reasoning_summary_text.done. Lehetséges értékek: response.reasoning_summary_text.done	Igen

OpenAI.ResponseReasoningTextDeltaEvent

Kibocsátva, ha a rendszer hozzáad egy eltérést egy érvelési szöveghez.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
delta	karakterlánc	Az érvelési tartalomhoz hozzáadott szöveg eltérése.	Igen
item_id	karakterlánc	Annak az elemnek az azonosítója, amelyhez az érvelési szöveg eltérése hozzá van rendelve.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.reasoning_text.delta. Lehetséges értékek: response.reasoning_text.delta	Igen

OpenAI.ResponseReasoningTextDoneEvent

Egy érvelési szöveg befejezésekor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
item_id	karakterlánc	Annak az elemnek az azonosítója, amelyhez az érvelési szöveg társítva van.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
SMS	karakterlánc	A befejezett érvelési tartalom teljes szövege.	Igen
típus	felsorolás	Az esemény típusa. Mindig response.reasoning_text.done. Lehetséges értékek: response.reasoning_text.done	Igen

OpenAI.ResponseRefusalDeltaEvent

Részleges elutasítási szöveg esetén kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
delta	karakterlánc	A hozzáadott elutasítási szöveg.	Igen
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelybe a visszautasító szöveg bekerül.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.refusal.delta. Lehetséges értékek: response.refusal.delta	Igen

OpenAI.ResponseRefusalDoneEvent

A visszautasító szöveg véglegesítésekor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
item_id	karakterlánc	Az azonosítója annak a kimeneti elemnek, amelyhez az elutasító szöveg véglegesítve van.	Igen
output_index	OpenAI.integer		Igen
visszautasítás	karakterlánc	A véglegesített elutasítási szöveg.	Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.refusal.done. Lehetséges értékek: response.refusal.done	Igen

OpenAI.ResponseStreamOptions

A streamelési válaszok beállításai. Ezt csak akkor állítsa be, ha be van állítva stream: true.

Name	Típus	Description	Szükséges	Alapértelmezett
include_obfuscation	boolean	Amikor igaz, a stream elhomályosítása engedélyezve lesz. Stream elhomályosítás hozzáad véletlenszerű karaktereket egy obfuscation olyan mezőre, amely a deltaesemények streamelésére szolgál normalizálja a hasznos adatméreteket bizonyos oldalcsatornás támadások mérsékléseként. Ezek az eltömítési mezők alapértelmezés szerint szerepelnek, de kis mennyiségű az adatfolyamra háruló többletterhelés. Beállíthatja include_obfuscation , hogy hamis a sávszélességre való optimalizáláshoz, ha megbízik a és az OpenAI API-t.	No

OpenAI.ResponseTextDeltaEvent

Kibocsátva, ha további szöveges változás áll fenn.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
delta	karakterlánc	A hozzáadott szöveg eltérése.	Igen
item_id	karakterlánc	Annak a kimeneti elemnek az azonosítója, amelybe a szöveg különbözetét hozzáadták.	Igen
logprobs	Az OpenAI.ResponseLogProb tömbje	A változásban lévő tokenek naplós valószínűségei.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.output_text.delta. Lehetséges értékek: response.output_text.delta	Igen

OpenAI.ResponseTextDoneEvent

A szöveges tartalom véglegesítésekor lesz kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
content_index	OpenAI.integer		Igen
item_id	karakterlánc	Az azonosítója annak a kimeneti elemnek, amelyhez a szöveges tartalom véglegesítése tartozik.	Igen
logprobs	Az OpenAI.ResponseLogProb tömbje	A változásban lévő tokenek naplós valószínűségei.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
SMS	karakterlánc	A véglegesített szöveges tartalom.	Igen
típus	felsorolás	Az esemény típusa. Mindig response.output_text.done. Lehetséges értékek: response.output_text.done	Igen

OpenAI.ResponseTextParam

A modell szöveges válaszának konfigurációs beállításai. Lehetnek egyszerű szöveges vagy strukturált JSON-adatok. Tudj meg többet:

• Szöveges bemenetek és kimenetek
• Strukturált kimenetek

Name	Típus	Description	Szükséges	Alapértelmezett
format	OpenAI.TextResponseFormatConfiguration	Egy objektum, amely megadja a modell által kiadandó formátumot. A konfigurálás { "type": "json_schema" } lehetővé teszi a strukturált kimeneteket, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. Tudjon meg többet itt: Az alapértelmezett formátum { "type": "text" } nem nyújt további beállításokat. *Nem ajánlott gpt-4o és újabb modellek esetén:** Beállítás a { "type": "json_object" } régebbi JSON módot engedélyezi. biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Az json_schema használata az azt támogató modellek esetében előnyben részesítik.	No
Bőbeszédűség	OpenAI.Részletesség	Korlátozza a modell válaszának részletességét. Az alacsonyabb értékek a következőt eredményezik: tömörebb válaszok, míg a magasabb értékek részletesebb válaszokat eredményeznek. Jelenleg a támogatott értékek a következőklow: és mediumhigh.	No

OpenAI.ResponseUsage

A jogkivonatok használati adatait jeleníti meg, beleértve a bemeneti jogkivonatokat, a kimeneti jogkivonatokat, a kimeneti jogkivonatok lebontását és a felhasznált összes jogkivonatot.

Name	Típus	Description	Szükséges	Alapértelmezett
input_tokens	OpenAI.integer		Igen
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Igen
└─ tárolt tokenek	OpenAI.integer		Igen
output_tokens	OpenAI.integer		Igen
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Igen
└─ érvelési tokenek	OpenAI.integer		Igen
total_tokens	OpenAI.integer		Igen

OpenAI.ResponseUsageInputTokensDetails

Name	Típus	Description	Szükséges	Alapértelmezett
cached_tokens	OpenAI.integer		Igen

OpenAI.ResponseUsageOutputTokensDetails

Name	Típus	Description	Szükséges	Alapértelmezett
érvelési_elemek	OpenAI.integer		Igen

OpenAI.ResponseWebSearchCallCompletedEvent

A webkeresési hívás befejezésekor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A webes keresési híváshoz társított kimeneti elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.web_search_call.completed. Lehetséges értékek: response.web_search_call.completed	Igen

OpenAI.ResponseWebSearchCallInProgressEvent

Webes keresési hívás indításakor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A webes keresési híváshoz társított kimeneti elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.web_search_call.in_progress. Lehetséges értékek: response.web_search_call.in_progress	Igen

OpenAI.ResponseWebSearchCallSearchingEvent

Egy webes keresési hívás végrehajtásakor kibocsátva.

Name	Típus	Description	Szükséges	Alapértelmezett
item_id	karakterlánc	A webes keresési híváshoz társított kimeneti elem egyedi azonosítója.	Igen
output_index	OpenAI.integer		Igen
sequence_number	OpenAI.integer		Igen
típus	felsorolás	Az esemény típusa. Mindig response.web_search_call.searching. Lehetséges értékek: response.web_search_call.searching	Igen

OpenAI.Screenshot

Képernyőkép művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Megadja az esemény típusát. Képernyőkép-művelet esetén ez a tulajdonság mindig screenshot-ra van állítva. Lehetséges értékek: screenshot	Igen

OpenAI.Scroll

Görgetési művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
scroll_x	OpenAI.integer		Igen
scroll_y	OpenAI.integer		Igen
típus	felsorolás	Megadja az esemény típusát. Görgetési művelet esetén ez a tulajdonság mindig scroll-ra van állítva. Lehetséges értékek: scroll	Igen
x	OpenAI.integer		Igen
y	OpenAI.integer		Igen

OpenAI.SearchContextSize

Property	Érték
Type	karakterlánc
Értékek	low medium high

OpenAI.ServiceTier

Megadja a kérés kiszolgálásához használt feldolgozási típust.

• Ha az "automatikus" értékre van állítva, akkor a kérés a Project beállításai között konfigurált szolgáltatási szinttel lesz feldolgozva. Ha másként nincs konfigurálva, a Project az "alapértelmezett" értéket fogja használni.
• Ha az alapértelmezett értékre van állítva, a rendszer a kérést a kiválasztott modell standard díjszabásával és teljesítményével dolgozza fel.
• Ha "flex" vagy "priority" értékre van állítva, akkor a kérés a megfelelő szolgáltatási szinttel lesz feldolgozva.
• Ha nincs beállítva, az alapértelmezett viselkedés az "auto". Ha a service_tier paraméter be van állítva, a válasz törzse tartalmazni fogja a service_tier kérés kiszolgálásához ténylegesen használt feldolgozási módon alapuló értéket. Ez a válaszérték eltérhet a paraméterben beállított értéktől.

Property	Érték
Type	karakterlánc
Nullable	Igen
Értékek	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

Kényszeríti a modellt, hogy meghívja a apply_patch eszközt egy eszközhívás végrehajtásakor.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A hívandó eszköz. Mindig apply_patch. Lehetséges értékek: apply_patch	Igen

OpenAI.SpecificFunctionShellParam

Kényszeríti a modellt, hogy meghívja a rendszerhéj-eszközt, amikor szükség van egy eszközhívásra.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A hívandó eszköz. Mindig shell. Lehetséges értékek: shell	Igen

OpenAI.Summary

A modell összefoglaló szövege.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell eddigi érvelési kimenetének összegzése.	Igen
típus	felsorolás	Az objektum típusa. Mindig summary_text. Lehetséges értékek: summary_text	Igen

OpenAI.SummaryTextContent

A modell összefoglaló szövege.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A modell eddigi érvelési kimenetének összegzése.	Igen
típus	felsorolás	Az objektum típusa. Mindig summary_text. Lehetséges értékek: summary_text	Igen

OpenAI.TextContent

Szöveges tartalom.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc		Igen
típus	felsorolás	Lehetséges értékek: text	Igen

OpenAI.TextResponseFormatConfiguration

Egy objektum, amely megadja a modell által kiadandó formátumot. A konfigurálás { "type": "json_schema" } lehetővé teszi a strukturált kimeneteket, ami biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. Tudjon meg többet itt:

Az alapértelmezett formátum { "type": "text" } nem nyújt további beállításokat. A gpt-4o és újabb modellek esetében nem ajánlott:* A { "type": "json_object" } régebbi JSON mód engedélyezése, amely biztosítja, hogy a modell által generált üzenet érvényes JSON-alapú legyen. Az azt támogató modelleknél előnyben részesítik a használatot json_schema .

Az OpenAI.TextResponseFormatConfiguration diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.TextResponseFormatConfigurationType		Igen

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON-objektum válaszformátuma. Egy régebbi módszer JSON-válaszok létrehozására. A használatát json_schema az azt támogató modellek esetében javasoljuk. Vegye figyelembe, hogy a modell nem hoz létre JSON-t, hacsak egy rendszer vagy felhasználói üzenet nem utasítja erre.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A definiált válaszformátum típusa. Mindig json_object. Lehetséges értékek: json_object	Igen

OpenAI.TextResponseFormatConfigurationResponseFormatText

Alapértelmezett válaszformátum. Szöveges válaszok létrehozására szolgál.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A definiált válaszformátum típusa. Mindig text. Lehetséges értékek: text	Igen

OpenAI.TextResponseFormatConfigurationType

Property	Érték
Type	karakterlánc
Értékek	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON-séma válaszformátuma. Strukturált JSON-válaszok létrehozására szolgál. További információ a strukturált kimenetekről.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	A modell által használt válaszformátum leírása határozza meg, hogyan válaszoljon a formátum szerint.	No
név	karakterlánc	A válaszformátum neve. A következőknek kell lennie: a-z, A-Z, 0-9 vagy tartalmaznia kell azokat. aláhúzásjelek és kötőjelek, legfeljebb 64 karakter hosszúságban.	Igen
séma	OpenAI.ResponseFormatJsonSchemaSchema	A válaszformátum sémája, amely JSON-sémaobjektumként van leírva. Itt megtudhatja, hogyan hozhat létre JSON-sémákat.	Igen
szigorú	logikai (null értékű)		No
típus	felsorolás	A definiált válaszformátum típusa. Mindig json_schema. Lehetséges értékek: json_schema	Igen

OpenAI.Tool

A válasz létrehozásához használható eszköz.

Az OpenAI.Tool diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
bing_grounding	BingGroundingTool
fabric_dataagent_preview	MicrosoftFabricPreviewTool
sharepoint_grounding_preview	SharepointPreviewTool
azure_ai_search	AzureAISearchTool
openapi	OpenApiTool
bing_custom_search_preview	BingCustomSearchPreviewTool
browser_automation_preview	BrowserAutomationPreviewTool
azure_function	AzureFunctionTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2APreviewTool
memory_search_preview	MemorySearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search	OpenAI.WebSearchTool
mcp	OpenAI.MCPTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellToolParam
shell	OpenAI.FunctionShellToolParam
custom	OpenAI.CustomToolParam
web_search_preview	OpenAI.WebSearchPreviewTool
apply_patch	OpenAI.ApplyPatchToolParam

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ToolType		Igen

OpenAI.ToolChoiceAllowed

A modell számára elérhető eszközöket egy előre definiált készletre korlátozza.

Name	Típus	Description	Szükséges	Alapértelmezett
mode	felsorolás	A modell számára elérhető eszközöket egy előre definiált készletre korlátozza. auto lehetővé teszi a modell számára, hogy válasszon az engedélyezett eszközök közül, és létrehoz egy üzenet. required megköveteli, hogy a modell meghívjon egy vagy több engedélyezett eszközt. Lehetséges értékek: auto, required	Igen
tools	objektumtömb	A modell által meghívható eszközdefiníciók listája. A Responses API esetében az eszközdefiníciók listája a következőképpen nézhet ki: json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>	Igen
típus	felsorolás	Engedélyezett eszközkonfiguráció típusa. Mindig allowed_tools. Lehetséges értékek: allowed_tools	Igen

OpenAI.ToolChoiceCodeInterpreter

Azt jelzi, hogy a modellnek egy beépített eszközt kell használnia a válasz létrehozásához. További információ a beépített eszközökről.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: code_interpreter	Igen

OpenAI.ToolChoiceComputerUsePreview

Azt jelzi, hogy a modellnek egy beépített eszközt kell használnia a válasz létrehozásához. További információ a beépített eszközökről.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: computer_use_preview	Igen

OpenAI.ToolChoiceCustom

Ezzel a beállítással kényszerítse a modellt egy adott egyéni eszköz meghívására.

Name	Típus	Description	Szükséges	Alapértelmezett
név	karakterlánc	A meghívandó egyéni eszköz neve.	Igen
típus	felsorolás	Egyéni eszközhívás esetén a típus mindig customaz . Lehetséges értékek: custom	Igen

OpenAI.ToolChoiceFileSearch

Azt jelzi, hogy a modellnek egy beépített eszközt kell használnia a válasz létrehozásához. További információ a beépített eszközökről.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: file_search	Igen

OpenAI.ToolChoiceFunction

Ezzel a beállítással kényszerítse a modellt egy adott függvény meghívására.

Name	Típus	Description	Szükséges	Alapértelmezett
név	karakterlánc	A meghívandó függvény neve.	Igen
típus	felsorolás	Függvényhívás esetén a típus mindig function. Lehetséges értékek: function	Igen

OpenAI.ToolChoiceImageGeneration

Azt jelzi, hogy a modellnek egy beépített eszközt kell használnia a válasz létrehozásához. További információ a beépített eszközökről.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: image_generation	Igen

OpenAI.ToolChoiceMCP

Ezzel a beállítással kényszerítse a modellt arra, hogy egy távoli MCP-kiszolgálón meghívjon egy adott eszközt.

Name	Típus	Description	Szükséges	Alapértelmezett
név	sztring (null értékű)		No
szerver_címke	karakterlánc	A használni kívánt MCP-kiszolgáló címkéje.	Igen
típus	felsorolás	Az MCP-eszközök esetében a típus mindig mcp. Lehetséges értékek: mcp	Igen

OpenAI.ToolChoiceOptions

Azt szabályozza, hogy a modell melyik eszközt hívja meg (ha van ilyen). none azt jelenti, hogy a modell nem hív meg egyetlen eszközt sem, és ehelyett létrehoz egy üzenetet. auto azt jelenti, hogy a modell választhat egy üzenet létrehozása vagy egy vagy több eszköz meghívása között. required azt jelenti, hogy a modellnek egy vagy több eszközt kell meghívnia.

Property	Érték
Type	karakterlánc
Értékek	none auto required

OpenAI.ToolChoiceParam

Hogyan válassza ki a modell a válasz létrehozásakor használni kívánt eszközt (vagy eszközöket). A paraméterből tools megtudhatja, hogyan adhatja meg, hogy a modell mely eszközöket hívhatja meg.

Az OpenAI.ToolChoiceParam diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
allowed_tools	OpenAI.ToolChoiceAllowed
function	OpenAI.ToolChoiceFunction
mcp	OpenAI.ToolChoiceMCP
custom	OpenAI.ToolChoiceCustom
apply_patch	OpenAI.SpecificApplyPatchParam
shell	OpenAI.SpecificFunctionShellParam
file_search	OpenAI.ToolChoiceFileSearch
web_search_preview	OpenAI.ToolChoiceWebSearchPreview
computer_use_preview	OpenAI.ToolChoiceComputerUsePreview
web_search_preview_2025_03_11	OpenAI.ToolChoiceWebSearchPreview20250311
image_generation	OpenAI.ToolChoiceImageGeneration
code_interpreter	OpenAI.ToolChoiceCodeInterpreter

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenAI.ToolChoiceParamType		Igen

OpenAI.ToolChoiceParamType

Property	Érték
Type	karakterlánc
Értékek	allowed_tools function mcp custom apply_patch shell file_search web_search_preview computer_use_preview web_search_preview_2025_03_11 image_generation code_interpreter

OpenAI.ToolChoiceWebSearchPreview

Azt jelzi, hogy a modellnek egy beépített eszközt kell használnia a válasz létrehozásához. További információ a beépített eszközökről.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: web_search_preview	Igen

OpenAI.ToolChoiceWebSearchPreview20250311

Azt jelzi, hogy a modellnek egy beépített eszközt kell használnia a válasz létrehozásához. További információ a beépített eszközökről.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: web_search_preview_2025_03_11	Igen

OpenAI.ToolType

Property	Érték
Type	karakterlánc
Értékek	function file_search computer_use_preview web_search mcp code_interpreter image_generation local_shell shell custom web_search_preview apply_patch a2a_preview bing_custom_search_preview browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview memory_search_preview azure_ai_search azure_function bing_grounding capture_structured_outputs openapi

OpenAI.ToolsArray

A modell által a válasz létrehozása során meghívható eszközök tömbje. A paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja. Az eszközök alábbi kategóriáit támogatjuk:

• Beépített eszközök: Az OpenAI által biztosított eszközök, amelyek kibővítik a modell képességeit, például a webes keresést vagy a fájlkeresést. További információ a beépített eszközökről.
• MCP-eszközök: Integráció külső rendszerekkel egyéni MCP-kiszolgálókon vagy előre definiált összekötőken, például a Google Drive-on és a SharePointon keresztül. További információ az MCP-eszközökről.
• Függvényhívások (egyéni eszközök):Az Ön által definiált függvények, amelyek lehetővé teszik a modell számára, hogy erősen beírt argumentumokkal és kimenetekkel hívja meg a saját kódját. További információ a függvényhívásról. Egyéni eszközökkel is meghívhatja a saját kódját.

Az OpenAI.Tooltömbje

OpenAI.TopLogProb

A token legnagyobb valószínűség logaritmusa.

Name	Típus	Description	Szükséges	Alapértelmezett
bytes	OpenAI.integer tömbje		Igen
logprob	OpenAI.numerikus		Igen
kód	karakterlánc		Igen

OpenAI.Type

Szövegbe írandó művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
SMS	karakterlánc	A beírandó szöveg.	Igen
típus	felsorolás	Megadja az esemény típusát. Típusművelet esetében ez a tulajdonság mindig type-ra van állítva. Lehetséges értékek: type	Igen

OpenAI.UpdateConversationBody

Name	Típus	Description	Szükséges	Alapértelmezett
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	Igen

OpenAI.UrlCitationBody

Egy modellválasz létrehozásához használt webes erőforrás idézete.

Name	Típus	Description	Szükséges	Alapértelmezett
end_index	OpenAI.integer		Igen
start_index	OpenAI.integer		Igen
title	karakterlánc	A webes erőforrás címe.	Igen
típus	felsorolás	Az URL-idézet típusa. Mindig url_citation. Lehetséges értékek: url_citation	Igen
url	karakterlánc	A webes erőforrás URL-címe.	Igen

OpenAI.VectorStoreFileAttributes

Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez hasznos lehet az objektum további információinak strukturált formátumban való tárolásához, valamint az api-val vagy az irányítópulton keresztüli objektumok lekérdezéséhez. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú, logikai vagy számokat tartalmazó sztringek.

Típus: objektum

OpenAI.Részletesség

Korlátozza a modell válaszának részletességét. Az alacsonyabb értékek tömörebb válaszokat eredményeznek, míg a magasabb értékek részletesebb válaszokat eredményeznek. Jelenleg a támogatott értékek a következőklow: és mediumhigh.

Property	Érték
Type	karakterlánc
Nullable	Igen
Értékek	low medium high

OpenAI.Wait

Várakozási művelet.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Megadja az esemény típusát. Várakozási művelet esetén ez a tulajdonság mindig wait-ra van állítva. Lehetséges értékek: wait	Igen

OpenAI.WebSearchActionFind

"find" művelettípus: Egy betöltött oldalon belüli mintát keres.

Name	Típus	Description	Szükséges	Alapértelmezett
minta	karakterlánc	Az oldalon belül keresendő minta vagy szöveg.	Igen
típus	felsorolás	A művelet típusa. Lehetséges értékek: find_in_page	Igen
url	karakterlánc	A keresett minta oldalának URL-címe.	Igen

OpenAI.WebSearchActionOpenPage

Művelettípus: "open_page" – Megnyit egy adott URL-címet a keresési eredményekből.

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	A művelet típusa. Lehetséges értékek: open_page	Igen
url	karakterlánc	A modell által megnyitott URL-cím.	Igen

OpenAI.WebSearchActionSearch

Művelettípus: "keresés" – Webes keresési lekérdezést hajt végre.

Name	Típus	Description	Szükséges	Alapértelmezett
queries	sztringtömb	A keresési lekérdezések.	No
lekérdezés	sztring (elavult)	[ELAVULT] A keresési lekérdezés.	Igen
Források	Az OpenAI.WebSearchActionSearchSources tömbje	A keresésben használt források.	No
típus	felsorolás	A művelet típusa. Lehetséges értékek: search	Igen

OpenAI.WebSearchActionSearchSources

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Lehetséges értékek: url	Igen
url	karakterlánc		Igen

OpenAI.WebSearchApproximateLocation

A felhasználó hozzávetőleges helye.

Name	Típus	Description	Szükséges	Alapértelmezett
Város	sztring (null értékű)		No
ország	sztring (null értékű)		No
régió	sztring (null értékű)		No
timezone	sztring (null értékű)		No
típus	felsorolás	A hely közelítésének típusa. Mindig approximate. Lehetséges értékek: approximate	No

OpenAI.WebSearchPreviewTool

Ez az eszköz a weben keres releváns eredményeket, amelyeket válaszként használhat. További információ a web keresőeszközről.

Name	Típus	Description	Szükséges	Alapértelmezett
keresési_kontextus_méret	OpenAI.SearchContextSize		No
típus	felsorolás	A webes keresőeszköz típusa. Az egyik: web_search_preview vagy web_search_preview_2025_03_11. Lehetséges értékek: web_search_preview	Igen
felhasználó_helyszín	OpenAI.ApproximateLocation (null értékű)		No
└─ város	sztring (null értékű)		No
└─ ország	sztring (null értékű)		No
└─ régió	sztring (null értékű)		No
└─ időzónában	sztring (null értékű)		No
└─ típus	felsorolás	A hely közelítésének típusa. Mindig approximate. Lehetséges értékek: approximate	Igen

OpenAI.WebSearchTool

Keress az interneten a prompthoz kapcsolódó forrásokat. További információ a web keresőeszközről.

Name	Típus	Description	Szükséges	Alapértelmezett
custom_search_configuration	WebSearchConfiguration	Webes keresési konfiguráció bing egyéni kereséshez	No
└─ instance_name	karakterlánc	A konfigurációnak adott egyéni konfigurációs példány neve.	Igen
└─ project_connection_id	karakterlánc	Project kapcsolatazonosító a bing egyéni kereséssel való alapozáshoz	Igen
filters	OpenAI.WebSearchToolFilters (null értékű)		No
└─ allowed_domains	sztringtömb (null értékű)		No
keresési_kontextus_méret	felsorolás	Magas szintű útmutatás a kereséshez használandó környezeti ablakterület mennyiségéhez. Az egyik low, medium, vagy high. medium az alapértelmezett érték. Lehetséges értékek: low, , mediumhigh	No
típus	felsorolás	A webes keresőeszköz típusa. Az egyik: web_search vagy web_search_2025_08_26. Lehetséges értékek: web_search	Igen
felhasználó_helyszín	OpenAI.WebSearchApproximateLocation (nullable)	A felhasználó hozzávetőleges helye.	No
└─ város	sztring (null értékű)		No
└─ ország	sztring (null értékű)		No
└─ régió	sztring (null értékű)		No
└─ időzónában	sztring (null értékű)		No
└─ típus	felsorolás	A hely közelítésének típusa. Mindig approximate. Lehetséges értékek: approximate	No

OpenAI.WebSearchToolFilters

Name	Típus	Description	Szükséges	Alapértelmezett
allowed_domains	sztringtömb		No

OpenAI.integer

Típus: egész szám

Formátum: int64

OpenAI.numerikus

Típus: szám

Formátum: dupla

OpenApiAnonymousAuthDetails

Az OpenApi névtelen hitelesítés biztonsági adatai

Name	Típus	Description	Szükséges	Alapértelmezett
típus	felsorolás	Az objektum típusa, amely mindig "névtelen". Lehetséges értékek: anonymous	Igen

OpenApiAuthDetails

az OpenApiFunctionDefinition hitelesítési adatai

Diszkriminatív az OpenApiAuthDetails esetében

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Típus	Description	Szükséges	Alapértelmezett
típus	OpenApiAuthType	Az OpenApi-végpont hitelesítési típusa. Az engedélyezett típusok a következők: - Névtelen (nincs szükség hitelesítésre) - Project kapcsolat (project_connection_id szükséges a végponthoz, az AI Foundry beállításaként) - Managed_Identity (az identitásalapú hitelesítéshez célközönségre van szükség)	Igen

OpenApiAuthType

Az OpenApi-végpont hitelesítési típusa. Az engedélyezett típusok a következők:

• Névtelen (nincs szükség hitelesítésre)
• Project Connection (az AI Foundry-ben beállított project_connection_id végponthoz szükséges)
• Managed_Identity (célközönség szükséges az identitásalapú hitelesítéshez)

Property	Érték
Leírás	Az OpenApi-végpont hitelesítési típusa. Az engedélyezett típusok a következők: - Névtelen (nincs szükség hitelesítésre) - Project kapcsolat (project_connection_id szükséges a végponthoz, az AI Foundry beállításaként) - Managed_Identity (az identitásalapú hitelesítéshez célközönségre van szükség)
Type	karakterlánc
Értékek	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Egy openapi-függvény bemeneti definíciós információi.

Name	Típus	Description	Szükséges	Alapértelmezett
auth	OpenApiAuthDetails	az OpenApiFunctionDefinition hitelesítési adatai	Igen
└─ típus	OpenApiAuthType	A hitelesítés típusának névtelennek/project_connection/managed_identity	Igen
default_params	sztringtömb	A felhasználó által megadott alapértelmezett értékeket használó OpenAPI-specifikációs paraméterek listája	No
leírás	karakterlánc	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	No
functions	objektumtömb	Az OpenApi eszköz által használt függvénydefiníciók listája	No
név	karakterlánc	A meghívandó függvény neve.	Igen
spec	objektum	A JSON-sémaobjektumként leírt openapi függvényalakzat.	Igen

OpenApiManagedAuthDetails

Az OpenApi managed_identity hitelesítés biztonsági adatai

Name	Típus	Description	Szükséges	Alapértelmezett
security_scheme	OpenApiManagedSecurityScheme	Az OpenApi managed_identity hitelesítés biztonsági sémája	Igen
└─ közönség	karakterlánc	Hitelesítési hatókör managed_identity hitelesítési típushoz	Igen
típus	felsorolás	Az objektum típusa, amely mindig "managed_identity". Lehetséges értékek: managed_identity	Igen

OpenApiManagedSecurityScheme

Az OpenApi managed_identity hitelesítés biztonsági sémája

Name	Típus	Description	Szükséges	Alapértelmezett
audience	karakterlánc	Hitelesítési hatókör managed_identity hitelesítési típushoz	Igen

OpenApiProjectConnectionAuthDetails

Az OpenApi project kapcsolathitelesítés biztonsági adatai

Name	Típus	Description	Szükséges	Alapértelmezett
security_scheme	OpenApiProjectConnectionSecurityScheme	Az OpenApi managed_identity hitelesítés biztonsági sémája	Igen
└─ project_connection_id	karakterlánc	Project kapcsolatazonosító Project kapcsolati hitelesítés típusához	Igen
típus	felsorolás	Az objektum típusa, amely mindig "project_connection". Lehetséges értékek: project_connection	Igen

OpenApiProjectConnectionSecurityScheme

Az OpenApi managed_identity hitelesítés biztonsági sémája

Name	Típus	Description	Szükséges	Alapértelmezett
project_connection_id	karakterlánc	Project kapcsolatazonosító Project kapcsolati hitelesítés típusához	Igen

OpenApiTool

Az ügynök konfigurálásához használt OpenAPI-eszközök bemeneti definíciós információi.

Name	Típus	Description	Szükséges	Alapértelmezett
openapi	OpenApiFunctionDefinition	Egy openapi-függvény bemeneti definíciós információi.	Igen
└─ hitelesítés	OpenApiAuthDetails	API-hitelesítés részleteinek megnyitása	Igen
└─ default_params	sztringtömb	A felhasználó által megadott alapértelmezett értékeket használó OpenAPI-specifikációs paraméterek listája	No
└─ leírás	karakterlánc	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	No
└─ függvények	objektumtömb (írásvédett)	Az OpenApi eszköz által használt függvénydefiníciók listája	No
└─ leírás	karakterlánc	A függvény működésének leírása, amelyet a modell használ annak kiválasztásához, hogy mikor és hogyan hívja meg a függvényt.	No
└─ név	karakterlánc	A meghívandó függvény neve.	Igen
└─ paraméterek	objektum	A függvények által elfogadott paraméterek JSON-sémaobjektumként vannak leírva.	Igen
└─ név	karakterlánc	A meghívandó függvény neve.	Igen
└─ specifikáció	objektum	A JSON-sémaobjektumként leírt openapi függvényalakzat.	Igen
típus	felsorolás	Az objektum típusa, amely mindig "openapi". Lehetséges értékek: openapi	Igen

PageOrder

Property	Érték
Type	karakterlánc
Értékek	asc desc

PagedConnection

Kapcsolatelemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	a Kapcsolat tömbje	A kapcsolatelemek ezen a lapon	Igen

PagedDatasetVersion

DatasetVersion-elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	DatasetVersion tömbje	A lap DatasetVersion elemei	Igen

PagedDeployment

Üzembehelyezési elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	üzembe helyezés tömbje	Az ezen a lapon található üzembehelyezési elemek	Igen

PagedEvaluationRule

A EvaluationRule-elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	a EvaluationRule tömbje	Az oldalon található EvaluationRule-elemek	Igen

PagedEvaluationTaxonomy

A EvaluationTaxonomy elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	a EvaluationTaxonomy tömbje	A EvaluationTaxonomy elemei ezen az oldalon	Igen

PagedEvaluatorVersion

Az EvaluatorVersion-elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	Az EvaluatorVersion tömbje	A lapon található EvaluatorVersion elemek	Igen

PagedIndex

Indexelemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	indextömb	Az indexelemek ezen a lapon	Igen

PagedInsight

Megállapításelemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	az Insight tömbje	Az elemzési elemek ezen a lapon	Igen

PagedRedTeam

RedTeam elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	RedTeam tömb	Az oldalon található RedTeam elemek	Igen

PagedSchedule

Ütemezési elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	ütemezés tömbje	A lapon található Ütemezés elemek	Igen

PagedScheduleRun

ScheduleRun-elemek lapozott gyűjteménye

Name	Típus	Description	Szükséges	Alapértelmezett
nextLink	karakterlánc	Az elemek következő oldalára mutató hivatkozás	No
value	ScheduleRun tömbje	A scheduleRun elemek ezen a lapon	Igen

PendingUploadRequest

Függőben lévő feltöltésre vonatkozó kérést jelöl.

Name	Típus	Description	Szükséges	Alapértelmezett
connectionName	karakterlánc	Az ideiglenes SAS-jogkivonat létrehozásához használandó Azure Storage-fiók kapcsolatneve	No
pendingUploadId	karakterlánc	Ha nincs megadva PendingUploadId, a rendszer véletlenszerű GUID azonosítót használ.	No
pendingUploadType	felsorolás	A BlobReference az egyetlen támogatott típus. Lehetséges értékek: BlobReference	Igen

PendingUploadResponse

A függőben lévő feltöltési kérelemre adott választ jelöli

Name	Típus	Description	Szükséges	Alapértelmezett
blobReference	BlobReference	Blob-hivatkozás részletei.	Igen
└─ blobUri	karakterlánc	Blob URI elérési útja az ügyfél számára adatok feltöltéséhez. Például: https://blob.windows.core.net/Container/Path	Igen
└─ hitelesítő adatok	SasCredential	Hitelesítő adatok a tárfiók eléréséhez.	Igen
└─ storageAccountArmId	karakterlánc	A használni kívánt tárfiók ARM-azonosítója.	Igen
pendingUploadId	karakterlánc	A feltöltési kérelem azonosítója.	Igen
pendingUploadType	felsorolás	A BlobReference az egyetlen támogatott típus Lehetséges értékek: BlobReference	Igen
verzió	karakterlánc	A létrehozandó tartalmi elem verziója, ha a felhasználó nem adta meg a verziót a feltöltés kezdeti létrehozásakor	No

PromptAgentDefinition

A parancssori ügynök definíciója

Name	Típus	Description	Szükséges	Alapértelmezett
instructions	sztring (null értékű)	A modell környezetébe beszúrt rendszer-(vagy fejlesztői) üzenet.	No
kind	felsorolás	Lehetséges értékek: prompt	Igen
modell	karakterlánc	Az ügynökhöz használandó modell üzembe helyezése.	Igen
rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
└─ rai_policy_name	karakterlánc	Az alkalmazandó RAI-szabályzat neve.	Igen
reasoning	OpenAI.Reasoning (null értékű)	csak gpt-5 és o-sorozatú modellek Konfigurációs beállítások a következőhöz: érvelési modelleket.	No
└─ erőfeszítés	OpenAI.ReasoningEffort	Korlátozza az érveléssel kapcsolatos erőfeszítéseket érvelési modelleket. Jelenleg a támogatott értékek a következőknone: , minimallow, , mediumhighés xhigh. Csökkenti az érvelési erőfeszítés gyorsabb válaszidőt és kevesebb szót eredményezhet a válaszban lévő érvelésről. - gpt-5.1 alapértelmezett érték, noneamely nem végez érvelést. A támogatott érvelési értékek a gpt-5.1 következők none: , low, mediumés high. Az eszközhívások a gpt-5.1 összes érvelési értékéhez támogatottak. - Minden modell alapértelmezés szerint gpt-5.1 az medium érvelési munka, és nem támogatja none. – A gpt-5-pro modell alapértelmezés szerint (és csak) támogatja az high érvelési erőfeszítéseket. - xhigh a következő után minden modell gpt-5.1-codex-maxesetében támogatott.	No
└─ összefoglaló generálása	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
└─ összegzés	felsorolás	Lehetséges értékek: auto, , concisedetailed	No
structured_inputs	objektum	Strukturált bemenetek halmaza, amelyek részt vehetnek a promptsablonok helyettesítésében vagy az eszközargumentumok kötésében.	No
hőmérséklet	szám	Milyen mintavételi hőmérsékletet kell használni, 0 és 2 között. A magasabb értékek, például a 0,8 véletlenszerűbbé teszik a kimenetet, míg az alacsonyabb értékek, például a 0,2, koncentráltabbá és determinisztikusabbá teszik a kimenetet. Általában azt javasoljuk, hogy módosítsa ezt vagy top_p, de ne mindkettőt.	No	1
SMS	PromptAgentDefinitionTextOptions	A modell szöveges válaszának konfigurációs beállításai. Lehetnek egyszerű szöveges vagy strukturált JSON-adatok.	No
└─ formátum	OpenAI.TextResponseFormatConfiguration	Egy objektum, amely megadja a modell által kiadandó formátumot. A konfigurálás { "type": "json_schema" } lehetővé teszi a strukturált kimeneteket, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. Tudjon meg többet itt: Az alapértelmezett formátum { "type": "text" } nem nyújt további beállításokat. *Nem ajánlott gpt-4o és újabb modellek esetén:** Beállítás a { "type": "json_object" } régebbi JSON módot engedélyezi. biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Az json_schema használata az azt támogató modellek esetében előnyben részesítik.	No
tool_choice	sztring vagy OpenAI.ToolChoiceParam	Hogyan válassza ki a modell a válasz létrehozásakor használni kívánt eszközt (vagy eszközöket). A paraméterből tools megtudhatja, hogyan adhatja meg, hogy a modell mely eszközöket hívhatja meg.	No
tools	Az OpenAI.Tool tömbje	A modell által a válasz létrehozása során meghívható eszközök tömbje. Ön paraméter beállításával tool_choice megadhatja, hogy melyik eszközt használja.	No
top_p	szám	A hőmérséklettel történő mintavétel alternatíva, az úgynevezett nukleusz-mintavételezés, ahol a modell a tokenek eredményeit a top_p-valószínűséggel veszi figyelembe tömeg. Tehát 0,1 csak azokat a tokeneket jelenti, amelyek a legfelső 10% valószínűségi tömeghez tartoznak. figyelembe vannak véve Általában azt javasoljuk, hogy módosítsa ezt vagy temperature, de ne mindkettőt.	No	1

PromptAgentDefinitionTextOptions

A modell szöveges válaszának konfigurációs beállításai. Lehetnek egyszerű szöveges vagy strukturált JSON-adatok.

Name	Típus	Description	Szükséges	Alapértelmezett
format	OpenAI.TextResponseFormatConfiguration	Egy objektum, amely megadja a modell által kiadandó formátumot. A konfigurálás { "type": "json_schema" } lehetővé teszi a strukturált kimeneteket, amely biztosítja, hogy a modell megfeleljen a megadott JSON-sémának. Tudjon meg többet itt: Az alapértelmezett formátum { "type": "text" } nem nyújt további beállításokat. *Nem ajánlott gpt-4o és újabb modellek esetén:** Beállítás a { "type": "json_object" } régebbi JSON módot engedélyezi. biztosítja, hogy a modell által generált üzenet érvényes JSON legyen. Az json_schema használata az azt támogató modellek esetében előnyben részesítik.	No

PromptBasedEvaluatorDefinition

Prompt alapú értékelő

Name	Típus	Description	Szükséges	Alapértelmezett
data_schema	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti adataihoz. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
init_parameters	objektum	A JSON-séma (2020-12-es tervezet) az értékelő bemeneti paramétereihez. Ez olyan paramétereket tartalmaz, mint a típus, a tulajdonságok, a kötelező.	No
metrikák	objektum	Az értékelő által előállított kimeneti metrikák listája	No
prompt_text	karakterlánc	A kiértékeléshez használt parancssori szöveg	Igen
típus	felsorolás	Lehetséges értékek: prompt	Igen

ProtocolVersionRecord

Egyetlen protokoll rekordleképezése és annak verziója.

Name	Típus	Description	Szükséges	Alapértelmezett
protokoll	AgentProtocol		Igen
verzió	karakterlánc	A protokoll verziósztringje, pl. "v0.1.1".	Igen

RaiConfig

Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.

Name	Típus	Description	Szükséges	Alapértelmezett
rai_policy_name	karakterlánc	Az alkalmazandó RAI-szabályzat neve.	Igen

RecurrenceSchedule

Ismétlődési ütemezési modell.

A RecurrenceSchedule diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Típus	Description	Szükséges	Alapértelmezett
típus	RecurrenceType	Ismétlődés típusa.	Igen

RecurrenceTrigger

Ismétlődésen alapuló eseményindító.

Name	Típus	Description	Szükséges	Alapértelmezett
endTime	karakterlánc	Az ismétlődési ütemterv záró időpontja ISO 8601 formátumban.	No
interval	egész szám	Az ismétlődési ütemezés időköze.	Igen
schedule	RecurrenceSchedule	Ismétlődési ütemezési modell.	Igen
└─ típus	RecurrenceType	Az ismétlődési ütemezés ismétlődési típusa.	Igen
startTime	karakterlánc	Az ismétlődési ütemezés kezdő időpontja ISO 8601 formátumban.	No
timeZone	karakterlánc	Az ismétlődési ütemezés időzónája.	No	egyezményes világidő
típus	felsorolás	A ravasz típusa. Lehetséges értékek: Recurrence	Igen

RecurrenceType

Ismétlődés típusa.

Property	Érték
Leírás	Ismétlődés típusa.
Type	karakterlánc
Értékek	Hourly Daily Weekly Monthly

RedTeam

A piros csapat részletei.

Name	Típus	Description	Szükséges	Alapértelmezett
applicationScenario	karakterlánc	Alkalmazásforgatókönyv a vörös csapatművelethez, amely esetspecifikus támadásokat hoz létre.	No
attackStrategies	Az AttackStrategy tömbje	A támadási stratégiák vagy a támadási stratégiák beágyazott listája.	No
displayName	karakterlánc	A vörös csapat futásának neve.	No
id	sztring (írásvédett)	A piros csapat futásának azonosítója.	Igen
numTurns	egész szám	Szimulációs kerekítések száma.	No
properties	objektum	Vörös csapat tulajdonságai. A címkéktől eltérően a tulajdonságok csak bővítmények. A hozzáadás után egy tulajdonság nem távolítható el.	No
riskCategories	A RiskCategory tömbje	A támadási célkitűzések létrehozásához szükséges kockázati kategóriák listája.	No
szimulációOnly	boolean	Csak szimuláció vagy szimuláció + kiértékelés. Alapértelmezett hamis, ha igaz, a vizsgálat nem kiértékelési eredményt ad ki.	No	Téves
állapot	sztring (írásvédett)	A vörös csapat állapota. Szolgáltatás szerint van beállítva, és írásvédett.	No
tags	objektum	Piros csapat címkéi. A tulajdonságoktól eltérően a címkék teljesen módosíthatók.	No
céladatbázis	TargetConfig	Absztrakt osztály a célkonfigurációhoz.	Igen
└─ típus	karakterlánc	A modellkonfiguráció típusa.	Igen

RedTeamEvalRunDataSource

Name	Típus	Description	Szükséges	Alapértelmezett
item_generation_params	ItemGenerationParams	Az elemlétrehozási műveletek vezérléséhez használt paraméterek készletét jelöli.	Igen
└─ típus	ItemGenerationParamsType	A használni kívánt elemgenerálási paraméterek típusa.	Igen
céladatbázis	Cél	Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.	Igen
└─ típus	karakterlánc	A cél típusa.	Igen
típus	felsorolás	Az adatforrás típusa. Mindig azure_ai_red_team. Lehetséges értékek: azure_ai_red_team	Igen

RedTeamItemGenerationParams

Name	Típus	Description	Szükséges	Alapértelmezett
attack_strategies	Az AttackStrategy tömbje	A használandó támadási stratégiák gyűjteménye.	Igen
num_turns	egész szám	A játékban engedélyezett fordulatok száma.	Igen	20
típus	felsorolás	Az elemgenerálási paraméterek típusa. Lehetséges értékek: red_team	Igen

RedTeamSeedPromptsItemGenerationParams

A vörös csapat vetőmagjának paramétereit jelöli, amely az elemgenerálást kéri.

Name	Típus	Description	Szükséges	Alapértelmezett
attack_strategies	Az AttackStrategy tömbje	A használandó támadási stratégiák gyűjteménye.	Igen
num_turns	egész szám	A játékban engedélyezett fordulatok száma.	Igen	20
adatforrás	OpenAI.EvalJsonlFileContentSource		Igen
└─ tartalom	Az OpenAI.EvalJsonlFileContentSourceContent tömbje	A jsonl-fájl tartalma.	Igen
└─ típus	felsorolás	A jsonl-forrás típusa. Mindig file_content. Lehetséges értékek: file_content	Igen
típus	felsorolás	Az elemgenerálási paraméterek típusa, mindig red_team_seed_prompts. Lehetséges értékek: red_team_seed_prompts	Igen

RedTeamTaxonomyItemGenerationParams

A piros csapat osztályozási elemének létrehozásának paramétereit jelöli.

Name	Típus	Description	Szükséges	Alapértelmezett
attack_strategies	Az AttackStrategy tömbje	A használandó támadási stratégiák gyűjteménye.	Igen
num_turns	egész szám	A játékban engedélyezett fordulatok száma.	Igen	20
adatforrás	OpenAI.EvalJsonlFileContentSource		Igen
└─ tartalom	Az OpenAI.EvalJsonlFileContentSourceContent tömbje	A jsonl-fájl tartalma.	Igen
└─ típus	felsorolás	A jsonl-forrás típusa. Mindig file_content. Lehetséges értékek: file_content	Igen
típus	felsorolás	Az elemgenerálási paraméterek típusa, mindig red_team_taxonomy. Lehetséges értékek: red_team_taxonomy	Igen

ResponseRetrievalItemGenerationParams

A válaszlekérési elem létrehozásának paramétereit jelöli.

Name	Típus	Description	Szükséges	Alapértelmezett
adatleképezés	objektum	Leképezés a forrásmezőkről response_id mezőre, amely a csevegési előzmények lekéréséhez szükséges.	Igen
max_num_turns	egész szám	A kiértékelendő csevegési előzmények maximális száma.	Igen
adatforrás	OpenAI.EvalJsonlFileContentSource vagy OpenAI.EvalJsonlFileIdSource	Az a forrás, amelyből a JSONL-tartalom beolvasható.	Igen
típus	felsorolás	Az elemgenerálási paraméterek típusa, mindig response_retrieval. Lehetséges értékek: response_retrieval	Igen

RiskCategory

A támadási cél kockázati kategóriája.

Property	Érték
Leírás	A támadási cél kockázati kategóriája.
Type	karakterlánc
Értékek	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SAS-hitelesítő adatok

Közös hozzáférésű jogosultságkód (SAS) hitelesítő adatainak meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
SAS	sztring (írásvédett)	SAS-jogkivonat	No
típus	felsorolás	A hitelesítő adatok típusa Lehetséges értékek: SAS	Igen

SampleType

Az elemzéshez használt minta típusa.

Property	Érték
Leírás	Az elemzéshez használt minta típusa.
Type	karakterlánc
Értékek	EvaluationResultSample

SasCredential

SAS hitelesítő adatok meghatározása

Name	Típus	Description	Szükséges	Alapértelmezett
sasUri	sztring (írásvédett)	SAS uri	Igen
típus	felsorolás	Hitelesítő adatok típusa Lehetséges értékek: SAS	Igen

Schedule

Ütemezési modell.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ütemezés leírása.	No
displayName	karakterlánc	Az ütemezés neve.	No
enabled	boolean	Az ütemezés engedélyezett állapota.	Igen
id	sztring (írásvédett)	Az ütemezés azonosítója.	Igen
properties	objektum	Ütemezés tulajdonságai. A címkéktől eltérően a tulajdonságok csak bővítmények. A hozzáadás után egy tulajdonság nem távolítható el.	No
előfizetési állapot	ScheduleProvisioningStatus (írásvédett )	Kiépítési állapot ütemezése.	No
rendszeradatok	objektum (írásvédett)	Az erőforrás rendszer metaadatai.	Igen
tags	objektum	Ütemezés címkéi. A tulajdonságoktól eltérően a címkék teljesen módosíthatók.	No
feladat	ScheduleTask	Feladatmodell ütemezése.	Igen
└─ konfiguráció	objektum	A feladat konfigurációja.	No
└─ típus	ScheduleTaskType	A feladat típusa.	Igen
aktivál	Trigger	Az ütemezés eseményindítójának alapmodellje.	Igen
└─ típus	TriggerType	A ravasz típusa.	Igen

ScheduleProvisioningStatus

Kiépítési állapot ütemezése.

Property	Érték
Leírás	Kiépítési állapot ütemezése.
Type	karakterlánc
Értékek	Creating Updating Deleting Succeeded Failed

ScheduleRun

Ütemezési futtatási modell.

Name	Típus	Description	Szükséges	Alapértelmezett
hiba	sztring (írásvédett)	Hibainformációk az ütemezés futtatásához.	No
id	sztring (írásvédett)	Az ütemezési futtatás azonosítója.	Igen
properties	objektum (írásvédett)	Az ütemezési futtatás tulajdonságai.	Igen
scheduleId	karakterlánc	Az ütemezés azonosítója.	Igen
siker	logikai (írásvédett)	Az ütemezési futtatás sikerességi állapotának aktiválása.	Igen
triggerTime	karakterlánc	Az ütemezés futtatásának aktiválási ideje.	No

ScheduleTask

Feladatmodell ütemezése.

A ScheduleTask diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Name	Típus	Description	Szükséges	Alapértelmezett
konfiguráció	objektum	A feladat konfigurációja.	No
típus	ScheduleTaskType	A feladat típusa.	Igen

ScheduleTaskType

A feladat típusa.

Property	Érték
Leírás	A feladat típusa.
Type	karakterlánc
Értékek	Evaluation Insight

SharepointGroundingToolParameters

A sharepoint földelő eszköz paraméterei.

Name	Típus	Description	Szükséges	Alapértelmezett
project_connections	a ToolProjectConnection tömbje	Az eszközhöz csatolt project kapcsolatok. Legfeljebb 1 kapcsolat lehet erőforrást csatolja az eszközhöz.	No

SharepointPreviewTool

Az ügynök konfigurálásához használt sharepoint-eszközök bemeneti definíciós információi.

Name	Típus	Description	Szükséges	Alapértelmezett
sharepoint_grounding_preview	SharepointGroundingToolParameters	A sharepoint földelő eszköz paraméterei.	Igen
└─ project_connections	a ToolProjectConnection tömbje	Az eszközhöz csatolt project kapcsolatok. Legfeljebb 1 kapcsolat lehet erőforrást csatolja az eszközhöz. Korlátozások: maxItems: 1	No
típus	felsorolás	Az objektumtípus, amely mindig 'sharepoint_grounding_preview'. Lehetséges értékek: sharepoint_grounding_preview	Igen

Sku

Termékváltozat adatai

Name	Típus	Description	Szükséges	Alapértelmezett
kapacitás	egész szám	Termékváltozat kapacitása	Igen
family	karakterlánc	Termékváltozatcsalád	Igen
név	karakterlánc	Termékváltozat neve	Igen
size	karakterlánc	Termékváltozat mérete	Igen
rétegez	karakterlánc	Termékváltozat szintje	Igen

StructuredInputDefinition

Strukturált bemenet, amely részt vehet a prompt sablonhelyettesítésekben és az eszközargumentumok kötésében.

Name	Típus	Description	Szükséges	Alapértelmezett
default_value		A bemenet alapértelmezett értéke, ha nincs megadva futásidejű érték.	No
leírás	karakterlánc	A bemenet ember által olvasható leírása.	No
required	boolean	Azt határozza meg, hogy a bemeneti tulajdonságra szükség van-e az ügynök meghívásakor.	No	Téves
séma	objektum	A strukturált bemenet JSON-sémája (nem kötelező).	No

StructuredOutputDefinition

Az ügynök által létrehozható strukturált kimenet.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	A kibocsátandó kimenet leírása. A modell arra használja, hogy meghatározza, mikor kell kibocsátani a kimenetet.	Igen
név	karakterlánc	A strukturált kimenet neve.	Igen
séma	objektum	A strukturált kimenet JSON-sémája.	Igen
szigorú	logikai (null értékű)	A szigorú ellenőrzés kényszerítése. Alapértelmezett true.	Igen

StructuredOutputsOutputItem

Name	Típus	Description	Szükséges	Alapértelmezett
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
kimenet		A válasz során rögzített strukturált kimenet.	Igen
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
típus	felsorolás	Lehetséges értékek: structured_outputs	Igen

SyntheticDataGenerationPreviewEvalRunDataSource

Olyan kiértékelési futtatások adatforrását jelöli, amely a létrehozott szintetikus adatok alapján kiértékel tesztelési célokra.

Name	Típus	Description	Szükséges	Alapértelmezett
bemeneti_üzenetek	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
└─ sablon	objektumtömb vagy OpenAI.EvalItem		Igen
└─ típus	felsorolás	Lehetséges értékek: template	Igen
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Igen
└─ model_deployment_name	karakterlánc	A szintetikus adatok előállításához használandó modelltelepítés neve.	Igen
└─ output_dataset_id	sztring (írásvédett)	Annak a kimeneti adatkészletnek az azonosítója, amelyben a generált szintetikus adatok tárolása történik. A létrehozott adatok egy jsonl-fájl, amelynek oszlopazonosítója, lekérdezése és test_description.	No
└─ output_dataset_name	karakterlánc	Annak a kimeneti adatkészletnek a neve, amelyben a generált szintetikus adatok tárolódnak. Ha nincs megadva, a szolgáltatás automatikusan létrehozza az adathalmaz nevét.	No
└─ parancssor	karakterlánc	A szintetikus adatok létrehozásához használt kérés. Ez akkor lehetséges, ha a cél típusa "azure_ai_agent" az ügynökben konfigurált utasítások szerint.	No
└─ samples_count	egész szám	A létrehozandó adatminták maximális száma.	Igen
└─ források	Az OpenAI.EvalJsonlFileIdSource tömbje	Az adatlétrehozáshoz választható kezdőadat-tartalomforrásfájlok.	Igen
└─ típus	felsorolás	Az elemgenerálási paraméterek típusa. Lehetséges értékek: synthetic_data_gen_preview	Igen
céladatbázis	Cél	Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.	Igen
└─ típus	karakterlánc	A cél típusa.	Igen
típus	felsorolás	Az adatforrás típusa, mindig azure_ai_synthetic_data_gen_preview. Lehetséges értékek: azure_ai_synthetic_data_gen_preview	Igen

SyntheticDataGenerationPreviewItemGenerationParams

Name	Típus	Description	Szükséges	Alapértelmezett
model_deployment_name	karakterlánc	A szintetikus adatok előállításához használandó modelltelepítés neve.	Igen
output_dataset_id	sztring (írásvédett)	Annak a kimeneti adatkészletnek az azonosítója, amelyben a generált szintetikus adatok tárolása történik. A létrehozott adatok egy jsonl-fájl, amelynek oszlopazonosítója, lekérdezése és test_description.	No
output_dataset_name	karakterlánc	Annak a kimeneti adatkészletnek a neve, amelyben a generált szintetikus adatok tárolódnak. Ha nincs megadva, a szolgáltatás automatikusan létrehozza az adathalmaz nevét.	No
kér	karakterlánc	A szintetikus adatok létrehozásához használt kérés. Ez akkor lehetséges, ha a cél típusa "azure_ai_agent" az ügynökben konfigurált utasítások szerint.	No
samples_count	egész szám	A létrehozandó adatminták maximális száma.	Igen
Források	Az OpenAI.EvalJsonlFileIdSource tömbje	Az adatlétrehozáshoz választható kezdőadat-tartalomforrásfájlok.	Igen
típus	felsorolás	Az elemgenerálási paraméterek típusa. Lehetséges értékek: synthetic_data_gen_preview	Igen

Cél

Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.

Diszkriminatív cél

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Name	Típus	Description	Szükséges	Alapértelmezett
típus	karakterlánc	A cél típusa.	Igen

TargetCompletionEvalRunDataSource

Egy adatforrást jelöl a célalapú befejezés-kiértékelési konfigurációhoz.

Name	Típus	Description	Szükséges	Alapértelmezett
bemeneti_üzenetek	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└─ tétel_hivatkozás	karakterlánc		Igen
└─ típus	felsorolás	Lehetséges értékek: item_reference	Igen
adatforrás	OpenAI.EvalJsonlFileContentSource vagy OpenAI.EvalJsonlFileIdSource	A beágyazott vagy fájladatok forráskonfigurációja.	Igen
céladatbázis	Cél	Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.	Igen
└─ típus	karakterlánc	A cél típusa.	Igen
típus	felsorolás	Az adatforrás típusa, mindig azure_ai_target_completions. Lehetséges értékek: azure_ai_target_completions	Igen

TargetConfig

Absztrakt osztály a célkonfigurációhoz.

A TargetConfig diszkriminatív beállítása

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Típus	Description	Szükséges	Alapértelmezett
típus	karakterlánc	A modellkonfiguráció típusa.	Igen

TargetUpdate

Alaposztály a diszkriminátor támogatással rendelkező célpontokhoz.

A TargetUpdate diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Name	Típus	Description	Szükséges	Alapértelmezett
típus	karakterlánc	A cél típusa.	Igen

TaxonomyCategory

Taxonómiai kategória meghatározása.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	A besorolási kategória leírása.	No
id	karakterlánc	Az osztályozási kategória egyedi azonosítója.	Igen
név	karakterlánc	A besorolási kategória neve.	Igen
properties	objektum	Az osztályozási kategória további tulajdonságai.	No
riskCategory	RiskCategory	A támadási cél kockázati kategóriája.	Igen
Alkategóriák	a TaxonomySubCategory tömbje	Osztályozási alkategóriák listája.	Igen

TaxonomySubCategory

Taxonómiai alkategória meghatározása.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az osztályozási alkategória leírása.	No
enabled	boolean	Az alkategória osztályozási elemeinek listája.	Igen
id	karakterlánc	Az osztályozási alkategória egyedi azonosítója.	Igen
név	karakterlánc	Az osztályozási alkategória neve.	Igen
properties	objektum	Az osztályozási alkategória további tulajdonságai.	No

ToolDescription

Az ügynök által használható eszköz leírása.

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az eszköz céljának rövid leírása.	No
név	karakterlánc	Az eszköz neve.	No

ToolProjectConnection

Egy project kapcsolati erőforrás.

Name	Típus	Description	Szükséges	Alapértelmezett
project_connection_id	karakterlánc	Az eszközhöz csatolt ToolProjectConnectionList projektkapcsolata.	Igen

TracesPreviewEvalRunDataSource

Olyan kiértékelési futtatások adatforrását jelöli, amelyek az Application Insightsban tárolt ügynök-nyomkövetéseken futnak.

Name	Típus	Description	Szükséges	Alapértelmezett
agent_id	karakterlánc	A nyomkövetések kiértékeléséhez használt ügynökazonosító.	No
agent_name	karakterlánc	A nyomkövetések kiértékeléséhez használt ügynöknév.	No
befejezési_idő	egész szám	Unix időbélyeg (másodpercben) a nyomkövetési lekérdezés ablakának végét jelöli. Alapértelmezett érték az aktuális időpontra.	No
ingestion_delay_seconds	egész szám	A nyomkövetések lekérdezése során a betöltési késedelem.	No	300
lookback_hours	egész szám	A nyomkövetések Application Insightsból való lekérésekor alkalmazott visszatekintő ablak (órákban). Az ütemezett értékelések esetében ez az ismétlődési időközből következik.	No	168
max_traces	egész szám	A kiértékeléshez lekért nyomkövetésekre alkalmazott mintavételezési korlát.	No	1000
trace_ids	sztringtömb	Kiértékelendő ügynök nyomkövetési azonosítóinak gyűjteménye.	No
típus	felsorolás	Az adatforrás típusa, mindig azure_ai_traces_preview. Lehetséges értékek: azure_ai_traces_preview	Igen

TreatmentEffectType

Kezelés hatásának típusa.

Property	Érték
Leírás	Kezelés hatásának típusa.
Type	karakterlánc
Értékek	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

Az ütemezés eseményindítójának alapmodellje.

Az eseményindító diszkriminatív

Ez az összetevő a tulajdonságot type használja a különböző típusok megkülönböztetésére:

Típusérték	Schema
Cron	CronTrigger
Recurrence	RecurrenceTrigger
OneTime	OneTimeTrigger

Name	Típus	Description	Szükséges	Alapértelmezett
típus	TriggerType	A ravasz típusa.	Igen

Indítótípus

A ravasz típusa.

Property	Érték
Leírás	A ravasz típusa.
Type	karakterlánc
Értékek	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Típus	Description	Szükséges	Alapértelmezett
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
manifest_id	karakterlánc	A jegyzékazonosító, amelyből importálni szeretné az ügynök verzióját.	Igen
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
parameter_values	objektum	A jegyzék bemenetei, amelyek teljes mértékben materializált ügynököt eredményeznek.	Igen

UpdateAgentRequest

Name	Típus	Description	Szükséges	Alapértelmezett
definíció	AgentDefinition		Igen
└─ fajta	AgentKind		Igen
└─ rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
leírás	karakterlánc	Az ágens ember által olvasható leírása. Korlátozások: maxLength: 512	No
metaadat	objektum	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No

UpdateEvalParametersBody

Name	Típus	Description	Szükséges	Alapértelmezett
metaadat	OpenAI.Metadata (null értékű)	Egy objektumhoz csatolható 16 kulcs-érték pár készlete. Ez lehet hasznos az objektumra vonatkozó további információk strukturált tárolására formázása és az objektumok lekérdezése API-val vagy az irányítópulton keresztül. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek sztringek legfeljebb 512 karakter hosszúságú.	No
név	karakterlánc		No
properties	objektum	Nem módosítható 16 kulcs-érték párok készlete, amelyek további információk tárolásához csatolhatók egy objektumhoz. A kulcsok legfeljebb 64 karakter hosszúságú sztringek. Az értékek legfeljebb 512 karakter hosszúságú sztringek.	No

UserProfileMemoryItem

Kifejezetten a beszélgetésekből kinyert felhasználói profiladatokat, például preferenciákat, érdeklődési köröket és személyes adatokat tartalmazó memóriaelem.

Name	Típus	Description	Szükséges	Alapértelmezett
tartalom	karakterlánc	Az emlék tartalma.	Igen
kind	felsorolás	A memóriaelem típusa. Lehetséges értékek: user_profile	Igen
memory_id	karakterlánc	A memóriaelem egyedi azonosítója.	Igen
hatókör	karakterlánc	Az a névtér, amely logikailag csoportosítja és elkülöníti az emlékeket, például egy felhasználói azonosítót.	Igen
updated_at	egész szám	A memóriaelem utolsó frissítési ideje.	Igen

WebSearchConfiguration

Webes keresési konfiguráció bing egyéni kereséshez

Name	Típus	Description	Szükséges	Alapértelmezett
instance_name	karakterlánc	A konfigurációnak adott egyéni konfigurációs példány neve.	Igen
project_connection_id	karakterlánc	Project kapcsolatazonosító a bing egyéni kereséssel való alapozáshoz	Igen

WeeklyRecurrenceSchedule

Heti ismétlődési ütemterv.

Name	Típus	Description	Szükséges	Alapértelmezett
Hét napjai	a DayOfWeek tömbje	A hét napjai az ismétlődési ütemezéshez.	Igen
típus	felsorolás	Heti ismétlődés típusa. Lehetséges értékek: Weekly	Igen

WorkflowActionOutputItem

Name	Típus	Description	Szükséges	Alapértelmezett
action_id	karakterlánc	A művelet egyedi azonosítója.	Igen
agent_reference	AgentReference		No
└─ név	karakterlánc	Az ügynök neve. Korlátozások: maxLength: 256	Igen
└─ típus	felsorolás	Lehetséges értékek: agent_reference	Igen
└─ verzió	karakterlánc	Az ügynök verzióazonosítója.	No
kind	karakterlánc	A CSDL-művelet típusa (pl. "SetVariable", 'InvokeAzureAgent').	Igen
parent_action_id	karakterlánc	A szülőművelet azonosítója, ha beágyazott műveletről van szó.	No
previous_action_id	karakterlánc	Az előző művelet azonosítója, ha ez a művelet egy másikat követ.	No
response_id	karakterlánc	Az a válasz, amelyen az elem létrejön.	No
állapot	felsorolás	A művelet állapota (pl. "in_progress", "completed", "failed", "cancelled"). Lehetséges értékek: completed, failed, , in_progresscancelled	Igen
típus	felsorolás	Lehetséges értékek: workflow_action	Igen

WorkflowAgentDefinition

A munkafolyamat-ügynök definíciója.

Name	Típus	Description	Szükséges	Alapértelmezett
kind	felsorolás	Lehetséges értékek: workflow	Igen
rai_config	RaiConfig	Felelős AI (RAI) tartalomszűrési és biztonsági funkciók konfigurálása.	No
└─ rai_policy_name	karakterlánc	Az alkalmazandó RAI-szabályzat neve.	Igen
munkafolyamat	karakterlánc	A munkafolyamat CSDL YAML-definíciója.	No

egész szám

Típus: egész szám

Formátum: int64