Referenční informace k rozhraní REST pro Microsoft Foundry Project

Verze rozhraní API: 2025-11-15-preview

Agenti – vytvoření agenta

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

Vytvoří agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
definice	objekt		Ano
└kind	AgentKind		Ne
└rai_config	RaiConfig	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Jedinečný název, který identifikuje agenta. Název lze použít k načtení/aktualizaci/odstranění agenta. - Musí začínat a končit alfanumerickými znaky, - Může obsahovat pomlčky uprostřed. - Nesmí překročit 63 znaků.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – výpis agentů

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

Vrátí seznam všech agentů.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
laskavý	dotaz	Ne		Filtrační prostředky podle druhu. Pokud není uvedeno, vrátí se všichni agenti.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – získání agenta

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

Načte agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, který se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – aktualizační agent

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

Aktualizuje agenta přidáním nové verze, pokud dojde k nějakým změnám v definici agenta. Pokud se nic nezmění, vrátí existující verzi agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, který se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
definice	objekt		Ano
└kind	AgentKind		Ne
└rai_config	RaiConfig	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – odstranění agenta

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

Odstraní agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, který chcete odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DeleteAgentResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – aktualizace agenta z manifestu

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

Aktualizuje agenta z manifestu přidáním nové verze, pokud dojde k nějakým změnám definice agenta. Pokud se nic nezmění, vrátí existující verzi agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, který se má aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
manifest_id	řetězec	ID manifestu pro import verze agenta z.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – výpis operací kontejneru agentů

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

Výpis operací kontejneru pro agenta

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – získání operace kontejneru agenta

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

Získejte stav operace kontejneru pro agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
operation_id	cesta	Ano	řetězec	Identifikační číslo operace.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentContainerOperationObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse nebo ApiErrorResponse

Agenti – vytvoření verze agenta

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

Vytvořte novou verzi agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Jedinečný název, který identifikuje agenta. Název lze použít k načtení/aktualizaci/odstranění agenta. - Musí začínat a končit alfanumerickými znaky, - Může obsahovat pomlčky uprostřed. - Nesmí překročit 63 znaků.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
definice	objekt		Ano
└kind	AgentKind		Ne
└rai_config	RaiConfig	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentVersionObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – výpis verzí agentů

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

Vrátí seznam verzí agentu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, pro který se mají načíst verze.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – získání verze agenta

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

Načte konkrétní verzi agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, který se má načíst.
agent_version	cesta	Ano	řetězec	Verze agenta, která se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentVersionObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – odstranění verze agenta

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

Odstraní konkrétní verzi agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta, který chcete odstranit.
agent_version	cesta	Ano	řetězec	Verze agenta k odstranění

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DeleteAgentVersionResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – získání kontejneru agentů

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

Získejte kontejner pro konkrétní verzi agenta.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentContainerObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – výpis operací kontejneru verzí agenta

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

Výpis operací kontejneru pro konkrétní verzi agenta

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – odstranění kontejneru agentů

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

Odstraňte kontejner pro konkrétní verzi agenta. Pokud kontejner neexistuje, operace se no-op. Operace je dlouhotrvající operace. Podle pokynů pro návrh pro dlouhotrvající operace v rozhraních REST API Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 202

Popis: Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Typ obsahu	Type	Description
application/json	AgentContainerOperationObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – spuštění kontejneru agentů

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

Spusťte kontejner pro konkrétní verzi agenta. Pokud je kontejner již spuštěný, bude operace no-op. Operace je dlouhotrvající operace. Podle pokynů pro návrh pro dlouhotrvající operace v rozhraních REST API Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
max_replicas	integer	Maximální počet replik. Výchozí hodnota je 1.	Ne	1
min_replicas	integer	Minimální počet replik. Výchozí hodnota je 1.	Ne	1

Responses

Stavový kód: 202

Popis: Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Typ obsahu	Type	Description
application/json	AgentContainerOperationObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – zastavení kontejneru agentů

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

Zastavte kontejner pro konkrétní verzi agenta. Pokud kontejner není spuštěný nebo již zastavený, bude operace no-op. Operace je dlouhotrvající operace. Podle pokynů pro návrh pro dlouhotrvající operace v rozhraních REST API Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 202

Popis: Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Typ obsahu	Type	Description
application/json	AgentContainerOperationObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse nebo ApiErrorResponse

Agenti – aktualizace kontejneru agentů

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

Aktualizujte kontejner pro konkrétní verzi agenta. Pokud kontejner není spuštěný, bude operace no-op. Operace je dlouhotrvající operace. Podle pokynů pro návrh pro dlouhotrvající operace v rozhraních REST API Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
max_replicas	integer	Maximální počet replik.	Ne
min_replicas	integer	Minimální počet replik.	Ne

Responses

Stavový kód: 202

Popis: Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Typ obsahu	Type	Description
application/json	AgentContainerOperationObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – vytvoření verze agenta z manifestu

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

Vytvořte novou verzi agenta z manifestu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
agent_name	cesta	Ano	řetězec	Jedinečný název, který identifikuje agenta. Název lze použít k načtení/aktualizaci/odstranění agenta. - Musí začínat a končit alfanumerickými znaky, - Může obsahovat pomlčky uprostřed. - Nesmí překročit 63 znaků.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
manifest_id	řetězec	ID manifestu pro import verze agenta z.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentVersionObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Agenti – vytvoření agenta z manifestu

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

Vytvoří agenta z manifestu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
manifest_id	řetězec	ID manifestu pro import verze agenta z.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Jedinečný název, který identifikuje agenta. Název lze použít k načtení/aktualizaci/odstranění agenta. - Musí začínat a končit alfanumerickými znaky, - Může obsahovat pomlčky uprostřed. - Nesmí překročit 63 znaků.	Ano
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AgentObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Připojení – seznam

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

Zobrazení seznamu všech připojení v project bez naplnění přihlašovacích údajů připojení

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
connectionType	dotaz	Ne		Seznam připojení tohoto konkrétního typu
defaultConnection	dotaz	Ne	Boolean	Vypsat připojení, která jsou výchozími připojeními
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedConnection

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Připojení – get

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

Získejte připojení podle názvu bez vyplnění přihlašovacích údajů pro připojení

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Popisný název připojení poskytnutý uživatelem.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Připojení

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Připojení – získání s přihlašovacími údaji

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

Získání připojení podle názvu s přihlašovacími údaji pro připojení

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Popisný název připojení poskytnutý uživatelem.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Připojení

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – seznam nejnovějších

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

Výpis nejnovějších verzí jednotlivých datových sad DatasetVersion

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedDatasetVersion

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – verze seznamu

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

Vypsat všechny verze dané verze DatasetVersion

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedDatasetVersion

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – získání verze

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

Získejte konkrétní verzi DatasetVersion. Služba vrátí chybu 404 Nenalezeno, pokud DatasetVersion neexistuje.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze DatasetVersion, které se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DatasetVersion

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – odstranění verze

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

Odstraňte konkrétní verzi DatasetVersion. Služba vrátí 204 Žádný obsah, pokud byla DatasetVersion úspěšně odstraněna nebo pokud DatasetVersion neexistuje.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Verze DatasetVersion, která se má odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – vytvoření nebo aktualizace verze

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

Vytvoření nového nebo aktualizace existujícího souboru DatasetVersion s daným ID verze

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze DatasetVersion, které chcete vytvořit nebo aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: aplikace/merge-patch+json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
typ	objekt	Výčet určující typ dat.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DatasetVersion

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	DatasetVersion

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – získání přihlašovacích údajů

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

Získejte přihlašovací údaje SAS k access účtu storage přidruženému k verzi datové sady.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze DatasetVersion, se kterým se má pracovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	AssetCredentialResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Datové sady – spuštění čekající na nahrání verze

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

Spusťte novou datovou sadu nebo získejte existující čekající nahrávání datové sady pro konkrétní verzi.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze DatasetVersion, se kterým se má pracovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
název_připojení	řetězec	Azure Storage název připojení účtu k vygenerování dočasného tokenu SAS	Ne
pendingUploadId	řetězec	Pokud PendingUploadId není zadaný, použije se náhodný identifikátor GUID.	Ne
pendingUploadType	výčet	BlobReference je jediný podporovaný typ. Možné hodnoty: BlobReference	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PendingUploadResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Nasazení – seznam

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

Výpis všech nasazených modelů v project

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
modelPublisher	dotaz	Ne	řetězec	Model publisher k filtrování modelů podle
modelName	dotaz	Ne	řetězec	Název modelu (publisher konkrétní název) pro filtrování modelů podle
deploymentType	dotaz	Ne		Typ nasazení pro filtrování seznamu podle
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedDeployment

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Nasazení – get

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

Získejte nasazený model.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název nasazení
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Nasazení

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Pravidla vyhodnocení – seznam

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

Vypsat všechna pravidla vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
actionType	dotaz	Ne		Filtrujte podle typu pravidla vyhodnocení.
jméno agenta	dotaz	Ne	řetězec	Filtrujte podle názvu agenta.
povoleno	dotaz	Ne	Boolean	Filtrujte podle stavu povoleno.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedEvaluationRule

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Pravidla vyhodnocení – get

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

Získejte pravidlo vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Jedinečný identifikátor pravidla vyhodnocení.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Vyhodnocení pravidla

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Zkušební pravidla – odstranění

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

Odstraňte pravidlo vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Jedinečný identifikátor pravidla vyhodnocení.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Pravidla vyhodnocení – vytvoření nebo aktualizace

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

Vytvořte nebo aktualizujte pravidlo vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Jedinečný identifikátor pravidla vyhodnocení.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
akce	objekt	Akční model vyhodnocení.	Ano
└- typ	EvaluationRuleActionType	Typ vyhodnocovací akce.	Ne
popis	řetězec	Popis pravidla vyhodnocení.	Ne
zobrazované jméno	řetězec	Zobrazovaný název pravidla vyhodnocení.	Ne
povoleno	Boolean	Označuje, zda je povoleno pravidlo vyhodnocení. Výchozí hodnota je true.	Ano
eventType	objekt	Typ události pravidla vyhodnocení.	Ano
filtr	objekt	Model filtru vyhodnocení.	Ne
└agentName	řetězec	Filtrujte podle názvu agenta.	Ne
ID	řetězec	Jedinečný identifikátor pravidla vyhodnocení.	Ano
systémová data	objekt	Systémová metadata pro pravidlo vyhodnocení.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Vyhodnocení pravidla

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	Vyhodnocení pravidla

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Taxonomie vyhodnocení – seznam

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

Taxonomie vyhodnocení seznamu

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
inputName	dotaz	Ne	řetězec	Filtrujte podle názvu vstupu vyhodnocení.
inputType	dotaz	Ne	řetězec	Filtrujte podle typu vstupu taxonomie.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedEvaluationTaxonomy

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Taxonomie vyhodnocení – get

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

Získejte zkušební spuštění podle názvu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvaluationTaxonomy

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Taxonomie vyhodnocení – odstranění

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

Odstraňte taxonomii vyhodnocení podle názvu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Zkušební taxonomie – vytvoření

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

Vytvořte taxonomii vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název zkušební taxonomie.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
vlastnosti	objekt	Další vlastnosti pro taxonomii vyhodnocení.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
taxonomieKategorie	pole	Seznam kategorií taxonomie.	Ne
taxonomyInput	objekt	Konfigurace vstupu pro taxonomii vyhodnocení.	Ano
└- typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvaluationTaxonomy

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	EvaluationTaxonomy

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Taxonomie vyhodnocení – aktualizace

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

Aktualizujte taxonomii vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název zkušební taxonomie.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
vlastnosti	objekt	Další vlastnosti pro taxonomii vyhodnocení.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
taxonomieKategorie	pole	Seznam kategorií taxonomie.	Ne
taxonomyInput	objekt	Konfigurace vstupu pro taxonomii vyhodnocení.	Ne
└- typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvaluationTaxonomy

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vyhodnocovače – výpis nejnovějších verzí

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

Uveďte nejnovější verzi každého hodnotitele

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
typ	dotaz	Ne		Filtrujte hodnotitele podle typu. Možné hodnoty: 'all', 'custom', 'builtin'.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedEvaluatorVersion

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vyhodnocovače – verze seznamu

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

Vypište všechny verze daného hodnotitele

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
typ	dotaz	Ne		Filtrujte hodnotitele podle typu. Možné hodnoty: 'all', 'custom', 'builtin'.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 100 a výchozí hodnota je 20.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedEvaluatorVersion

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vyhodnocovače – vytvoření verze

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

Vytvoření nového EvaluatorVersion s automaticky zvýšeným ID verze

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
categories	pole	Kategorie hodnotitele	Ano
definice	objekt	Základní konfigurace vyhodnocovače s diskriminátorem	Ano
└data_schema		Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└init_parameters		Schéma JSON (koncept 2020-12) pro vstupní parametry vyhodnocení. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└– metriky	objekt	Seznam výstupních metrik vytvořených tímto hodnotitelem	Ne
└- typ	EvaluatorDefinitionType	Typ definice hodnotitele	Ne
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít vyhodnocovače v Foundry. Nemusí být jedinečné.	Ne
evaluator_type	objekt	Typ hodnotitele	Ano
metadata	objekt	Metadata o hodnotiteli	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne

Responses

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	Vyhodnocovací verze

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vyhodnocovače – získání verze

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

Získejte konkrétní verzi EvaluatorVersion. Služba vrátí chybu 404 Nenalezeno, pokud EvaluatorVersion neexistuje.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze vyhodnocovače Pro načtení.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Vyhodnocovací verze

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vyhodnocovače – odstranění verze

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

Odstraňte konkrétní verzi EvaluatorVersion. Služba vrátí hodnotu 204 No Content, pokud byla úspěšně odstraněna hodnota EvaluatorVersion nebo pokud vlastnost EvaluatorVersion neexistuje.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Verze funkce EvaluatorVersion, která se má odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vyhodnocovače – verze aktualizace

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

Aktualizace existujícího EvaluatorVersion s daným ID verze

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Verze funkce EvaluatorVersion, která se má aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
categories	pole	Kategorie hodnotitele	Ne
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít vyhodnocovače v Foundry. Nemusí být jedinečné.	Ne
metadata	objekt	Metadata o hodnotiteli	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Vyhodnocovací verze

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Indexy – seznam nejnovějších

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

Vypsat nejnovější verzi každého indexu

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedIndex

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Indexy – výpis verzí

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

Vypsat všechny verze daného indexu

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedIndex

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Indexy – získání verze

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

Získejte konkrétní verzi indexu. Služba vrátí chybu 404 Nenalezeno, pokud index neexistuje.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze indexu, který se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Index

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Indexy – odstranění verze

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

Odstraňte konkrétní verzi rejstříku. Služba vrátí hodnotu 204 Žádný obsah, pokud byl index úspěšně odstraněn nebo pokud index neexistuje.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Verze rejstříku, který chcete odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Indexy – vytvoření nebo aktualizace verze

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

Vytvořit nový nebo aktualizovat existující index s daným ID verze

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název prostředku
verze	cesta	Ano	řetězec	Konkrétní ID verze indexu, který chcete vytvořit nebo aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: aplikace/merge-patch+json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
typ	objekt		Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Index

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	Index

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Přehledy – generování

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

Generování přehledů

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
Opakovatelnost –Request-ID	hlavička	Ne	řetězec	Jedinečný, klientem generovaný identifikátor pro zajištění idempotence požadavku. Pro opakované pokusy použijte stejné ID, abyste zabránili duplicitním vyhodnocením.
Opakovatelnost –First-Sent	hlavička	Ne	řetězec	Časové razítko označující, kdy byl tento požadavek poprvé zahájen. Používá se ve spojení s repeatability-request-id pro řízení idempotence.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
zobrazované jméno	řetězec	Uživatelsky přívětivý zobrazovaný název pro vhled.	Ano
ID	řetězec	Jedinečný identifikátor přehledu přehledů.	Ano
metadata	objekt	Metadata o poznatcích.	Ano
└- completedAt	řetězec	Časové razítko, kdy byly přehledy dokončeny.	Ne
└createdAt	řetězec	Časové razítko, kdy byly přehledy vytvořeny.	Ne
žádost	objekt	Žádost o zprávu o přehledech.	Ano
└- typ	InsightType	Typ požadavku.	Ne
výsledek	objekt	Výsledek poznatků.	Ne
└- typ	InsightType	Typ výsledku přehledů.	Ne
stav	objekt	Výčet popisující povolené stavy operací.	Ano

Responses

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	Pohled

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Přehledy – seznam

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

Všechny přehledy jsou uvedeny v obráceném chronologickém pořadí (od nejnovějších).

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
typ	dotaz	Ne		Filtrujte podle typu analýzy.
evalId	dotaz	Ne	řetězec	Vyfiltrujte podle ID vyhodnocení.
identifikátor spuštění	dotaz	Ne	řetězec	Vyfiltrujte podle ID spuštění vyhodnocení.
jméno agenta	dotaz	Ne	řetězec	Filtrujte podle názvu agenta.
includeCoordinates	dotaz	Ne	Boolean	Zda se mají do odpovědi zahrnout souřadnice pro vizualizaci. Výchozí nastavení je „false“.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedInsight

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Přehledy – získání

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

Získejte konkrétní vhled podle ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Jedinečný identifikátor přehledu přehledů.
includeCoordinates	dotaz	Ne	Boolean	Zda se mají do odpovědi zahrnout souřadnice pro vizualizaci. Výchozí nastavení je „false“.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Pohled

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Vytvoření úložiště paměti

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

Vytvořte úložiště paměti.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
definice	objekt	Základní definice pro konfigurace paměťových úložišť.	Ano
└kind	MemoryStoreKind	Druh úložiště paměti.	Ne
popis	řetězec	Popis úložiště paměti čitelný pro člověka.	Ne
metadata	objekt	Libovolná metadata páru klíč-hodnota, která se mají přidružit k úložišti paměti.	Ne
název	řetězec	Název úložiště paměti.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	MemoryStoreObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis úložišť paměti

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

Vypíše všechna paměťová úložiště.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Aktualizace úložiště paměti

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

Aktualizujte úložiště paměti.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti, které chcete aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis úložiště paměti čitelný pro člověka.	Ne
metadata	objekt	Libovolná metadata páru klíč-hodnota, která se mají přidružit k úložišti paměti.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	MemoryStoreObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Získání úložiště paměti

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

Načtěte úložiště paměti.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti, které se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	MemoryStoreObject

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Odstranění úložiště paměti

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

Odstraňte úložiště paměti.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti, které chcete odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DeleteMemoryStoreResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Získání výsledku aktualizace

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

Získejte výsledek aktualizace úložiště paměti.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti.
update_id	cesta	Ano	řetězec	ID operace aktualizace paměti.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	MemoryStoreUpdateResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Odstranění pamětí oboru

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

Odstraní z úložiště paměti všechny paměti spojené s určitým rozsahem.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
obor	řetězec	Obor názvů, který logicky seskupuje a izoluje vzpomínky k odstranění, například ID uživatele.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	MemoryStoreDeleteScopeResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Hledat vzpomínky

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

Vyhledávejte relevantní vzpomínky z paměťového úložiště na základě kontextu konverzace.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti, které se má prohledávat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
items	pole	Položky, pro které je třeba hledat relevantní vzpomínky.	Ne
options	objekt	Možnosti vyhledávání v paměti.	Ne
└max_memories	integer	Maximální počet položek paměti, které se mají vrátit.	Ne
previous_search_id	řetězec	Jedinečné ID předchozího požadavku na vyhledávání, které umožňuje přírůstkové vyhledávání v paměti od místa, kde skončila poslední operace.	Ne
obor	řetězec	Jmenný prostor, který logicky seskupuje a izoluje vzpomínky, například ID uživatele.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	MemoryStoreSearchResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Aktualizace pamětí

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

Aktualizujte paměťové úložiště pomocí konverzačních vzpomínek.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Název úložiště paměti, které chcete aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
items	pole	Položky konverzace, ze kterých lze extrahovat vzpomínky.	Ne
previous_update_id	řetězec	Jedinečné ID předchozí žádosti o aktualizaci, které umožňuje přírůstkové aktualizace paměti od místa, kde poslední operace skončila.	Ne
obor	řetězec	Jmenný prostor, který logicky seskupuje a izoluje vzpomínky, například ID uživatele.	Ano
update_delay	integer	Časový limit před zpracováním aktualizace paměti v sekundách. Pokud je během této doby přijata nová žádost o aktualizaci, zruší se aktuální žádost a resetuje se časový limit. Nastavením na hodnotu 0 se aktualizace spustí okamžitě a bez prodlení. Výchozí hodnota je 300 (5 minut).	Ne	300

Responses

Stavový kód: 202

Popis: Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Typ obsahu	Type	Description
application/json	MemoryStoreUpdateResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Vytvoření konverzace

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

Vytvořte konverzaci.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
items	pole	Počáteční položky, které mají obsahovat kontext konverzace Najednou můžete přidat až 20 položek.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Vypsání konverzací

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

Vrátí seznam všech konverzací.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
agent_name	dotaz	Ne	řetězec	Filtrujte podle názvu agenta. Pokud je zadáno, vrátí se pouze položky přidružené k zadanému agentu.
agent_id	dotaz	Ne	řetězec	Filtrujte podle ID agenta ve formátu name:version. Pokud je zadáno, vrátí se pouze položky přidružené k zadanému ID agenta.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Aktualizace konverzace

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

Aktualizujte konverzaci.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, která se má aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Získání konverzace

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

Načte konverzaci.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, která se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Odstranění konverzace

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

Odstraní konverzaci.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, která se má odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.DeletedConversationResource

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Vytváření položek konverzace

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

Vytvořte položky v konverzaci s daným ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, na které se má položka vytvořit.
include	dotaz	Ne	pole	Další pole, která se mají zahrnout do odpovědi. Další informace najdete v parametru include pro výpis položek konverzace.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
items	pole	Položky, které chcete přidat do konverzace. Najednou můžete přidat až 20 položek.	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ConversationItemList

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis položek konverzace

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

Zobrazí seznam všech položek pro konverzaci s daným ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, na které musí být položky uvedené.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
item_type	dotaz	Ne		Filtrovat podle typu položky Pokud je zadáno, vrátí se pouze položky zadaného typu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Získání položky konverzace

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

Získejte jednu položku z konverzace s danými ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, která obsahuje položku.
item_id	cesta	Ano	řetězec	ID položky konverzace, která se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ItemResource

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Odstranit položku konverzace

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

Odstraňte položku z konverzace s danými ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
conversation_id	cesta	Ano	řetězec	ID konverzace, ze které musí být položka odstraněna.
item_id	cesta	Ano	řetězec	ID položky konverzace, kterou chcete odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evaly OpenAI – výpisy

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

Vypíše všechna vyhodnocení seznamu pro project.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
after	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
limit	dotaz	Ne		Počet spuštění, která se mají načíst
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Řazení běhů podle časového razítka Slouží asc pro vzestupné nebo desc sestupné pořadí. Výchozí hodnota je asc.
seřadit podle	dotaz	Ne	řetězec Možné hodnoty: created_at, updated_at	Hodnocení lze řadit podle času vytvoření nebo času poslední aktualizace. Používání created_at pro čas vytvoření nebo updated_at čas poslední aktualizace.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – vytvoření zkušebního hodnocení

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

Vytvoření vyhodnocení Vytvoří strukturu vyhodnocení, která se dá použít k otestování výkonu modelu. Vyhodnocení je sada testovacích kritérií a konfigurace pro zdroj dat, která určuje schéma dat použitých při vyhodnocení. Po vytvoření vyhodnocení ho můžete spustit na různých modelech a parametrech modelu. Podporujeme několik typů graderů a zdrojů dat. Další informace najdete v tématu

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
konfigurace_zdroj_dat	objekt	Objekt CustomDataSourceConfig, který definuje schéma pro zdroj dat použitý pro zkušební spuštění. Toto schéma slouží k definování tvaru dat, která budou: - Slouží k definování kritérií testování a – Jaká data se vyžadují při vytváření spuštění	Ano
└─ zahrnout_vzorek_schématu	Boolean	Určuje, jestli by se měl očekávat, že naplníte ukázkový obor názvů (tj. vygenerováním odpovědí z vašeho zdroje dat).	Ne
└item_schema	objekt	Schéma JSON pro každý řádek ve zdroji dat.	Ne
└– metadata	objekt	Filtry metadat pro uložený zdroj dat dokončení	Ne
└scénář	výčet	Scénář schématu dat Možné hodnoty: red_team, responses, traces	Ne
└- typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: azure_ai_source	Ne
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Název vyhodnocení.	Ne
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
testovací_kritéria	pole	Seznam známkovačů pro všechny zkušební běhy v této skupině. Gradery můžou odkazovat na proměnné ve zdroji dat pomocí dvou složených závorek, například {{item.variable_name}}. Pokud chcete odkazovat na výstup modelu, použijte sample obor názvů (tj. {{sample.output_text}}).	Ano

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Eval

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evaly OpenAI – odstranění zkušebního hodnocení

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

Odstranění vyhodnocení– Odstranění vyhodnocení

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, které chcete odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DeleteEvalResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evaly OpenAI – získání

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

Získejte vyhodnocení získání vyhodnocení podle ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, které se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Eval

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evaly OpenAI – aktualizace

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

Aktualizujte zkušební aktualizaci určitých vlastností vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, které se má aktualizovat.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec		Ne
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Eval

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – spuštění seznamu

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

Získejte seznam spuštění pro vyhodnocení Získání seznamu spuštění pro vyhodnocení.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
after	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
limit	dotaz	Ne		Počet spuštění, která se mají načíst
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Řazení běhů podle časového razítka Slouží asc pro vzestupné nebo desc sestupné pořadí. Výchozí hodnota je asc.
stav	dotaz	Ne	řetězec Možné hodnoty: queued, in_progress, completed, canceled, failed . Filtr se spouští podle stavu. Jeden z queued, , in_progressfailed, completed, canceled.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – vytvoření zkušebního spuštění

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

Vytvoření zkušebního spuštění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, pro které se má vytvořit běh.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
zdroj dat	objekt	Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.	Ano
└input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate nebo OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Používá se při vzorkování z modelu. Určuje strukturu zpráv předaných do modelu. Může to být odkaz na předem připravenou trajektorii (tj item.input_trajectory. ) nebo šablonu s proměnnými odkazy na item obor názvů.	Ne
└item_generation_params	RedTeamItemGenerationParams	Parametry pro generování položek.	Ne
└model	řetězec	Název modelu, který se má použít ke generování dokončení (např. "o3-mini").	Ne
└sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Ne
└- zdroj	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource nebo OpenAI.EvalResponsesSource	Určuje, co naplní item obor názvů ve zdroji dat tohoto spuštění.	Ne
└- cíl	Cíl	Cílová konfigurace pro vyhodnocení.	Ne
└- typ	řetězec	Diskriminátor typu zdroje dat.	Ne
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Název běhu.	Ne
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvalRun

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – odstranění zkušebního spuštění

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

Odstranění zkušebního spuštění– Odstranění zkušebního spuštění– Odstranění zkušebního spuštění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, ze kterého se má běh odstranit.
run_id	cesta	Ano	řetězec	ID spuštění, které chcete odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DeleteEvalRunResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evaly OpenAI – získání zkušebního spuštění

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

Získejte vyšetření, nechte si udělat hodnocení od ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
run_id	cesta	Ano	řetězec	ID spuštění, které se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvalRun

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – zrušení zkušebního spuštění

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

Zrušení zkušebního spuštění Zrušení probíhajícího zkušebního spuštění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, jehož spuštění chcete zrušit.
run_id	cesta	Ano	řetězec	ID spuštění, které chcete zrušit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvalRun

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – získání výstupních položek spuštění zkušebního spuštění

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

Získání výstupních položek zkušebního spuštění Získání seznamu výstupních položek pro zkušební spuštění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec
run_id	cesta	Ano	řetězec	ID spuštění pro načtení výstupních položek.
after	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
limit	dotaz	Ne		Počet spuštění, která se mají načíst
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Řazení běhů podle časového razítka Slouží asc pro vzestupné nebo desc sestupné pořadí. Výchozí hodnota je asc.
stav	dotaz	Ne	řetězec Možné hodnoty: fail, pass	Filtrovat výstupní položky podle stavu Slouží failed k filtrování podle neúspěšného výstupu. nebo pass filtrovat podle předaných výstupních položek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Evals OpenAI – získání výstupní položky spuštění zkušebního spuštění

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

Získejte výstupní položku zkušebního spuštění Získání výstupní položky spuštění vyhodnocení podle ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
eval_id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
run_id	cesta	Ano	řetězec	ID spuštění, které se má načíst.
output_item_id	cesta	Ano	řetězec	ID výstupní položky, která se má načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	EvalRunOutputItem

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Vytvoření úlohy jemného ladění

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

Vytvoří jemně vyladěnou úlohu, která zahájí proces vytvoření nového modelu z dané datové sady.

Odpověď obsahuje podrobnosti o zaplněné úloze včetně stavu úlohy a názvu jemně vyladěných modelů po dokončení.

Vyučte si další informace o jemném ladění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
hyperparametry	objekt	Hyperparametry používané pro úlohu jemného ladění. Tato hodnota je nyní zastaralá ve prospěch methoda měla by být předána pod parametrem method .	Ne
└batch_size	výčet	Možné hodnoty: auto	Ne
└learning_rate_multiplier	výčet	Možné hodnoty: auto	Ne
└n_epochs	výčet	Možné hodnoty: auto	Ne
integrace	pole	Seznam integrací, které umožňují vaši jemně vyladěnou úlohu.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
metoda	OpenAI.FineTuneMethod	Metoda použitá k jemnému ladění.	Ne
model	řetězec (viz následující platné modely)	Název modelu, který se má vyladit. Můžete vybrat jednu z možností supported models.	Ano
seed	integer	Seed řídí reprodukovatelnost procesu. Předání stejných počátečních parametrů a parametrů úlohy by mělo vést ke stejným výsledkům, ale ve výjimečných případech se může lišit. Pokud není zadaná počáteční hodnota, vygeneruje se za vás.	Ne
suffix	řetězec	Řetězec o velikosti až 64 znaků, který se přidá do jemně vyladěného názvu modelu. Například " suffix custom-model-name" by vytvořil název modelu jako ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Ne	None
tréninkový soubor	řetězec	ID nahraného souboru, který obsahuje trénovací data. Datová sada musí být naformátovaná jako soubor JSONL. Kromě toho musíte nahrát soubor s účelem fine-tune. Obsah souboru by se měl lišit v závislosti na tom, jestli model používá chat, formát dokončení nebo pokud metoda jemného ladění používá formát předvoleb. Další podrobnosti najdete v průvodci laděním .	Ano
validační_soubor	řetězec	ID nahraného souboru, který obsahuje ověřovací data. Pokud tento soubor zadáte, data se použijí k vygenerování ověření. metriky se pravidelně dolaďují. Tyto metriky je možné zobrazit v soubor s výsledky jemného ladění. Stejná data by se neměla nacházet v souborech trénování i ověřování. Datová sada musí být naformátovaná jako soubor JSONL. Soubor musíte nahrát s tímto účelem fine-tune. Další podrobnosti najdete v průvodci laděním .	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis stránkovaných úloh jemného ladění

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

Zobrazení seznamu úloh v organizaci pro vyladění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
after	dotaz	Ne	řetězec	Identifikátor poslední úlohy z předchozího požadavku na stránkování
limit	dotaz	Ne	integer	Počet úloh jemného ladění, které se mají načíst.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Načtení úlohy jemného ladění

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

Získejte informace o jemně vyladěné úloze.

Vyučte si další informace o jemném ladění

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID jemně vyladěné úlohy.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Zrušení úlohy jemného ladění

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

Okamžitě zrušíte úlohu vyladění.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění, které se má zrušit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis kontrolních bodů úloh pro vyladění

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

Zobrazení kontrolních bodů pro jemně vyladěnou úlohu

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění pro získání kontrolních bodů.
after	dotaz	Ne	řetězec	Identifikátor posledního ID kontrolního bodu z předchozího požadavku na stránkování
limit	dotaz	Ne	integer	Počet kontrolních bodů, které se mají načíst

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis událostí úloh v jemném ladění

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

Získejte podrobné aktualizace stavu pro jemně vyladěnou úlohu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění pro získání událostí.
after	dotaz	Ne	řetězec	Identifikátor poslední události z předchozího požadavku na stránkování
limit	dotaz	Ne	integer	Počet událostí, které se mají načíst

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Pozastavení úlohy jemného ladění

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

Pozastavte spuštěnou úlohu vyladit.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění, které se má pozastavit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Obnovení úlohy jemného ladění

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

Obnovte pozastavenou úlohu vyladění.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy vyladění, která se má obnovit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Vytvoření odpovědi – vytvoření streamu odpovědí

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

Vytvoří modelovou odpověď. Vytvoří odpověď modelu (odpověď streamování).

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ne	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
agent	AgentReference	Agent, který se má použít ke generování odpovědi.	Ne
na pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
konverzace	řetězec nebo objekt		Ne
include	pole	Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou: - code_interpreter_call.outputs: Zahrnuje výstupy provádění kódu Pythonu. v nástroji interpretu kódu volají položky. - computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výstupu počítačového programu. - file_search_call.results: Zahrňte výsledky hledání volání nástroje pro vyhledávání souborů. - message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy. - message.output_text.logprobs: Zahrňte protokoly se zprávami pomocníka. - reasoning.encrypted_content: Zahrnuje šifrovanou verzi odůvodnění. tokeny ve výstupech položek odůvodnění. To umožňuje použití položek zdůvodnění v konverzace s vícenásobným otáčením při použití bezstavového rozhraní API pro odpovědi (například pokud je parametr nastaven na store hodnotu, nebo pokud je organizace zaregistrované v programu nulového uchovávání dat).	Ne
vstup	řetězec nebo pole	Textové, obrázkové nebo souborové vstupy do modelu, které se používají k vygenerování odpovědi. Další informace: - Textové vstupy a výstupy vstupy - Image - Souborové vstupy - Spravování stavu konverzace - Funkční volání	Ne
instructions	řetězec	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
previous_response_id	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
požádat	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
reasoning	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
úroveň služby	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
uložit	Boolean	Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím API.	Ne	Pravdivé
datový proud	Boolean	Pokud je nastavená hodnota true, data odpovědi modelu se streamují do klienta. jak se generuje pomocí událostí odesílaných serverem. další informace.	Ne	Nepravda
structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
Teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	1
poslat SMS	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
tool_choice	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Ty může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání souborů. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód.	Ne
top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	1
truncation	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.ResponseStreamEvent

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis odpovědí

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

Vrátí seznam všech odpovědí.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.
agent_name	dotaz	Ne	řetězec	Filtrujte podle názvu agenta. Pokud je zadáno, vrátí se pouze položky přidružené k zadanému agentu.
agent_id	dotaz	Ne	řetězec	Filtrujte podle ID agenta ve formátu name:version. Pokud je zadáno, vrátí se pouze položky přidružené k zadanému ID agenta.
conversation_id	dotaz	Ne	řetězec	Filtrovat podle ID konverzace Pokud je zadáno, vrátí se pouze odpovědi spojené se zadanou konverzací.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Získání odpovědi – získání streamu odpovědí

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

Načte odpověď modelu s daným ID. Načte odpověď modelu s daným ID (odpověď streamování).

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ne	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
response_id	cesta	Ano	řetězec
include[]	dotaz	Ne	pole
datový proud	dotaz	Ne	Boolean
starting_after	dotaz	Ne	integer
přijmout	hlavička	Ne	řetězec Možné hodnoty: text/event-stream

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.ResponseStreamEvent

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Odstranit odpověď

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

Odstraní odpověď modelu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
response_id	cesta	Ano	řetězec	ID odpovědi, která se má odstranit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	DeleteResponseResult

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Zrušit odpověď

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

Zruší odpověď modelu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
response_id	cesta	Ano	řetězec	ID odpovědi, která se má zrušit.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	OpenAI.Response

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Výpis vstupních položek

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

Vrátí seznam vstupních položek pro danou odpověď.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
response_id	cesta	Ano	řetězec
limit	dotaz	Ne	integer	Omezení počtu vrácených objektů. Limit může být v rozsahu od 1 do 100 a výchozí hodnota je 20.
pořadí	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí objektů seřaďte podle jejich časového razítka created_at. asc pro vzestupné pořadí adesc pro sestupné pořadí.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může zahrnovat after=obj_foo, aby bylo možné načíst další stránku seznamu.
před	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování before je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, vaše následné volání může obsahovat parametr před=obj_foo, aby bylo možné načíst předchozí stránku seznamu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	objekt	Data odpovědi pro požadovaný seznam položek.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	ApiErrorResponse

Redteams – seznam

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

Uveďte redteam podle jména.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedRedTeam

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Redteams – získat

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

Získejte redteam podle jména.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Identifikátor běhu červeného týmu.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	RedTeam

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Redteams – vytvoření

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

Vytvoří běh redteamu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
applicationScenario	řetězec	Aplikační scénář pro operaci červeného týmu, pro generování útoků specifických pro daný scénář.	Ne
attackStrategies	pole	Seznam útočných strategií nebo vnořené seznamy útočných strategií.	Ne
zobrazované jméno	řetězec	Název běhu červeného týmu.	Ne
ID	řetězec	Identifikátor běhu červeného týmu.	Ano
numTurns	integer	Počet simulačních kol.	Ne
vlastnosti	objekt	Vlastnosti červeného týmu. Na rozdíl od značek jsou vlastnosti pouze doplňky. Po přidání nelze odebrat vlastnost.	Ne
riskCategories	pole	Seznam kategorií rizik, pro které se mají generovat cíle útoku.	Ne
simulaceOnly	Boolean	Pouze simulace nebo simulace + vyhodnocení. Výchozí hodnota false, pokud je true, výstupem kontroly je konverzace, nikoli výsledek vyhodnocení.	Ne	Nepravda
stav	řetězec	Status červeného týmu. Je nastaven službou a je pouze ke čtení.	Ne
tags	objekt	Značky červeného týmu. Na rozdíl od vlastností jsou značky plně proměnlivé.	Ne
cíl	objekt	Abstraktní třída pro cílovou konfiguraci.	Ano
└- typ	řetězec	Typ konfigurace modelu.	Ne

Responses

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	RedTeam

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Plány – seznam

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

Vypsat všechny plány.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedSchedule

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Plány – odstranění

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

Smazat plán.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Identifikátor plánu.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 204

Popis: Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Plány – získání

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

Získejte rozvrh podle ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Identifikátor plánu.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Plán

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Plány – vytvoření nebo aktualizace

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

Vytvořte nebo aktualizujte rozvrh podle ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Identifikátor plánu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Tělo žádosti

Typ obsahu: application/json

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis plánu	Ne
zobrazované jméno	řetězec	Název plánu	Ne
povoleno	Boolean	Povolený stav plánu.	Ano
ID	řetězec	Identifikátor plánu.	Ano
vlastnosti	objekt	Vlastnosti tabulky. Na rozdíl od značek jsou vlastnosti pouze doplňky. Po přidání nelze odebrat vlastnost.	Ne
provisioningStatus	objekt	Naplánujte si stav zřizování.	Ne
systémová data	objekt	Systémová metadata pro prostředek.	Ano
tags	objekt	Značky plánu. Na rozdíl od vlastností jsou značky plně proměnlivé.	Ne
úkol	objekt	Naplánujte model úlohy.	Ano
Konfigurace └•	objekt	Konfigurace úlohy.	Ne
└- typ	ScheduleTaskType	Typ úkolu	Ne
aktivační událost	objekt	Základní model pro Trigger plánu.	Ano
└- typ	Typ spouště	Typ spouštěče.	Ne

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	Plán

Stavový kód: 201

Popis: Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Typ obsahu	Type	Description
application/json	Plán

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Plány – spuštění seznamu

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

Zobrazí seznam všech spuštění plánu.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
ID	cesta	Ano	řetězec	Identifikátor plánu.
x-ms-client-request-id	hlavička	Ne		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	PagedScheduleRun

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Plány – spuštění

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

Získejte plán spuštěný podle ID.

Parametry identifikátoru URI

Název	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec url	Foundry Project koncový bod ve formuláři https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Pokud máte ve službě Foundry Hub jenom jeden Project nebo chcete cílit na výchozí Project v centru, použijte formulář https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project
verze API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
scheduleId	cesta	Ano	řetězec	Identifikátor plánu.
identifikátor spuštění	cesta	Ano	řetězec	Identifikátor spuštění plánu.

Hlavička požadavku

Název	Povinné	Typ	Description
Authorization	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token} Vygenerování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://ai.azure.com/ Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize scope: https://ai.azure.com/.default

Responses

Stavový kód: 200

Popis: Požadavek byl úspěšný.

Typ obsahu	Type	Description
application/json	ScheduleRun

Stavový kód: výchozí

Popis: Neočekávaná chybová odpověď

Typ obsahu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Components

A2ATool

Agent implementující protokol A2A.

Název	Typ	Description	Povinné	Výchozí
agent_card_path	řetězec	Cesta ke kartě agenta vzhledem k rozhraní base_url. Pokud není zadaný, výchozí hodnota je /.well-known/agent-card.json	Ne
base_url	řetězec	Základní adresa URL agenta.	Ne
project_connection_id	řetězec	ID připojení v project pro server A2A. V připojení je uložena autentizace a další podrobnosti o připojení potřebné pro připojení k A2A serveru.	Ne
typ	výčet	Typ nástroje. Vždy a2a. Možné hodnoty: a2a_preview	Ano

AISearchIndexResource

Zdroj indexu vyhledávání AI.

Název	Typ	Description	Povinné	Výchozí
filtr	řetězec	Řetězec filtru pro vyhledávací prostředek. Vyučte se tady.	Ne
index_asset_id	řetězec	ID datového zdroje indexu pro vyhledávací prostředek.	Ne
název_indexu	řetězec	Název indexu v IndexResource připojeném k tomuto agentu.	Ne
project_connection_id	řetězec	ID připojení indexu v IndexResource připojeném k tomuto agentovi.	Ne
typ_dotazu	objekt	Dostupné typy dotazů pro nástroj Azure AI Search	Ne
top_k	integer	Počet dokumentů, které se mají načíst z hledání a prezentace modelu	Ne

AgentClusterInsightResult

Poznatky z analýzy shluku agentů.

Název	Typ	Description	Povinné	Výchozí
clusterInsight	ClusterInsightResult	Postřehy ze shlukové analýzy.	Ano
typ	výčet	Typ výsledku přehledů. Možné hodnoty: AgentClusterInsight	Ano

AgentClusterInsightsRequest

Přehledy o sadě výsledků vyhodnocení agenta

Název	Typ	Description	Povinné	Výchozí
jméno agenta	řetězec	Identifikátor agenta.	Ano
konfigurace modelu	objekt	Konfigurace modelu použitého při generování náhledů.	Ne
└- modelDeploymentName	řetězec	Nasazení modelu, které má být vyhodnoceno. Přijímá buď samotný název nasazení, nebo s názvem připojení jako {connectionName}/<modelDeploymentName>.	Ne
typ	výčet	Typ požadavku. Možné hodnoty: AgentClusterInsight	Ano

AgentContainerObject

Podrobnosti o kontejneru konkrétní verze agenta

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	řetězec	Čas vytvoření kontejneru.	Ano
error_message	řetězec	Chybová zpráva, pokud se kontejneru nepodařilo pracovat, pokud existuje.	Ne
max_replicas	integer	Maximální počet replik pro kontejner. Výchozí hodnota je 1.	Ne
min_replicas	integer	Minimální počet replik pro kontejner. Výchozí hodnota je 1.	Ne
objekt	výčet	Typ objektu, který je vždy agent.container. Možné hodnoty: agent.container	Ano
stav	objekt	Stav kontejneru konkrétní verze agenta	Ano
updated_at	řetězec	Čas poslední aktualizace kontejneru.	Ano

AgentContainerOperationError

Podrobnosti o chybě operace kontejneru( pokud existuje).

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Kód chyby operace kontejneru, pokud existuje.	Ano
zpráva	řetězec	Chybová zpráva operace kontejneru, pokud existuje.	Ano
typ	řetězec	Typ chyby operace kontejneru, pokud existuje.	Ano

AgentContainerOperationObject

Operace kontejneru pro konkrétní verzi agenta.

Název	Typ	Description	Povinné	Výchozí
agent_id	řetězec	ID agenta.	Ano
agent_version_id	řetězec	ID verze agenta.	Ano
kontejner	objekt	Podrobnosti o kontejneru konkrétní verze agenta	Ne
└created_at	řetězec	Čas vytvoření kontejneru.	Ne
└error_message	řetězec	Chybová zpráva, pokud se kontejneru nepodařilo pracovat, pokud existuje.	Ne
└max_replicas	integer	Maximální počet replik pro kontejner. Výchozí hodnota je 1.	Ne
└min_replicas	integer	Minimální počet replik pro kontejner. Výchozí hodnota je 1.	Ne
└– objekt	výčet	Typ objektu, který je vždy agent.container. Možné hodnoty: agent.container	Ne
└stavu	AgentContainerStatus	Stav kontejneru konkrétní verze agenta	Ne
└updated_at	řetězec	Čas poslední aktualizace kontejneru.	Ne
chyba	objekt	Podrobnosti o chybě operace kontejneru( pokud existuje).	Ne
└ kód	řetězec	Kód chyby operace kontejneru, pokud existuje.	Ne
└- zpráva	řetězec	Chybová zpráva operace kontejneru, pokud existuje.	Ne
└- typ	řetězec	Typ chyby operace kontejneru, pokud existuje.	Ne
ID	řetězec	ID operace kontejneru. Toto ID je jedinečný identifikátor v systému.	Ano
stav	objekt	Stav operace kontejneru pro konkrétní verzi agenta	Ano

AgentContainerOperationStatus

Stav operace kontejneru pro konkrétní verzi agenta

Vlastnictví	Hodnota
Description	Stav operace kontejneru pro konkrétní verzi agenta
Type	řetězec
Hodnoty	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Stav kontejneru konkrétní verze agenta

Vlastnictví	Hodnota
Description	Stav kontejneru konkrétní verze agenta
Type	řetězec
Hodnoty	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Diskriminátor pro agentaDefinition

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schema
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition
prompt	PromptAgentDefinition

Název	Typ	Description	Povinné	Výchozí
laskavý	AgentKind		Ano
rai_config	objekt	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
└rai_policy_name	řetězec	Název zásady RAI, která se má použít.	Ne

AgentId

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Název agenta.	Ano
typ	výčet	Možné hodnoty: agent_id	Ano
verze	řetězec	Identifikátor verze agenta.	Ano

AgentKind

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	prompt hosted container_app workflow

AgentObject

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	Jedinečný identifikátor agenta.	Ano
název	řetězec	Název agenta.	Ano
objekt	výčet	Typ objektu, který je vždy 'agent'. Možné hodnoty: agent	Ano
versions	objekt	Nejnovější verze agenta.	Ano
└nejnovější	AgentVersionObject		Ne

AgentProtocol

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	activity_protocol responses

Odkaz na agenta

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Název agenta.	Ano
typ	výčet	Možné hodnoty: agent_reference	Ano
verze	řetězec	Identifikátor verze agenta.	Ne

AgentTaxonomyInput

Konfigurace vstupu pro taxonomii vyhodnocení, pokud je typ vstupu agent.

Název	Typ	Description	Povinné	Výchozí
riskCategories	pole	Seznam kategorií rizik k hodnocení.	Ano
cíl	objekt	Představuje cíl určující Azure agenta AI.	Ano
└– název	řetězec	Jedinečný identifikátor agenta Azure AI.	Ne
└tool_descriptions	pole	Parametry používané k řízení chování vzorkování agenta během generování textu.	Ne
└- typ	výčet	Typ cíle, vždy azure_ai_agent. Možné hodnoty: azure_ai_agent	Ne
└- verze	řetězec	Verze agenta Azure AI.	Ne
typ	výčet	Typ vstupu taxonomie vyhodnocení. Možné hodnoty: agent	Ano

AgentTaxonomyInputUpdate

Konfigurace vstupu pro taxonomii vyhodnocení, pokud je typ vstupu agent.

Název	Typ	Description	Povinné	Výchozí
riskCategories	pole	Seznam kategorií rizik k hodnocení.	Ne
cíl	objekt	Představuje cíl určující Azure agenta AI.	Ne
└– název	řetězec	Jedinečný identifikátor agenta Azure AI.	Ne
└tool_descriptions	pole	Parametry používané k řízení chování vzorkování agenta během generování textu.	Ne
└- typ	výčet	Typ cíle, vždy azure_ai_agent. Možné hodnoty: azure_ai_agent	Ne
└- verze	řetězec	Verze agenta Azure AI.	Ne
typ	výčet	Typ vstupu taxonomie vyhodnocení. Možné hodnoty: agent	Ne

AgentVersionObject

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer	Unixové časové razítko (sekundy), kdy byl agent vytvořen.	Ano
definice	AgentDefinition		Ano
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
ID	řetězec	Jedinečný identifikátor verze agenta.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ano
název	řetězec	Název agenta. Název lze použít k načtení/aktualizaci/odstranění agenta.	Ano
objekt	výčet	Typ objektu, který je vždy 'agent.version'. Možné hodnoty: agent.version	Ano
verze	řetězec	Identifikátor verze agenta. Agenti jsou neměnní a každá aktualizace vytvoří novou verzi při zachování stejného názvu.	Ano

AgenticIdentityCredentials

Definice přihlašovacích údajů identity agenta

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: AgenticIdentityToken	Ano

ApiErrorResponse

Chybová odpověď při selhání rozhraní API.

Název	Typ	Description	Povinné	Výchozí
chyba	OpenAI.Error		Ano

ApiKeyCredentials

Definice přihlašovacích údajů klíče rozhraní API

Název	Typ	Description	Povinné	Výchozí
klíč	řetězec	Klíč rozhraní API	Ne
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: ApiKey	Ano

AssetCredentialResponse

Představuje odkaz na objekt blob určený ke spotřebě

Název	Typ	Description	Povinné	Výchozí
blobReference	objekt	Podrobnosti o referenčních informacích o objektech blob.	Ano
└– identifikátor blobUri	řetězec	Cesta URI objektu blob pro klienta k nahrání dat Příklad: https://blob.windows.core.net/Container/Path	Ne
└- přihlašovací údaje	SasCredential	Informace o přihlašovacích údajích pro access účtu storage.	Ne
└- storageAccountArmId	řetězec	ID ARM účtu storage, který se má použít.	Ne

ID majetku

Identifikátor uloženého prostředku.

Typ: řetězec

AttackStrategy

Strategie pro útoky.

Vlastnictví	Hodnota
Description	Strategie pro útoky.
Type	řetězec
Hodnoty	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansii_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundations.Error

Objekt chyby.

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ano
Podrobnosti	pole	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.	Ne
innererror	objekt	Objekt obsahující konkrétnější informace o chybě. Pokyny k rozhraní REST API Azure – https://aka.ms/AzureRestApiGuidelines#handling-errors.	Ne
└ kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ne
└- vnitřní chyba	Azure. Core.Foundations.InnerError	Vnitřní chyba.	Ne
zpráva	řetězec	Čitelné znázornění chyby člověkem.	Ano
cíl	řetězec	Cíl chyby.	Ne

Azure. Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Název	Typ	Description	Povinné	Výchozí
chyba	objekt	Objekt chyby.	Ano
└ kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ne
└- podrobnosti	pole	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.	Ne
└- vnitřní chyba	Azure. Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.	Ne
└- zpráva	řetězec	Čitelné znázornění chyby člověkem.	Ne
└- cíl	řetězec	Cíl chyby.	Ne

Azure. Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Pokyny k rozhraní REST API Azure – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ne
innererror	objekt	Objekt obsahující konkrétnější informace o chybě. Pokyny k rozhraní REST API Azure – https://aka.ms/AzureRestApiGuidelines#handling-errors.	Ne
└ kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ne
└- vnitřní chyba	Azure. Core.Foundations.InnerError	Vnitřní chyba.	Ne

Azure. Core.Foundations.OperationState

Výčet popisující povolené stavy operací.

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Univerzální jedinečný identifikátor

Typ: řetězec

Formát: uuid

AzureAIAgentTarget

Představuje cíl určující Azure agenta AI.

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Jedinečný identifikátor agenta Azure AI.	Ano
tool_descriptions	pole	Parametry používané k řízení chování vzorkování agenta během generování textu.	Ne
typ	výčet	Typ cíle, vždy azure_ai_agent. Možné hodnoty: azure_ai_agent	Ano
verze	řetězec	Verze agenta Azure AI.	Ne

AzureAIAgentTargetUpdate

Představuje cíl určující Azure agenta AI.

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Jedinečný identifikátor agenta Azure AI.	Ne
tool_descriptions	pole	Parametry používané k řízení chování vzorkování agenta během generování textu.	Ne
typ	výčet	Typ cíle, vždy azure_ai_agent. Možné hodnoty: azure_ai_agent	Ne
verze	řetězec	Verze agenta Azure AI.	Ne

AzureAIAssistantTarget

Představuje cíl určující koncový bod Azure AI Assistant (Agent V1), včetně jeho ID.

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	Jedinečný identifikátor pomocníka Azure AI.	Ne
tool_descriptions	pole	Popisy nástrojů dostupných asistentovi.	Ano
typ	výčet	Typ cíle, vždy azure_ai_assistant. Možné hodnoty: azure_ai_assistant	Ano

AzureAIAssistantTargetUpdate

Představuje cíl určující koncový bod Azure AI Assistant (Agent V1), včetně jeho ID.

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	Jedinečný identifikátor pomocníka Azure AI.	Ne
tool_descriptions	pole	Popisy nástrojů dostupných asistentovi.	Ne
typ	výčet	Typ cíle, vždy azure_ai_assistant. Možné hodnoty: azure_ai_assistant	Ne

AzureAIEvaluator

Azure definici vyhodnocovače umělé inteligence pro slévatelské vyhodnocovače.

Název	Typ	Description	Povinné	Výchozí
mapování dat	objekt	Model, který se má použít pro vyhodnocení. Musí podporovat strukturované výstupy.	Ne
evaluator_name	řetězec	Název vyhodnocovače.	Ano
evaluator_version	řetězec	Verze vyhodnocovače.	Ne
initialization_parameters	objekt	Parametry inicializace pro vyhodnocení. Musí podporovat strukturované výstupy.	Ne
název	řetězec	Název hodnotitele.	Ano
typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: azure_ai_evaluator	Ano

AzureAIModelTarget

Představuje cíl určující model Azure AI pro operace vyžadující výběr modelu.

Název	Typ	Description	Povinné	Výchozí
model	řetězec	Jedinečný identifikátor modelu Azure AI.	Ne
parametry vzorkování	objekt	Představuje sadu parametrů sloužících k řízení chování vzorkování jazykového modelu během generování textu.	Ne
└─ maximální_dokončovací_tokeny	integer	Maximální počet tokenů povolených v dokončení	Ne
└semeno	integer	Náhodné počáteční hodnoty pro reprodukovatelnost.	Ne
└− teplota	číslo	Parametr teploty pro vzorkování.	Ne
└top_p	číslo	Parametr top-p pro vzorkování vzorků.	Ne
typ	výčet	Typ cíle, vždy azure_ai_model. Možné hodnoty: azure_ai_model	Ano

AzureAIModelTargetUpdate

Představuje cíl určující model Azure AI pro operace vyžadující výběr modelu.

Název	Typ	Description	Povinné	Výchozí
model	řetězec	Jedinečný identifikátor modelu Azure AI.	Ne
parametry vzorkování	objekt	Představuje sadu parametrů sloužících k řízení chování vzorkování jazykového modelu během generování textu.	Ne
└─ maximální_dokončovací_tokeny	integer	Maximální počet tokenů povolených v dokončení	Ne
└semeno	integer	Náhodné počáteční hodnoty pro reprodukovatelnost.	Ne
└− teplota	číslo	Parametr teploty pro vzorkování.	Ne
└top_p	číslo	Parametr top-p pro vzorkování vzorků.	Ne
typ	výčet	Typ cíle, vždy azure_ai_model. Možné hodnoty: azure_ai_model	Ne

AzureAIRedTeam

Název	Typ	Description	Povinné	Výchozí
item_generation_params	objekt	Představuje parametry pro generování červených položek týmu.	Ano
└attack_strategies	pole	Kolekce strategií útoku, které se mají použít.	Ne
└num_turns	integer	Počet otáček povolených ve hře.	Ne
└- typ	výčet	Typ parametrů generování položek, vždy red_team. Možné hodnoty: red_team	Ne
cíl	objekt	Základní třída pro cíle s podporou diskriminátoru.	Ano
└- typ	řetězec	Typ cíle.	Ne
typ	výčet	Typ zdroje dat. Vždy azure_ai_red_team. Možné hodnoty: azure_ai_red_team	Ano

AzureAIResponses

Představuje zdroj dat pro zkušební spuštění, která jsou specifická pro scénáře průběžného vyhodnocování.

Název	Typ	Description	Povinné	Výchozí
event_configuration_id	řetězec	Název konfigurace události přidružený k tomuto zkušebnímu spuštění.	Ano
item_generation_params	objekt	Představuje parametry pro průběžné generování položek hodnocení.	Ano
└data_mapping	objekt	Mapování ze zdrojových polí na pole response_id požadované pro načtení historie chatu.	Ne
└max_num_turns	integer	Maximální počet otočení historie chatu, který se má vyhodnotit.	Ne
└- zdroj	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource	Zdroj, ze kterého se čte obsah JSONL.	Ne
└- typ	výčet	Typ parametrů generování položek, vždy ResponseRetrieval. Možné hodnoty: response_retrieval	Ne
max_runs_hourly	integer	Maximální povolený počet vyhodnocovacích běhů za hodinu.	Ano
typ	výčet	Typ zdroje dat, vždy AzureAIResponses. Možné hodnoty: azure_ai_responses	Ano

AzureAISearchAgentTool

Informace o definici vstupu pro nástroj Azure AI search, jak slouží ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
azure_ai_search	objekt	Sada prostředků indexu, které nástroj azure_ai_search používá.	Ano
└- indexy	pole	Indexy připojené k tomuto agentu. Může existovat maximálně 1 index. prostředek připojený k agentu.	Ne
typ	výčet	Typ objektu, který je vždy 'azure_ai_search'. Možné hodnoty: azure_ai_search	Ano

AzureAI Vyhledávací Index

Definice indexu Azure AI Search

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ indexu Možné hodnoty: AzureSearch	Ano

AzureAISearchIndexUpdate

Definice indexu Azure AI Search

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ indexu Možné hodnoty: AzureSearch	Ano

AzureAISearchQueryType

Dostupné typy dotazů pro nástroj Azure AI Search

Vlastnictví	Hodnota
Description	Dostupné typy dotazů pro nástroj Azure AI Search
Type	řetězec
Hodnoty	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchToolResource

Sada prostředků indexu, které nástroj azure_ai_search používá.

Název	Typ	Description	Povinné	Výchozí
indexy	pole	Indexy připojené k tomuto agentu. Může existovat maximálně 1 index. prostředek připojený k agentu.	Ano

AzureAISource

Název	Typ	Description	Povinné	Výchozí
scénář	výčet	Scénář schématu dat Možné hodnoty: red_team, responses, traces	Ano
typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: azure_ai_source	Ano

AzureFunctionAgentTool

Informace o definici vstupu pro nástroj Azure Function Tool, jak se používá ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
azure_function	objekt	Definice funkce Azure.	Ano
└– funkce	objekt	Definice funkce azure a jejích parametrů.	Ne
└- popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
└– parametry		Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON.	Ne
└input_binding	AzureFunctionBinding	Vstupní storage fronta Trigger fronty storage spustí funkci při přidání zpráv.	Ne
└output_binding	AzureFunctionBinding	Výstupní storage fronta Funkce zapíše výstup do této fronty při zpracování vstupních položek.	Ne
typ	výčet	Typ objektu, který je vždy 'browser_automation'. Možné hodnoty: azure_function	Ano

AzureFunctionBinding

Struktura pro zachování názvu fronty a identifikátoru URI storage.

Název	Typ	Description	Povinné	Výchozí
storage_queue	objekt	Struktura pro zachování názvu fronty a identifikátoru URI storage.	Ano
└queue_name	řetězec	Název Azure funkce storage fronty.	Ne
└- queue_service_endpoint	řetězec	Identifikátor URI služby fronty Azure Storage umožňuje manipulovat s frontou.	Ne
typ	výčet	Typ vazby, která je vždy "storage_queue". Možné hodnoty: storage_queue	Ano

AzureFunctionDefinition

Definice funkce Azure.

Název	Typ	Description	Povinné	Výchozí
funkce	objekt	Definice funkce azure a jejích parametrů.	Ano
└- popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
└– parametry		Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON.	Ne
input_binding	objekt	Struktura pro zachování názvu fronty a identifikátoru URI storage.	Ano
└storage_queue	AzureFunctionStorageQueue	Storage fronty.	Ne
└- typ	výčet	Typ vazby, která je vždy "storage_queue". Možné hodnoty: storage_queue	Ne
output_binding	objekt	Struktura pro zachování názvu fronty a identifikátoru URI storage.	Ano
└storage_queue	AzureFunctionStorageQueue	Storage fronty.	Ne
└- typ	výčet	Typ vazby, která je vždy "storage_queue". Možné hodnoty: storage_queue	Ne

AzureFunctionStorageQueue

Struktura pro zachování názvu fronty a identifikátoru URI storage.

Název	Typ	Description	Povinné	Výchozí
queue_name	řetězec	Název Azure funkce storage fronty.	Ano
queue_service_endpoint	řetězec	Identifikátor URI služby fronty Azure Storage umožňuje manipulovat s frontou.	Ano

AzureOpenAIModelConfiguration

Azure konfiguraci modelu OpenAI. Služba by vybrala verzi rozhraní API pro dotazování modelu.

Název	Typ	Description	Povinné	Výchozí
modelDeploymentName	řetězec	Název nasazení pro model AOAI. Příklad: gpt-4o pokud je v AIServices nebo na connection_name/deployment_name základě připojení (např. my-aoai-connection/gpt-4o).	Ano
typ	výčet	Možné hodnoty: AzureOpenAIModel	Ano

BaseCredentials

Základní třída pro pověření pro připojení

Diskriminátor pro BaseCredentials

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SasCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken	AgenticIdentityCredentials

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ přihlašovacích údajů používaný připojením	Ano

BingCustomSearchAgentTool

Informace o definici vstupu pro Bing vlastní vyhledávací nástroj, který slouží ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
bing_custom_search_preview	objekt	Parametry vlastního vyhledávacího nástroje bing.	Ano
└search_configurations	pole	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji.	Ne
typ	výčet	Typ objektu, který je vždy "bing_custom_search". Možné hodnoty: bing_custom_search_preview	Ano

BingCustomSearchConfiguration

Konfigurace vlastního vyhledávání bing.

Název	Typ	Description	Povinné	Výchozí
count	integer	Počet výsledků hledání, které se mají vrátit v odpovědi rozhraní API bing	Ne
freshness	řetězec	Filtrujte výsledky vyhledávání podle určitého časového rozsahu. Podívejte se na ukázné hodnoty tady.	Ne
instance_name	řetězec	Název vlastní instance konfigurace zadané ke konfiguraci.	Ano
trh	řetězec	Trh, ze kterého pocházejí výsledky.	Ne
project_connection_id	řetězec	Project ID připojení pro uzemnění s hledáním bing	Ano
set_lang	řetězec	Jazyk, který se má použít pro řetězce uživatelského rozhraní při volání Bing API.	Ne

BingCustomSearchToolParameters

Parametry vlastního vyhledávacího nástroje bing.

Název	Typ	Description	Povinné	Výchozí
search_configurations	pole	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji.	Ano

BingGroundingAgentTool

Informace o definici vstupu pro bing vyhledávací nástroj, který slouží ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
bing_grounding	objekt	Parametry bing uzemnění vyhledávacího nástroje.	Ano
└search_configurations	pole	Konfigurace vyhledávání připojené k tomuto nástroji. Může existovat maximálně 1 vyhledejte konfigurační prostředek připojený k nástroji.	Ne
typ	výčet	Typ objektu, který je vždy "bing_grounding". Možné hodnoty: bing_grounding	Ano

BingGroundingSearchConfiguration

Konfigurace hledání pro Bing uzemnění

Název	Typ	Description	Povinné	Výchozí
count	integer	Počet výsledků hledání, které se mají vrátit v odpovědi rozhraní API bing	Ne
freshness	řetězec	Filtrujte výsledky vyhledávání podle určitého časového rozsahu. Podívejte se na ukázné hodnoty tady.	Ne
trh	řetězec	Trh, ze kterého pocházejí výsledky.	Ne
project_connection_id	řetězec	Project ID připojení pro uzemnění s hledáním bing	Ano
set_lang	řetězec	Jazyk, který se má použít pro řetězce uživatelského rozhraní při volání Bing API.	Ne

BingGroundingSearchToolParameters

Parametry bing uzemnění vyhledávacího nástroje.

Název	Typ	Description	Povinné	Výchozí
search_configurations	pole	Konfigurace vyhledávání připojené k tomuto nástroji. Může existovat maximálně 1 vyhledejte konfigurační prostředek připojený k nástroji.	Ano

BlobReference

Podrobnosti o referenčních informacích o objektech blob.

Název	Typ	Description	Povinné	Výchozí
blobUri	řetězec	Cesta URI objektu blob pro klienta k nahrání dat Příklad: https://blob.windows.core.net/Container/Path	Ano
přihlašovací údaje	objekt	Definice přihlašovacích údajů SAS	Ano
└– sasUri	řetězec	Identifikátor URI SAS	Ne
└- typ	výčet	Typ přihlašovacích údajů Možné hodnoty: SAS	Ne
storageAccountArmId	řetězec	ID ARM účtu storage, který se má použít.	Ano

BrowserAutomationAgentTool

Informace o definici vstupu pro nástroj pro automatizaci prohlížeče, který se používá ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
browser_automation_preview	objekt	Definice vstupních parametrů pro nástroj pro automatizaci prohlížeče.	Ano
└- připojení	BrowserAutomationToolConnectionParameters	Parametry připojení project přidružené k nástroji Automatizace prohlížeče.	Ne
typ	výčet	Typ objektu, který je vždy 'browser_automation'. Možné hodnoty: browser_automation_preview	Ano

BrowserAutomationToolConnectionParameters

Definice vstupních parametrů pro připojení používané nástrojem pro automatizaci prohlížeče.

Název	Typ	Description	Povinné	Výchozí
project_connection_id	řetězec	ID project připojení k prostředku Azure Playwright.	Ano

BrowserAutomationToolParameters

Definice vstupních parametrů pro nástroj pro automatizaci prohlížeče.

Název	Typ	Description	Povinné	Výchozí
propojení	objekt	Definice vstupních parametrů pro připojení používané nástrojem pro automatizaci prohlížeče.	Ano
└project_connection_id	řetězec	ID project připojení k prostředku Azure Playwright.	Ne

CaptureStructuredOutputsTool

Nástroj pro zachycení strukturovaných výstupů

Název	Typ	Description	Povinné	Výchozí
výstupy	objekt	Strukturovaný výstup, který může vytvořit agent.	Ano
└- popis	řetězec	Popis výstupu, který se má vygenerovat. Model jej používá k určení, kdy se má výstup vygenerovat.	Ne
└– název	řetězec	Název strukturovaného výstupu.	Ne
└- schéma		Schéma JSON pro strukturovaný výstup.	Ne
└- striktní	Boolean	Zda se má vynutit přísné ověřování. Výchozí true.	Ne
typ	výčet	Typ nástroje. Vždy capture_structured_outputs. Možné hodnoty: capture_structured_outputs	Ano

ChartCoordinate

Souřadnice pro analytický diagram.

Název	Typ	Description	Povinné	Výchozí
velikost	integer	Velikost prvku grafu.	Ano
x	integer	Souřadnice osy X.	Ano
y	integer	Souřadnice osy Y.	Ano

ChatSummaryMemoryItem

Paměťová položka obsahující souhrn extrahovaný z konverzací.

Název	Typ	Description	Povinné	Výchozí
laskavý	výčet	Druh paměťové položky. Možné hodnoty: chat_summary	Ano

ClusterInsightResult

Postřehy ze shlukové analýzy.

Název	Typ	Description	Povinné	Výchozí
clusters	pole	Seznam clusterů identifikovaných v přehledech.	Ano
souřadnice	objekt	Volitelné mapování ID na 2D souřadnice, které UX používá pro vizualizaci. Klíče mapy jsou identifikátory řetězců (například ID clusteru nebo ukázkové ID). a hodnoty jsou souřadnice a velikost vizuálu pro vykreslení v 2D grafu. Tato vlastnost není vynechána, pokud klient požádá o souřadnice (například předáním includeCoordinates=true parametru dotazu). Příklad: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Souřadnice jsou určeny pouze pro vizualizaci na straně klienta a ne upravte výsledky kanonického přehledu.	Ne
souhrn	objekt	Shrnutí analýzy shluků chyb.	Ano
Metoda └}	řetězec	Metoda používaná pro shlukování.	Ne
└- sampleCount	integer	Celkový počet analyzovaných vzorků.	Ne
└- uniqueClusterCount	integer	Celkový počet unikátních clusterů.	Ne
└- uniqueSubclusterCount	integer	Celkový počet jedinečných popisků podclusteru.	Ne
└─ využití	ClusterTokenUsage	Použití tokenu při provádění analýzy clusteringu	Ne

ClusterTokenUsage

Použití tokenu pro clusterovou analýzu

Název	Typ	Description	Povinné	Výchozí
inputTokenUsage	integer	Použití vstupního tokenu	Ano
outputTokenUsage	integer	Použití výstupního tokenu	Ano
totalTokenUsage	integer	Celkové využití tokenu	Ano

CodeBasedEvaluatorDefinition

Definice vyhodnocovače založená na kódu pomocí pythonského kódu

Název	Typ	Description	Povinné	Výchozí
code_text	řetězec	Vložený text kódu pro vyhodnocovatele	Ano
typ	výčet	Možné hodnoty: code	Ano

Připojení

Operace odpovědi ze seznamu a získání připojení

Název	Typ	Description	Povinné	Výchozí
přihlašovací údaje	objekt	Základní třída pro pověření pro připojení	Ano
└- typ	CredentialType	Typ přihlašovacích údajů používaných připojením	Ne
ID	řetězec	Jedinečný identifikátor připojení vygenerovaný službou	Ano
isDefault	Boolean	Zda je připojení označeno jako výchozí připojení svého typu	Ano
metadata	objekt	Metadata připojení	Ano
název	řetězec	Popisný název připojení poskytnutý uživatelem.	Ano
cíl	řetězec	Adresa URL připojení, která se má použít pro tuto službu	Ano
typ	objekt	Typ (nebo kategorie) připojení	Ano

Typ připojení

Typ (nebo kategorie) připojení

Vlastnictví	Hodnota
Description	Typ (nebo kategorie) připojení
Type	řetězec
Hodnoty	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool

ContainerAppAgentDefinition

Definice agenta aplikace kontejneru.

Název	Typ	Description	Povinné	Výchozí
container_app_resource_id	řetězec	ID prostředku aplikace kontejneru Azure, která je hostitelem tohoto agenta. Není měnitelné napříč verzemi.	Ano
container_protocol_versions	pole	Protokoly, které agent podporuje pro příchozí komunikaci kontejnerů.	Ano
ingress_subdomain_suffix	řetězec	Přípona, která se má použít pro subdoménu aplikace při odesílání příchozího přenosu dat agentovi. Může to být popisek (např. "---current"), konkrétní revize (např. "--0000001") nebo prázdný pro použití výchozího koncového bodu pro aplikaci kontejneru.	Ano
laskavý	výčet	Možné hodnoty: container_app	Ano

ContinuousEvalItemGenerationParams

Představuje parametry pro průběžné generování položek hodnocení.

Název	Typ	Description	Povinné	Výchozí
mapování dat	objekt	Mapování ze zdrojových polí na pole response_id požadované pro načtení historie chatu.	Ano
max_num_turns	integer	Maximální počet otočení historie chatu, který se má vyhodnotit.	Ano
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ne
typ	výčet	Typ parametrů generování položek, vždy ResponseRetrieval. Možné hodnoty: response_retrieval	Ano

ContinuousEvaluationRuleAction

Akce pravidla vyhodnocení pro průběžné vyhodnocování.

Název	Typ	Description	Povinné	Výchozí
evalId	řetězec	ID vyhodnocení, do kterého se má přidat průběžné vyhodnocování.	Ano
maxHourlyRuns	integer	Maximální povolený počet vyhodnocovacích běhů za hodinu.	Ne
typ	výčet	Možné hodnoty: continuousEvaluation	Ano

CosmosDBIndex

Definice indexu úložiště vektorů CosmosDB

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ indexu Možné hodnoty: CosmosDBNoSqlVectorStore	Ano

CosmosDBIndexUpdate

Definice indexu úložiště vektorů CosmosDB

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ indexu Možné hodnoty: CosmosDBNoSqlVectorStore	Ano

CreateAgentFromManifestRequest

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
manifest_id	řetězec	ID manifestu pro import verze agenta z.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Jedinečný název, který identifikuje agenta. Název lze použít k načtení/aktualizaci/odstranění agenta. - Musí začínat a končit alfanumerickými znaky, - Může obsahovat pomlčky uprostřed. - Nesmí překročit 63 znaků.	Ano
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

CreateAgentRequest

Název	Typ	Description	Povinné	Výchozí
definice	objekt		Ano
└kind	AgentKind		Ne
└rai_config	RaiConfig	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Jedinečný název, který identifikuje agenta. Název lze použít k načtení/aktualizaci/odstranění agenta. - Musí začínat a končit alfanumerickými znaky, - Může obsahovat pomlčky uprostřed. - Nesmí překročit 63 znaků.	Ano

CreateAgentVersionFromManifestRequest

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
manifest_id	řetězec	ID manifestu pro import verze agenta z.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

CreateAgentVersionRequest

Název	Typ	Description	Povinné	Výchozí
definice	objekt		Ano
└kind	AgentKind		Ne
└rai_config	RaiConfig	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

VytvořitPožadavekNaHodnocení

Název	Typ	Description	Povinné	Výchozí
konfigurace_zdroj_dat	objekt	Objekt CustomDataSourceConfig, který definuje schéma pro zdroj dat použitý pro zkušební spuštění. Toto schéma slouží k definování tvaru dat, která budou: - Slouží k definování kritérií testování a – Jaká data se vyžadují při vytváření spuštění	Ano
└─ zahrnout_vzorek_schématu	Boolean	Určuje, jestli by se měl očekávat, že naplníte ukázkový obor názvů (tj. vygenerováním odpovědí z vašeho zdroje dat).	Ne
└item_schema	objekt	Schéma JSON pro každý řádek ve zdroji dat.	Ne
└– metadata	objekt	Filtry metadat pro uložený zdroj dat dokončení	Ne
└scénář	výčet	Scénář schématu dat Možné hodnoty: red_team, responses, traces	Ne
└- typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: azure_ai_source	Ne
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Název vyhodnocení.	Ne
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
testovací_kritéria	pole	Seznam známkovačů pro všechny zkušební běhy v této skupině. Gradery můžou odkazovat na proměnné ve zdroji dat pomocí dvou složených závorek, například {{item.variable_name}}. Pokud chcete odkazovat na výstup modelu, použijte sample obor názvů (tj. {{sample.output_text}}).	Ano

VytvořitŽádostOProvedeníHodnocení

Název	Typ	Description	Povinné	Výchozí
zdroj dat	objekt	Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.	Ano
└input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate nebo OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Používá se při vzorkování z modelu. Určuje strukturu zpráv předaných do modelu. Může to být odkaz na předem připravenou trajektorii (tj item.input_trajectory. ) nebo šablonu s proměnnými odkazy na item obor názvů.	Ne
└item_generation_params	RedTeamItemGenerationParams	Parametry pro generování položek.	Ne
└model	řetězec	Název modelu, který se má použít ke generování dokončení (např. "o3-mini").	Ne
└sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Ne
└- zdroj	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource nebo OpenAI.EvalResponsesSource	Určuje, co naplní item obor názvů ve zdroji dat tohoto spuštění.	Ne
└- cíl	Cíl	Cílová konfigurace pro vyhodnocení.	Ne
└- typ	řetězec	Diskriminátor typu zdroje dat.	Ne
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec	Název běhu.	Ne
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne

Vytvořeno kým

Název	Typ	Description	Povinné	Výchozí
agent	objekt		Ne
└– název	řetězec	Název agenta.	Ne
└- typ	výčet	Možné hodnoty: agent_id	Ne
└- verze	řetězec	Identifikátor verze agenta.	Ne
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne

CredentialType

Typ přihlašovacích údajů používaný připojením

Vlastnictví	Hodnota
Description	Typ přihlašovacích údajů používaný připojením
Type	řetězec
Hodnoty	ApiKey AAD SAS CustomKeys None AgenticIdentityToken

CronTrigger

Spouštěč založený na Cronu.

Název	Typ	Description	Povinné	Výchozí
endTime	řetězec	Čas ukončení plánu cron ve formátu ISO 8601.	Ne
výraz	řetězec	Cron, který definuje frekvenci plánování.	Ano
startTime	řetězec	Čas spuštění plánu cron ve formátu ISO 8601.	Ne
timeZone	řetězec	Časové pásmo pro plán cron.	Ne	standard UTC
typ	výčet	Možné hodnoty: Cron	Ano

CustomCredential

Vlastní definice přihlašovacích údajů

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: CustomKeys	Ano

DailyRecurrenceSchedule

Denní plán opakování.

Název	Typ	Description	Povinné	Výchozí
hodin	pole	Hodiny pro plán opakování.	Ano
typ	výčet	Typ denního opakování. Možné hodnoty: Daily	Ano

DatasetType

Výčet určující typ dat.

Vlastnictví	Hodnota
Description	Výčet určující typ dat.
Type	řetězec
Hodnoty	uri_file uri_folder

DatasetVersion

Definice DatasetVersion

Diskriminátor pro DatasetVersion

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Název	Typ	Description	Povinné	Výchozí
název_připojení	řetězec	Název připojení účtu Azure Storage. Vyžaduje se, pokud startPendingUploadVersion nebyla volána před vytvořením datové sady	Ne
dataUri	řetězec	Identifikátor URI dat (příklad)	Ano
ID	řetězec	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
isReference	Boolean	Označuje, jestli datová sada obsahuje odkaz na storage nebo jestli datová sada spravuje storage sama. Pokud je true, podkladová data se při odstranění verze datové sady neodstraní	Ne
název	řetězec	Název prostředku	Ano
typ	objekt	Výčet určující typ dat.	Ano
verze	řetězec	Verze prostředku	Ano

DatasetVersionUpdate

Definice DatasetVersion

Diskriminátor pro DatasetVersionUpdate

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
typ	objekt	Výčet určující typ dat.	Ano

den v týdnu

Dny v týdnu pro plán opakování.

Vlastnictví	Hodnota
Description	Dny v týdnu pro plán opakování.
Type	řetězec
Hodnoty	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Odstraněný objekt agenta

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean	Zda byl agent úspěšně odstraněn.	Ano
název	řetězec	Název agenta.	Ano
objekt	výčet	Typ objektu. Vždy 'agent.deleted'. Možné hodnoty: agent.deleted	Ano

DeleteAgentVersionResponse

Objekt verze odstraněného agenta

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean	Zda byl agent úspěšně odstraněn.	Ano
název	řetězec	Název agenta.	Ano
objekt	výčet	Typ objektu. Vždy 'agent.deleted'. Možné hodnoty: agent.version.deleted	Ano
verze	řetězec	Identifikátor verze agenta.	Ano

DeleteEvalResponse

Odstraněný objekt vyhodnocení

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean	Zda byl zkušební hodnota úspěšně odstraněna.	Ano
eval_id	řetězec	id zkušebního stavu.	Ano
objekt	výčet	Typ objektu. Vždy 'eval.deleted'. Možné hodnoty: eval.deleted	Ano

DeleteEvalRunResponse

Odstraněný objekt spuštění vyhodnocení.

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean	Zda byl zkušební hodnota úspěšně odstraněna.	Ne
objekt	výčet	Typ objektu. Vždy 'eval.deleted'. Možné hodnoty: eval.deleted	Ne
run_id	řetězec	id zkušebního stavu.	Ne

DeleteMemoryStoreResponse

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean	Zda bylo úložiště paměti úspěšně odstraněno.	Ano
název	řetězec	Název úložiště paměti.	Ano
objekt	výčet	Typ objektu. Vždy 'memory_store.deleted'. Možné hodnoty: memory_store.deleted	Ano

DeleteResponseResult

Výsledek operace odstranění odpovědi.

Název	Typ	Description	Povinné	Výchozí
smazaný	výčet	Vždy vrátit true Možné hodnoty: True	Ano
ID	řetězec	Identifikační číslo operace.	Ano
objekt	výčet	Vždy vraťte "odpověď". Možné hodnoty: response	Ano

Nasazení

Definice nasazení modelu

Diskriminátor pro nasazení

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
ModelDeployment	ModelDeployment

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Název nasazení	Ano
typ	objekt		Ano

Typ nasazení

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	ModelDeployment

EntraIDCredentials

Definice přihlašovacích údajů Entra ID

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: AAD	Ano

Vyhodnocení

Objekt Eval s konfiguračními a testovacími kritérii zdroje dat. Eval představuje úkol, který se má provést pro integraci LLM. Jako:

• Zlepšení kvality chatovacího robota
• Podívejte se, jak dobře chatbot zpracovává zákaznickou podporu
• Zkontrolujte, jestli je o4-mini lepší v mém případu použití než gpt-4o

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	objekt		Ano
vytvořeno kým	řetězec	jméno osoby, která spuštění vytvořila.	Ne
konfigurace_zdroj_dat	objekt	Objekt CustomDataSourceConfig, který definuje schéma pro zdroj dat použitý pro zkušební spuštění. Toto schéma slouží k definování tvaru dat, která budou: - Slouží k definování kritérií testování a – Jaká data se vyžadují při vytváření spuštění	Ano
└─ zahrnout_vzorek_schématu	Boolean	Určuje, jestli by se měl očekávat, že naplníte ukázkový obor názvů (tj. vygenerováním odpovědí z vašeho zdroje dat).	Ne
└item_schema	objekt	Schéma JSON pro každý řádek ve zdroji dat.	Ne
└– metadata	objekt	Filtry metadat pro uložený zdroj dat dokončení	Ne
└scénář	výčet	Scénář schématu dat Možné hodnoty: red_team, responses, traces	Ne
└- typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: azure_ai_source	Ne
ID	řetězec	Jedinečný identifikátor pro vyhodnocení.	Ano
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ano
modified_at	objekt		Ne
název	řetězec	Název vyhodnocení.	Ano
objekt	výčet	Typ objektu. Možné hodnoty: eval	Ano
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
testovací_kritéria	pole	Seznam testovacích kritérií.	Ano

EvalCompareReport

Postřehy z porovnání hodnocení.

Název	Typ	Description	Povinné	Výchozí
porovnání	pole	Výsledky srovnání pro každou léčbu prováděnou ve srovnání s výchozí hodnotou.	Ano
metoda	řetězec	Statistická metoda použitá pro srovnání.	Ano
typ	výčet	Typ výsledku přehledů. Možné hodnoty: EvaluationComparison	Ano

EvalResult

Výsledek vyhodnocení.

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Název kontroly	Ano
prošel	Boolean	označuje, zda kontrola proběhla úspěšně nebo neúspěšně	Ano
skóre	číslo	skóre	Ano
typ	řetězec	Typ kontroly	Ano

EvalRun

Schéma představující běh vyhodnocení

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	objekt		Ano
vytvořeno kým	řetězec	jméno osoby, která spuštění vytvořila.	Ne
zdroj dat	objekt	Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.	Ano
└input_messages	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate nebo OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Používá se při vzorkování z modelu. Určuje strukturu zpráv předaných do modelu. Může to být odkaz na předem připravenou trajektorii (tj item.input_trajectory. ) nebo šablonu s proměnnými odkazy na item obor názvů.	Ne
└item_generation_params	RedTeamItemGenerationParams	Parametry pro generování položek.	Ne
└model	řetězec	Název modelu, který se má použít ke generování dokončení (např. "o3-mini").	Ne
└sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Ne
└- zdroj	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource nebo OpenAI.EvalResponsesSource	Určuje, co naplní item obor názvů ve zdroji dat tohoto spuštění.	Ne
└- cíl	Cíl	Cílová konfigurace pro vyhodnocení.	Ne
└- typ	řetězec	Diskriminátor typu zdroje dat.	Ne
chyba	OpenAI.EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ano
eval_id	řetězec	Identifikátor přidruženého hodnocení.	Ano
ID	řetězec	Jedinečný identifikátor pro spuštění vyhodnocení.	Ano
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ano
model	řetězec	Model, který se vyhodnocuje, pokud je k dispozici.	Ano
modified_at	objekt		Ne
název	řetězec	Název zkušebního spuštění.	Ano
objekt	výčet	Typ objektu. Vždy "eval.run". Možné hodnoty: eval.run	Ano
pokrytí podle modelu	pole	Statistiky využití pro každý model během zkušebního spuštění	Ano
výsledky podle testovacích kritérií	pole	Výsledky podle kritérií testování uplatněných během vyhodnocovacího běhu.	Ano
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
report_url	řetězec	Adresa URL vykreslené sestavy spuštění vyhodnocení na řídicím panelu uživatelského rozhraní.	Ano
počet_výsledků	objekt		Ano
└- chyba	OpenAI.integer		Ne
└– selhalo	OpenAI.integer		Ne
└─ prošlo	OpenAI.integer		Ne
└- celkem	OpenAI.integer		Ne
stav	řetězec	Stav spuštění vyhodnocení.	Ano

EvalRunDataSource

Základní třída pro spouštění zdrojů dat s nediskriminační podporou

Diskriminátor pro EvalRunDataSource

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
azure_ai_traces	TracesEvalRunDataSource
azure_ai_responses	AzureAIResponses
azure_ai_target_completions	TargetCompletions

Název	Typ	Description	Povinné	Výchozí
typ	řetězec	Diskriminátor typu zdroje dat.	Ano

EvalRunOutputItem

Schéma představující výstupní položku zkušebního spuštění

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	objekt		Ano
položka_datového_zdroje	objekt	Podrobnosti o položce vstupního zdroje dat	Ano
ID položky datového zdroje	objekt		Ano
eval_id	řetězec	Identifikátor zkušební skupiny.	Ano
ID	řetězec	Jedinečný identifikátor výstupní položky zkušebního spuštění.	Ano
objekt	výčet	Typ objektu. Vždy "eval.run.output_item". Možné hodnoty: eval.run.output_item	Ano
results	pole	Seznam výsledků známkování pro tuto výstupní položku.	Ano
run_id	řetězec	Identifikátor zkušebního spuštění přidruženého k této výstupní položce.	Ano
vzorek	objekt		Ano
└─ chyba	OpenAI.EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ne
└konec_duvod	řetězec		Ne
└─ vstup	pole		Ne
└─ maximální_dokončovací_tokeny	OpenAI.integer		Ne
└model	řetězec		Ne
└─ výstup	pole		Ne
└semeno	OpenAI.integer		Ne
└− teplota	OpenAI.numeric		Ne
└top_p	OpenAI.numeric		Ne
└─ využití	OpenAI.EvalRunOutputItemSampleUsage		Ne
stav	řetězec	Stav spuštění vyhodnocení.	Ano

EvalRunOutputItemResult

Jeden výsledek klasifikačního nástroje pro výstupní položku zkušebního spuštění

Název	Typ	Description	Povinné	Výchozí
jmenovka	řetězec	Popisek přidružený k metrice kritérií testu (např. "pass", "fail", "good", "bad").	Ne
metrika	řetězec	Název metriky (např. "fluency", "f1_score").	Ne
název	řetězec	Název hodnotitele.	Ano
prošel	Boolean	Určuje, jestli klasiátor považoval výstup za průchod.	Ano
vlastnosti	objekt	Další podrobnosti o metrice kritérií testu	Ne
důvod	řetězec	Důvod metriky kritérií testu.	Ne
vzorek	objekt	Volitelná vzorková nebo zprostředkující data vytvořená klasifikačním nástrojem	Ne
skóre	objekt		Ano
mezní hodnota	číslo	Prahová hodnota použitá k určení pass/fail pro tato kritéria testu, pokud je číselná.	Ne
typ	řetězec	Typ známkovače (například "string-check-grader").	Ne

EvalRunResultCompareItem

Porovnání metrik léčby s výchozí hodnotou.

Název	Typ	Description	Povinné	Výchozí
deltaEstimate	číslo	Odhadovaný rozdíl mezi léčbou a výchozím stavem.	Ano
pValue	číslo	P-hodnota pro efekt ošetření.	Ano
léčbaEffect	objekt	Typ účinku ošetření.	Ano
treatmentRunId	řetězec	ID běhu ošetření.	Ano
léčbaRunSummary	objekt	Souhrnná statistika metriky v běhu vyhodnocení.	Ano
└- průměr	číslo	Průměrná hodnota metriky v běhu vyhodnocení.	Ne
└- runId	řetězec	ID spuštění vyhodnocení.	Ne
└- sampleCount	integer	Počet vzorků v běhu vyhodnocení.	Ne
└- standardDeviation	číslo	Směrodatná odchylka metriky v běhu vyhodnocení.	Ne

EvalRunResultComparison

Výsledky srovnání léčby jsou v porovnání s výchozí hodnotou.

Název	Typ	Description	Povinné	Výchozí
baselineRunSummary	objekt	Souhrnná statistika metriky v běhu vyhodnocení.	Ano
└- průměr	číslo	Průměrná hodnota metriky v běhu vyhodnocení.	Ne
└- runId	řetězec	ID spuštění vyhodnocení.	Ne
└- sampleCount	integer	Počet vzorků v běhu vyhodnocení.	Ne
└- standardDeviation	číslo	Směrodatná odchylka metriky v běhu vyhodnocení.	Ne
compareItems	pole	Seznam výsledků porovnání pro každý běh ošetření.	Ano
hodnotitel	řetězec	Jméno hodnotitele pro toto testovací kritérium.	Ano
metrika	řetězec	Vyhodnocovaná metrika.	Ano
testingCriteria	řetězec	Název testovacího kritéria.	Ano

EvalRunResultSummary

Souhrnná statistika metriky v běhu vyhodnocení.

Název	Typ	Description	Povinné	Výchozí
průměrný	číslo	Průměrná hodnota metriky v běhu vyhodnocení.	Ano
identifikátor spuštění	řetězec	ID spuštění vyhodnocení.	Ano
sampleCount	integer	Počet vzorků v běhu vyhodnocení.	Ano
standardDeviation	číslo	Směrodatná odchylka metriky v běhu vyhodnocení.	Ano

EvaluationComparisonRequest

Žádost o porovnání vyhodnocení

Název	Typ	Description	Povinné	Výchozí
baselineRunId	řetězec	ID základního spuštění pro porovnání.	Ano
evalId	řetězec	Identifikátor pro vyhodnocení.	Ano
treatmentRunIds	pole	Seznam ID běhů léčby pro srovnání.	Ano
typ	výčet	Typ požadavku. Možné hodnoty: EvaluationComparison	Ano

EvaluationResultSample

Ukázka z výsledku vyhodnocení.

Název	Typ	Description	Povinné	Výchozí
evaluationResult	objekt	Výsledek vyhodnocení.	Ano
└– název	řetězec	Název kontroly	Ne
└─ prošlo	Boolean	označuje, zda kontrola proběhla úspěšně nebo neúspěšně	Ne
└- skóre	číslo	skóre	Ne
└- typ	řetězec	Typ kontroly	Ne
typ	výčet	Typ vzorku výsledku vyhodnocení Možné hodnoty: EvaluationResultSample	Ano

Pravidlo vyhodnocení

Model vyhodnocovacího pravidla.

Název	Typ	Description	Povinné	Výchozí
akce	objekt	Akční model vyhodnocení.	Ano
└- typ	EvaluationRuleActionType	Typ vyhodnocovací akce.	Ne
popis	řetězec	Popis pravidla vyhodnocení.	Ne
zobrazované jméno	řetězec	Zobrazovaný název pravidla vyhodnocení.	Ne
povoleno	Boolean	Označuje, zda je povoleno pravidlo vyhodnocení. Výchozí hodnota je true.	Ano
eventType	objekt	Typ události pravidla vyhodnocení.	Ano
filtr	objekt	Model filtru vyhodnocení.	Ne
└agentName	řetězec	Filtrujte podle názvu agenta.	Ne
ID	řetězec	Jedinečný identifikátor pravidla vyhodnocení.	Ano
systémová data	objekt	Systémová metadata pro pravidlo vyhodnocení.	Ano

EvaluationRuleAction

Akční model vyhodnocení.

Diskriminátor pro EvaluationRuleAction

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluation	HumanEvaluationRuleAction

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ vyhodnocovací akce.	Ano

EvaluationRuleActionType

Typ vyhodnocovací akce.

Vlastnictví	Hodnota
Description	Typ vyhodnocovací akce.
Type	řetězec
Hodnoty	continuousEvaluation humanEvaluation

EvaluationRuleEventType

Typ události pravidla vyhodnocení.

Vlastnictví	Hodnota
Description	Typ události pravidla vyhodnocení.
Type	řetězec
Hodnoty	responseCompleted manual

EvaluationRuleFilter

Model filtru vyhodnocení.

Název	Typ	Description	Povinné	Výchozí
jméno agenta	řetězec	Filtrujte podle názvu agenta.	Ano

EvaluationRunClusterInsightResult

Poznatky z vyhodnocení spustí shlukovou analýzu.

Název	Typ	Description	Povinné	Výchozí
clusterInsight	ClusterInsightResult	Postřehy ze shlukové analýzy.	Ano
typ	výčet	Typ výsledku přehledů. Možné hodnoty: EvaluationRunClusterInsight	Ano

EvaluationRunClusterInsightsRequest

Poznatky o sadě výsledků vyhodnocení

Název	Typ	Description	Povinné	Výchozí
evalId	řetězec	ID vyhodnocení pro přehledy.	Ano
konfigurace modelu	objekt	Konfigurace modelu použitého při generování náhledů.	Ne
└- modelDeploymentName	řetězec	Nasazení modelu, které má být vyhodnoceno. Přijímá buď samotný název nasazení, nebo s názvem připojení jako {connectionName}/<modelDeploymentName>.	Ne
runIds	pole	Seznam ID spuštění vyhodnocení pro přehledy.	Ano
typ	výčet	Typ žádosti o přehledy. Možné hodnoty: EvaluationRunClusterInsight	Ano

EvaluationScheduleTask

Vyhodnocení úlohy pro harmonogram.

Název	Typ	Description	Povinné	Výchozí
evalId	řetězec	Identifikátor vyhodnocovací skupiny.	Ano
evalRun	objekt	Datová část spuštění vyhodnocení.	Ano
typ	výčet	Možné hodnoty: Evaluation	Ano

EvaluationTaxonomy

Definice taxonomie hodnocení

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	řetězec	Název prostředku	Ano
vlastnosti	objekt	Další vlastnosti pro taxonomii vyhodnocení.	Ne
taxonomieKategorie	pole	Seznam kategorií taxonomie.	Ne
taxonomyInput	objekt	Konfigurace vstupu pro taxonomii vyhodnocení.	Ano
└- typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ne
verze	řetězec	Verze prostředku	Ano

EvaluationTaxonomyCreateOrUpdate

Definice taxonomie hodnocení

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
vlastnosti	objekt	Další vlastnosti pro taxonomii vyhodnocení.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
taxonomieKategorie	pole	Seznam kategorií taxonomie.	Ne
taxonomyInput	objekt	Konfigurace vstupu pro taxonomii vyhodnocení.	Ano
└- typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ne

EvaluationTaxonomyInput

Konfigurace vstupu pro taxonomii vyhodnocení.

Diskriminátor pro EvaluationTaxonomyInput

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
agent	AgentTaxonomyInput

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ vstupu taxonomie vyhodnocení.	Ano

EvaluationTaxonomyInputType

Typ vstupu taxonomie vyhodnocení.

Vlastnictví	Hodnota
Description	Typ vstupu taxonomie vyhodnocení.
Type	řetězec
Hodnoty	agent policy

EvaluationTaxonomyInputUpdate

Konfigurace vstupu pro taxonomii vyhodnocení.

Diskriminátor pro EvaluationTaxonomyInputUpdate

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
agent	AgentTaxonomyInputUpdate

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ vstupu taxonomie vyhodnocení.	Ano

EvaluationTaxonomyUpdate

Definice taxonomie hodnocení

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
vlastnosti	objekt	Další vlastnosti pro taxonomii vyhodnocení.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
taxonomieKategorie	pole	Seznam kategorií taxonomie.	Ne
taxonomyInput	objekt	Konfigurace vstupu pro taxonomii vyhodnocení.	Ne
└- typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ne

VyhodnoceníCategory

Kategorie hodnotitele

Vlastnictví	Hodnota
Description	Kategorie hodnotitele
Type	řetězec
Hodnoty	quality safety agents

VyhodnoceníDefinition

Základní konfigurace vyhodnocovače s diskriminátorem

Diskriminátor pro vyhodnoceníDefinition

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Název	Typ	Description	Povinné	Výchozí
data_schema		Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
init_parameters		Schéma JSON (koncept 2020-12) pro vstupní parametry vyhodnocení. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
metriky	objekt	Seznam výstupních metrik vytvořených tímto hodnotitelem	Ne
typ	objekt	Typ definice hodnotitele	Ano

EvaluatorDefinitionType

Typ definice hodnotitele

Vlastnictví	Hodnota
Description	Typ definice hodnotitele
Type	řetězec
Hodnoty	prompt code prompt_and_code service openai_graders

Metrika vyhodnocování

Metrika hodnotitele

Název	Typ	Description	Povinné	Výchozí
desirable_direction	objekt	Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální	Ne
is_primary	Boolean	Označuje, zda je tato metrika primární, pokud existuje více metrik.	Ne
max_value	číslo	Maximální hodnota metriky. Pokud není určeno, předpokládá se, že je nevázané.	Ne
min_value	číslo	Minimální hodnota metriky	Ne
typ	objekt	Typ hodnotitele	Ne

Vyhodnocovací metrikaDirection

Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální

Vlastnictví	Hodnota
Description	Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální
Type	řetězec
Hodnoty	increase decrease neutral

Vyhodnocovací typMetricType

Typ hodnotitele

Vlastnictví	Hodnota
Description	Typ hodnotitele
Type	řetězec
Hodnoty	ordinal continuous boolean

Vyhodnocovací typ

Typ hodnotitele

Vlastnictví	Hodnota
Description	Typ hodnotitele
Type	řetězec
Hodnoty	builtin custom

Vyhodnocovací verze

Definice hodnotitele

Název	Typ	Description	Povinné	Výchozí
categories	pole	Kategorie hodnotitele	Ano
datum_vytvoření	integer	Datum/čas vytvoření hodnotitele	Ano
vytvořeno kým	řetězec	Tvůrce hodnotitele	Ano
definice	objekt	Základní konfigurace vyhodnocovače s diskriminátorem	Ano
└data_schema		Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└init_parameters		Schéma JSON (koncept 2020-12) pro vstupní parametry vyhodnocení. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└– metriky	objekt	Seznam výstupních metrik vytvořených tímto hodnotitelem	Ne
└- typ	EvaluatorDefinitionType	Typ definice hodnotitele	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít vyhodnocovače v Foundry. Nemusí být jedinečné.	Ne
evaluator_type	objekt	Typ hodnotitele	Ano
ID	řetězec	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
metadata	objekt	Metadata o hodnotiteli	Ne
modified_at	integer	Datum a čas poslední změny hodnotitele	Ano
název	řetězec	Název prostředku	Ano
verze	řetězec	Verze prostředku	Ano

EvaluatorVersionCreate

Definice hodnotitele

Název	Typ	Description	Povinné	Výchozí
categories	pole	Kategorie hodnotitele	Ano
definice	objekt	Základní konfigurace vyhodnocovače s diskriminátorem	Ano
└data_schema		Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└init_parameters		Schéma JSON (koncept 2020-12) pro vstupní parametry vyhodnocení. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└– metriky	objekt	Seznam výstupních metrik vytvořených tímto hodnotitelem	Ne
└- typ	EvaluatorDefinitionType	Typ definice hodnotitele	Ne
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít vyhodnocovače v Foundry. Nemusí být jedinečné.	Ne
evaluator_type	objekt	Typ hodnotitele	Ano
metadata	objekt	Metadata o hodnotiteli	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne

EvaluatorVersionUpdate

Definice hodnotitele

Název	Typ	Description	Povinné	Výchozí
categories	pole	Kategorie hodnotitele	Ne
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít vyhodnocovače v Foundry. Nemusí být jedinečné.	Ne
metadata	objekt	Metadata o hodnotiteli	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne

FabricDataAgentToolParameters

Parametry nástroje agenta dat prostředků Fabric.

Název	Typ	Description	Povinné	Výchozí
project_connections	pole	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji.	Ne

FileDatasetVersion

Definice FileDatasetVersion

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ datové sady Možné hodnoty: uri_file	Ano

FileDatasetVersionUpdate

Definice FileDatasetVersion

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ datové sady Možné hodnoty: uri_file	Ano

FolderDatasetVersion

Definice FileDatasetVersion

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ datové sady Možné hodnoty: uri_folder	Ano

FolderDatasetVersionUpdate

Definice FileDatasetVersion

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ datové sady Možné hodnoty: uri_folder	Ano

HostedAgentDefinition

Definice hostovaného agenta.

Diskriminátor pro HostedAgentDefinition

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schema
hosted	ImageBasedHostedAgentDefinition

Název	Typ	Description	Povinné	Výchozí
container_protocol_versions	pole	Protokoly, které agent podporuje pro příchozí komunikaci kontejnerů.	Ano
procesor	řetězec	Konfigurace procesoru pro hostovaného agenta.	Ano
environment_variables	objekt	Proměnné prostředí, které se mají nastavit v kontejneru hostovaného agenta.	Ne
laskavý	výčet	Možné hodnoty: hosted	Ano
paměť	řetězec	Konfigurace paměti pro hostovaného agenta.	Ano
nářadí	pole	Pole nástrojů, které může model hostovaného agenta volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice .	Ne

HourlyRecurrenceSchedule

Hodinový plán opakování.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: Hourly	Ano

HumanEvaluationRuleAction

Akce pravidla vyhodnocení pro lidské hodnocení.

Název	Typ	Description	Povinné	Výchozí
ID šablony	objekt	Identifikátor uloženého prostředku.	Ano
typ	výčet	Možné hodnoty: humanEvaluation	Ano

ImageBasedHostedAgentDefinition

Definice nasazení na základě bitových kopií pro hostovaného agenta.

Název	Typ	Description	Povinné	Výchozí
bitová kopie	řetězec	Image pro hostovaného agenta.	Ano
laskavý	výčet	Možné hodnoty: hosted	Ano

Index

Definice prostředku indexu

Diskriminátor indexu

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	řetězec	Název prostředku	Ano
typ	objekt		Ano
verze	řetězec	Verze prostředku	Ano

Typ indexu

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Definice prostředku indexu

Diskriminátor pro IndexUpdate

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Text popisu prostředku.	Ne
tags	objekt	Označení slovníku Značky je možné přidávat, odebírat a aktualizovat.	Ne
typ	objekt		Ano

Postřeh

Text odpovědi pro cluster insights.

Název	Typ	Description	Povinné	Výchozí
zobrazované jméno	řetězec	Uživatelsky přívětivý zobrazovaný název pro vhled.	Ano
ID	řetězec	Jedinečný identifikátor přehledu přehledů.	Ano
metadata	objekt	Metadata o poznatcích.	Ano
└- completedAt	řetězec	Časové razítko, kdy byly přehledy dokončeny.	Ne
└createdAt	řetězec	Časové razítko, kdy byly přehledy vytvořeny.	Ne
žádost	objekt	Žádost o zprávu o přehledech.	Ano
└- typ	InsightType	Typ požadavku.	Ne
výsledek	objekt	Výsledek poznatků.	Ne
└- typ	InsightType	Typ výsledku přehledů.	Ne
stav	objekt	Výčet popisující povolené stavy operací.	Ano

InsightCluster

Shluk vzorků analýzy.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis analytického clusteru.	Ano
ID	řetězec	ID analytického clusteru.	Ano
jmenovka	řetězec	Štítek pro cluster	Ano
vzorky	pole	Seznam vzorků, které patří do tohoto clusteru. Vyprázdněte, pokud jsou vzorky součástí podclusterů.	Ne
subClusters	pole	Seznam podclusterů v rámci tohoto clusteru. Prázdné, pokud neexistují žádné podclustery.	Ne
návrh	řetězec	Návrh pro cluster	Ano
suggestionTitle	řetězec	Název návrhu pro klastr	Ano
weight	integer	Váha analytického clusteru. Označuje počet vzorků v clusteru.	Ano

InsightModelConfiguration

Konfigurace modelu použitého při generování náhledů.

Název	Typ	Description	Povinné	Výchozí
modelDeploymentName	řetězec	Nasazení modelu, které má být vyhodnoceno. Přijímá buď samotný název nasazení, nebo s názvem připojení jako {connectionName}/<modelDeploymentName>.	Ano

InsightRequest

Žádost o zprávu o přehledech.

Diskriminátor pro InsightRequest

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightsRequest
AgentClusterInsight	AgentClusterInsightsRequest
EvaluationComparison	EvaluationComparisonRequest

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Žádost o postřehy.	Ano

InsightResult

Výsledek poznatků.

Diskriminátor pro InsightResult

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
EvaluationComparison	EvalCompareReport
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Žádost o postřehy.	Ano

InsightSample

Ukázka z analýzy.

Diskriminátor pro InsightSample

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
EvaluationResultSample	EvaluationResultSample

Název	Typ	Description	Povinné	Výchozí
correlationInfo	objekt	Informace o korelaci pro vzorek analýzy.	Ano
features	objekt	Funkce pro pomoc s dodatečným filtrováním dat v UX.	Ano
ID	řetězec	Jedinečný identifikátor vzorku analýzy.	Ano
typ	objekt	Typ vzorku použitého při analýze.	Ano

InsightScheduleTask

Úkol Insight pro plán.

Název	Typ	Description	Povinné	Výchozí
přehled	objekt	Text odpovědi pro cluster insights.	Ano
└- displayName	řetězec	Uživatelsky přívětivý zobrazovaný název pro vhled.	Ne
└- ID	řetězec	Jedinečný identifikátor přehledu přehledů.	Ne
└– metadata	InsightsMetadata	Metadata o přehledu přehledů.	Ne
└– žádost	InsightRequest	Žádost o analýzu poznatků.	Ne
└výsledek	InsightResult	Výsledek přehledové sestavy.	Ne
└stavy	Azure. Core.Foundations.OperationState	Současný stav poznatků.	Ne
typ	výčet	Možné hodnoty: Insight	Ano

InsightSummary

Shrnutí analýzy shluků chyb.

Název	Typ	Description	Povinné	Výchozí
metoda	řetězec	Metoda používaná pro shlukování.	Ano
sampleCount	integer	Celkový počet analyzovaných vzorků.	Ano
uniqueClusterCount	integer	Celkový počet unikátních clusterů.	Ano
uniqueSubclusterCount	integer	Celkový počet jedinečných popisků podclusteru.	Ano
využití	objekt	Použití tokenu pro clusterovou analýzu	Ano
└- inputTokenUsage	integer	Použití vstupního tokenu	Ne
└- outputTokenUsage	integer	Použití výstupního tokenu	Ne
└- totalTokenUsage	integer	Celkové využití tokenu	Ne

InsightType

Žádost o postřehy.

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadata o poznatcích.

Název	Typ	Description	Povinné	Výchozí
completedAt	řetězec	Časové razítko, kdy byly přehledy dokončeny.	Ne
createdAt	řetězec	Časové razítko, kdy byly přehledy vytvořeny.	Ano

ItemGenerationParams

Představuje sadu parametrů použitých k řízení operací generování položek.

Diskriminátor pro ItemGenerationParams

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema

Název	Typ	Description	Povinné	Výchozí
typ	řetězec	Typ parametrů generování položek, které se mají použít.	Ano

ManagedAzureAISearchIndex

Definice indexu spravovaného Azure AI Search

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ indexu Možné hodnoty: ManagedAzureSearch	Ano

ManagedAzureAISearchIndexUpdate

Definice indexu spravovaného Azure AI Search

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ indexu Možné hodnoty: ManagedAzureSearch	Ano

MemoryItem

Jedna paměťová položka uložená v paměťovém úložišti, která obsahuje obsah a metadata.

Diskriminátor pro MemoryItem

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec	Obsah paměti.	Ano
laskavý	objekt	Druh paměťové položky.	Ano
memory_id	řetězec	Jedinečné ID paměťové položky.	Ano
obor	řetězec	Jmenný prostor, který logicky seskupuje a izoluje vzpomínky, například ID uživatele.	Ano
updated_at	integer	Čas poslední aktualizace paměťové položky.	Ano

MemoryItemKind

Druh paměťové položky.

Vlastnictví	Hodnota
Description	Druh paměťové položky.
Type	řetězec
Hodnoty	user_profile chat_summary

MemoryOperation

Představuje jednu operaci s pamětí (vytvoření, aktualizaci nebo odstranění) provedenou s položkou paměti.

Název	Typ	Description	Povinné	Výchozí
laskavý	objekt	Druh provozu paměti.	Ano
memory_item	objekt	Jedna paměťová položka uložená v paměťovém úložišti, která obsahuje obsah a metadata.	Ano
└- obsah	řetězec	Obsah paměti.	Ne
└kind	MemoryItemKind	Druh paměťové položky.	Ne
└memory_id	řetězec	Jedinečné ID paměťové položky.	Ne
└rozsah	řetězec	Jmenný prostor, který logicky seskupuje a izoluje vzpomínky, například ID uživatele.	Ne
└updated_at	integer	Čas poslední aktualizace paměťové položky.	Ne

MemoryOperationKind

Druh provozu paměti.

Vlastnictví	Hodnota
Description	Druh provozu paměti.
Type	řetězec
Hodnoty	create update delete

MemorySearchItem

Načtená položka paměti z vyhledávání v paměti.

Název	Typ	Description	Povinné	Výchozí
memory_item	objekt	Jedna paměťová položka uložená v paměťovém úložišti, která obsahuje obsah a metadata.	Ano
└- obsah	řetězec	Obsah paměti.	Ne
└kind	MemoryItemKind	Druh paměťové položky.	Ne
└memory_id	řetězec	Jedinečné ID paměťové položky.	Ne
└rozsah	řetězec	Jmenný prostor, který logicky seskupuje a izoluje vzpomínky, například ID uživatele.	Ne
└updated_at	integer	Čas poslední aktualizace paměťové položky.	Ne

MemorySearchOptions

Možnosti vyhledávání v paměti.

Název	Typ	Description	Povinné	Výchozí
max_memories	integer	Maximální počet položek paměti, které se mají vrátit.	Ne

MemorySearchTool

Nástroj pro integraci pamětí do agenta.

Název	Typ	Description	Povinné	Výchozí
memory_store_name	řetězec	Název úložiště paměti, které se má použít.	Ano
obor	řetězec	Jmenný prostor používaný k seskupení a izolaci pamětí, jako je ID uživatele. Omezuje, které paměti lze načíst nebo aktualizovat. Pomocí speciální proměnné {{$userId}} můžete nastavit rozsah pamětí na aktuálně přihlášeného uživatele.	Ano
search_options	objekt	Možnosti vyhledávání v paměti.	Ne
└max_memories	integer	Maximální počet položek paměti, které se mají vrátit.	Ne
typ	výčet	Typ nástroje. Vždy memory_search. Možné hodnoty: memory_search	Ano
update_delay	integer	Doba čekání před aktualizací pamětí po nečinnosti (sekundy). Výchozí hodnota 300.	Ne	300

MemorySearchToolCallItemParam

Název	Typ	Description	Povinné	Výchozí
results	pole	Výsledky vrácené z prohledávání paměti.	Ne
typ	výčet	Možné hodnoty: memory_search_call	Ano

MemorySearchToolCallItemResource

Název	Typ	Description	Povinné	Výchozí
results	pole	Výsledky vrácené z prohledávání paměti.	Ne
stav	výčet	Stav volání nástroje pro vyhledávání paměti. Jeden z in_progress. searching, completednebo incompletefailed, Možné hodnoty: in_progress, searching, completed, incomplete, failed	Ano
typ	výčet	Možné hodnoty: memory_search_call	Ano

MemoryStoreDefaultDefinition

Výchozí implementace úložiště paměti.

Název	Typ	Description	Povinné	Výchozí
chat_model	řetězec	Název nebo identifikátor nasazení modelu dokončování chatu používaného pro zpracování paměti.	Ano
embedding_model	řetězec	Název nebo identifikátor nasazení modelu vkládání použitého pro zpracování paměti.	Ano
laskavý	výčet	Druh úložiště paměti. Možné hodnoty: default	Ano
options	objekt	Výchozí konfigurace úložiště paměti.	Ne
└chat_summary_enabled	Boolean	Jestli chcete povolit extrakci souhrnu chatu a storage. Výchozí hodnota je true.	Ne	Pravdivé
└user_profile_details	řetězec	Specifické kategorie nebo typy informací o uživatelském profilu, které mají být extrahovány a uloženy.	Ne
└user_profile_enabled	Boolean	Jestli chcete povolit extrakci profilů uživatelů a storage. Výchozí hodnota je true.	Ne	Pravdivé

MemoryStoreDefaultOptions

Výchozí konfigurace úložiště paměti.

Název	Typ	Description	Povinné	Výchozí
chat_summary_enabled	Boolean	Jestli chcete povolit extrakci souhrnu chatu a storage. Výchozí hodnota je true.	Ano	Pravdivé
user_profile_details	řetězec	Specifické kategorie nebo typy informací o uživatelském profilu, které mají být extrahovány a uloženy.	Ne
user_profile_enabled	Boolean	Jestli chcete povolit extrakci profilů uživatelů a storage. Výchozí hodnota je true.	Ano	Pravdivé

MemoryStoreDefinition

Základní definice pro konfigurace paměťových úložišť.

Diskriminátor pro MemoryStoreDefinition

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schema
default	MemoryStoreDefaultDefinition

Název	Typ	Description	Povinné	Výchozí
laskavý	objekt	Typ implementace úložiště paměti, která se má použít.	Ano

MemoryStoreDeleteScopeResponse

Odpověď pro smazání pamětí z rozsahu.

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean	Zda byla operace odstranění úspěšná.	Ano
název	řetězec	Název úložiště paměti.	Ano
objekt	výčet	Typ objektu. Vždy 'memory_store.scope.deleted'. Možné hodnoty: memory_store.scope.deleted	Ano
obor	řetězec	Rozsah, ze kterého byly vzpomínky vymazány.	Ano

MemoryStoreKind

Typ implementace úložiště paměti, která se má použít.

Vlastnictví	Hodnota
Description	Typ implementace úložiště paměti, která se má použít.
Type	řetězec
Hodnoty	default

MemoryStoreObject

Úložiště paměti, které může ukládat a načítat uživatelské paměti.

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer	Unixové časové razítko (sekundy), kdy bylo úložiště paměti vytvořeno.	Ano
definice	objekt	Základní definice pro konfigurace paměťových úložišť.	Ano
└kind	MemoryStoreKind	Druh úložiště paměti.	Ne
popis	řetězec	Popis úložiště paměti čitelný pro člověka.	Ne
ID	řetězec	Jedinečný identifikátor úložiště paměti.	Ano
metadata	objekt	Libovolná metadata páru klíč-hodnota, která se mají přidružit k úložišti paměti.	Ne
název	řetězec	Název úložiště paměti.	Ano
objekt	výčet	Typ objektu, který je vždy 'memory_store'. Možné hodnoty: memory_store	Ano
updated_at	integer	Unixové časové razítko (sekundy), kdy bylo úložiště paměti naposledy aktualizováno.	Ano

MemoryStoreOperationUsage

Statistika využití operace úložiště paměti.

Název	Typ	Description	Povinné	Výchozí
embedding_tokens	integer	Počet vložených tokenů.	Ano
input_tokens	integer	Počet vstupních tokenů.	Ano
input_tokens_details	objekt	Podrobný rozpis vstupních tokenů	Ano
└─ uložené_tokény	integer	Počet tokenů, které byly načteny z mezipaměti. Další ukládání do mezipaměti.	Ne
output_tokens	integer	Počet výstupních tokenů	Ano
output_tokens_details	objekt	Podrobný rozpis výstupních tokenů	Ano
└─ "reasoning_tokens"	integer	Počet tokenů pro logické uvažování.	Ne
total_tokens	integer	Celkový počet použitých tokenů	Ano

MemoryStoreSearchResponse

Odpověď na vyhledávání v paměti.

Název	Typ	Description	Povinné	Výchozí
vzpomínky	pole	Související paměťové položky nalezené během operace vyhledávání.	Ano
search_id	řetězec	Jedinečné ID tohoto požadavku na vyhledávání. Tuto hodnotu použijte jako previous_search_id v následných požadavcích na provádění přírůstkového vyhledávání.	Ano
využití	objekt	Statistika využití operace úložiště paměti.	Ano
└embedding_tokens	integer	Počet vložených tokenů.	Ne
└input_tokens	integer	Počet vstupních tokenů.	Ne
└- input_tokens_details	objekt	Podrobný rozpis vstupních tokenů	Ne
└─ uložené_tokény	integer	Počet tokenů, které byly načteny z mezipaměti. Další ukládání do mezipaměti.	Ne
└output_tokens	integer	Počet výstupních tokenů	Ne
└output_tokens_details	objekt	Podrobný rozpis výstupních tokenů	Ne
└─ "reasoning_tokens"	integer	Počet tokenů pro logické uvažování.	Ne
└─ celkem_tokeny	integer	Celkový počet použitých tokenů	Ne

MemoryStoreUpdateCompletedResult

Výsledek aktualizace paměti.

Název	Typ	Description	Povinné	Výchozí
memory_operations	pole	Seznam jednotlivých operací s pamětí, které byly provedeny během aktualizace.	Ano
využití	objekt	Statistika využití operace úložiště paměti.	Ano
└embedding_tokens	integer	Počet vložených tokenů.	Ne
└input_tokens	integer	Počet vstupních tokenů.	Ne
└- input_tokens_details	objekt	Podrobný rozpis vstupních tokenů	Ne
└─ uložené_tokény	integer	Počet tokenů, které byly načteny z mezipaměti. Další ukládání do mezipaměti.	Ne
└output_tokens	integer	Počet výstupních tokenů	Ne
└output_tokens_details	objekt	Podrobný rozpis výstupních tokenů	Ne
└─ "reasoning_tokens"	integer	Počet tokenů pro logické uvažování.	Ne
└─ celkem_tokeny	integer	Celkový počet použitých tokenů	Ne

MemoryStoreUpdateResponse

Poskytuje stav operace aktualizace úložiště paměti.

Název	Typ	Description	Povinné	Výchozí
chyba	objekt		Ne
└- další informace	objekt		Ne
└ kód	řetězec		Ne
└- debugInfo	objekt		Ne
└- podrobnosti	pole		Ne
└- zpráva	řetězec		Ne
└- param	řetězec		Ne
└- typ	řetězec		Ne
výsledek	objekt	Výsledek aktualizace paměti.	Ne
└memory_operations	pole	Seznam jednotlivých operací s pamětí, které byly provedeny během aktualizace.	Ne
└─ využití	MemoryStoreOperationUsage	Statistiky využití spojené s operací aktualizace paměti.	Ne
stav	objekt	Stav operace aktualizace úložiště paměti.	Ano
superseded_by	řetězec	update_id operace byla nahrazena stavem "nahrazeno".	Ne
update_id	řetězec	Jedinečné ID této žádosti o aktualizaci. Tuto hodnotu použijte jako previous_update_id v následných požadavcích na provádění přírůstkových aktualizací.	Ano

MemoryStoreUpdateStatus

Stav operace aktualizace úložiště paměti.

Vlastnictví	Hodnota
Description	Stav operace aktualizace úložiště paměti.
Type	řetězec
Hodnoty	queued in_progress completed failed superseded

MicrosoftFabricAgentTool

Informace o definici vstupu pro nástroj Microsoft Fabric, jak slouží ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
fabric_dataagent_preview	objekt	Parametry nástroje agenta dat prostředků Fabric.	Ano
└project_connections	pole	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji.	Ne
typ	výčet	Typ objektu, který je vždy "fabric_dataagent". Možné hodnoty: fabric_dataagent_preview	Ano

ModelDeployment

Definice nasazení modelu

Název	Typ	Description	Povinné	Výchozí
capabilities	objekt	Možnosti nasazeného modelu	Ano
název_připojení	řetězec	Název připojení, ze kterého nasazení pochází	Ne
modelName	řetězec	Publisher konkrétní název nasazeného modelu	Ano
modelPublisher	řetězec	Název publisher nasazeného modelu	Ano
verze modelu	řetězec	Publisher verze nasazeného modelu	Ano
sku	objekt	Informace o skladové posílce	Ano
└- kapacita	integer	Kapacita skladové položky	Ne
└- rodina	řetězec	Rodina SKU	Ne
└– název	řetězec	Název skladové položky	Ne
└- velikost	řetězec	Velikost skladové položky	Ne
└- úroveň	řetězec	Úroveň skladové položky	Ne
typ	výčet	Typ nasazení Možné hodnoty: ModelDeployment	Ano

ModelSamplingParams

Představuje sadu parametrů sloužících k řízení chování vzorkování jazykového modelu během generování textu.

Název	Typ	Description	Povinné	Výchozí
max_completion_tokens	integer	Maximální počet tokenů povolených v dokončení	Ano
seed	integer	Náhodné počáteční hodnoty pro reprodukovatelnost.	Ano
Teplota	číslo	Parametr teploty pro vzorkování.	Ano
top_p	číslo	Parametr top-p pro vzorkování vzorků.	Ano

ModelSamplingParamsUpdate

Představuje sadu parametrů sloužících k řízení chování vzorkování jazykového modelu během generování textu.

Název	Typ	Description	Povinné	Výchozí
max_completion_tokens	integer	Maximální počet tokenů povolených v dokončení	Ne
seed	integer	Náhodné počáteční hodnoty pro reprodukovatelnost.	Ne
Teplota	číslo	Parametr teploty pro vzorkování.	Ne
top_p	číslo	Parametr top-p pro vzorkování vzorků.	Ne

MěsíčnírecurrenceSchedule

Měsíční plán opakování.

Název	Typ	Description	Povinné	Výchozí
daysOfMonth	pole	Dny v měsíci pro plán opakování.	Ano
typ	výčet	Typ opakování v měsíci. Možné hodnoty: Monthly	Ano

NoAuthenticationCredentials

Přihlašovací údaje, které nevyžadují ověření

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: None	Ano

OAuthConsentRequestItemResource

Požádejte uživatele o udělení souhlasu OAuth ze služby.

Název	Typ	Description	Povinné	Výchozí
consent_link	řetězec	Odkaz, který může uživatel použít k provedení souhlasu OAuth.	Ano
ID	řetězec		Ano
označení serveru	řetězec	Popisek serveru pro žádost o souhlas OAuth.	Ano
typ	výčet	Možné hodnoty: oauth_consent_request	Ano

OneTimeTrigger

Jednorázová spouštěč.

Název	Typ	Description	Povinné	Výchozí
timeZone	řetězec	Časové pásmo pro jednorázovou spouštěč.	Ne	standard UTC
triggerAt	řetězec	Datum a čas jednorázového spouštěče ve formátu ISO 8601.	Ano
typ	výčet	Možné hodnoty: OneTime	Ano

OpenAI.Annotation

Diskriminátor pro OpenAI.Annotation

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.AnnotationType		Ano

OpenAI.AnnotationFileCitation

Citace souboru.

Název	Typ	Description	Povinné	Výchozí
ID souboru	řetězec	ID souboru.	Ano
filename	řetězec	Název souboru citovaného souboru.	Ano
index	integer	Index souboru v seznamu souborů.	Ano
typ	výčet	Typ citace souboru. Vždy file_citation. Možné hodnoty: file_citation	Ano

OpenAI.AnnotationFilePath

Cesta k souboru.

Název	Typ	Description	Povinné	Výchozí
ID souboru	řetězec	ID souboru.	Ano
index	integer	Index souboru v seznamu souborů.	Ano
typ	výčet	Typ cesty k souboru. Vždy file_path. Možné hodnoty: file_path	Ano

OpenAI.AnnotationType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

Citace webového prostředku použitého k vygenerování odpovědi modelu

Název	Typ	Description	Povinné	Výchozí
end_index	integer	Index posledního znaku citace adresy URL ve zprávě.	Ano
start_index	integer	Index prvního znaku citace adresy URL ve zprávě.	Ano
title	řetězec	Název webového prostředku.	Ano
typ	výčet	Typ citace adresy URL. Vždy url_citation. Možné hodnoty: url_citation	Ano
url	řetězec	Adresa URL webového prostředku.	Ano

OpenAI.PřibližnáPoloha

Název	Typ	Description	Povinné	Výchozí
město	řetězec		Ne
země	řetězec		Ne
oblast	řetězec		Ne
timezone	řetězec		Ne
typ	výčet	Možné hodnoty: approximate	Ano

OpenAI.NástrojProDokončeníChatu

Nástroj funkce, který lze použít k vygenerování odpovědi.

Název	Typ	Description	Povinné	Výchozí
funkce	OpenAI.FunctionObject		Ano
typ	výčet	Typ nástroje. V současné době se podporuje pouze function . Možné hodnoty: function	Ano

OpenAI.CodeInterpreterOutput

Diskriminátor pro OpenAI.CodeInterpreterOutput

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.CodeInterpreterOutputType		Ano

OpenAI.CodeInterpreterOutputImage

Výstup obrázku z interpretu kódu.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ výstupu. Vždy image. Možné hodnoty: image	Ano
url	řetězec	Adresa URL výstupu obrázku z interpretu kódu.	Ano

OpenAI.CodeInterpreterOutputLogs

Výstup protokolů z interpretu kódu.

Název	Typ	Description	Povinné	Výchozí
protokoly	řetězec	Výstup protokolů z interpretu kódu.	Ano
typ	výčet	Typ výstupu. Vždy protokoly. Možné hodnoty: logs	Ano

OpenAI.CodeInterpreterOutputType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	logs image

OpenAI.CodeInterpreterTool

Nástroj, který spouští kód Pythonu, který pomáhá vygenerovat odpověď na výzvu.

Název	Typ	Description	Povinné	Výchozí
kontejner	objekt	Konfigurace kontejneru interpretu kódu Volitelně zadejte ID. souborů, na kterých se má kód spustit.	Ano
└- file_ids	pole	Volitelný seznam nahraných souborů, které mají být zpřístupněny vašemu kódu.	Ne
└- typ	výčet	Vždy auto. Možné hodnoty: auto	Ne
typ	výčet	Typ nástroje pro interpret kódu. Vždy code_interpreter. Možné hodnoty: code_interpreter	Ano

OpenAI.CodeInterpreterToolAuto

Konfigurace kontejneru interpretu kódu Volitelně zadejte ID souborů, na kterých se má kód spustit.

Název	Typ	Description	Povinné	Výchozí
identifikátory_souborů	pole	Volitelný seznam nahraných souborů, které mají být zpřístupněny vašemu kódu.	Ne
typ	výčet	Vždy auto. Možné hodnoty: auto	Ano

OpenAI.CodeInterpreterToolCallItemParam

Volání nástroje ke spuštění kódu

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Kód, který se má spustit, nebo null, pokud není k dispozici.	Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
výstupy	pole	Výstupy vygenerované interpretem kódu, jako jsou protokoly nebo obrázky. Pokud nejsou k dispozici žádné výstupy, může mít hodnotu null.	Ano
typ	výčet	Možné hodnoty: code_interpreter_call	Ano

OpenAI.CodeInterpreterToolCallItemResource

Volání nástroje ke spuštění kódu

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Kód, který se má spustit, nebo null, pokud není k dispozici.	Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
výstupy	pole	Výstupy vygenerované interpretem kódu, jako jsou protokoly nebo obrázky. Pokud nejsou k dispozici žádné výstupy, může mít hodnotu null.	Ano
stav	výčet	Možné hodnoty: in_progress, completed, incomplete, interpreting, failed	Ano
typ	výčet	Možné hodnoty: code_interpreter_call	Ano

OpenAI.ComparisonFilter

Filtr použitý k porovnání zadaného klíče atributu s danou hodnotou pomocí definované operace porovnání.

Název	Typ	Description	Povinné	Výchozí
klíč	řetězec	Klíč k porovnání s hodnotou.	Ano
typ	výčet	Určuje relační operátor: eq (rovno), (nerovná se), negt (větší než), gte (větší než nebo rovno), lt (menší než lte nebo rovno). Možné hodnoty: eq, ne, gt, gte, ltlte	Ano
value	řetězec nebo číslo nebo logická hodnota		Ano

OpenAI.CompoundFilter

Kombinování více filtrů pomocí and nebo or.

Název	Typ	Description	Povinné	Výchozí
filters	pole	Pole filtrů k kombinování. Položky mohou být ComparisonFilter nebo CompoundFilter.	Ano
typ	výčet	Typ operace: and nebo or. Možné hodnoty: and, or	Ano

OpenAI.ComputerAction

Diskriminátor pro OpenAI.ComputerAction

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
click	OpenAI.ComputerActionClick
double_click	OpenAI.ComputerActionDoubleClick
drag	OpenAI.ComputerActionDrag
move	OpenAI.ComputerActionMove
screenshot	OpenAI.ComputerActionScreenshot
scroll	OpenAI.ComputerActionScroll
type	OpenAI.ComputerActionTypeKeys
wait	OpenAI.ComputerActionWait
keypress	OpenAI.ComputerActionKeyPress

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ComputerActionType		Ano

OpenAI.ComputerActionClick

Kliknutí myší.

Název	Typ	Description	Povinné	Výchozí
knoflík	výčet	Označuje, které tlačítko myši bylo během kliknutí stisknuto. Jeden z left, , rightwheel, backnebo forward. Možné hodnoty: left, right, wheel, back, forward	Ano
typ	výčet	Určuje typ události. U akce kliknutí je tato vlastnost vždy nastaveno na click. Možné hodnoty: click	Ano
x	integer	Souřadnice x, kde došlo k kliknutí.	Ano
y	integer	Souřadnice y, kde došlo k kliknutí.	Ano

OpenAI.ComputerActionDoubleClick

Akce dvojkliku.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Určuje typ události. U akce poklikání je tato vlastnost vždy nastaveno na double_click. Možné hodnoty: double_click	Ano
x	integer	Souřadnice x, kde došlo k dvojitému kliknutí.	Ano
y	integer	Souřadnice y, kde došlo k dvojitému kliknutí.	Ano

OpenAI.ComputerActionDrag

Akce přetažení

Název	Typ	Description	Povinné	Výchozí
cesta	pole	Pole souřadnic představující cestu přetahování Souřadnice se zobrazí jako pole. objektů, například <br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>	Ano
typ	výčet	Určuje typ události. U akce přetažení je tato vlastnost vždy nastaveno na drag. Možné hodnoty: drag	Ano

OpenAI.ComputerActionKeyPress

Kolekce klávesových stisků, které model chce provést.

Název	Typ	Description	Povinné	Výchozí
keys	pole	Kombinace kláves, které model žádá stisknout. Toto je pole řetězců, z nichž každý představuje klíč.	Ano
typ	výčet	Určuje typ události. U akce keypressu je tato vlastnost vždy nastaveno na keypress. Možné hodnoty: keypress	Ano

OpenAI.ComputerActionMove

Akce přesunutí myší.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Určuje typ události. U akce přesunutí je tato vlastnost vždy nastaveno na move. Možné hodnoty: move	Ano
x	integer	Souřadnice x, ke které se chcete přesunout.	Ano
y	integer	Souřadnice y, ke které se chcete přesunout.	Ano

OpenAI.ComputerActionScreenshot

Akce snímku obrazovky

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Určuje typ události. U akce snímku obrazovky je tato vlastnost vždy nastaveno na screenshot. Možné hodnoty: screenshot	Ano

OpenAI.ComputerActionScroll

Akce scrollování

Název	Typ	Description	Povinné	Výchozí
scroll_x	integer	Vodorovná vzdálenost posouvání.	Ano
scroll_y	integer	Svislá posuvná vzdálenost.	Ano
typ	výčet	Určuje typ události. U akce posouvání je tato vlastnost vždy nastaveno na scroll. Možné hodnoty: scroll	Ano
x	integer	Souřadnice x, kde došlo k posunu.	Ano
y	integer	Souřadnice y, kde došlo ke scrollování.	Ano

OpenAI.ComputerActionType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

Akce pro zadávání textu.

Název	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Text, který chcete zadat.	Ano
typ	výčet	Určuje typ události. U akce typu je tato vlastnost vždy nastaveno na type. Možné hodnoty: type	Ano

OpenAI.ComputerActionWait

Akce čekání.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Určuje typ události. U akce čekání je tato vlastnost vždy nastaveno na wait. Možné hodnoty: wait	Ano

OpenAI.ComputerToolCallItemParam

Zavolání nástroje k použití s počítačovým nástrojem. Další informace najdete v průvodci používáním počítače.

Název	Typ	Description	Povinné	Výchozí
akce	OpenAI.ComputerAction		Ano
call_id	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Ano
pending_safety_checks	pole	Čekající bezpečnostní kontroly volání počítače.	Ano
typ	výčet	Možné hodnoty: computer_call	Ano

OpenAI.ComputerToolCallItemResource

Zavolání nástroje k použití s počítačovým nástrojem. Další informace najdete v průvodci používáním počítače.

Název	Typ	Description	Povinné	Výchozí
akce	OpenAI.ComputerAction		Ano
call_id	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Ano
pending_safety_checks	pole	Čekající bezpečnostní kontroly volání počítače.	Ano
stav	výčet	Stav položky. jeden z in_progress, completed, nebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Možné hodnoty: computer_call	Ano

OpenAI.ComputerToolCallOutputItemOutput

Diskriminátor pro OpenAI.ComputerToolCallOutputItemOutput

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ComputerToolCallOutputItemOutputType	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Název	Typ	Description	Povinné	Výchozí
ID souboru	řetězec		Ne
image_url	řetězec		Ne
typ	výčet	Možné hodnoty: computer_screenshot	Ano

OpenAI.ComputerToolCallOutputItemOutputType

Snímek obrazovky počítače použitý s nástrojem pro použití počítače

Vlastnictví	Hodnota
Description	Snímek obrazovky počítače použitý s nástrojem pro použití počítače
Type	řetězec
Hodnoty	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

Výstup z volání počítačového nástroje.

Název	Typ	Description	Povinné	Výchozí
acknowledged_safety_checks	pole	Bezpečnostní kontroly hlášené rozhraním API, které byly potvrzeny vývojář.	Ne
call_id	řetězec	ID volání počítačového nástroje, které vytvořilo výstup.	Ano
výstup	OpenAI.ComputerToolCallOutputItemOutput		Ano
typ	výčet	Možné hodnoty: computer_call_output	Ano

OpenAI.ComputerToolCallOutputItemResource

Výstup z volání počítačového nástroje.

Název	Typ	Description	Povinné	Výchozí
acknowledged_safety_checks	pole	Bezpečnostní kontroly hlášené rozhraním API, které byly potvrzeny vývojář.	Ne
call_id	řetězec	ID volání počítačového nástroje, které vytvořilo výstup.	Ano
výstup	OpenAI.ComputerToolCallOutputItemOutput		Ano
stav	výčet	Stav položky. jeden z in_progress, completed, nebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Možné hodnoty: computer_call_output	Ano

OpenAI.ComputerToolCallSafetyCheck

Čekající bezpečnostní kontrola pro počítačové volání.

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Typ čekající bezpečnostní kontroly.	Ano
ID	řetězec	ID čekající bezpečnostní kontroly.	Ano
zpráva	řetězec	Podrobnosti o čekající bezpečnostní kontrole	Ano

Nástroj pro náhled použití počítače OpenAI

Nástroj, který řídí virtuální počítač.

Název	Typ	Description	Povinné	Výchozí
výška displeje	integer	Výška displeje počítače.	Ano
šířka displeje	integer	Šířka displeje počítače.	Ano
prostředí	výčet	Typ počítačového prostředí, které se má řídit. Možné hodnoty: windows, mac, linux, ubuntu, browser	Ano
typ	výčet	Typ nástroje pro použití počítače. Vždy computer_use_preview. Možné hodnoty: computer_use_preview	Ano

OpenAI.ConversationItemList

Název	Typ	Description	Povinné	Výchozí
data	pole		Ano
first_id	řetězec		Ano
má více	Boolean		Ano
last_id	řetězec		Ano
objekt	výčet	Možné hodnoty: list	Ano

OpenAI.ConversationResource

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer		Ano
ID	řetězec	Jedinečné ID konverzace.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ano
objekt	výčet	Typ objektu, který je vždy "konverzace". Možné hodnoty: conversation	Ano

OpenAI.Coordinate

Dvojice souřadnic x/y, například { x: 100, y: 200 }.

Název	Typ	Description	Povinné	Výchozí
x	integer	Souřadnice x.	Ano
y	integer	Souřadnice y.	Ano

OpenAI.CreateConversationRequest

Vytvoření konverzace

Název	Typ	Description	Povinné	Výchozí
items	pole	Počáteční položky, které mají obsahovat kontext konverzace Najednou můžete přidat až 20 položek.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

OpenAI.CreateEvalCompletionsRunDataSource

Objekt CompletionsRunDataSource popisující konfiguraci vzorkování modelu.

Název	Typ	Description	Povinné	Výchozí
zprávy_vstupu	objekt		Ne
└ item_reference	řetězec		Ne
Šablona └─	pole		Ne
└- typ	výčet	Možné hodnoty: item_reference	Ne
model	řetězec	Název modelu, který se má použít ke generování dokončení (např. "o3-mini").	Ne
parametry vzorkování	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Ne
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└created_after	OpenAI.integer		Ne
└created_before	OpenAI.integer		Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- limit	OpenAI.integer		Ne
└– metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec		Ne
└- typ	výčet	Typ zdroje. Vždy stored_completions. Možné hodnoty: stored_completions	Ne
typ	výčet	Typ spuštění zdroje dat. Vždy completions. Možné hodnoty: completions	Ano

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Název	Typ	Description	Povinné	Výchozí
item_reference	řetězec		Ano
typ	výčet	Možné hodnoty: item_reference	Ano

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Název	Typ	Description	Povinné	Výchozí
šablona	pole		Ano
typ	výčet	Možné hodnoty: template	Ano

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Název	Typ	Description	Povinné	Výchozí
max_completion_tokens	OpenAI.integer		Ne
úsilí o usuzování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
formát_odpovědi	objekt	Výchozí formát odpovědi Používá se ke generování textových odpovědí.	Ne
└json_schema	objekt	Možnosti konfigurace strukturovaných výstupů, včetně schématu JSON.	Ne
└- popis	řetězec	Popis toho, k čemu formát odpovědi slouží, který model používá k určete, jak postupovat v daném formátu.	Ne
└– název	řetězec	Název formátu odpovědi. Musí to být a-z, A-Z, 0-9 nebo musí obsahovat podtržítka a pomlčky s maximální délkou 64 znaků.	Ne
└- schéma	objekt		Ne
└- striktní	Boolean	Zda povolit přísné dodržování schématu při generování výstupu. Pokud je nastavená hodnota true, model bude vždy dodržovat přesné schéma definované. schema v poli. Podporována je pouze podmnožina schématu JSON. strict je true. Další informace najdete v Strukturované výstupy. průvodce.	Ne	Nepravda
└- typ	výčet	Typ formátu odpovědi, který se definuje. Vždy json_object. Možné hodnoty: json_object	Ne
seed	objekt		Ne
Teplota	objekt		Ne
nářadí	pole		Ne
top_p	objekt		Ne

OpenAI.CreateEvalCustomDataSourceConfig

Objekt CustomDataSourceConfig, který definuje schéma pro zdroj dat použitý pro zkušební spuštění. Toto schéma slouží k definování tvaru dat, která budou:

• Slouží k definování kritérií testování a
• Jaká data se vyžadují při vytváření spuštění

Název	Typ	Description	Povinné	Výchozí
zahrnout_vzorek_schématu	Boolean	Určuje, jestli by se měl očekávat, že naplníte ukázkový obor názvů (tj. vygenerováním odpovědí z vašeho zdroje dat).	Ne
schéma položky	objekt	Schéma JSON pro každý řádek ve zdroji dat.	Ano
typ	výčet	Typ zdroje dat. Vždy custom. Možné hodnoty: custom	Ano

OpenAI.CreateEvalJsonlRunDataSource

Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.

Název	Typ	Description	Povinné	Výchozí
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ne
typ	výčet	Typ zdroje dat. Vždy jsonl. Možné hodnoty: jsonl	Ano

OpenAI.CreateEvalLogsDataSourceConfig

Konfigurace zdroje dat, která určuje vlastnost metadat dotazu protokolů. Obvykle se jedná o metadata jako usecase=chatbot nebo prompt-version=v2atd.

Název	Typ	Description	Povinné	Výchozí
metadata	objekt	Filtry metadat pro zdroj dat protokolů	Ne
typ	výčet	Typ zdroje dat. Vždy logs. Možné hodnoty: logs	Ano

OpenAI.CreateEvalResponsesRunDataSource

A ResponsesRunDataSource objekt popisující konfiguraci vzorkování modelu.

Název	Typ	Description	Povinné	Výchozí
zprávy_vstupu	objekt		Ne
└ item_reference	řetězec		Ne
Šablona └─	pole		Ne
└- typ	výčet	Možné hodnoty: item_reference	Ne
model	řetězec	Název modelu, který se má použít ke generování dokončení (např. "o3-mini").	Ne
parametry vzorkování	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Ne
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└created_after	OpenAI.integer		Ne
└created_before	OpenAI.integer		Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└instructions_search	řetězec		Ne
└– metadata	objekt		Ne
└model	řetězec		Ne
└reasoning_effort	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
└− teplota	OpenAI.numeric		Ne
└ nástroje	pole		Ne
└top_p	OpenAI.numeric		Ne
└- typ	výčet	Typ spuštění zdroje dat. Vždy responses. Možné hodnoty: responses	Ne
└uživatelé	pole		Ne
typ	výčet	Typ spuštění zdroje dat. Vždy responses. Možné hodnoty: responses	Ano

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Název	Typ	Description	Povinné	Výchozí
item_reference	řetězec		Ano
typ	výčet	Možné hodnoty: item_reference	Ano

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Název	Typ	Description	Povinné	Výchozí
šablona	pole		Ano
typ	výčet	Možné hodnoty: template	Ano

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Název	Typ	Description	Povinné	Výchozí
max_completion_tokens	OpenAI.integer		Ne
úsilí o usuzování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
seed	objekt		Ne
Teplota	objekt		Ne
poslat SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Ne
nářadí	pole		Ne
top_p	objekt		Ne

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Název	Typ	Description	Povinné	Výchozí
format	OpenAI.TextResponseFormatConfiguration	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy. tím zajistíte, že model bude odpovídat zadanému schématu JSON. Další informace najdete v Výchozí formát je { "type": "text" } bez dalších možností. *Nedoporučuje se pro gpt-4o a novější modely:** Nastavení na { "type": "json_object" } umožní starší režim JSON, který zajišťuje, že zpráva, kterou model vygeneruje, je platný JSON. Použití json_schema je upřednostňovaný pro modely, které ho podporují.	Ne

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Zastaralé ve prospěch LogsDataSourceConfig.

Název	Typ	Description	Povinné	Výchozí
metadata	objekt	Filtry metadat pro uložený zdroj dat dokončení	Ne
typ	výčet	Typ zdroje dat. Vždy stored_completions. Možné hodnoty: stored_completions	Ano

OpenAI.CreateFineTuningJobRequest

Platné modely:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Název	Typ	Description	Povinné	Výchozí
hyperparametry	objekt	Hyperparametry používané pro úlohu jemného ladění. Tato hodnota je nyní zastaralá ve prospěch methoda měla by být předána pod parametrem method .	Ne
└batch_size	výčet	Možné hodnoty: auto	Ne
└learning_rate_multiplier	výčet	Možné hodnoty: auto	Ne
└n_epochs	výčet	Možné hodnoty: auto	Ne
integrace	pole	Seznam integrací, které umožňují vaši jemně vyladěnou úlohu.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
metoda	OpenAI.FineTuneMethod	Metoda použitá k jemnému ladění.	Ne
model	řetězec (viz následující platné modely)	Název modelu, který se má vyladit. Můžete vybrat jednu z možností supported models.	Ano
seed	integer	Seed řídí reprodukovatelnost procesu. Předání stejných počátečních parametrů a parametrů úlohy by mělo vést ke stejným výsledkům, ale ve výjimečných případech se může lišit. Pokud není zadaná počáteční hodnota, vygeneruje se za vás.	Ne
suffix	řetězec	Řetězec o velikosti až 64 znaků, který se přidá do jemně vyladěného názvu modelu. Například " suffix custom-model-name" by vytvořil název modelu jako ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	Ne	None
tréninkový soubor	řetězec	ID nahraného souboru, který obsahuje trénovací data. Datová sada musí být naformátovaná jako soubor JSONL. Kromě toho musíte nahrát soubor s účelem fine-tune. Obsah souboru by se měl lišit v závislosti na tom, jestli model používá chat, formát dokončení nebo pokud metoda jemného ladění používá formát předvoleb. Další podrobnosti najdete v průvodci laděním .	Ano
validační_soubor	řetězec	ID nahraného souboru, který obsahuje ověřovací data. Pokud tento soubor zadáte, data se použijí k vygenerování ověření. metriky se pravidelně dolaďují. Tyto metriky je možné zobrazit v soubor s výsledky jemného ladění. Stejná data by se neměla nacházet v souborech trénování i ověřování. Datová sada musí být naformátovaná jako soubor JSONL. Soubor musíte nahrát s tímto účelem fine-tune. Další podrobnosti najdete v průvodci laděním .	Ne

OpenAI.CreateFineTuningJobRequestIntegration

Diskriminátor pro OpenAI.CreateFineTuningJobRequestIntegration

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

Název	Typ	Description	Povinné	Výchozí
typ	řetězec (viz následující platné modely)		Ano

OpenAI.CreateFineTuningJobRequestWandbIntegration

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: wandb	Ano
wandb	objekt		Ano
└– entita	řetězec		Ne
└– název	řetězec		Ne
└- project	řetězec		Ne
└– značky	pole		Ne

OpenAI.CreateResponse

Název	Typ	Description	Povinné	Výchozí
agent	objekt		Ne
└– název	řetězec	Název agenta.	Ne
└- typ	výčet	Možné hodnoty: agent_reference	Ne
└- verze	řetězec	Identifikátor verze agenta.	Ne
na pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
konverzace	objekt		Ne
└- ID	řetězec		Ne
include	pole	Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou: - code_interpreter_call.outputs: Zahrnuje výstupy provádění kódu Pythonu. v nástroji interpretu kódu volají položky. - computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výstupu počítačového programu. - file_search_call.results: Zahrňte výsledky hledání volání nástroje pro vyhledávání souborů. - message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy. - message.output_text.logprobs: Zahrňte protokoly se zprávami pomocníka. - reasoning.encrypted_content: Zahrnuje šifrovanou verzi odůvodnění. tokeny ve výstupech položek odůvodnění. To umožňuje použití položek zdůvodnění v konverzace s vícenásobným otáčením při použití bezstavového rozhraní API pro odpovědi (například pokud je parametr nastaven na store hodnotu, nebo pokud je organizace zaregistrované v programu nulového uchovávání dat).	Ne
vstup	řetězec nebo pole		Ne
instructions	řetězec	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
previous_response_id	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
požádat	objekt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└- ID	řetězec	Jedinečný identifikátor šablony výzvy, která se má použít.	Ne
Proměnné └•	OpenAI.ResponsePromptVariables	Volitelná mapa hodnot, které se mají nahradit proměnnými ve vaší pobídnout. Hodnoty nahrazení můžou být řetězce nebo jiné. Vstupní typy odpovědí, jako jsou obrázky nebo soubory.	Ne
└- verze	řetězec	Volitelná verze šablony výzvy	Ne
reasoning	objekt	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└– úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
└─ vytvořit_shrnutí	výčet	Zastaralé: místo toho použijte summary . Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
└─ souhrn	výčet	Souhrn důvodů provedených modelem Může to být užitečné pro ladění a pochopení způsobu uvažování modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
úroveň služby	objekt	Určuje typ zpracování použitý pro obsluhu požadavku. * Pokud je nastavená hodnota "auto", požadavek se zpracuje s úrovní služby. nakonfigurováno v nastavení Project. Pokud není nakonfigurované jinak, použije Project výchozí hodnotu. * Pokud je nastavená hodnota default, požadavek se zpracuje se standardním ceny a výkon pro vybraný model. * Pokud je nastavená hodnota flex nebo "priorita", žádost se zpracuje s odpovídající službou. úroveň. Kontaktujte sales a získejte další informace o zpracování priority. * Pokud není nastaveno, výchozí chování je "auto". Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnota založená na režimu zpracování, který se skutečně používá k poskytování požadavku. Tato hodnota odpovědi může se lišit od hodnoty nastavené v parametru.	Ne
uložit	Boolean	Zda se má vygenerovaná odpověď modelu uložit pro pozdější načtení prostřednictvím API.	Ne	Pravdivé
datový proud	Boolean	Pokud je nastavená hodnota true, data odpovědi modelu se streamují do klienta. jak se generuje pomocí událostí odesílaných serverem. další informace.	Ne	Nepravda
structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
Teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	1
poslat SMS	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
tool_choice	objekt	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model může vybírat mezi generováním zprávy nebo voláním jedné nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů.	Ne
└- typ	OpenAI.ToolChoiceObjectType	Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.	Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Ty může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání souborů. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód.	Ne
top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	1
truncation	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne

OpenAI.DeletedConversationResource

Název	Typ	Description	Povinné	Výchozí
smazaný	Boolean		Ano
ID	řetězec		Ano
objekt	výčet	Možné hodnoty: conversation.deleted	Ano

OpenAI.EasyInputMessage

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec nebo pole		Ano
role	řetězec		Ano

OpenAI.Error

Název	Typ	Description	Povinné	Výchozí
doplňkové informace	objekt		Ne
kód	řetězec		Ano
Informace o ladění	objekt		Ne
Podrobnosti	pole		Ne
zpráva	řetězec		Ano
param	řetězec		Ano
typ	řetězec		Ano

OpenAI.EvalApiError

Objekt představující chybovou odpověď z rozhraní Eval API.

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Kód chyby.	Ano
zpráva	řetězec	Chybová zpráva.	Ano

OpenAI.EvalGraderLabelModel

Název	Typ	Description	Povinné	Výchozí
vstup	pole		Ano
labels	pole	Popisky, které se mají přiřadit ke každé položce v hodnocení.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení. Musí podporovat strukturované výstupy.	Ano
název	řetězec	Název hodnotitele.	Ano
předávání štítků	pole	Popisky označující úspěšný výsledek. Musí to být podmnožina popisků.	Ano
typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: label_model	Ano

OpenAI.EvalGraderPython

Název	Typ	Description	Povinné	Výchozí
image_tag	řetězec	Značka obrázku, která se má použít pro skript Pythonu.	Ne
název	řetězec	Název hodnotitele.	Ano
prah průchodu	objekt		Ne
odeslat k provedení	řetězec	Zdrojový kód skriptu Pythonu.	Ano
typ	výčet	Typ objektu, který je vždy python. Možné hodnoty: python	Ano

OpenAI.EvalGraderScoreModel

Název	Typ	Description	Povinné	Výchozí
vstup	pole	Vstupní text. To může zahrnovat řetězce vzorů.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení.	Ano
název	řetězec	Název hodnotitele.	Ano
prah průchodu	objekt		Ne
oblast	pole	Rozsah skóre. Výchozí hodnota je [0, 1].	Ne
parametry vzorkování	objekt		Ne
└max_completions_tokens	OpenAI.integer		Ne
└reasoning_effort	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
└semeno	OpenAI.integer		Ne
└− teplota	OpenAI.numeric		Ne
└top_p	OpenAI.numeric		Ne
typ	výčet	Typ objektu, který je vždy score_model. Možné hodnoty: score_model	Ano

OpenAI.EvalGraderScoreModelSamplingParams

Název	Typ	Description	Povinné	Výchozí
max_completions_tokens	objekt		Ne
úsilí o usuzování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
seed	objekt		Ne
Teplota	objekt		Ne
top_p	objekt		Ne

OpenAI.EvalGraderStringCheck

Název	Typ	Description	Povinné	Výchozí
vstup	řetězec	Vstupní text. To může zahrnovat řetězce vzorů.	Ano
název	řetězec	Název hodnotitele.	Ano
operace	výčet	Kontrola řetězce, kterou je třeba provést. Jeden z eq, ne, likenebo ilike. Možné hodnoty: eq, ne, like, ilike	Ano
odkazovat	řetězec	Text odkazu. To může zahrnovat řetězce vzorů.	Ano
typ	výčet	Typ objektu, který je vždy string_check. Možné hodnoty: string_check	Ano

OpenAI.EvalGraderTextSimilarity

Název	Typ	Description	Povinné	Výchozí
hodnotící metrika	výčet	Metrika vyhodnocení, která se má použít. Jeden z cosine, , fuzzy_matchbleu, gleu, meteor, rouge_1, , rouge_2rouge_3, rouge_4, , rouge_5 nebo rouge_l. Možné hodnoty: cosine, fuzzy_match, bleu, , gleumeteor, rouge_1rouge_2, rouge_3, rouge_4rouge_5rouge_l	Ano
vstup	řetězec	Text, který se ohodnotuje.	Ano
název	řetězec	Název hodnotitele.	Ano
prah průchodu	objekt		Ano
odkazovat	řetězec	Text, který se hodnotí podle.	Ano
typ	výčet	Typ grejdru. Možné hodnoty: text_similarity	Ano

OpenAI.EvalItem

Vstup zprávy do modelu s rolí, která označuje dodržování hierarchie pokynů. Pokyny, které mají roli developer nebo system, mají přednost před pokyny s rolí user. U zpráv s rolí assistant se předpokládá, že byly vygenerovány modelem v předchozích interakcích.

Název	Typ	Description	Povinné	Výchozí
obsah	objekt	Textový vstup do modelu.	Ano
└- data	řetězec	Zvuková data s kódováním Base64	Ne
└detail	řetězec		Ne
└─ Formát	výčet	Formát zvukových dat. Aktuálně podporované formáty jsou mp3 a wav. Možné hodnoty: mp3, wav	Ne
└image_url	řetězec		Ne
└- text	řetězec		Ne
└- typ	výčet	Typ vstupní položky. Vždy input_audio. Možné hodnoty: input_audio	Ne
role	výčet	Role vstupu zprávy. Jeden z user, assistant, system nebo developer. Možné hodnoty: user, assistant, system, developer	Ano
typ	výčet	Typ vstupu zprávy. Vždy message. Možné hodnoty: message	Ne

OpenAI.EvalItemContentInputImage

Název	Typ	Description	Povinné	Výchozí
detail	řetězec		Ne
image_url	řetězec		Ano
typ	výčet	Možné hodnoty: input_image	Ano

OpenAI.EvalItemContentOutputText

Název	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec		Ano
typ	výčet	Možné hodnoty: output_text	Ano

OpenAI.EvalJsonlFileContentSource

Název	Typ	Description	Povinné	Výchozí
obsah	pole	Obsah souboru jsonl.	Ano
typ	výčet	Typ zdroje jsonl. Vždy file_content. Možné hodnoty: file_content	Ano

OpenAI.EvalJsonlFileContentSourceContent

Název	Typ	Description	Povinné	Výchozí
položka	objekt		Ano
vzorek	objekt		Ne

OpenAI.EvalJsonlFileIdSource

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	Identifikátor souboru.	Ano
typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ano

OpenAI.EvalResponsesSource

A EvalResponsesSource objekt popisující konfiguraci spustit zdroj dat.

Název	Typ	Description	Povinné	Výchozí
vytvořeno po	objekt		Ne
vytvořeno před	objekt		Ne
instructions_search	řetězec		Ne
metadata	objekt		Ne
model	řetězec		Ne
úsilí o usuzování	objekt	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
Teplota	objekt		Ne
nářadí	pole		Ne
top_p	objekt		Ne
typ	výčet	Typ spuštění zdroje dat. Vždy responses. Možné hodnoty: responses	Ano
users	pole		Ne

OpenAI.EvalRunOutputItemSample

Název	Typ	Description	Povinné	Výchozí
chyba	OpenAI.EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ano
důvod ukončení	řetězec		Ano
vstup	pole		Ano
max_completion_tokens	OpenAI.integer		Ano
model	řetězec		Ano
výstup	pole		Ano
seed	OpenAI.integer		Ano
Teplota	OpenAI.numeric		Ano
top_p	OpenAI.numeric		Ano
využití	OpenAI.EvalRunOutputItemSampleUsage		Ano

OpenAI.EvalRunOutputItemSampleInput

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec		Ano
role	řetězec		Ano

OpenAI.EvalRunOutputItemSampleOutput

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec		Ne
role	řetězec		Ne

OpenAI.EvalRunOutputItemSampleUsage

Název	Typ	Description	Povinné	Výchozí
cached_tokens	OpenAI.integer		Ano
completion_tokens	OpenAI.integer		Ano
prompt_tokens	OpenAI.integer		Ano
total_tokens	OpenAI.integer		Ano

OpenAI.EvalRunPerModelUsage

Název	Typ	Description	Povinné	Výchozí
cached_tokens	OpenAI.integer		Ano
completion_tokens	OpenAI.integer		Ano
invocation_count	OpenAI.integer		Ano
model_name	řetězec		Ano
prompt_tokens	OpenAI.integer		Ano
total_tokens	OpenAI.integer		Ano

OpenAI.EvalRunPerTestingCriteriaResults

Název	Typ	Description	Povinné	Výchozí
selhalo	OpenAI.integer		Ano
prošel	OpenAI.integer		Ano
testovací_kritéria	řetězec		Ano

OpenAI.EvalRunResultCounts

Název	Typ	Description	Povinné	Výchozí
chyba	OpenAI.integer		Ano
selhalo	OpenAI.integer		Ano
prošel	OpenAI.integer		Ano
totální	OpenAI.integer		Ano

OpenAI.EvalStoredCompletionsSource

Konfigurace StoredCompletionsRunDataSource popisující sadu filtrů

Název	Typ	Description	Povinné	Výchozí
vytvořeno po	objekt		Ne
vytvořeno před	objekt		Ne
limit	objekt		Ne
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
model	řetězec		Ne
typ	výčet	Typ zdroje. Vždy stored_completions. Možné hodnoty: stored_completions	Ano

OpenAI.FileSearchTool

Nástroj, který hledá relevantní obsah z nahraných souborů.

Název	Typ	Description	Povinné	Výchozí
filters	objekt		Ne
max_počet_výsledků	integer	Maximální počet výsledků, které se mají vrátit. Toto číslo by mělo být mezi 1 a 50 včetně.	Ne
možnosti hodnocení	objekt		Ne
└- ranker	výčet	Ranker, který se má použít pro vyhledávání souborů. Možné hodnoty: auto, default-2024-11-15	Ne
└ score_threshold	číslo	Prahová hodnota skóre pro hledání souboru je číslo v rozmezí od 0 do 1. Čísla blížící se 1 se pokusí vrátit pouze nejrelevantní výsledky, ale můžou vrátit méně výsledků.	Ne
typ	výčet	Typ nástroje pro vyhledávání souborů. Vždy file_search. Možné hodnoty: file_search	Ano
identifikátory_vektorového_úložiště	pole	ID vektorových úložišť, která se mají prohledávat.	Ano

OpenAI.FileSearchToolCallItemParam

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Název	Typ	Description	Povinné	Výchozí
dotazy	pole	Dotazy používané k hledání souborů.	Ano
results	pole	Výsledky volání nástroje pro vyhledávání souborů.	Ne
typ	výčet	Možné hodnoty: file_search_call	Ano

OpenAI.FileSearchToolCallItemResource

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Název	Typ	Description	Povinné	Výchozí
dotazy	pole	Dotazy používané k hledání souborů.	Ano
results	pole	Výsledky volání nástroje pro vyhledávání souborů.	Ne
stav	výčet	Stav volání nástroje pro vyhledávání souborů. Jeden z in_progress. searching, incomplete nebo failed, Možné hodnoty: in_progress, searching, completed, incomplete, failed	Ano
typ	výčet	Možné hodnoty: file_search_call	Ano

OpenAI Filtry

Název	Typ	Description	Povinné	Výchozí
filters	pole	Pole filtrů k kombinování. Položky mohou být ComparisonFilter nebo CompoundFilter.	Ano
klíč	řetězec	Klíč k porovnání s hodnotou.	Ano
typ	výčet	Typ operace: and nebo or. Možné hodnoty: and, or	Ano
value	řetězec nebo číslo nebo logická hodnota	Hodnota, která se má porovnat s klíčem atributu; podporuje typy řetězců, čísel nebo logických hodnot.	Ano

OpenAI.FineTuneDPOHyperparameters

Hyperparametry používané pro úlohu vyladění DPO.

Název	Typ	Description	Povinné	Výchozí
velikost dávky	výčet	Možné hodnoty: auto	Ne
beta verze	výčet	Možné hodnoty: auto	Ne
násobič rychlosti učení	výčet	Možné hodnoty: auto	Ne
počet epoch	výčet	Možné hodnoty: auto	Ne

OpenAI.FineTuneDPOMethod

Konfigurace pro metodu jemného ladění DPO

Název	Typ	Description	Povinné	Výchozí
hyperparametry	OpenAI.FineTuneDPOHyperparameters	Hyperparametry používané pro úlohu vyladění DPO.	Ne

OpenAI.FineTuneMethod

Metoda použitá k jemnému ladění.

Název	Typ	Description	Povinné	Výchozí
dpo	OpenAI.FineTuneDPOMethod	Konfigurace pro metodu jemného ladění DPO	Ne
výztuž	OpenAI.FineTuneReinforcementMethod	Konfigurace pro metodu jemného ladění výztuže	Ne
supervizovaný	OpenAI.FineTuneSupervisedMethod	Konfigurace pro metodu jemného ladění pod dohledem	Ne
typ	výčet	Typ metody. Je buď supervised, dponebo reinforcement. Možné hodnoty: supervised, dpo, reinforcement	Ano

OpenAI.FineTuneReinforcementHyperparameters

Hyperparametry používané pro úlohu jemného ladění výztuže.

Název	Typ	Description	Povinné	Výchozí
velikost dávky	výčet	Možné hodnoty: auto	Ne
compute_multiplier	výčet	Možné hodnoty: auto	Ne
eval_interval	výčet	Možné hodnoty: auto	Ne
eval_samples	výčet	Možné hodnoty: auto	Ne
násobič rychlosti učení	výčet	Možné hodnoty: auto	Ne
počet epoch	výčet	Možné hodnoty: auto	Ne
úsilí o usuzování	výčet	Úroveň úsilí o odůvodnění. Možné hodnoty: default, low, medium, high	Ne

OpenAI.FineTuneReinforcementMethod

Konfigurace pro metodu jemného ladění výztuže

Název	Typ	Description	Povinné	Výchozí
srovnávač	objekt	A StringCheckGrader objekt, který provádí porovnání řetězců mezi vstupem a odkazem pomocí zadané operace.	Ano
└calculate_output	řetězec	Vzorec pro výpočet výstupu na základě výsledků klasifikačního nástroje	Ne
└evaluation_metric	výčet	Metrika vyhodnocení, která se má použít. Jeden z cosine, , fuzzy_matchbleu, gleu, meteor, rouge_1, , rouge_2rouge_3, rouge_4, , rouge_5 nebo rouge_l. Možné hodnoty: cosine, fuzzy_match, bleu, , gleumeteor, rouge_1rouge_2, rouge_3, rouge_4rouge_5rouge_l	Ne
└- gradery	OpenAI.GraderStringCheck nebo OpenAI.GraderTextSimilarity nebo OpenAI.GraderPython nebo OpenAI.GraderScoreModel nebo OpenAI.GraderLabelModel	A StringCheckGrader objekt, který provádí porovnání řetězců mezi vstupem a odkazem pomocí zadané operace.	Ne
└image_tag	řetězec	Značka obrázku, která se má použít pro skript Pythonu.	Ne
└─ vstup	pole	Vstupní text. To může zahrnovat řetězce vzorů.	Ne
└model	řetězec	Model, který se má použít pro vyhodnocení.	Ne
└– název	řetězec	Název hodnotitele.	Ne
└operace	výčet	Kontrola řetězce, kterou je třeba provést. Jeden z eq, ne, likenebo ilike. Možné hodnoty: eq, ne, like, ilike	Ne
Rozsah └•	pole	Rozsah skóre. Výchozí hodnota je [0, 1].	Ne
└- referenční dokumentace	řetězec	Text, který se hodnotí podle.	Ne
└sampling_params	OpenAI.EvalGraderScoreModelSamplingParams	Parametry vzorkování modelu.	Ne
└- zdroj	řetězec	Zdrojový kód skriptu Pythonu.	Ne
└- typ	výčet	Typ objektu, který je vždy multi. Možné hodnoty: multi	Ne
hyperparametry	OpenAI.FineTuneReinforcementHyperparameters	Hyperparametry používané pro úlohu jemného ladění výztuže.	Ne

OpenAI.FineTuneSupervisedHyperparameters

Hyperparametry používané pro úlohu jemného ladění.

Název	Typ	Description	Povinné	Výchozí
velikost dávky	výčet	Možné hodnoty: auto	Ne
násobič rychlosti učení	výčet	Možné hodnoty: auto	Ne
počet epoch	výčet	Možné hodnoty: auto	Ne

OpenAI.FineTuneSupervisedMethod

Konfigurace pro metodu jemného ladění pod dohledem

Název	Typ	Description	Povinné	Výchozí
hyperparametry	OpenAI.FineTuneSupervisedHyperparameters	Hyperparametry používané pro úlohu jemného ladění.	Ne

OpenAI.FineTuningIntegration

Diskriminátor pro OpenAI.FineTuningIntegration

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
wandb	OpenAI.FineTuningIntegrationWandb

Název	Typ	Description	Povinné	Výchozí
typ	řetězec (viz následující platné modely)		Ano

OpenAI.FineTuningIntegrationWandb

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ povolení integrace pro úlohu jemného ladění Možné hodnoty: wandb	Ano
wandb	objekt	Nastavení pro integraci s Weights a Biases. Tato datová část určuje project, která metriky se odešlou. Volitelně můžete pro spuštění nastavit explicitní zobrazovaný název, přidat značky. a nastavte výchozí entitu (tým, uživatelské jméno atd.), která se má přidružit k vašemu spuštění.	Ano
└– entita	řetězec	Entita, která se má použít pro spuštění. To vám umožní nastavit tým nebo uživatelské jméno uživatele WandB, který byste vytvořili. asociované se spuštěním. Pokud není nastavená, použije se výchozí entita pro zaregistrovaný klíč rozhraní WANDB API.	Ne
└– název	řetězec	Zobrazovaný název, který se má pro spuštění nastavit. Pokud není nastavené, použijeme jako název ID úlohy.	Ne
└- project	řetězec	Název project, pod kterým se vytvoří nové spuštění.	Ne
└– značky	pole	Seznam značek, které se mají připojit k nově vytvořenému spuštění. Tyto značky se předávají přímo do WandB. Some OpenAI generuje výchozí značky: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Ne

OpenAI.FineTuningJob

Objekt fine_tuning.job představuje jemně vyladěnou úlohu, která byla vytvořena prostřednictvím rozhraní API.

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer	Časové razítko unixu (v sekundách) pro vytvoření úlohy jemného ladění.	Ano
chyba	objekt	V případě jemně vyladěných úloh failedbude obsahovat další informace o příčině selhání.	Ano
└ kód	řetězec	Strojově čitelný kód chyby.	Ne
└- zpráva	řetězec	Chybová zpráva čitelná člověkem.	Ne
└- param	řetězec	Parametr, který byl neplatný, obvykle training_file nebo validation_file. Pokud selhání nebylo specifické pro parametr, bude toto pole null.	Ne
odhadované dokončení	integer	Časové razítko unixu (v sekundách) pro dobu, kdy se odhaduje dokončení úlohy jemného ladění. Hodnota bude null, pokud není spuštěna úloha jemného ladění.	Ne
fine_tuned_model	řetězec	Název jemně vyladěného modelu, který se vytváří. Hodnota bude null, pokud je úloha jemného ladění stále spuštěná.	Ano
dokončeno v	integer	Časové razítko unixu (v sekundách) pro dokončení úlohy jemného ladění. Hodnota bude null, pokud je úloha jemného ladění stále spuštěná.	Ano
hyperparametry	objekt	Hyperparametry používané pro úlohu jemného ladění. Tato hodnota bude vrácena pouze při spouštění supervised úloh.	Ano
└batch_size	výčet	Možné hodnoty: auto	Ne
└learning_rate_multiplier	výčet	Možné hodnoty: auto	Ne
└n_epochs	výčet	Možné hodnoty: auto	Ne
ID	řetězec	Identifikátor objektu, na který lze odkazovat v koncových bodech rozhraní API.	Ano
integrace	pole	Seznam integrací, které umožňují tuto jemně vyladěnou úlohu.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ano
metoda	OpenAI.FineTuneMethod	Metoda použitá k jemnému ladění.	Ne
model	řetězec	Základní model, který je vyladěný.	Ano
objekt	výčet	Typ objektu, který je vždy "fine_tuning.job". Možné hodnoty: fine_tuning.job	Ano
organization_id	řetězec	Organizace, která vlastní jemně vyladěnou úlohu.	Ano
výsledkové_soubory	pole	ID zkompilovaných souborů výsledků pro úlohu jemného ladění. Výsledky můžete načíst pomocí rozhraní Files API.	Ano
seed	integer	Semeno použité pro úlohu jemného ladění.	Ano
stav	výčet	Aktuální stav jemně vyladěné úlohy, která může být buď validating_files, queued, running, , succeeded, failednebo cancelled. Možné hodnoty: validating_files, queued, running, succeeded, failedcancelled	Ano
trénované tokeny	integer	Celkový počet fakturovatelnýchtokench Hodnota bude null, pokud je úloha jemného ladění stále spuštěná.	Ano
tréninkový soubor	řetězec	ID souboru použitého pro trénování. Trénovací data můžete načíst pomocí rozhraní FILES API.	Ano
user_provided_suffix	řetězec	Popisná přípona použitá pro úlohu, jak je uvedeno v požadavku na vytvoření úlohy.	Ne
validační_soubor	řetězec	ID souboru použitého k ověření. Výsledky ověření můžete načíst pomocí rozhraní Files API.	Ano

OpenAI.FineTuningJobCheckpoint

Objekt fine_tuning.job.checkpoint představuje kontrolní bod modelu pro jemně vyladěnou úlohu, která je připravená k použití.

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer	Časové razítko unixu (v sekundách) pro vytvoření kontrolního bodu.	Ano
kontrolní bod doladěného modelu	řetězec	Název jemně vyladěného modelu kontrolního bodu, který se vytvoří.	Ano
identifikátor_fine_tuning_jobu	řetězec	Název úlohy jemného ladění, ze které byl tento kontrolní bod vytvořen.	Ano
ID	řetězec	Identifikátor kontrolního bodu, na který lze odkazovat v koncových bodech rozhraní API.	Ano
metriky	objekt	Metriky na čísle kroku během úlohy vyladění	Ano
└full_valid_loss	číslo		Ne
└full_valid_mean_token_accuracy	číslo		Ne
Krok └-	číslo		Ne
└train_loss	číslo		Ne
└train_mean_token_accuracy	číslo		Ne
└- valid_loss	číslo		Ne
└valid_mean_token_accuracy	číslo		Ne
objekt	výčet	Typ objektu, který je vždy "fine_tuning.job.checkpoint". Možné hodnoty: fine_tuning.job.checkpoint	Ano
číslo_kroku	integer	Číslo kroku, na které byl kontrolní bod vytvořen.	Ano

OpenAI.FineTuningJobEvent

Vyladění objektu události úlohy

Název	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer	Časové razítko unixu (v sekundách) pro vytvoření úlohy jemného ladění.	Ano
data		Data přidružená k události.	Ne
ID	řetězec	Identifikátor objektu.	Ano
úroveň	výčet	Úroveň protokolu události. Možné hodnoty: info, warn, error	Ano
zpráva	řetězec	Zpráva události.	Ano
objekt	výčet	Typ objektu, který je vždy "fine_tuning.job.event". Možné hodnoty: fine_tuning.job.event	Ano
typ	výčet	Typ události. Možné hodnoty: message, metrics	Ne

OpenAI.FunctionObject

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
název	řetězec	Název funkce, která se má volat. Musí být a-z, A-Z, 0-9 nebo obsahovat podtržítka a pomlčky s maximální délkou 64.	Ano
parametry		Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v guide a dokumentaci k formátu najdete v referenčních informacích ke schématu JSON. Vynechání parameters definuje funkci s prázdným seznamem parametrů.	Ne
přísné	Boolean	Zda povolit přísné dodržování schématu při generování volání funkce. Pokud je nastavená hodnota true, model bude dodržovat přesné schéma definované v parameters poli. Pokud je stricttrue, podporuje se pouze podmnožina schématu JSON. Další informace o strukturovaných výstupech v tématu	Ne	Nepravda

OpenAI.FunctionTool

Ve vašem vlastním kódu definuje funkci, kterou může model volitelně volat.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis funkce. Model se používá k rozhodnutí, zda má být funkce volána či nikoliv.	Ne
název	řetězec	Název funkce, která se má volat.	Ano
parametry		Objekt schématu JSON popisující parametry funkce.	Ano
přísné	Boolean	Určuje, jestli se má vynutit přísné ověřování parametrů. Výchozí true.	Ano
typ	výčet	Typ nástroje funkce. Vždy function. Možné hodnoty: function	Ano

OpenAI.FunctionToolCallItemParam

Volání nástroje ke spuštění funkce Další informace najdete v průvodci voláním funkční.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Řetězec JSON obsahující argumenty, které mají být předány funkci.	Ano
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
název	řetězec	Název funkce, která se má spustit.	Ano
typ	výčet	Možné hodnoty: function_call	Ano

OpenAI.FunctionToolCallItemResource

Volání nástroje ke spuštění funkce Další informace najdete v průvodci voláním funkční.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Řetězec JSON obsahující argumenty, které mají být předány funkci.	Ano
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
název	řetězec	Název funkce, která se má spustit.	Ano
stav	výčet	Stav položky. jeden z in_progress, completed, nebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Možné hodnoty: function_call	Ano

OpenAI.FunctionToolCallOutputItemParam

Výstup z volání funkčního nástroje.

Název	Typ	Description	Povinné	Výchozí
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
výstup	řetězec	Řetězec JSON výstupu volání nástroje funkcí.	Ano
typ	výčet	Možné hodnoty: function_call_output	Ano

OpenAI.FunctionToolCallOutputItemResource

Výstup z volání funkčního nástroje.

Název	Typ	Description	Povinné	Výchozí
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
výstup	řetězec	Řetězec JSON výstupu volání nástroje funkcí.	Ano
stav	výčet	Stav položky. jeden z in_progress, completed, nebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Možné hodnoty: function_call_output	Ano

OpenAI.GraderLabelModel

Objekt LabelModelGrader, který používá model k přiřazení popisků ke každé položce v vyhodnocení.

Název	Typ	Description	Povinné	Výchozí
vstup	pole		Ano
labels	pole	Popisky, které se mají přiřadit ke každé položce v hodnocení.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení. Musí podporovat strukturované výstupy.	Ano
název	řetězec	Název hodnotitele.	Ano
předávání štítků	pole	Popisky označující úspěšný výsledek. Musí to být podmnožina popisků.	Ano
typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: label_model	Ano

OpenAI.GraderMulti

Objekt MultiGrader kombinuje výstup více graderů, aby vytvořil jedno skóre.

Název	Typ	Description	Povinné	Výchozí
calculate_output	řetězec	Vzorec pro výpočet výstupu na základě výsledků klasifikačního nástroje	Ano
Grejdry	objekt	A StringCheckGrader objekt, který provádí porovnání řetězců mezi vstupem a odkazem pomocí zadané operace.	Ano
└evaluation_metric	výčet	Metrika vyhodnocení, která se má použít. Jeden z cosine, , fuzzy_matchbleu, gleu, meteor, rouge_1, , rouge_2rouge_3, rouge_4, , rouge_5 nebo rouge_l. Možné hodnoty: cosine, fuzzy_match, bleu, , gleumeteor, rouge_1rouge_2, rouge_3, rouge_4rouge_5rouge_l	Ne
└image_tag	řetězec	Značka obrázku, která se má použít pro skript Pythonu.	Ne
└─ vstup	pole		Ne
Popisky └}	pole	Popisky, které se mají přiřadit ke každé položce v hodnocení.	Ne
└model	řetězec	Model, který se má použít pro vyhodnocení. Musí podporovat strukturované výstupy.	Ne
└– název	řetězec	Název hodnotitele.	Ne
└operace	výčet	Kontrola řetězce, kterou je třeba provést. Jeden z eq, ne, likenebo ilike. Možné hodnoty: eq, ne, like, ilike	Ne
└passing_labels	pole	Popisky označující úspěšný výsledek. Musí to být podmnožina popisků.	Ne
Rozsah └•	pole	Rozsah skóre. Výchozí hodnota je [0, 1].	Ne
└- referenční dokumentace	řetězec	Text, který se hodnotí podle.	Ne
└sampling_params	OpenAI.EvalGraderScoreModelSamplingParams	Parametry vzorkování modelu.	Ne
└- zdroj	řetězec	Zdrojový kód skriptu Pythonu.	Ne
└- typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: label_model	Ne
název	řetězec	Název hodnotitele.	Ano
typ	výčet	Typ objektu, který je vždy multi. Možné hodnoty: multi	Ano

OpenAI.GraderPython

Objekt PythonGrader, který spouští skript Pythonu na vstupu.

Název	Typ	Description	Povinné	Výchozí
image_tag	řetězec	Značka obrázku, která se má použít pro skript Pythonu.	Ne
název	řetězec	Název hodnotitele.	Ano
odeslat k provedení	řetězec	Zdrojový kód skriptu Pythonu.	Ano
typ	výčet	Typ objektu, který je vždy python. Možné hodnoty: python	Ano

OpenAI.GraderScoreModel

A ScoreModelGrader objekt, který používá model k přiřazení skóre vstupu.

Název	Typ	Description	Povinné	Výchozí
vstup	pole	Vstupní text. To může zahrnovat řetězce vzorů.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení.	Ano
název	řetězec	Název hodnotitele.	Ano
oblast	pole	Rozsah skóre. Výchozí hodnota je [0, 1].	Ne
parametry vzorkování	objekt		Ne
└max_completions_tokens	OpenAI.integer		Ne
└reasoning_effort	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
└semeno	OpenAI.integer		Ne
└− teplota	OpenAI.numeric		Ne
└top_p	OpenAI.numeric		Ne
typ	výčet	Typ objektu, který je vždy score_model. Možné hodnoty: score_model	Ano

OpenAI.GraderStringCheck

A StringCheckGrader objekt, který provádí porovnání řetězců mezi vstupem a odkazem pomocí zadané operace.

Název	Typ	Description	Povinné	Výchozí
vstup	řetězec	Vstupní text. To může zahrnovat řetězce vzorů.	Ano
název	řetězec	Název hodnotitele.	Ano
operace	výčet	Kontrola řetězce, kterou je třeba provést. Jeden z eq, ne, likenebo ilike. Možné hodnoty: eq, ne, like, ilike	Ano
odkazovat	řetězec	Text odkazu. To může zahrnovat řetězce vzorů.	Ano
typ	výčet	Typ objektu, který je vždy string_check. Možné hodnoty: string_check	Ano

OpenAI.GraderTextSimilarity

A TextSimilarityGrader objekt, který ohodnotuje text na základě metrik podobnosti.

Název	Typ	Description	Povinné	Výchozí
hodnotící metrika	výčet	Metrika vyhodnocení, která se má použít. Jeden z cosine, , fuzzy_matchbleu, gleu, meteor, rouge_1, , rouge_2rouge_3, rouge_4, , rouge_5 nebo rouge_l. Možné hodnoty: cosine, fuzzy_match, bleu, , gleumeteor, rouge_1rouge_2, rouge_3, rouge_4rouge_5rouge_l	Ano
vstup	řetězec	Text, který se ohodnotuje.	Ano
název	řetězec	Název hodnotitele.	Ano
odkazovat	řetězec	Text, který se hodnotí podle.	Ano
typ	výčet	Typ grejdru. Možné hodnoty: text_similarity	Ano

OpenAI.ImageGenTool

Nástroj, který generuje obrázky pomocí modelu, jako je gpt-image-1.

Název	Typ	Description	Povinné	Výchozí
na pozadí	výčet	Typ pozadí pro vygenerovaný obrázek Jeden z transparent. opaquenebo auto. Výchozí hodnota: auto. Možné hodnoty: transparent, opaque, auto	Ne
vstupní_obrázková_maska	objekt	Volitelná maska pro inpainting Obsahuje image_url (řetězec, volitelné) a file_id (řetězec, volitelné).	Ne
└ file_id	řetězec	ID souboru pro obrázek masky	Ne
└image_url	řetězec	Obrázek masky s kódováním Base64	Ne
model	výčet	Model generování obrazu, který se má použít. Výchozí hodnota: gpt-image-1. Možné hodnoty: gpt-image-1	Ne
moderation	výčet	Úroveň moderování pro vygenerovanou image Výchozí hodnota: auto. Možné hodnoty: auto, low	Ne
komprese_výstupu	integer	Úroveň komprese pro výstupní obrázek. Výchozí hodnota: 100.	Ne	100
formát_výstupu	výčet	Výstupní formát vygenerované image. jeden z png, webp, nebo jpeg. Výchozí hodnota: png. Možné hodnoty: png, webp, jpeg	Ne
částečné_obrázky	integer	Počet částečných imagí, které se mají vygenerovat v režimu streamování, od 0 (výchozí hodnota) do 3	Ne	0
kvalita	výčet	Kvalita vygenerované image. Jeden z low, , mediumhigh, nebo auto. Výchozí hodnota: auto. Možné hodnoty: low, medium, high, auto	Ne
velikost	výčet	Velikost vygenerované image. Jeden z 1024x1024, , 1024x1536 1536x1024nebo auto. Výchozí hodnota: auto. Možné hodnoty: 1024x1024, 1024x1536, 1536x1024, auto	Ne
typ	výčet	Typ nástroje pro generování obrázků. Vždy image_generation. Možné hodnoty: image_generation	Ano

OpenAI.ImageGenToolCallItemParam

Požadavek na generování obrazu vytvořený modelem.

Název	Typ	Description	Povinné	Výchozí
výsledek	řetězec	Vygenerovaný obrázek kódovaný v base64.	Ano
typ	výčet	Možné hodnoty: image_generation_call	Ano

OpenAI.ImageGenToolCallItemResource

Požadavek na generování obrazu vytvořený modelem.

Název	Typ	Description	Povinné	Výchozí
výsledek	řetězec	Vygenerovaný obrázek kódovaný v base64.	Ano
stav	výčet	Možné hodnoty: in_progress, completed, generating, failed	Ano
typ	výčet	Možné hodnoty: image_generation_call	Ano

OpenAI.Includable

Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou:

• code_interpreter_call.outputs: Zahrnuje výstupy spuštění kódu Pythonu v nástroji pro interpret kódu volání položek.
• computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výsledku počítačového volání.
• file_search_call.results: Zahrňte výsledky vyhledávání nástroje pro hledání souborů.
• message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy.
• message.output_text.logprobs: Zahrňte protokoly se zprávami pomocníka.
• reasoning.encrypted_content: Zahrnuje zašifrovanou verzi tokenů odůvodnění ve výstupech zdůvodnění položek. To umožňuje, aby byly položky pro uvažování použity v konverzacích na více otočení při použití stateless Responses API (například když je parametr nastaven na store, nebo když je organizace zaregistrována v programu nulového uchovávání dat).

Vlastnictví	Hodnota
Description	Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou: - code_interpreter_call.outputs: Zahrnuje výstupy provádění kódu Pythonu. v nástroji interpretu kódu volají položky. - computer_call_output.output.image_url: Zahrňte adresy URL obrázků z výstupu počítačového programu. - file_search_call.results: Zahrňte výsledky hledání volání nástroje pro vyhledávání souborů. - message.input_image.image_url: Zahrňte adresy URL obrázků ze vstupní zprávy. - message.output_text.logprobs: Zahrňte protokoly se zprávami pomocníka. - reasoning.encrypted_content: Zahrnuje šifrovanou verzi odůvodnění. tokeny ve výstupech položek odůvodnění. To umožňuje použití položek zdůvodnění v konverzace s vícenásobným otáčením při použití bezstavového rozhraní API pro odpovědi (například pokud je parametr nastaven na store hodnotu, nebo pokud je organizace zaregistrované v programu nulového uchovávání dat).
Type	řetězec
Hodnoty	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content web_search_call.results web_search_call.action.sources memory_search_call.results

OpenAI.ItemContent

Diskriminátor pro OpenAI.ItemContent

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
input_audio	OpenAI.ItemContentInputAudio
output_audio	OpenAI.ItemContentOutputAudio
refusal	OpenAI.ItemContentRefusal
input_text	OpenAI.ItemContentInputText
input_image	OpenAI.ItemContentInputImage
input_file	OpenAI.ItemContentInputFile
output_text	OpenAI.ItemContentOutputText

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ItemContentType	Multimodální vstupní a výstupní obsah	Ano

OpenAI.ItemContentInputAudio

Zvukový vstup do modelu.

Název	Typ	Description	Povinné	Výchozí
data	řetězec	Zvuková data s kódováním Base64	Ano
format	výčet	Formát zvukových dat. Aktuálně podporované formáty jsou mp3 a wav. Možné hodnoty: mp3, wav	Ano
typ	výčet	Typ vstupní položky. Vždy input_audio. Možné hodnoty: input_audio	Ano

OpenAI.ItemContentInputFile

Vstup souboru do modelu.

Název	Typ	Description	Povinné	Výchozí
file_data	řetězec	Obsah souboru, který se má odeslat do modelu.	Ne
ID souboru	řetězec	ID souboru, který se má odeslat do modelu.	Ne
filename	řetězec	Název souboru, který se má odeslat do modelu.	Ne
typ	výčet	Typ vstupní položky. Vždy input_file. Možné hodnoty: input_file	Ano

OpenAI.ItemContentInputImage

Vstup obrázku do modelu. Přečtěte si o vstupech .

Název	Typ	Description	Povinné	Výchozí
detail	výčet	Úroveň podrobností obrázku, která se má odeslat do modelu. Jeden z high, lownebo auto. Výchozí hodnota je auto. Možné hodnoty: low, high, auto	Ne
ID souboru	řetězec	ID souboru, který se má odeslat do modelu.	Ne
image_url	řetězec	Adresa URL obrázku, který se má odeslat do modelu. Plně kvalifikovaná adresa URL nebo obrázek s kódováním Base64 v adrese URL dat.	Ne
typ	výčet	Typ vstupní položky. Vždy input_image. Možné hodnoty: input_image	Ano

OpenAI.ItemContentInputText

Textový vstup do modelu.

Název	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Textový vstup do modelu.	Ano
typ	výčet	Typ vstupní položky. Vždy input_text. Možné hodnoty: input_text	Ano

OpenAI.ItemContentOutputAudio

Zvukový výstup z modelu.

Název	Typ	Description	Povinné	Výchozí
data	řetězec	Zvuková data s kódováním Base64 z modelu.	Ano
přepis	řetězec	Přepis zvukových dat z modelu.	Ano
typ	výčet	Typ výstupního zvuku. Vždy output_audio. Možné hodnoty: output_audio	Ano

OpenAI.ItemContentOutputText

Textový výstup z modelu.

Název	Typ	Description	Povinné	Výchozí
anotace	pole	Poznámky textového výstupu.	Ano
logaritmované pravděpodobnosti	pole		Ne
poslat SMS	řetězec	Textový výstup z modelu.	Ano
typ	výčet	Typ výstupního textu. Vždy output_text. Možné hodnoty: output_text	Ano

OpenAI.ItemContentRefusal

Odmítnutí modelu.

Název	Typ	Description	Povinné	Výchozí
odmítnutí	řetězec	Vysvětlení zamítnutí z modelu.	Ano
typ	výčet	Typ odmítnutí. Vždy refusal. Možné hodnoty: refusal	Ano

OpenAI.ItemContentType

Multimodální vstupní a výstupní obsah

Vlastnictví	Hodnota
Description	Multimodální vstupní a výstupní obsah
Type	řetězec
Hodnoty	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

Položka obsahu použitá k vygenerování odpovědi

Diskriminátor pro OpenAI.ItemParam

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
message	OpenAI.ResponsesMessageItemParam
function_call_output	OpenAI.FunctionToolCallOutputItemParam
file_search_call	OpenAI.FileSearchToolCallItemParam
computer_call	OpenAI.ComputerToolCallItemParam
computer_call_output	OpenAI.ComputerToolCallOutputItemParam
web_search_call	OpenAI.WebSearchToolCallItemParam
function_call	OpenAI.FunctionToolCallItemParam
reasoning	OpenAI.ReasoningItemParam
item_reference	OpenAI.ItemReferenceItemParam
image_generation_call	OpenAI.ImageGenToolCallItemParam
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemParam
local_shell_call	OpenAI.LocalShellToolCallItemParam
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemParam
mcp_list_tools	OpenAI.MCPListToolsItemParam
mcp_approval_request	OpenAI.MCPApprovalRequestItemParam
mcp_approval_response	OpenAI.MCPApprovalResponseItemParam
mcp_call	OpenAI.MCPCallItemParam
memory_search_call	MemorySearchToolCallItemParam

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ItemType		Ano

OpenAI.ItemReferenceItemParam

Interní identifikátor položky, na kterou se má odkazovat.

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	ID dříve vygenerované položky odpovědi, na kterou odkazuje služba.	Ano
typ	výčet	Možné hodnoty: item_reference	Ano

OpenAI.ItemResource

Položka obsahu použitá k vygenerování odpovědi

Diskriminátor pro OpenAI.ItemResource

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
structured_outputs	StructuredOutputsItemResource
workflow_action	WorkflowActionOutputItemResource
oauth_consent_request	OAuthConsentRequestItemResource
message	OpenAI.ResponsesMessageItemResource
computer_call_output	OpenAI.ComputerToolCallOutputItemResource
function_call	OpenAI.FunctionToolCallItemResource
function_call_output	OpenAI.FunctionToolCallOutputItemResource
mcp_approval_response	OpenAI.MCPApprovalResponseItemResource
file_search_call	OpenAI.FileSearchToolCallItemResource
computer_call	OpenAI.ComputerToolCallItemResource
web_search_call	OpenAI.WebSearchToolCallItemResource
reasoning	OpenAI.ReasoningItemResource
image_generation_call	OpenAI.ImageGenToolCallItemResource
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource
local_shell_call	OpenAI.LocalShellToolCallItemResource
local_shell_call_output	OpenAI.LocalShellToolCallOutputItemResource
mcp_list_tools	OpenAI.MCPListToolsItemResource
mcp_approval_request	OpenAI.MCPApprovalRequestItemResource
mcp_call	OpenAI.MCPCallItemResource
memory_search_call	MemorySearchToolCallItemResource

Název	Typ	Description	Povinné	Výchozí
vytvořeno kým	objekt		Ne
└agent	AgentId	Agent, který položku vytvořil.	Ne
└response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
ID	řetězec		Ano
typ	OpenAI.ItemType		Ano

OpenAI.ItemType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call structured_outputs workflow_action memory_search_call oauth_consent_request

OpenAI.ListFineTuningJobCheckpointsResponse

Název	Typ	Description	Povinné	Výchozí
data	pole		Ano
first_id	řetězec		Ne
má více	Boolean		Ano
last_id	řetězec		Ne
objekt	výčet	Možné hodnoty: list	Ano

OpenAI.ListFineTuningJobEventsResponse

Název	Typ	Description	Povinné	Výchozí
data	pole		Ano
má více	Boolean		Ano
objekt	výčet	Možné hodnoty: list	Ano

OpenAI.ListPaginatedFineTuningJobsResponse

Název	Typ	Description	Povinné	Výchozí
data	pole		Ano
má více	Boolean		Ano
objekt	výčet	Možné hodnoty: list	Ano

OpenAI.LocalShellExecAction

Na serveru spusťte příkaz prostředí.

Název	Typ	Description	Povinné	Výchozí
příkaz	pole	Příkaz, který se má spustit.	Ano
env	objekt	Proměnné prostředí, které se mají pro příkaz nastavit.	Ano
časový limit_ms	integer	Volitelný časový limit v milisekundách příkazu	Ne
typ	výčet	Typ místní akce prostředí. Vždy exec. Možné hodnoty: exec	Ano
uživatel	řetězec	Nepovinný uživatel, který má příkaz spustit jako.	Ne
working_directory	řetězec	Volitelný pracovní adresář pro spuštění příkazu.	Ne

OpenAI.LocalShellTool

Nástroj, který umožňuje modelu spouštět příkazy prostředí v místním prostředí.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ místního nástroje prostředí. Vždy local_shell. Možné hodnoty: local_shell	Ano

OpenAI.LocalShellToolCallItemParam

Volání nástroje ke spuštění příkazu v místním prostředí

Název	Typ	Description	Povinné	Výchozí
akce	OpenAI.LocalShellExecAction	Na serveru spusťte příkaz prostředí.	Ano
call_id	řetězec	Jedinečné ID volání místního nástroje prostředí vygenerované modelem.	Ano
typ	výčet	Možné hodnoty: local_shell_call	Ano

OpenAI.LocalShellToolCallItemResource

Volání nástroje ke spuštění příkazu v místním prostředí

Název	Typ	Description	Povinné	Výchozí
akce	OpenAI.LocalShellExecAction	Na serveru spusťte příkaz prostředí.	Ano
call_id	řetězec	Jedinečné ID volání místního nástroje prostředí vygenerované modelem.	Ano
stav	výčet	Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Možné hodnoty: local_shell_call	Ano

OpenAI.LocalShellToolCallOutputItemParam

Výstup volání místního nástroje prostředí.

Název	Typ	Description	Povinné	Výchozí
výstup	řetězec	Řetězec JSON výstupu volání místního nástroje prostředí.	Ano
typ	výčet	Možné hodnoty: local_shell_call_output	Ano

OpenAI.LocalShellToolCallOutputItemResource

Výstup volání místního nástroje prostředí.

Název	Typ	Description	Povinné	Výchozí
výstup	řetězec	Řetězec JSON výstupu volání místního nástroje prostředí.	Ano
stav	výčet	Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Možné hodnoty: local_shell_call_output	Ano

OpenAI.Location

Diskriminátor pro OpenAI.Location

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
approximate	OpenAI.ApproximateLocation

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.LocationType		Ano

OpenAI.LocationType (Typ umístění)

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	approximate

OpenAI.LogProb

Pravděpodobnost protokolu tokenu.

Název	Typ	Description	Povinné	Výchozí
bytes	pole		Ano
logprob	číslo		Ano
token	řetězec		Ano
top_logprobs	pole		Ano

OpenAI.MCPApprovalRequestItemParam

Žádost o lidské schválení vyvolání nástroje.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
název	řetězec	Název nástroje, který se má spustit.	Ano
označení serveru	řetězec	Popisek MCP serveru, který provádí požadavek.	Ano
typ	výčet	Možné hodnoty: mcp_approval_request	Ano

OpenAI.MCPApprovalRequestItemResource

Žádost o lidské schválení vyvolání nástroje.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
název	řetězec	Název nástroje, který se má spustit.	Ano
označení serveru	řetězec	Popisek MCP serveru, který provádí požadavek.	Ano
typ	výčet	Možné hodnoty: mcp_approval_request	Ano

OpenAI.MCPApprovalResponseItemParam

Odpověď na žádost o schválení MCP.

Název	Typ	Description	Povinné	Výchozí
approval_request_id	řetězec	ID žádosti o schválení, na kterou se odpovídá.	Ano
approve	Boolean	Zda byla žádost schválena.	Ano
důvod	řetězec	Nepovinný důvod rozhodnutí.	Ne
typ	výčet	Možné hodnoty: mcp_approval_response	Ano

OpenAI.MCPApprovalResponseItemResource

Odpověď na žádost o schválení MCP.

Název	Typ	Description	Povinné	Výchozí
approval_request_id	řetězec	ID žádosti o schválení, na kterou se odpovídá.	Ano
approve	Boolean	Zda byla žádost schválena.	Ano
důvod	řetězec	Nepovinný důvod rozhodnutí.	Ne
typ	výčet	Možné hodnoty: mcp_approval_response	Ano

OpenAI.MCPCallItemParam

Vyvolání nástroje na serveru MCP.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec	Chyba z volání nástroje, pokud existuje.	Ne
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec	Výstup volání nástroje.	Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
typ	výčet	Možné hodnoty: mcp_call	Ano

OpenAI.MCPCallItemResource

Vyvolání nástroje na serveru MCP.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec	Chyba z volání nástroje, pokud existuje.	Ne
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec	Výstup volání nástroje.	Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
typ	výčet	Možné hodnoty: mcp_call	Ano

OpenAI.MCPListToolsItemParam

Seznam nástrojů dostupných na serveru MCP

Název	Typ	Description	Povinné	Výchozí
chyba	řetězec	Chybová zpráva, pokud server nemohl vypsat nástroje.	Ne
označení serveru	řetězec	Popisek serveru MCP.	Ano
nářadí	pole	Nástroje dostupné na serveru.	Ano
typ	výčet	Možné hodnoty: mcp_list_tools	Ano

OpenAI.MCPListToolsItemResource

Seznam nástrojů dostupných na serveru MCP

Název	Typ	Description	Povinné	Výchozí
chyba	řetězec	Chybová zpráva, pokud server nemohl vypsat nástroje.	Ne
označení serveru	řetězec	Popisek serveru MCP.	Ano
nářadí	pole	Nástroje dostupné na serveru.	Ano
typ	výčet	Možné hodnoty: mcp_list_tools	Ano

OpenAI.MCPListToolsTool

Nástroj dostupný na serveru MCP.

Název	Typ	Description	Povinné	Výchozí
anotace		Další poznámky o nástroji	Ne
popis	řetězec	Popis nástroje.	Ne
input_schema		Schéma JSON popisující vstup nástroje.	Ano
název	řetězec	Název nástroje.	Ano

OpenAI.MCPTool

Poskytněte modelu access dalším nástrojům prostřednictvím vzdálených serverů MCP (Model Context Protocol). Vyučte si další informace o MCP.

Název	Typ	Description	Povinné	Výchozí
povolené_nástroje	objekt		Ne
└─názvy_nástrojů	pole	Seznam povolených názvů nástrojů	Ne
headers	objekt	Volitelné hlavičky HTTP, které se mají odeslat na server MCP. Slouží k ověřování. nebo pro jiné účely.	Ne
project_connection_id	řetězec	ID připojení v project pro server MCP. V připojení je uložena autentizace a další podrobnosti připojení potřebné pro připojení k MCP serveru.	Ne
vyžadovat_schválení	object (viz platné modely níže)	Určete, které nástroje serveru MCP vyžadují schválení.	Ne
označení serveru	řetězec	Označení pro tento MCP server, které se používá k jeho identifikaci při volání nástrojů.	Ano
server_url	řetězec	Adresa URL serveru MCP.	Ano
typ	výčet	Typ nástroje MCP. Vždy mcp. Možné hodnoty: mcp	Ano

OpenAI.Metadata

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu.

Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.

Typ: objekt

OpenAI.Prompt

Odkaz na šablonu výzvy a její proměnné Uučte se více.

Název	Typ	Description	Povinné	Výchozí
ID	řetězec	Jedinečný identifikátor šablony výzvy, která se má použít.	Ano
variables	objekt	Volitelná mapa hodnot, které se mají nahradit proměnnými ve vaší pobídnout. Hodnoty nahrazení můžou být řetězce nebo jiné. Vstupní typy odpovědí, jako jsou obrázky nebo soubory.	Ne
verze	řetězec	Volitelná verze šablony výzvy	Ne

OpenAI.RankingOptions

Název	Typ	Description	Povinné	Výchozí
nástroj pro hodnocení	výčet	Ranker, který se má použít pro vyhledávání souborů. Možné hodnoty: auto, default-2024-11-15	Ne
práh skóre	číslo	Prahová hodnota skóre pro hledání souboru je číslo v rozmezí od 0 do 1. Čísla blížící se 1 se pokusí vrátit pouze nejrelevantní výsledky, ale můžou vrátit méně výsledků.	Ne

OpenAI.Reasoning

Modely řady o-series pouze

Možnosti konfigurace pro zdůvodnění modelů

Název	Typ	Description	Povinné	Výchozí
úsilí	objekt	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
generate_summary	výčet	Zastaralé: místo toho použijte summary . Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
souhrn	výčet	Souhrn důvodů provedených modelem Může to být užitečné pro ladění a pochopení způsobu uvažování modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne

OpenAI.ReasoningEffort

Omezuje úsilí na odůvodnění modelů.

Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké.

Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi.

gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1.

Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné.

Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.

Vlastnictví	Hodnota
Description	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.
Type	řetězec
Hodnoty	none minimal low medium high

OpenAI.ReasoningItemParam

Popis řetězce myšlenky používaného modelem odůvodnění při generování odpovědi. Pokud ručně , nezapomeňte tyto položky zahrnout > < do rozhraní API pro odpovědi do rozhraní API pro odpovědi.

Název	Typ	Description	Povinné	Výchozí
encrypted_content	řetězec	Šifrovaný obsah důvodové položky – vyplněný při odpovědi vygenerováno s reasoning.encrypted_content v parametru include.	Ne
souhrn	pole	Zdůvodnění obsahu textu	Ano
typ	výčet	Možné hodnoty: reasoning	Ano

OpenAI.ReasoningItemResource

Popis řetězce myšlenky používaného modelem odůvodnění při generování odpovědi. Pokud ručně , nezapomeňte tyto položky zahrnout > < do rozhraní API pro odpovědi do rozhraní API pro odpovědi.

Název	Typ	Description	Povinné	Výchozí
encrypted_content	řetězec	Šifrovaný obsah důvodové položky – vyplněný při odpovědi vygenerováno s reasoning.encrypted_content v parametru include.	Ne
souhrn	pole	Zdůvodnění obsahu textu	Ano
typ	výčet	Možné hodnoty: reasoning	Ano

OpenAI.ReasoningItemSummaryPart

Diskriminátor pro OpenAI.ReasoningItemSummaryPart

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
summary_text	OpenAI.ReasoningItemSummaryTextPart

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ReasoningItemSummaryPartType		Ano

OpenAI.ReasoningItemSummaryPartType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	summary_text

OpenAI.ReasoningItemSummaryTextPart

Název	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec		Ano
typ	výčet	Možné hodnoty: summary_text	Ano

OpenAI.Response

Název	Typ	Description	Povinné	Výchozí
agent	objekt		Ne
└– název	řetězec	Název agenta.	Ne
└- typ	výčet	Možné hodnoty: agent_id	Ne
└- verze	řetězec	Identifikátor verze agenta.	Ne
na pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
konverzace	objekt		Ano
└- ID	řetězec		Ne
datum_vytvoření	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
chyba	objekt	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└ kód	OpenAI.ResponseErrorCode	Kód chyby pro odpověď.	Ne
└- zpráva	řetězec	Popis chyby čitelný člověkem.	Ne
ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
incomplete_details	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ano
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
instructions	řetězec nebo pole		Ano
max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ano
model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ano
výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ano
output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
previous_response_id	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
požádat	objekt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└- ID	řetězec	Jedinečný identifikátor šablony výzvy, která se má použít.	Ne
Proměnné └•	OpenAI.ResponsePromptVariables	Volitelná mapa hodnot, které se mají nahradit proměnnými ve vaší pobídnout. Hodnoty nahrazení můžou být řetězce nebo jiné. Vstupní typy odpovědí, jako jsou obrázky nebo soubory.	Ne
└- verze	řetězec	Volitelná verze šablony výzvy	Ne
reasoning	objekt	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└– úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
└─ vytvořit_shrnutí	výčet	Zastaralé: místo toho použijte summary . Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
└─ souhrn	výčet	Souhrn důvodů provedených modelem Může to být užitečné pro ladění a pochopení způsobu uvažování modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
úroveň služby	objekt	Určuje typ zpracování použitý pro obsluhu požadavku. * Pokud je nastavená hodnota "auto", požadavek se zpracuje s úrovní služby. nakonfigurováno v nastavení Project. Pokud není nakonfigurované jinak, použije Project výchozí hodnotu. * Pokud je nastavená hodnota default, požadavek se zpracuje se standardním ceny a výkon pro vybraný model. * Pokud je nastavená hodnota flex nebo "priorita", žádost se zpracuje s odpovídající službou. úroveň. Kontaktujte sales a získejte další informace o zpracování priority. * Pokud není nastaveno, výchozí chování je "auto". Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnota založená na režimu zpracování, který se skutečně používá k poskytování požadavku. Tato hodnota odpovědi může se lišit od hodnoty nastavené v parametru.	Ne
stav	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
Teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ano
poslat SMS	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
tool_choice	objekt	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model může vybírat mezi generováním zprávy nebo voláním jedné nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů.	Ne
└- typ	OpenAI.ToolChoiceObjectType	Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.	Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ano
truncation	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ano

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Vygeneruje se při streamování částečného fragmentu kódu interpretem kódu.

Název	Typ	Description	Povinné	Výchozí
delta	řetězec	Částečný fragment kódu streamovaný interpretem kódu.	Ano
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	integer	Index výstupní položky v odpovědi, pro kterou se kód streamuje.	Ano
typ	výčet	Typ události. Vždy response.code_interpreter_call_code.delta. Možné hodnoty: response.code_interpreter_call_code.delta	Ano

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Vygeneruje se při dokončení fragmentu kódu interpretem kódu.

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Výstup konečného fragmentu kódu interpretem kódu.	Ano
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	integer	Index výstupní položky v odpovědi, pro kterou je kód finalizován.	Ano
typ	výčet	Typ události. Vždy response.code_interpreter_call_code.done. Možné hodnoty: response.code_interpreter_call_code.done	Ano

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Po dokončení volání interpreta kódu se vysílá.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	integer	Index výstupní položky v odpovědi, pro kterou je volání interpretu kódu dokončeno.	Ano
typ	výčet	Typ události. Vždy response.code_interpreter_call.completed. Možné hodnoty: response.code_interpreter_call.completed	Ano

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Vygenerováno, když probíhá volání interpreta kódu.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	integer	Index výstupní položky v odpovědi, pro kterou probíhá volání interpreta kódu.	Ano
typ	výčet	Typ události. Vždy response.code_interpreter_call.in_progress. Možné hodnoty: response.code_interpreter_call.in_progress	Ano

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Vygeneruje se, když interpret kódu aktivně interpretuje fragment kódu.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	integer	Index výstupní položky v odpovědi, pro kterou interpret kódu interpretuje kód.	Ano
typ	výčet	Typ události. Vždy response.code_interpreter_call.interpreting. Možné hodnoty: response.code_interpreter_call.interpreting	Ano

OpenAI.ResponseCompletedEvent

Po dokončení odpovědi modelu se aktivuje.

Název	Typ	Description	Povinné	Výchozí
odpověď	objekt		Ano
└agent	AgentId	Agent použitý pro tuto odpověď	Ne
└pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
└- konverzace	objekt		Ne
└- ID	řetězec		Ne
└created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ne
└─ chyba	OpenAI.ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ne
└- ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ne
└─neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ne
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
└- pokyny	řetězec nebo pole	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
└ max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
└max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
└– metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
└– objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ne
└─ výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ne
└output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
└─ paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
└─ předchozí_id_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└— odůvodnění	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└service_tier	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
└stavu	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
└structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
└− teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
└- text	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
└ nástroje	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
└ top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
└top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
└– zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
└─ využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
└- uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne
typ	výčet	Typ události. Vždy response.completed. Možné hodnoty: response.completed	Ano

OpenAI.ResponseContentPartAddedEvent

Vygeneruje se při přidání nové části obsahu.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index přidané části obsahu.	Ano
item_id	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Ano
output_index	integer	Index výstupní položky, do které byla část obsahu přidána.	Ano
part	objekt		Ano
└- typ	OpenAI.ItemContentType	Multimodální vstupní a výstupní obsah	Ne
typ	výčet	Typ události. Vždy response.content_part.added. Možné hodnoty: response.content_part.added	Ano

OpenAI.ResponseContentPartDoneEvent

Vydává se, když je část obsahu hotová.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index části obsahu, která je dokončena.	Ano
item_id	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Ano
output_index	integer	Index výstupní položky, do které byla část obsahu přidána.	Ano
part	objekt		Ano
└- typ	OpenAI.ItemContentType	Multimodální vstupní a výstupní obsah	Ne
typ	výčet	Typ události. Vždy response.content_part.done. Možné hodnoty: response.content_part.done	Ano

OpenAI.ResponseCreatedEvent

Událost, která se vygeneruje při vytvoření odpovědi.

Název	Typ	Description	Povinné	Výchozí
odpověď	objekt		Ano
└agent	AgentId	Agent použitý pro tuto odpověď	Ne
└pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
└- konverzace	objekt		Ne
└- ID	řetězec		Ne
└created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ne
└─ chyba	OpenAI.ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ne
└- ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ne
└─neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ne
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
└- pokyny	řetězec nebo pole	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
└ max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
└max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
└– metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
└– objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ne
└─ výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ne
└output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
└─ paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
└─ předchozí_id_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└— odůvodnění	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└service_tier	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
└stavu	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
└structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
└− teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
└- text	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
└ nástroje	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
└ top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
└top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
└– zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
└─ využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
└- uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne
typ	výčet	Typ události. Vždy response.created. Možné hodnoty: response.created	Ano

OpenAI.ResponseError

Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.

Název	Typ	Description	Povinné	Výchozí
kód	OpenAI.ResponseErrorCode	Kód chyby pro odpověď.	Ano
zpráva	řetězec	Popis chyby čitelný člověkem.	Ano

OpenAI.ResponseErrorCode

Kód chyby pro odpověď.

Vlastnictví	Hodnota
Description	Kód chyby pro odpověď.
Type	řetězec
Hodnoty	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

Vygenerováno, když dojde k chybě.

Název	Typ	Description	Povinné	Výchozí
kód	řetězec	Kód chyby.	Ano
zpráva	řetězec	Chybová zpráva.	Ano
param	řetězec	Parametr chyby.	Ano
typ	výčet	Typ události. Vždy error. Možné hodnoty: error	Ano

OpenAI.ResponseFailedEvent

Událost, která se vygeneruje v případě selhání odpovědi.

Název	Typ	Description	Povinné	Výchozí
odpověď	objekt		Ano
└agent	AgentId	Agent použitý pro tuto odpověď	Ne
└pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
└- konverzace	objekt		Ne
└- ID	řetězec		Ne
└created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ne
└─ chyba	OpenAI.ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ne
└- ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ne
└─neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ne
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
└- pokyny	řetězec nebo pole	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
└ max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
└max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
└– metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
└– objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ne
└─ výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ne
└output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
└─ paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
└─ předchozí_id_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└— odůvodnění	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└service_tier	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
└stavu	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
└structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
└− teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
└- text	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
└ nástroje	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
└ top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
└top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
└– zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
└─ využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
└- uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne
typ	výčet	Typ události. Vždy response.failed. Možné hodnoty: response.failed	Ano

OpenAI.ResponseFileSearchCallCompletedEvent

Vygenerováno při dokončení volání hledání souborů (nalezeny výsledky).

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
output_index	integer	Index výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
typ	výčet	Typ události. Vždy response.file_search_call.completed. Možné hodnoty: response.file_search_call.completed	Ano

OpenAI.ResponseFileSearchCallInProgressEvent

Vygenerováno při zahájení volání hledání souboru.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
output_index	integer	Index výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
typ	výčet	Typ události. Vždy response.file_search_call.in_progress. Možné hodnoty: response.file_search_call.in_progress	Ano

OpenAI.ResponseFileSearchCallSearchingEvent

Vygenerováno při hledání souborů, které právě hledáte.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
output_index	integer	Index výstupní položky, kterou hledá volání hledání souboru.	Ano
typ	výčet	Typ události. Vždy response.file_search_call.searching. Možné hodnoty: response.file_search_call.searching	Ano

OpenAI.ResponseFormat

Diskriminátor pro OpenAI.ResponseFormat

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: text, json_object, json_schema	Ano

OpenAI.ResponseFormatJsonObject

Formát odpovědi objektu JSON. Starší metoda generování odpovědí JSON. Použití json_schema se doporučuje pro modely, které ho podporují. Všimněte si, že model nebude generovat JSON bez systémové zprávy nebo zprávy uživatele s pokyny, to do tak.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy json_object. Možné hodnoty: json_object	Ano

OpenAI.ResponseFormatJsonSchema

Schéma pro formát odpovědi popsané jako objekt schématu JSON. Tady se dozvíte, jak se vytvářejí schémata JSON. Formát odpovědi schématu JSON Slouží ke generování strukturovaných odpovědí JSON. Přečtěte si další informace o Strukturované výstupy.

Název	Typ	Description	Povinné	Výchozí
JSON schema	objekt	Možnosti konfigurace strukturovaných výstupů, včetně schématu JSON.	Ano
└- popis	řetězec	Popis toho, k čemu formát odpovědi slouží, který model používá k určete, jak postupovat v daném formátu.	Ne
└– název	řetězec	Název formátu odpovědi. Musí to být a-z, A-Z, 0-9 nebo musí obsahovat podtržítka a pomlčky s maximální délkou 64 znaků.	Ne
└- schéma	objekt		Ne
└- striktní	Boolean	Zda povolit přísné dodržování schématu při generování výstupu. Pokud je nastavená hodnota true, model bude vždy dodržovat přesné schéma definované. schema v poli. Podporována je pouze podmnožina schématu JSON. strict je true. Další informace najdete v Strukturované výstupy. průvodce.	Ne	Nepravda
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy json_schema. Možné hodnoty: json_schema	Ano

OpenAI.ResponseFormatText

Výchozí formát odpovědi Používá se ke generování textových odpovědí.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy text. Možné hodnoty: text	Ano

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Vygenerováno v případě, že existuje rozdíl argumentů částečného volání funkce.

Název	Typ	Description	Povinné	Výchozí
delta	řetězec	Argumenty volání funkce delta, které se přidají.	Ano
item_id	řetězec	ID konkrétní výstupní položky, ke které se přičítá delta argumentů volání funkce.	Ano
output_index	integer	Index výstupní položky, ke které je přidána delta argumentů volání funkce.	Ano
typ	výčet	Typ události. Vždy response.function_call_arguments.delta. Možné hodnoty: response.function_call_arguments.delta	Ano

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Vygenerováno, když jsou argumenty volání funkce finalizovány.

Název	Typ	Description	Povinné	Výchozí
argumenty	řetězec	Argumenty volání funkce.	Ano
item_id	řetězec	ID položky.	Ano
output_index	integer	Index výstupní položky.	Ano
typ	výčet	Možné hodnoty: response.function_call_arguments.done	Ano

OpenAI.ResponseImageGenCallCompletedEvent

Vygenerováno při dokončení volání nástroje pro generování image a je k dispozici konečná image.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy „response.image_generation_call.completed“. Možné hodnoty: response.image_generation_call.completed	Ano

OpenAI.ResponseImageGenCallGeneratingEvent

Je vyvolán, když volání nástroje pro generování obrazu aktivně vytváří obraz (meziprostřední stav).

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy 'response.image_generation_call.generating'. Možné hodnoty: response.image_generation_call.generating	Ano

OpenAI.ResponseImageGenCallInProgressEvent

Vygenerováno, když probíhá volání nástroje pro generování obrázků.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy 'response.image_generation_call.in_progress'. Možné hodnoty: response.image_generation_call.in_progress	Ano

OpenAI.ResponseImageGenCallPartialImageEvent

Vysíláno, když je během streamování generování obrazu k dispozici částečný obraz.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
partial_image_b64	řetězec	Částečná data obrázků s kódováním Base64, která jsou vhodná pro vykreslování jako obrázek.	Ano
partial_image_index	integer	Index začínající nulou pro částečný snímek (back-end používá index začínající jedničkou, ale pro uživatele je to začínající nulou).	Ano
typ	výčet	Typ události. Vždy 'response.image_generation_call.partial_image'. Možné hodnoty: response.image_generation_call.partial_image	Ano

OpenAI.ResponseInProgressEvent

Vygenerováno, když probíhá odpověď.

Název	Typ	Description	Povinné	Výchozí
odpověď	objekt		Ano
└agent	AgentId	Agent použitý pro tuto odpověď	Ne
└pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
└- konverzace	objekt		Ne
└- ID	řetězec		Ne
└created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ne
└─ chyba	OpenAI.ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ne
└- ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ne
└─neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ne
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
└- pokyny	řetězec nebo pole	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
└ max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
└max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
└– metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
└– objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ne
└─ výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ne
└output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
└─ paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
└─ předchozí_id_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└— odůvodnění	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└service_tier	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
└stavu	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
└structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
└− teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
└- text	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
└ nástroje	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
└ top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
└top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
└– zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
└─ využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
└- uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne
typ	výčet	Typ události. Vždy response.in_progress. Možné hodnoty: response.in_progress	Ano

OpenAI.ResponseIncompleteEvent

Událost, která se vygeneruje, když se odpověď dokončí jako neúplná.

Název	Typ	Description	Povinné	Výchozí
odpověď	objekt		Ano
└agent	AgentId	Agent použitý pro tuto odpověď	Ne
└pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
└- konverzace	objekt		Ne
└- ID	řetězec		Ne
└created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ne
└─ chyba	OpenAI.ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ne
└- ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ne
└─neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ne
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
└- pokyny	řetězec nebo pole	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
└ max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
└max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
└– metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
└– objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ne
└─ výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ne
└output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
└─ paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
└─ předchozí_id_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└— odůvodnění	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└service_tier	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
└stavu	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
└structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
└− teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
└- text	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
└ nástroje	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
└ top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
└top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
└– zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
└─ využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
└- uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne
typ	výčet	Typ události. Vždy response.incomplete. Možné hodnoty: response.incomplete	Ano

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Emituje se v případě, že dojde ke změně (částečné aktualizaci) v argumentech volání nástroje MCP.

Název	Typ	Description	Povinné	Výchozí
delta		Částečná aktualizace argumentů pro volání nástroje MCP.	Ano
item_id	řetězec	Jedinečný identifikátor položky volání nástroje MCP, která je právě zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy "response.mcp_call.arguments_delta". Možné hodnoty: response.mcp_call.arguments_delta	Ano

OpenAI.ResponseMCPCallArgumentsDoneEvent

Vygeneruje se při finalizaci argumentů volání nástroje MCP.

Název	Typ	Description	Povinné	Výchozí
argumenty		Finalizované argumenty volání nástroje MCP.	Ano
item_id	řetězec	Jedinečný identifikátor položky volání nástroje MCP, která je právě zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy 'response.mcp_call.arguments_done'. Možné hodnoty: response.mcp_call.arguments_done	Ano

OpenAI.ResponseMCPCallCompletedEvent

Vygenerováno, když se úspěšně dokončilo volání nástroje MCP.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ události. Vždy 'response.mcp_call.completed'. Možné hodnoty: response.mcp_call.completed	Ano

OpenAI.ResponseMCPCallFailedEvent

Vygenerováno, když se volání nástroje MCP nezdařilo.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ události. Vždy 'response.mcp_call.failed'. Možné hodnoty: response.mcp_call.failed	Ano

OpenAI.ResponseMCPCallInProgressEvent

Vygenerováno, když probíhá volání nástroje MCP.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky volání nástroje MCP, která je právě zpracovávána.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy 'response.mcp_call.in_progress'. Možné hodnoty: response.mcp_call.in_progress	Ano

OpenAI.ResponseMCPListToolsCompletedEvent

Vygenerováno, když se úspěšně načte seznam dostupných nástrojů MCP.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ události. Vždy „response.mcp_list_tools.completed“. Možné hodnoty: response.mcp_list_tools.completed	Ano

OpenAI.ResponseMCPListToolsFailedEvent

Vygenerováno, když se nepovedlo zobrazit seznam dostupných nástrojů MCP.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ události. Vždy 'response.mcp_list_tools.failed'. Možné hodnoty: response.mcp_list_tools.failed	Ano

OpenAI.ResponseMCPListToolsInProgressEvent

Vygeneruje se, když je systém v procesu načítání seznamu dostupných nástrojů MCP.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ události. Vždy 'response.mcp_list_tools.in_progress'. Možné hodnoty: response.mcp_list_tools.in_progress	Ano

OpenAI.ResponseOutputItemAddedEvent

Dojde k emisi, když je přidána nová výstupní položka.

Název	Typ	Description	Povinné	Výchozí
položka	objekt	Položka obsahu použitá k vygenerování odpovědi	Ano
└created_by	Vytvořil(a)	Informace o tvůrci položky	Ne
└- ID	řetězec		Ne
└- typ	OpenAI.ItemType		Ne
output_index	integer	Index přidané výstupní položky.	Ano
typ	výčet	Typ události. Vždy response.output_item.added. Možné hodnoty: response.output_item.added	Ano

OpenAI.ResponseOutputItemDoneEvent

Vygenerováno, když je výstupní položka označena jako dokončená.

Název	Typ	Description	Povinné	Výchozí
položka	objekt	Položka obsahu použitá k vygenerování odpovědi	Ano
└created_by	Vytvořil(a)	Informace o tvůrci položky	Ne
└- ID	řetězec		Ne
└- typ	OpenAI.ItemType		Ne
output_index	integer	Index výstupní položky, která byla označena jako dokončená.	Ano
typ	výčet	Typ události. Vždy response.output_item.done. Možné hodnoty: response.output_item.done	Ano

OpenAI.ResponsePromptVariables

Volitelné mapování hodnot, které se mají nahradit proměnnými ve výzvě Hodnoty nahrazení můžou být řetězce nebo jiné typy vstupu odpovědi, jako jsou obrázky nebo soubory.

Typ: objekt

OpenAI.ResponseQueuedEvent

Vygenerováno, když je odpověď zařazena do fronty a čeká na zpracování.

Název	Typ	Description	Povinné	Výchozí
odpověď	objekt		Ano
└agent	AgentId	Agent použitý pro tuto odpověď	Ne
└pozadí	Boolean	Určuje, jestli chcete spustit odpověď modelu na pozadí. Vyučte další informace o odpovědích na pozadí.	Ne	Nepravda
└- konverzace	objekt		Ne
└- ID	řetězec		Ne
└created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ne
└─ chyba	OpenAI.ResponseError	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ne
└- ID	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ne
└─neúplné_detaily	objekt	Podrobnosti o tom, proč je odpověď neúplná.	Ne
└důvod	výčet	Důvod, proč je odpověď neúplná. Možné hodnoty: max_output_tokens, content_filter	Ne
└- pokyny	řetězec nebo pole	Zpráva systému (nebo vývojáře) vložená do kontextu modelu. Při použití spolu s previous_response_id pokyny z předchozího odpověď se nepřenese do další odpovědi. To usnadňuje zaměnit systémové (nebo vývojářské) zprávy v nových odpovědích	Ne
└ max_output_tokens	integer	Horní mez počtu tokenů, které lze vygenerovat pro odpověď, včetně viditelných výstupních tokenů a reasoning tokenů.	Ne
└max_tool_calls	integer	Maximální počet volání integrovaných nástrojů, které je možné zpracovat v odpovědi. Toto maximální číslo platí pro všechna integrovaná volání nástrojů, ne pro jednotlivé nástroje. Všechny další pokusy o volání nástroje modelem budou ignorovány.	Ne
└– metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
└model	řetězec	Nasazení modelu, které se použije k vytvoření této odpovědi.	Ne
└– objekt	výčet	Typ objektu tohoto prostředku – vždy nastaven na response. Možné hodnoty: response	Ne
└─ výstup	pole	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v output poli je závislé. na odpovědi modelu. - Místo přístupu k první položce v output poli a za předpokladu, že se jedná o assistant zprávu s obsahem vygenerovaným u modelu můžete zvážit použití vlastnosti output_text, kde podporováno v kitech SDK	Ne
└output_text	řetězec	Vlastnost usnadnění pouze sady SDK, která obsahuje agregovaný textový výstup ze všech output_text položek v output poli, pokud jsou k dispozici. Podporováno v SDK pro Python a JavaScript.	Ne
└─ paralelní volání nástrojů	Boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ne	Pravdivé
└─ předchozí_id_odpovědi	řetězec	Jedinečné ID předchozí odpovědi na model. Použít k vytvářet konverzace s více koly dialogu. Další informace o managing conversation state.	Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu výzvy a její proměnné Uučte se více.	Ne
└— odůvodnění	OpenAI.Reasoning	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└service_tier	OpenAI.ServiceTier	Poznámka: service_tier se nevztahuje na Azure OpenAI.	Ne
└stavu	výčet	Stav generování odpovědi. Jeden z completed, , failed in_progress, cancelled, queued nebo incomplete. Možné hodnoty: completed, failed, in_progress, cancelled, queuedincomplete	Ne
└structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
└− teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
└- text	objekt	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Viz Textové vstupy a výstupy a Strukturované výstupy	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceObject	Jak by měl model vybrat nástroj (nebo nástroje), který se má použít při generování odpověď. V tomto parametru tools se dozvíte, jak určit nástroje. model může volat.	Ne
└ nástroje	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice . Existují dvě kategorie nástrojů, které můžete poskytnout modelu: * Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je webové vyhledávání nebo souborové vyhledávání. Další informace o built-in tools. * Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, umožňuje modelu volat váš vlastní kód. Další informace o funkční volání	Ne
└ top_logprobs	integer	Celé číslo v rozmezí od 0 do 20 určující počet nejpravděpodobnějších tokenů, které se mají vrátit na každé pozici tokenu, každý s přidruženou pravděpodobností protokolu.	Ne
└top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
└– zkrácení	výčet	Strategie zkrácení, která se má použít pro odpověď modelu. - auto: Pokud kontext této odpovědi a předchozích odpovědí překročí velikost kontextového okna modelu zkrátí model odpověď pro úpravu kontextového okna vyloučením vstupních položek uprostřed konverzace. - disabled (výchozí): Pokud odpověď modelu překročí kontextové okno Žádost s velikostí modelu selže a vznikne chyba 400. Možné hodnoty: auto, disabled	Ne
└─ využití	OpenAI.ResponseUsage	Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpis výstupních tokenů a celkové použité tokeny.	Ne
└- uživatel	řetězec	Vyučte další informace o osvědčených postupech pro bezpečnost.	Ne
typ	výčet	Typ události. Vždy "response.queued". Možné hodnoty: response.queued	Ano

OpenAI.ResponseReasoningDeltaEvent

Vydá se, když dojde ke změně (částečná aktualizace) v obsahu odůvodnění.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index části obsahu odůvodnění ve výstupní položce.	Ano
delta		Částečná aktualizace obsahu odůvodnění.	Ano
item_id	řetězec	Jedinečný identifikátor položky, pro kterou se aktualizuje zdůvodnění.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
typ	výčet	Typ události. Vždy "response.reasoning.delta". Možné hodnoty: response.reasoning.delta	Ano

OpenAI.ResponseReasoningDoneEvent

Vygenerováno při dokončení obsahu odůvodnění pro položku.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index části obsahu odůvodnění ve výstupní položce.	Ano
item_id	řetězec	Jedinečný identifikátor položky, pro kterou je důvod finalizován.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
poslat SMS	řetězec	Finalizovaný text odůvodnění.	Ano
typ	výčet	Typ události. Vždy "response.reasoning.done". Možné hodnoty: response.reasoning.done	Ano

OpenAI.ResponseReasoningSummaryDeltaEvent

Vyskytne se rozdíl (částečná aktualizace) v obsahu shrnutí důvodů.

Název	Typ	Description	Povinné	Výchozí
delta		Částečná aktualizace obsahu souhrnu odůvodnění.	Ano
item_id	řetězec	Jedinečný identifikátor položky, pro kterou se aktualizuje souhrn důvodů.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
summary_index	integer	Index souhrnné části v rámci výstupní položky.	Ano
typ	výčet	Typ události. Vždy "response.reasoning_summary.delta". Možné hodnoty: response.reasoning_summary.delta	Ano

OpenAI.ResponseReasoningSummaryDoneEvent

Vygenerováno při dokončování obsahu souhrnu odůvodnění pro položku.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečný identifikátor položky, pro kterou je souhrn odůvodnění finalizován.	Ano
output_index	integer	Index výstupní položky ve výstupním poli odpovědi.	Ano
summary_index	integer	Index souhrnné části v rámci výstupní položky.	Ano
poslat SMS	řetězec	Konečný text souhrnu odůvodnění.	Ano
typ	výčet	Typ události. Vždy 'response.reasoning_summary.done'. Možné hodnoty: response.reasoning_summary.done	Ano

OpenAI.ResponseReasoningSummaryPartAddedEvent

Při přidání nové části souhrnu odůvodnění se vygeneruje.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	ID položky, ke které je tato souhrnná část přidružena.	Ano
output_index	integer	Index výstupní položky, ke které je tato souhrnná část přidružená.	Ano
part	objekt		Ano
└- typ	OpenAI.ReasoningItemSummaryPartType		Ne
summary_index	integer	Index souhrnné části v rámci souhrnu odůvodnění.	Ano
typ	výčet	Typ události. Vždy response.reasoning_summary_part.added. Možné hodnoty: response.reasoning_summary_part.added	Ano

OpenAI.ResponseReasoningSummaryPartDoneEvent

Po dokončení části s odůvodněním se emituje.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	ID položky, ke které je tato souhrnná část přidružena.	Ano
output_index	integer	Index výstupní položky, ke které je tato souhrnná část přidružená.	Ano
part	objekt		Ano
└- typ	OpenAI.ReasoningItemSummaryPartType		Ne
summary_index	integer	Index souhrnné části v rámci souhrnu odůvodnění.	Ano
typ	výčet	Typ události. Vždy response.reasoning_summary_part.done. Možné hodnoty: response.reasoning_summary_part.done	Ano

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Vyvoláno při přidání změny do textu shrnutí s odůvodněním.

Název	Typ	Description	Povinné	Výchozí
delta	řetězec	Text delta, který byl přidán do souhrnu.	Ano
item_id	řetězec	ID položky, ke které je přidružen tento souhrnný textový delta.	Ano
output_index	integer	Index výstupní položky, ke kterému je tento souhrnný text delta přidružen.	Ano
summary_index	integer	Index souhrnné části v rámci souhrnu odůvodnění.	Ano
typ	výčet	Typ události. Vždy response.reasoning_summary_text.delta. Možné hodnoty: response.reasoning_summary_text.delta	Ano

OpenAI.ResponseReasoningSummaryTextDoneEvent

Vygeneruje se při dokončení souhrnného textu zdůvodnění.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	ID položky, ke které je tento souhrnný text přidružený.	Ano
output_index	integer	Index výstupní položky, ke které je tento souhrnný text přidružený.	Ano
summary_index	integer	Index souhrnné části v rámci souhrnu odůvodnění.	Ano
poslat SMS	řetězec	Úplný text souhrnu dokončených důvodů.	Ano
typ	výčet	Typ události. Vždy response.reasoning_summary_text.done. Možné hodnoty: response.reasoning_summary_text.done	Ano

OpenAI.ResponseRefusalDeltaEvent

Vygenerováno v případě částečného odmítnutí textu.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index části obsahu, do které se přidává text odmítnutí.	Ano
delta	řetězec	Text o odmítnutí, který je přidán.	Ano
item_id	řetězec	ID výstupní položky, do které je přidán text odmítnutí.	Ano
output_index	integer	Index výstupní položky, do které je přidán text zamítnutí.	Ano
typ	výčet	Typ události. Vždy response.refusal.delta. Možné hodnoty: response.refusal.delta	Ano

OpenAI.ResponseRefusalDoneEvent

Emitováno, když je dokončen text odmítnutí.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index části obsahu, ve které je text odmítnutí finalizován.	Ano
item_id	řetězec	ID výstupní položky, kterou je zamítnutý text finalizován.	Ano
output_index	integer	Index výstupní položky, kdy je zamítnutý text finalizován.	Ano
odmítnutí	řetězec	Text odmítnutí, který je finalizován.	Ano
typ	výčet	Typ události. Vždy response.refusal.done. Možné hodnoty: response.refusal.done	Ano

OpenAI.ResponseStreamEvent

Diskriminátor pro OpenAI.ResponseStreamEvent

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
response.completed	OpenAI.ResponseCompletedEvent
response.content_part.added	OpenAI.ResponseContentPartAddedEvent
response.content_part.done	OpenAI.ResponseContentPartDoneEvent
response.created	OpenAI.ResponseCreatedEvent
error	OpenAI.ResponseErrorEvent
response.file_search_call.completed	OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress	OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching	OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done	OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress	OpenAI.ResponseInProgressEvent
response.failed	OpenAI.ResponseFailedEvent
response.incomplete	OpenAI.ResponseIncompleteEvent
response.output_item.added	OpenAI.ResponseOutputItemAddedEvent
response.output_item.done	OpenAI.ResponseOutputItemDoneEvent
response.refusal.delta	OpenAI.ResponseRefusalDeltaEvent
response.refusal.done	OpenAI.ResponseRefusalDoneEvent
response.output_text.delta	OpenAI.ResponseTextDeltaEvent
response.output_text.done	OpenAI.ResponseTextDoneEvent
response.reasoning_summary_part.added	OpenAI.ResponseReasoningSummaryPartAddedEvent
response.reasoning_summary_part.done	OpenAI.ResponseReasoningSummaryPartDoneEvent
response.reasoning_summary_text.delta	OpenAI.ResponseReasoningSummaryTextDeltaEvent
response.reasoning_summary_text.done	OpenAI.ResponseReasoningSummaryTextDoneEvent
response.web_search_call.completed	OpenAI.ResponseWebSearchCallCompletedEvent
response.web_search_call.in_progress	OpenAI.ResponseWebSearchCallInProgressEvent
response.web_search_call.searching	OpenAI.ResponseWebSearchCallSearchingEvent
response.image_generation_call.completed	OpenAI.ResponseImageGenCallCompletedEvent
response.image_generation_call.generating	OpenAI.ResponseImageGenCallGeneratingEvent
response.image_generation_call.in_progress	OpenAI.ResponseImageGenCallInProgressEvent
response.image_generation_call.partial_image	OpenAI.ResponseImageGenCallPartialImageEvent
response.mcp_call.arguments_delta	OpenAI.ResponseMCPCallArgumentsDeltaEvent
response.mcp_call.arguments_done	OpenAI.ResponseMCPCallArgumentsDoneEvent
response.mcp_call.completed	OpenAI.ResponseMCPCallCompletedEvent
response.mcp_call.failed	OpenAI.ResponseMCPCallFailedEvent
response.mcp_call.in_progress	OpenAI.ResponseMCPCallInProgressEvent
response.mcp_list_tools.completed	OpenAI.ResponseMCPListToolsCompletedEvent
response.mcp_list_tools.failed	OpenAI.ResponseMCPListToolsFailedEvent
response.mcp_list_tools.in_progress	OpenAI.ResponseMCPListToolsInProgressEvent
response.queued	OpenAI.ResponseQueuedEvent
response.reasoning.delta	OpenAI.ResponseReasoningDeltaEvent
response.reasoning.done	OpenAI.ResponseReasoningDoneEvent
response.reasoning_summary.delta	OpenAI.ResponseReasoningSummaryDeltaEvent
response.reasoning_summary.done	OpenAI.ResponseReasoningSummaryDoneEvent
response.code_interpreter_call_code.delta	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
response.code_interpreter_call_code.done	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
response.code_interpreter_call.completed	OpenAI.ResponseCodeInterpreterCallCompletedEvent
response.code_interpreter_call.in_progress	OpenAI.ResponseCodeInterpreterCallInProgressEvent
response.code_interpreter_call.interpreting	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Název	Typ	Description	Povinné	Výchozí
sequence_number	integer	Pořadové číslo této události.	Ano
typ	OpenAI.ResponseStreamEventType		Ano

OpenAI.ResponseStreamEventType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Emitováno, když je k dispozici dodatečný textový delta.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index části obsahu, do které byla přidána textová delta.	Ano
delta	řetězec	Text delta, který byl přidán.	Ano
item_id	řetězec	ID výstupní položky, ke které byla přidána textová delta.	Ano
output_index	integer	Index výstupní položky, do které byl přidán rozdíl textu.	Ano
typ	výčet	Typ události. Vždy response.output_text.delta. Možné hodnoty: response.output_text.delta	Ano

OpenAI.ResponseTextDoneEvent

Vygenerováno při finalizaci textového obsahu.

Název	Typ	Description	Povinné	Výchozí
content_index	integer	Index té části obsahu, ve které je textový obsah finalizován.	Ano
item_id	řetězec	ID výstupní položky, kterou je textový obsah finalizován.	Ano
output_index	integer	Index výstupní položky, který finalizuje textový obsah.	Ano
poslat SMS	řetězec	Textový obsah, který je finalizován.	Ano
typ	výčet	Typ události. Vždy response.output_text.done. Možné hodnoty: response.output_text.done	Ano

OpenAI.ResponseTextFormatConfiguration

Rozlišovač pro OpenAI.ResponseTextFormatConfiguration

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ResponseTextFormatConfigurationType	Objekt určující formát, který musí model vypíše. Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy. tím zajistíte, že model bude odpovídat zadanému schématu JSON. Další informace najdete v Výchozí formát je { "type": "text" } bez dalších možností. Nedoporučuje se pro gpt-4o a novější modely: Nastavení na { "type": "json_object" } umožní starší režim JSON, který zajišťuje, že zpráva, kterou model vygeneruje, je platný JSON. Použití json_schema je upřednostňovaný pro modely, které ho podporují.	Ano

OpenAI.ResponseTextFormatConfigurationJsonObject

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: json_object	Ano

OpenAI.ResponseTextFormatConfigurationJsonSchema

Formát odpovědi schématu JSON Slouží ke generování strukturovaných odpovědí JSON. Přečtěte si další informace o Strukturované výstupy.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis toho, k čemu formát odpovědi slouží, který model používá k určete, jak postupovat v daném formátu.	Ne
název	řetězec	Název formátu odpovědi. Musí to být a-z, A-Z, 0-9 nebo musí obsahovat podtržítka a pomlčky s maximální délkou 64 znaků.	Ano
schéma	objekt		Ano
přísné	Boolean	Zda povolit přísné dodržování schématu při generování výstupu. Pokud je nastavená hodnota true, model bude vždy dodržovat přesné schéma definované. schema v poli. Podporována je pouze podmnožina schématu JSON. strict je true. Další informace najdete v Strukturované výstupy. průvodce.	Ne	Nepravda
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy json_schema. Možné hodnoty: json_schema	Ano

OpenAI.ResponseTextFormatConfigurationText

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: text	Ano

OpenAI.ResponseTextFormatKonfiguraceTyp

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

Vlastnictví	Hodnota
Description	Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují. | | Typ | řetězec | | Hodnoty | text
json_schema
json_object |

OpenAI.ResponseUsage

Představuje podrobnosti o využití tokenů, včetně vstupních tokenů, výstupních tokenů, rozpisu výstupních tokenů a celkových použitých tokenů.

Název	Typ	Description	Povinné	Výchozí
input_tokens	integer	Počet vstupních tokenů.	Ano
input_tokens_details	objekt	Podrobný rozpis vstupních tokenů	Ano
└─ uložené_tokény	integer	Počet tokenů, které byly načteny z mezipaměti. Další ukládání do mezipaměti.	Ne
output_tokens	integer	Počet výstupních tokenů	Ano
output_tokens_details	objekt	Podrobný rozpis výstupních tokenů	Ano
└─ "reasoning_tokens"	integer	Počet tokenů pro logické uvažování.	Ne
total_tokens	integer	Celkový počet použitých tokenů	Ano

OpenAI.ResponseWebSearchCallCompletedEvent

Poznámka: web_search ještě není prostřednictvím Azure OpenAI k dispozici.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečné ID výstupní položky přidružené k volání vyhledávání na webu	Ano
output_index	integer	Index výstupní položky, ke které je přidruženo volání webového vyhledávání.	Ano
typ	výčet	Typ události. Vždy response.web_search_call.completed. Možné hodnoty: response.web_search_call.completed	Ano

OpenAI.ResponseWebSearchCallInProgressEvent

Poznámka: web_search ještě není prostřednictvím Azure OpenAI k dispozici.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečné ID výstupní položky přidružené k volání vyhledávání na webu	Ano
output_index	integer	Index výstupní položky, ke které je přidruženo volání webového vyhledávání.	Ano
typ	výčet	Typ události. Vždy response.web_search_call.in_progress. Možné hodnoty: response.web_search_call.in_progress	Ano

OpenAI.ResponseWebSearchCallSearchingEvent

Poznámka: web_search ještě není prostřednictvím Azure OpenAI k dispozici.

Název	Typ	Description	Povinné	Výchozí
item_id	řetězec	Jedinečné ID výstupní položky přidružené k volání vyhledávání na webu	Ano
output_index	integer	Index výstupní položky, ke které je přidruženo volání webového vyhledávání.	Ano
typ	výčet	Typ události. Vždy response.web_search_call.searching. Možné hodnoty: response.web_search_call.searching	Ano

OpenAI.ResponsesAssistantMessageItemParam

Položka parametru zprávy s rolí assistant.

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec nebo pole		Ano
role	výčet	Role zprávy, která je vždy assistant. Možné hodnoty: assistant	Ano

OpenAI.ResponsesAssistantMessageItemResource

Položka zdroje zprávy s rolí assistant.

Název	Typ	Description	Povinné	Výchozí
obsah	pole	Obsah přidružený ke zprávě.	Ano
role	výčet	Role zprávy, která je vždy assistant. Možné hodnoty: assistant	Ano

OpenAI.ResponsesDeveloperMessageItemParam

Položka parametru zprávy s rolí developer.

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec nebo pole		Ano
role	výčet	Role zprávy, která je vždy developer. Možné hodnoty: developer	Ano

OpenAI.ResponsesDeveloperMessageItemResource

Položka zdroje zprávy s rolí developer.

Název	Typ	Description	Povinné	Výchozí
obsah	pole	Obsah přidružený ke zprávě.	Ano
role	výčet	Role zprávy, která je vždy developer. Možné hodnoty: developer	Ano

OpenAI.ResponsesMessageItemParam

Roli a obsah, které jsou určené jako parametry požadavku klienta, představuje položka zprávy odpovědi.

Diskriminátor pro OpenAI.ResponsesMessageItemParam

Tato komponenta používá vlastnost role k rozlišování mezi různými typy:

Hodnota typu	Schema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

Název	Typ	Description	Povinné	Výchozí
role	objekt	Kolekce platných rolí pro položky zpráv na odpovědi.	Ano
typ	výčet	Typ položky odpovědí, která je vždy "zpráva". Možné hodnoty: message	Ano

OpenAI.ResponsesMessageItemResource

Položka odpovědní zprávy představující roli a obsah, jak je poskytováno v odpovědích služeb.

Identifikátor pro OpenAI.ResponsesMessageItemResource

Tato komponenta používá vlastnost role k rozlišování mezi různými typy:

Hodnota typu	Schema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

Název	Typ	Description	Povinné	Výchozí
role	objekt	Kolekce platných rolí pro položky zpráv na odpovědi.	Ano
stav	výčet	Stav položky. jeden z in_progress, completed, nebo incomplete. Naplněno při vrácení položek přes rozhraní API. Možné hodnoty: in_progress, completed, incomplete	Ano
typ	výčet	Typ položky odpovědí, která je vždy "zpráva". Možné hodnoty: message	Ano

OpenAI.ResponsesMessageRole

Kolekce platných rolí pro položky zpráv na odpovědi.

Vlastnictví	Hodnota
Description	Kolekce platných rolí pro položky zpráv na odpovědi.
Type	řetězec
Hodnoty	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Položka parametru zprávy s rolí system.

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec nebo pole		Ano
role	výčet	Role zprávy, která je vždy system. Možné hodnoty: system	Ano

OpenAI.ResponsesSystemMessageItemResource

Položka zdroje zprávy s rolí system.

Název	Typ	Description	Povinné	Výchozí
obsah	pole	Obsah přidružený ke zprávě.	Ano
role	výčet	Role zprávy, která je vždy system. Možné hodnoty: system	Ano

OpenAI.ResponsesUserMessageItemParam

Položka parametru zprávy s rolí user.

Název	Typ	Description	Povinné	Výchozí
obsah	řetězec nebo pole		Ano
role	výčet	Role zprávy, která je vždy user. Možné hodnoty: user	Ano

OpenAI.ResponsesUserMessageItemResource

Položka zdroje zprávy s rolí user.

Název	Typ	Description	Povinné	Výchozí
obsah	pole	Obsah přidružený ke zprávě.	Ano
role	výčet	Role zprávy, která je vždy user. Možné hodnoty: user	Ano

OpenAI.ServiceTier

Určuje typ zpracování použitý pro obsluhu požadavku.

• Pokud je nastavená hodnota auto, požadavek se zpracuje s úrovní služby nakonfigurovanou v nastavení Project. Pokud není nakonfigurované jinak, použije Project výchozí hodnotu.
• Pokud je nastavená na výchozí, požadavek se zpracuje se standardními cenami a výkonem vybraného modelu.
• Pokud je nastavená hodnota flex nebo priority, požadavek se zpracuje s odpovídající úrovní služby. Kontaktujte sales a získejte další informace o zpracování priority.
• Pokud není nastavené, výchozí chování je "auto".

Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnotu založenou na režimu zpracování, který se skutečně používá k obsluhování požadavku. Tato hodnota odpovědi se může lišit od hodnoty nastavené v parametru.

Vlastnictví	Hodnota
Description	Určuje typ zpracování použitý pro obsluhu požadavku. * Pokud je nastavená hodnota "auto", požadavek se zpracuje s úrovní služby. nakonfigurováno v nastavení Project. Pokud není nakonfigurované jinak, použije Project výchozí hodnotu. * Pokud je nastavená hodnota default, požadavek se zpracuje se standardním ceny a výkon pro vybraný model. * Pokud je nastavená hodnota flex nebo "priorita", žádost se zpracuje s odpovídající službou. úroveň. Kontaktujte sales a získejte další informace o zpracování priority. * Pokud není nastaveno, výchozí chování je "auto". Při nastavení parametru service_tier bude text odpovědi obsahovat service_tier hodnota založená na režimu zpracování, který se skutečně používá k poskytování požadavku. Tato hodnota odpovědi může se lišit od hodnoty nastavené v parametru.
Type	řetězec
Hodnoty	auto default flex scale priority

OpenAI.TextResponseFormatConfiguration

Objekt určující formát, který musí model vypíše.

Konfigurace { "type": "json_schema" } umožňuje strukturované výstupy, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v

Výchozí formát je { "type": "text" } bez dalších možností.

Nedoporučuje se pro gpt-4o a novější modely:*

Nastavení { "type": "json_object" } umožní původní režim JSON, což zajišťuje, že zpráva vygenerovaná modelem je platný JSON. Použití json_schema je upřednostňované pro modely, které ho podporují.

Diskriminátor pro OpenAI.TextResponseFormatConfiguration

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema

Název	Typ	Description	Povinné	Výchozí
typ	řetězec		Ano

OpenAI.Tool

Diskriminátor pro nástroj OpenAI

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search_preview	OpenAI.WebSearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellTool
mcp	OpenAI.MCPTool
bing_grounding	BingGroundingAgentTool
fabric_dataagent_preview	MicrosoftFabricAgentTool
sharepoint_grounding_preview	SharepointAgentTool
azure_ai_search	AzureAISearchAgentTool
openapi	OpenApiAgentTool
bing_custom_search_preview	BingCustomSearchAgentTool
browser_automation_preview	BrowserAutomationAgentTool
azure_function	AzureFunctionAgentTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2ATool
memory_search	MemorySearchTool

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ToolType	Nástroj, který lze použít k vygenerování odpovědi.	Ano

OpenAI.ToolChoiceObject

Diskriminátor pro OpenAI.ToolChoiceObject

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
file_search	OpenAI.ToolChoiceObjectFileSearch
computer_use_preview	OpenAI.ToolChoiceObjectComputer
web_search_preview	OpenAI.ToolChoiceObjectWebSearch
image_generation	OpenAI.ToolChoiceObjectImageGen
code_interpreter	OpenAI.ToolChoiceObjectCodeInterpreter
function	OpenAI.ToolChoiceObjectFunction
mcp	OpenAI.ToolChoiceObjectMCP

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.ToolChoiceObjectType	Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.	Ano

OpenAI.ToolChoiceObjectCodeInterpreter

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: code_interpreter	Ano

OpenAI.ToolChoiceObjectComputer

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: computer_use_preview	Ano

OpenAI.ToolChoiceObjectFileSearch

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: file_search	Ano

OpenAI.ToolChoiceObjectFunction

Tuto možnost použijte k vynucení volání konkrétní funkce modelu.

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Název funkce, která se má volat.	Ano
typ	výčet	Pro volání funkce je typ vždy function. Možné hodnoty: function	Ano

OpenAI.ToolChoiceObjectImageGen

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: image_generation	Ano

OpenAI.ToolChoiceObjectMCP

Tuto možnost použijte k vynucení volání konkrétního nástroje na vzdáleném serveru MCP.

Název	Typ	Description	Povinné	Výchozí
název	řetězec	Název nástroje, který se má volat na serveru.	Ne
označení serveru	řetězec	Popisek serveru MCP, který se má použít.	Ano
typ	výčet	U nástrojů MCP je typ vždy mcp. Možné hodnoty: mcp	Ano

OpenAI.ToolChoiceObjectType

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Vyučte si další informace o integrovaných nástrojích.

Vlastnictví	Hodnota
Description	Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj.
Vyučte si další informace o integrovaných nástrojích.
Type	řetězec
Hodnoty	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

Poznámka: web_search ještě není prostřednictvím Azure OpenAI k dispozici.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: web_search_preview	Ano

OpenAI.ToolChoiceOptions

Určuje, který (pokud existuje) nástroj, který model volá.

none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu.

auto znamená, že model si může vybrat mezi generováním zprávy nebo voláním jednoho nebo více nástrojů.

required znamená, že model musí volat jeden nebo více nástrojů.

Vlastnictví	Hodnota
Description	Určuje, který (pokud existuje) nástroj, který model volá. none znamená, že model nebude volat žádný nástroj a místo toho vygeneruje zprávu. auto znamená, že model může vybírat mezi generováním zprávy nebo voláním jedné nebo více nástrojů. required znamená, že model musí volat jeden nebo více nástrojů.
Type	řetězec
Hodnoty	none auto required

OpenAI.ToolType

Nástroj, který lze použít k vygenerování odpovědi.

Vlastnictví	Hodnota
Description	Nástroj, který lze použít k vygenerování odpovědi.
Type	řetězec
Hodnoty	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell bing_grounding browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview azure_ai_search openapi bing_custom_search_preview capture_structured_outputs a2a_preview azure_function memory_search

OpenAI.TopLogProb

Nejvyšší pravděpodobnost protokolu tokenu.

Název	Typ	Description	Povinné	Výchozí
bytes	pole		Ano
logprob	číslo		Ano
token	řetězec		Ano

OpenAI.UpdateConversationRequest

Aktualizace konverzace

Název	Typ	Description	Povinné	Výchozí
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

OpenAI.VectorStoreFileAttributes

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků, pravdivostní hodnoty nebo čísla.

Typ: objekt

OpenAI.WebSearchAction

Diskriminátor pro OpenAI.WebSearchAction

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearchSearch

Název	Typ	Description	Povinné	Výchozí
typ	OpenAI.WebSearchActionType		Ano

OpenAI.WebSearchActionFind

Typ akce "find": Vyhledá vzor na načtené stránce.

Název	Typ	Description	Povinné	Výchozí
vzor	řetězec	Vzor nebo text, který chcete vyhledat na stránce.	Ano
typ	výčet	Typ akce. Možné hodnoty: find	Ano
url	řetězec	Adresa URL stránky hledaná vzorem.	Ano

OpenAI.WebSearchActionOpenPage

Typ akce "open_page" – Otevře konkrétní adresu URL z výsledků hledání.

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ akce. Možné hodnoty: open_page	Ano
url	řetězec	Adresa URL otevřená modelem	Ano

OpenAI.WebSearchActionSearchSearch

Typ akce "search" – provede vyhledávací dotaz na webu.

Název	Typ	Description	Povinné	Výchozí
dotaz	řetězec	Vyhledávací dotaz.	Ano
zdroje	pole	Zdroje použité při vyhledávání.	Ne
typ	výčet	Typ akce. Možné hodnoty: search	Ano

OpenAI.WebSearchActionSearchSources

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: url	Ano
url	řetězec		Ano

OpenAI.WebSearchActionType

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	search open_page find

OpenAI.WebSearchPreviewTool

Poznámka: web_search ještě není prostřednictvím Azure OpenAI k dispozici.

Název	Typ	Description	Povinné	Výchozí
velikost_kontextu_vyhledávání	výčet	Pokyny vysoké úrovně pro množství prostoru kontextového okna, které se má použít pro hledání. Jeden z low, mediumnebo high. medium je výchozí. Možné hodnoty: low, medium, high	Ne
typ	výčet	Typ vyhledávacího nástroje pro web. Jedna z možností: web_search_preview nebo web_search_preview_2025_03_11 Možné hodnoty: web_search_preview	Ano
uživatelská_lokalita	objekt		Ne
└- typ	OpenAI.LocationType		Ne

OpenAI.WebSearchToolCallItemParam

Výsledky volání nástroje pro vyhledávání na webu. Další informace najdete v průvodci vyhledáváním webu .

Název	Typ	Description	Povinné	Výchozí
akce	objekt		Ano
└- typ	OpenAI.WebSearchActionType		Ne
typ	výčet	Možné hodnoty: web_search_call	Ano

OpenAI.WebSearchToolCallItemResource

Výsledky volání nástroje pro vyhledávání na webu. Další informace najdete v průvodci vyhledáváním webu .

Název	Typ	Description	Povinné	Výchozí
akce	objekt		Ano
└- typ	OpenAI.WebSearchActionType		Ne
stav	výčet	Stav volání nástroje pro vyhledávání na webu. Možné hodnoty: in_progress, searching, completed, failed	Ano
typ	výčet	Možné hodnoty: web_search_call	Ano

OpenAI.integer

Typ: celé číslo

Formát: int64

OpenAI.numeric

Typ: číslo

Formát: double

OpenApiAgentTool

Informace o definici vstupu pro nástroj OpenAPI, jak slouží ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
openapi	objekt	Informace o definici vstupu pro funkci openapi.	Ano
└- ověřování	OpenApiAuthDetails	Podrobnosti o ověřování rozhraní API	Ne
└default_params	pole	Seznam parametrů specifikace OpenAPI, které budou používat výchozí hodnoty zadané uživatelem	Ne
└- popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
└– funkce	pole	Seznam definic funkcí používaných nástrojem OpenApi	Ne
└– název	řetězec	Název funkce, která se má volat.	Ne
└specifikace		Obrazec funkce openapi, který je popsán jako objekt schématu JSON.	Ne
typ	výčet	Typ objektu, který je vždy 'openapi'. Možné hodnoty: openapi	Ano

OpenApiAnonymousAuthDetails

Podrobnosti zabezpečení pro anonymní ověřování OpenApi

Název	Typ	Description	Povinné	Výchozí
typ	výčet	Typ objektu, který je vždy anonymní. Možné hodnoty: anonymous	Ano

OpenApiAuthDetails

podrobnosti o ověřování pro OpenApiFunctionDefinition

Diskriminátor pro OpenApiAuthDetails

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ ověření pro koncový bod OpenApi. Povolené typy jsou: – Anonymní (nevyžaduje se ověřování) – Project Připojení (vyžaduje project_connection_id ke koncovému bodu jako nastavení v Foundry) – Managed_Identity (vyžaduje cílovou skupinu pro ověřování na základě identit).	Ano

OpenApiAuthType

Typ ověření pro koncový bod OpenApi. Povolené typy jsou:

• Anonymní (není vyžadováno ověření)
• připojení Project (vyžaduje project_connection_id ke koncovému bodu jako nastavení v Foundry)
• Managed_Identity (vyžaduje cílovou skupinu pro ověření na základě identity)

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Informace o definici vstupu pro funkci openapi.

Název	Typ	Description	Povinné	Výchozí
auth	objekt	podrobnosti o ověřování pro OpenApiFunctionDefinition	Ano
└- typ	OpenApiAuthType	Typ ověřování musí být anonymní, project_connection/managed_identity	Ne
default_params	pole	Seznam parametrů specifikace OpenAPI, které budou používat výchozí hodnoty zadané uživatelem	Ne
popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
functions	pole	Seznam definic funkcí používaných nástrojem OpenApi	Ne
název	řetězec	Název funkce, která se má volat.	Ano
spec		Obrazec funkce openapi, který je popsán jako objekt schématu JSON.	Ano

OpenApiManagedAuthDetails

Podrobnosti zabezpečení pro ověřování managed_identity OpenApi

Název	Typ	Description	Povinné	Výchozí
security_scheme	objekt	Schéma zabezpečení pro ověřování managed_identity OpenApi	Ano
└- cílová skupina	řetězec	Rozsah ověřování pro typ ověřování managed_identity	Ne
typ	výčet	Typ objektu, který je vždy "managed_identity". Možné hodnoty: managed_identity	Ano

OpenApiManagedSecurityScheme

Schéma zabezpečení pro ověřování managed_identity OpenApi

Název	Typ	Description	Povinné	Výchozí
audience	řetězec	Rozsah ověřování pro typ ověřování managed_identity	Ano

OpenApiProjectConnectionAuthDetails

Podrobnosti zabezpečení pro ověřování připojení project OpenApi

Název	Typ	Description	Povinné	Výchozí
security_scheme	objekt	Schéma zabezpečení pro ověřování managed_identity OpenApi	Ano
└project_connection_id	řetězec	PROJECT ID připojení pro typ ověřování připojení Project	Ne
typ	výčet	Typ objektu, který je vždy 'project_connection'. Možné hodnoty: project_connection	Ano

OpenApiProjectConnectionSecurityScheme

Schéma zabezpečení pro ověřování managed_identity OpenApi

Název	Typ	Description	Povinné	Výchozí
project_connection_id	řetězec	PROJECT ID připojení pro typ ověřování připojení Project	Ano

PagedConnection

Stránkovaná kolekce položek připojení

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky Připojení na této stránce	Ano

PagedDatasetVersion

Stránkovaná kolekce položek DatasetVersion

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky DatasetVersion na této stránce	Ano

PagedDeployment

Stránkovaná kolekce položek nasazení

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky nasazení na této stránce	Ano

PagedEvaluationRule

Sbíraná sbírka položek Hodnotících pravidel

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky Vyhodnocenírule na této stránce	Ano

PagedEvaluationTaxonomy

Stránkovaná sbírka položek EvaluationTaxonomy

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky EvaluationTaxonomy na této stránce	Ano

PagedEvaluatorVersion

Stránkovaná sbírka položek EvaluatorVersion

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky EvaluatorVersion na této stránce	Ano

PagedIndex

Stránkovaná kolekce položek rejstříku

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky rejstříku na této stránce	Ano

PagedInsight

Stránkovaná kolekce položek Přehledu

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky přehledu na této stránce	Ano

PagedRedTeam

Stránkovaná kolekce položek RedTeamu

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky RedTeam na této stránce	Ano

PagedSchedule

Stránkovaná kolekce položek plánu

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky plánu na této stránce	Ano

PagedScheduleRun

Stránkovaná kolekce položek ScheduleRun

Název	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole	Položky ScheduleRun na této stránce	Ano

PendingUploadRequest

Představuje požadavek na čekající nahrání.

Název	Typ	Description	Povinné	Výchozí
název_připojení	řetězec	Azure Storage název připojení účtu k vygenerování dočasného tokenu SAS	Ne
pendingUploadId	řetězec	Pokud PendingUploadId není zadaný, použije se náhodný identifikátor GUID.	Ne
pendingUploadType	výčet	BlobReference je jediný podporovaný typ. Možné hodnoty: BlobReference	Ano

PendingUploadResponse

Představuje odpověď na čekající žádost o nahrání

Název	Typ	Description	Povinné	Výchozí
blobReference	objekt	Podrobnosti o referenčních informacích o objektech blob.	Ano
└– identifikátor blobUri	řetězec	Cesta URI objektu blob pro klienta k nahrání dat Příklad: https://blob.windows.core.net/Container/Path	Ne
└- přihlašovací údaje	SasCredential	Informace o přihlašovacích údajích pro access účtu storage.	Ne
└- storageAccountArmId	řetězec	ID ARM účtu storage, který se má použít.	Ne
pendingUploadId	řetězec	ID této žádosti o nahrání.	Ano
pendingUploadType	výčet	BlobReference je jediným podporovaným typem Možné hodnoty: BlobReference	Ano
verze	řetězec	Verze datového zdroje, která má být vytvořena, pokud uživatel při počátečním nahrávání nezadal verzi	Ne

PromptAgentDefinition

Definice agenta výzvy

Název	Typ	Description	Povinné	Výchozí
instructions	řetězec	Zpráva systému (nebo vývojáře) vložená do kontextu modelu.	Ne
laskavý	výčet	Možné hodnoty: prompt	Ano
model	řetězec	Nasazení modelu, které se má použít pro tohoto agenta.	Ano
reasoning	objekt	Modely řady o-series pouze Možnosti konfigurace pro zdůvodnění modelů	Ne
└– úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodnění modelů. Aktuálně podporované hodnoty nejsou žádné, minimální, nízké, střední a vysoké. Snížení úsilí o odůvodnění může vést k rychlejším odpovědím a menšímu počtu tokenů používaných při odůvodnění v odpovědi. gpt-5.1 je výchozí hodnota žádné, což neprovádí odůvodnění. Podporované hodnoty důvodů pro gpt-5.1 nejsou žádné, nízké, střední a vysoké. Volání nástrojů jsou podporována pro všechny hodnoty odůvodnění v gpt-5.1. Všechny modely před gpt-5.1 jsou ve výchozím nastavení středně náročné a nepodporují žádné. Model gpt-5-pro ve výchozím nastavení používá (a podporuje) velké úsilí.	Ne
└─ vytvořit_shrnutí	výčet	Zastaralé: místo toho použijte summary . Souhrn důvodů provedených modelem To může být užitečné pro ladění a pochopení procesu odůvodnění modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
└─ souhrn	výčet	Souhrn důvodů provedených modelem Může to být užitečné pro ladění a pochopení způsobu uvažování modelu. Jeden z auto, concisenebo detailed. Možné hodnoty: auto, concise, detailed	Ne
structured_inputs	objekt	Sada strukturovaných vstupů, které se mohou podílet na nahrazení šablony výzvy nebo vazbách argumentů nástroje.	Ne
Teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne	1
poslat SMS	objekt	Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON.	Ne
└─ Formát	OpenAI.ResponseTextFormatConfiguration		Ne
nářadí	pole	Pole nástrojů, které může model volat při generování odpovědi. Vy může určit, který nástroj se má použít nastavením parametru tool_choice .	Ne
top_p	číslo	Alternativou k odběru vzorků s teplotou, nazývané jako nukleární vzorkování kde model bere v úvahu výsledky tokenů s pravděpodobností top_p mše. Hodnota 0,1 tedy označuje pouze tokeny, které tvoří vrchních 10 % pravděpodobnostní hmoty%. jsou považovány. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne	1

PromptBasedEvaluatorDefinition

Hodnotitel založený na výzvě

Název	Typ	Description	Povinné	Výchozí
prompt_text	řetězec	Text výzvy použitý k vyhodnocení	Ano
typ	výčet	Možné hodnoty: prompt	Ano

ProtocolVersionRecord

Mapování záznamů pro jeden protokol a jeho verzi.

Název	Typ	Description	Povinné	Výchozí
protokol	objekt		Ano
verze	řetězec	Řetězec verze protokolu, např. 'v0.1.1'.	Ano

RaiConfig

Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).

Název	Typ	Description	Povinné	Výchozí
rai_policy_name	řetězec	Název zásady RAI, která se má použít.	Ano

RecurrenceSchedule

Model plánu opakování.

Diskriminátor pro opakováníSchedule

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	TýdennírecurrenceSchedule
Monthly	MěsíčnírecurrenceSchedule

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ opakování.	Ano

RecurrenceTrigger

Spouštěč založený na opakování.

Název	Typ	Description	Povinné	Výchozí
endTime	řetězec	Čas ukončení plánu opakování ve formátu ISO 8601.	Ne
interval	integer	Interval pro plán opakování.	Ano
rozvrh	objekt	Model plánu opakování.	Ano
└- typ	RecurrenceType	Typ opakování pro plán opakování	Ne
startTime	řetězec	Čas spuštění plánu opakování ve formátu ISO 8601.	Ne
timeZone	řetězec	Časové pásmo pro plán opakování.	Ne	standard UTC
typ	výčet	Typ spouštěče. Možné hodnoty: Recurrence	Ano

RecurrenceType

Typ opakování.

Vlastnictví	Hodnota
Description	Typ opakování.
Type	řetězec
Hodnoty	Hourly Daily Weekly Monthly

RedTeam

Podrobnosti o červeném týmu.

Název	Typ	Description	Povinné	Výchozí
applicationScenario	řetězec	Aplikační scénář pro operaci červeného týmu, pro generování útoků specifických pro daný scénář.	Ne
attackStrategies	pole	Seznam útočných strategií nebo vnořené seznamy útočných strategií.	Ne
zobrazované jméno	řetězec	Název běhu červeného týmu.	Ne
ID	řetězec	Identifikátor běhu červeného týmu.	Ano
numTurns	integer	Počet simulačních kol.	Ne
vlastnosti	objekt	Vlastnosti červeného týmu. Na rozdíl od značek jsou vlastnosti pouze doplňky. Po přidání nelze odebrat vlastnost.	Ne
riskCategories	pole	Seznam kategorií rizik, pro které se mají generovat cíle útoku.	Ne
simulaceOnly	Boolean	Pouze simulace nebo simulace + vyhodnocení. Výchozí hodnota false, pokud je true, výstupem kontroly je konverzace, nikoli výsledek vyhodnocení.	Ne	Nepravda
stav	řetězec	Status červeného týmu. Je nastaven službou a je pouze ke čtení.	Ne
tags	objekt	Značky červeného týmu. Na rozdíl od vlastností jsou značky plně proměnlivé.	Ne
cíl	objekt	Abstraktní třída pro cílovou konfiguraci.	Ano
└- typ	řetězec	Typ konfigurace modelu.	Ne

RedTeamItemGenerationParams

Představuje parametry pro generování červených položek týmu.

Název	Typ	Description	Povinné	Výchozí
attack_strategies	pole	Kolekce strategií útoku, které se mají použít.	Ano
num_turns	integer	Počet otáček povolených ve hře.	Ano
typ	výčet	Typ parametrů generování položek, vždy red_team. Možné hodnoty: red_team	Ano

RiskCategory

Kategorie rizika pro cíl útoku.

Vlastnictví	Hodnota
Description	Kategorie rizika pro cíl útoku.
Type	řetězec
Hodnoty	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SasCredentials

Definice přihlašovacích údajů sdíleného Access podpisu (SAS)

Název	Typ	Description	Povinné	Výchozí
SAS	řetězec	token SAS	Ne
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: SAS	Ano

SampleType

Typ vzorku použitého při analýze.

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	EvaluationResultSample

SasCredential

Definice přihlašovacích údajů SAS

Název	Typ	Description	Povinné	Výchozí
sasUri	řetězec	Identifikátor URI SAS	Ano
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: SAS	Ano

Schedule

Model plánu.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis plánu	Ne
zobrazované jméno	řetězec	Název plánu	Ne
povoleno	Boolean	Povolený stav plánu.	Ano
ID	řetězec	Identifikátor plánu.	Ano
vlastnosti	objekt	Vlastnosti tabulky. Na rozdíl od značek jsou vlastnosti pouze doplňky. Po přidání nelze odebrat vlastnost.	Ne
provisioningStatus	objekt	Naplánujte si stav zřizování.	Ne
systémová data	objekt	Systémová metadata pro prostředek.	Ano
tags	objekt	Značky plánu. Na rozdíl od vlastností jsou značky plně proměnlivé.	Ne
úkol	objekt	Naplánujte model úlohy.	Ano
Konfigurace └•	objekt	Konfigurace úlohy.	Ne
└- typ	ScheduleTaskType	Typ úkolu	Ne
aktivační událost	objekt	Základní model pro Trigger plánu.	Ano
└- typ	Typ spouště	Typ spouštěče.	Ne

ScheduleProvisioningStatus

Naplánujte si stav zřizování.

Vlastnictví	Hodnota
Description	Naplánujte si stav zřizování.
Type	řetězec
Hodnoty	Creating Updating Deleting Succeeded Failed

ScheduleRun

Naplánujte si model spuštění.

Název	Typ	Description	Povinné	Výchozí
chyba	řetězec	Informace o chybě pro spuštění plánu.	Ne
ID	řetězec	Identifikátor spuštění plánu.	Ano
vlastnosti	objekt	Vlastnosti spuštění plánu.	Ano
scheduleId	řetězec	Identifikátor plánu.	Ano
úspěch	Boolean	Aktivujte úspěšný stav spuštění plánu.	Ano
triggerTime	řetězec	Čas triggeru spuštění plánu.	Ne

Naplánovat úkol

Naplánujte model úlohy.

Diskriminátor pro ScheduleTask

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Název	Typ	Description	Povinné	Výchozí
konfigurace	objekt	Konfigurace úlohy.	Ne
typ	objekt	Typ úkolu	Ano

ScheduleTaskType

Typ úkolu

Vlastnictví	Hodnota
Description	Typ úkolu
Type	řetězec
Hodnoty	Evaluation Insight

SeedPromptsRedTeamItemGenerationParams

Představuje parametry pro generování červených položek týmu s počátečními výzvami.

Název	Typ	Description	Povinné	Výchozí
attack_strategies	pole	Kolekce strategií útoku, které se mají použít.	Ano
num_turns	integer	Počet otáček povolených ve hře.	Ano
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ne
typ	výčet	Typ parametrů generování položek, vždy red_team. Možné hodnoty: red_team_seed_prompts	Ano

SharepointAgentTool

Informace o definici vstupu pro nástroj služby SharePoint, jak slouží ke konfiguraci agenta.

Název	Typ	Description	Povinné	Výchozí
sharepoint_grounding_preview	objekt	Parametry nástroje pro uzemnění služby SharePoint.	Ano
└project_connections	pole	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji.	Ne
typ	výčet	Typ objektu, který je vždy "sharepoint_grounding". Možné hodnoty: sharepoint_grounding_preview	Ano

SharepointGroundingToolParameters

Parametry nástroje pro uzemnění služby SharePoint.

Název	Typ	Description	Povinné	Výchozí
project_connections	pole	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji.	Ne

Skladová jednotka (SKU)

Informace o skladové posílce

Název	Typ	Description	Povinné	Výchozí
kapacita	integer	Kapacita skladové položky	Ano
rodina	řetězec	Rodina SKU	Ano
název	řetězec	Název skladové položky	Ano
velikost	řetězec	Velikost skladové položky	Ano
přesunout do jiné vrstvy	řetězec	Úroveň skladové položky	Ano

StructuredInputDefinition

Strukturovaný vstup, který se může podílet na nahrazení předlohy výzvy a vázání argumentů nástroje.

Název	Typ	Description	Povinné	Výchozí
default_value		Výchozí hodnota vstupu, pokud není zadána žádná hodnota za běhu.	Ne
popis	řetězec	Popis vstupu čitelný pro člověka.	Ne
povinné	Boolean	Určuje, zda je vstupní vlastnost vyžadována při vyvolání agenta.	Ne	Nepravda
schéma		Schéma JSON pro strukturovaný vstup (volitelné).	Ne

StructuredOutputDefinition

Strukturovaný výstup, který může vytvořit agent.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis výstupu, který se má vygenerovat. Model jej používá k určení, kdy se má výstup vygenerovat.	Ano
název	řetězec	Název strukturovaného výstupu.	Ano
schéma		Schéma JSON pro strukturovaný výstup.	Ano
přísné	Boolean	Zda se má vynutit přísné ověřování. Výchozí true.	Ano

StructuredOutputsItemResource

Název	Typ	Description	Povinné	Výchozí
výstup		Strukturovaný výstup zachycený během odpovědi.	Ano
typ	výčet	Možné hodnoty: structured_outputs	Ano

Target

Základní třída pro cíle s podporou diskriminátoru.

Diskriminátor pro cíl

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget
azure_ai_assistant	AzureAIAssistantTarget

Název	Typ	Description	Povinné	Výchozí
typ	řetězec	Typ cíle.	Ano

TargetCompletions

Představuje zdroj dat pro konfiguraci vyhodnocení dokončení na základě cíle.

Název	Typ	Description	Povinné	Výchozí
zprávy_vstupu	objekt		Ne
└ item_reference	řetězec		Ne
└- typ	výčet	Možné hodnoty: item_reference	Ne
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ne
cíl	objekt	Základní třída pro cíle s podporou diskriminátoru.	Ano
└- typ	řetězec	Typ cíle.	Ne
typ	výčet	Typ zdroje dat, vždy TargetCompletions. Možné hodnoty: azure_ai_target_completions	Ano

TargetConfig

Abstraktní třída pro cílovou konfiguraci.

Diskriminátor pro TargetConfig

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Název	Typ	Description	Povinné	Výchozí
typ	řetězec	Typ konfigurace modelu.	Ano

TargetUpdate

Základní třída pro cíle s podporou diskriminátoru.

Diskriminátor pro TargetUpdate

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_assistant	AzureAIAssistantTargetUpdate

Název	Typ	Description	Povinné	Výchozí
typ	řetězec	Typ cíle.	Ano

TaxonomyCategory

Definice kategorie taxonomie.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis kategorie taxonomie.	Ne
ID	řetězec	Jedinečný identifikátor kategorie taxonomie.	Ano
název	řetězec	Název kategorie taxonomie.	Ano
vlastnosti	objekt	Další vlastnosti pro kategorii taxonomie.	Ne
riskCategory	objekt	Kategorie rizika pro cíl útoku.	Ano
Podkategorie	pole	Seznam podkategorií taxonomie.	Ano

TaxonomyRedTeamItemGenerationParams

Představuje parametry pro generování červených položek týmu s počátečními výzvami.

Název	Typ	Description	Povinné	Výchozí
attack_strategies	pole	Kolekce strategií útoku, které se mají použít.	Ano
num_turns	integer	Počet otáček povolených ve hře.	Ano
odeslat k provedení	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ne
typ	výčet	Typ parametrů generování položek, vždy red_team. Možné hodnoty: red_team_taxonomy	Ano

TaxonomieSubCategory

Definice podkategorie Taxonomie.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis podkategorie taxonomie.	Ne
povoleno	Boolean	Seznam položek taxonomie v této podkategorii.	Ano
ID	řetězec	Jedinečný identifikátor podkategorie taxonomie.	Ano
název	řetězec	Název podkategorie taxonomie.	Ano
vlastnosti	objekt	Další vlastnosti pro podkategorii taxonomie.	Ne

Popis toolDescription

Popis nástroje, který může agent použít.

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Stručný popis účelu nástroje.	Ne
název	řetězec	Název nástroje.	Ne

ToolProjectConnection

Prostředek připojení project.

Název	Typ	Description	Povinné	Výchozí
project_connection_id	řetězec	Připojení project v toolProjectConnectionList připojeném k tomuto nástroji.	Ano

TracesEvalRunDataSource

Představuje zdroj dat pro zkušební spuštění, která pracují s trasováními agentů uloženými v Application Insights.

Název	Typ	Description	Povinné	Výchozí
lookback_hours	integer	Okno zpětného vyhledávání (v hodinách) použité při načítání trasování z Application Insights	Ne	168
trace_ids	pole	Kolekce identifikátorů trasování agenta, které by se měly vyhodnotit.	Ano
typ	výčet	Typ zdroje dat, vždy azure_ai_traces. Možné hodnoty: azure_ai_traces	Ano

TreatmentEffectType

Typ účinku ošetření.

Vlastnictví	Hodnota
Type	řetězec
Hodnoty	TooFewSamples Inconclusive Changed Improved Degraded

Spouštěč

Základní model pro Trigger plánu.

Diskriminátor aktivační události

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schema
Cron	CronTrigger
Recurrence	Opakovací spouštěč
OneTime	OneTimeTrigger

Název	Typ	Description	Povinné	Výchozí
typ	objekt	Typ spouštěče.	Ano

Typ triggeru

Typ spouštěče.

Vlastnictví	Hodnota
Description	Typ spouštěče.
Type	řetězec
Hodnoty	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Název	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
manifest_id	řetězec	ID manifestu pro import verze agenta z.	Ano
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

UpdateAgentRequest

Název	Typ	Description	Povinné	Výchozí
definice	objekt		Ano
└kind	AgentKind		Ne
└rai_config	RaiConfig	Konfigurace pro filtrování obsahu a bezpečnostní funkce zodpovědné umělé inteligence (RAI).	Ne
popis	řetězec	Popis agenta čitelný pro člověka.	Ne
metadata	objekt	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne

UpdateEvalParametersBody

Název	Typ	Description	Povinné	Výchozí
metadata	OpenAI.Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. Může to být užitečné pro strukturované ukládání dalších informací o objektu formátování a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce. s maximální délkou 512 znaků.	Ne
název	řetězec		Ne
vlastnosti	objekt	Sada neměnných párů klíč-hodnota 16, které lze připojit k objektu pro ukládání dalších informací. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne

UserProfileMemoryItem

Paměťová položka konkrétně obsahující informace o profilu uživatele extrahované z konverzací, jako jsou preference, zájmy a osobní údaje.

Název	Typ	Description	Povinné	Výchozí
laskavý	výčet	Druh paměťové položky. Možné hodnoty: user_profile	Ano

TýdennírecurrenceSchedule

Týdenní plán opakování.

Název	Typ	Description	Povinné	Výchozí
daysOfWeek	pole	Dny v týdnu pro plán opakování.	Ano
typ	výčet	Typ týdenního opakování. Možné hodnoty: Weekly	Ano

WorkflowActionOutputItemResource

Název	Typ	Description	Povinné	Výchozí
action_id	řetězec	Jedinečný identifikátor akce.	Ano
laskavý	řetězec	Druh akce CSDL (např. SetVariable, InvokeAzureAgent).	Ano
parent_action_id	řetězec	ID nadřazené akce, pokud se jedná o vnořenou akci.	Ne
previous_action_id	řetězec	ID předchozí akce, pokud tato akce následuje za jinou.	Ne
stav	výčet	Stav akce (např. "in_progress", "completed", "failed", "cancelled"). Možné hodnoty: completed, failed, in_progress, cancelled	Ano
typ	výčet	Možné hodnoty: workflow_action	Ano

WorkflowAgentDefinition

Definice agenta pracovního postupu.

Název	Typ	Description	Povinné	Výchozí
laskavý	výčet	Možné hodnoty: workflow	Ano
pracovní postup	řetězec	Definice pracovního postupu CSDL YAML.	Ne

integer

Typ: celé číslo

Formát: int64