Microsoft Foundry

Verze rozhraní API: v1

Autentizace

Tok: implicitní

Adresa URL autorizace:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Obory:

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

Agents

Agenti – vytvoření agenta

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

Vytvoří agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
definice	AgentDefinition		Ano
└kind	AgentKind		Ano
└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. Omezení: maxLength: 512	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ů. Omezení: maxLength: 63	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	AgentObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – výpis agentů

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

Vrátí seznam všech agentů.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
kind	dotaz	Ne	řetězec Možné hodnoty: `prompt`, `hosted`, `container_app`, `workflow`	Filtrujte agenty podle druhu. Pokud není k dispozici, vrátí se všechny agenty.
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í a`desc` pro sestupné pořadí.
Po	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.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Agenti – získání agenta

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

Načte agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta, který se má načíst.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	AgentObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – aktualizační agent

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

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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta, který se má načíst.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
definice	AgentDefinition		Ano
└kind	AgentKind		Ano
└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. Omezení: maxLength: 512	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	Typ	Description
application/json	AgentObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – odstranění agenta

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

Odstraní agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta, který chcete odstranit.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DeleteAgentResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – aktualizace agenta z manifestu

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

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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta, který se má aktualizovat.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
popis	řetězec	Popis agenta čitelný pro člověka. Omezení: maxLength: 512	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	Typ	Description
application/json	AgentObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – vytvoření verze agenta

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

Vytvořte novou verzi agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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ů.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
definice	AgentDefinition		Ano
└kind	AgentKind		Ano
└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. Omezení: maxLength: 512	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	Typ	Description
application/json	AgentVersionObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – výpis verzí agentů

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

Vrátí seznam verzí agentu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Agenti – získání verze agenta

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

Načte konkrétní verzi agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	AgentVersionObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – odstranění verze agenta

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

Odstraní konkrétní verzi agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta, který chcete odstranit.
agent_version	cesta	Ano	řetězec	Verze agenta k odstranění
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DeleteAgentVersionResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – vytvoření verze agenta z manifestu

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

Vytvořte novou verzi agenta z manifestu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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ů.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
popis	řetězec	Popis agenta čitelný pro člověka. Omezení: maxLength: 512	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	Typ	Description
application/json	AgentVersionObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Agenti – vytvoření agenta z manifestu

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

Vytvoří agenta z manifestu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
popis	řetězec	Popis agenta čitelný pro člověka. Omezení: maxLength: 512	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ů. Omezení: maxLength: 63	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	Typ	Description
application/json	AgentObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů

Kontejnery agentů – výpis operací kontejneru agenta

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

Výpis operací kontejneru pro agenta

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – získání operace kontejneru agenta

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

Získejte stav operace kontejneru pro agenta.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
operation_id	cesta	Ano	řetězec	Identifikační číslo operace.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	AgentContainerOperationObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – získání kontejneru agentů

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	AgentContainerObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – výpis operací kontejneru verzí agenta

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – odstranění kontejneru agenta

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

Odstraňte kontejner pro konkrétní verzi agenta. Pokud kontejner neexistuje, operace bude 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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 202

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

Typ obsahu	Typ	Description
application/json	AgentContainerOperationObject

Hlavičky odpovědi:

Záhlaví	Typ	Description
Umístění operace	řetězec

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – streamování protokolů kontejnerů agentů

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

Položka protokolu kontejneru streamovaná z kontejneru jako textové bloky Každý blok dat je řetězec UTF-8, který může být řádkem protokolu prostého textu nebo položkou protokolu ve formátu JSON v závislosti na typu streamovaného protokolu kontejneru. Klienti by se měli s každým blokem zacházet jako s neprůstředným textem a v případě potřeby se ho pokusí analyzovat jako JSON na základě požadavků na protokolování.

V případě systémových protokolů: Formát je JSON s následující strukturou: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Připojení ke kolektoru událostí...","Reason":"StartingGettingEvents ","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Úspěšně připojeno k událostem server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Pro protokoly konzoly je formát prostý text, který je generován stdout/stderr kontejneru. 2025-12-15T08:43:48.72656 Připojení ke kontejneru agent-container... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
kind	dotaz	Ne	řetězec Možné hodnoty: `console`, `system`	Konzola vrátí kontejner stdout/stderr, systém vrátí stream událostí aplikace kontejneru. výchozí nastavení konzoly
replica_name	dotaz	Ne	řetězec	Pokud tento parametr vynecháte, server zvolí první repliku pro protokoly konzoly. Vyžaduje se pro cílení na konkrétní repliku.
ocas	dotaz	Ne	integer	Počet vrácených koncových řádků Vynuceno na 1–300. Výchozí hodnota 20
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – spuštění kontejneru agenta

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

Spusťte kontejner pro konkrétní verzi agenta. Pokud kontejner již běží, operace bude 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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	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	Typ	Description
application/json	AgentContainerOperationObject

Hlavičky odpovědi:

Záhlaví	Typ	Description
Umístění operace	řetězec

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – zastavení kontejneru agenta

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

Zastavte kontejner pro konkrétní verzi agenta. Pokud kontejner neběží nebo je již zastaven, operace bude 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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 202

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

Typ obsahu	Typ	Description
application/json	AgentContainerOperationObject

Hlavičky odpovědi:

Záhlaví	Typ	Description
Umístění operace	řetězec

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Kontejnery agentů – kontejner agenta aktualizace

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

Aktualizujte kontejner pro konkrétní verzi agenta. Pokud kontejner neběží, operace bude 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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
agent_name	cesta	Ano	řetězec	Název agenta.
agent_version	cesta	Ano	řetězec	Verze agenta.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `ContainerAgents=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	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	Typ	Description
application/json	AgentContainerOperationObject

Hlavičky odpovědi:

Záhlaví	Typ	Description
Umístění operace	řetězec

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Connections

Připojení – seznam

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
connectionType	dotaz	Ne	řetězec Možné hodnoty: `AzureOpenAI`, `AzureBlob`, `AzureStorageAccount`, , `CognitiveSearch`, `CosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool_Preview`	Výpis připojení tohoto konkrétního typu
defaultConnection	dotaz	Ne	boolean	Zobrazení seznamu připojení, která jsou výchozími připojeními

Hlavička požadavku

Name	Povinné	Typ	Description
x-ms-client-request-id	Nepravda	řetězec	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedConnection

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-client-request-id		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Připojení – get

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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.

Hlavička požadavku

Name	Povinné	Typ	Description
x-ms-client-request-id	Nepravda	řetězec	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Připojení

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-client-request-id		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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.

Hlavička požadavku

Name	Povinné	Typ	Description
x-ms-client-request-id	Nepravda	řetězec	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Připojení

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-client-request-id		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Datasets

Datové sady – seznam nejnovějších

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedDatasetVersion

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Datové sady – verze seznamu

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

Výpis všech verzí dané datové sady DatasetVersion

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedDatasetVersion

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Datové sady – získání verze

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

Získejte konkrétní verzi Datové sady. Služba vrátí chybu 404 Nenalezena, pokud datasetVersion neexistuje.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 Datové sady, která se má načíst.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DatasetVersion

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Datové sady – odstranění verze

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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.

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	Typ	Description
application/json	Azure. Core.Foundations.ErrorResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Datové sady – vytvoření nebo aktualizace verze

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 datové sady DatasetVersion pro vytvoření nebo aktualizaci.

Tělo žádosti

Typ obsahu: aplikace/merge-patch+json

Name	Typ	Description	Povinné
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	DatasetType	Výčet určující typ dat.	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	DatasetVersion

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

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

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

Získejte přihlašovací údaje SAS pro přístup k účtu úložiště přidruženému k verzi datové sady.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 datové sady DatasetVersion, na které se má pracovat.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	AssetCredentialResponse

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 datové sady DatasetVersion, na které se má pracovat.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
connectionName	řetězec	Název připojení účtu služby Azure Storage, který se má použít pro generová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	Typ	Description
application/json	PendingUploadResponse

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Nasazení

Nasazení – seznam

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

Zobrazení seznamu všech nasazených modelů v projektu

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
modelPublisher	dotaz	Ne	řetězec	Vydavatel modelů pro filtrování modelů podle
modelName	dotaz	Ne	řetězec	Název modelu (název konkrétního vydavatele) pro filtrování modelů podle
deploymentType	dotaz	Ne	řetězec Možné hodnoty: `ModelDeployment`	Typ nasazení pro filtrování seznamu podle

Hlavička požadavku

Name	Povinné	Typ	Description
x-ms-client-request-id	Nepravda	řetězec	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedDeployment

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-client-request-id		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Nasazení – get

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

Získejte nasazený model.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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í

Hlavička požadavku

Name	Povinné	Typ	Description
x-ms-client-request-id	Nepravda	řetězec	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Nasazení

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-client-request-id		Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Taxonomie vyhodnocení

Taxonomie vyhodnocení – seznam

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

Výpis taxonomií vyhodnocení

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
inputName	dotaz	Ne	řetězec	Vyfiltrujte podle názvu vstupu vyhodnocení.
inputType	dotaz	Ne	řetězec	Filtrujte podle typu vstupu taxonomie.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedEvaluationTaxonomy

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Taxonomie vyhodnocení – get

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	EvaluationTaxonomy

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Taxonomie vyhodnocení – odstranění

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

Odstraňte zkušební taxonomii podle názvu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

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	Typ	Description
application/json	Azure. Core.Foundations.ErrorResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Zkušební taxonomie – vytvoření

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

Vytvořte zkušební taxonomii.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
popis	řetězec	Text popisu prostředku.	Ne
properties	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 TaxonomyCategory	Seznam kategorií taxonomie	Ne
taxonomyInput	EvaluationTaxonomyInput	Konfigurace vstupu pro taxonomii vyhodnocení.	Ano
└- typ	EvaluationTaxonomyInputType	Vstupní typ vyhodnocovací taxonomie	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	EvaluationTaxonomy

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Taxonomie vyhodnocení – aktualizace

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

Aktualizujte zkušební taxonomii.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
popis	řetězec	Text popisu prostředku.	Ne
properties	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 TaxonomyCategory	Seznam kategorií taxonomie	Ne
taxonomyInput	EvaluationTaxonomyInputUpdate	Konfigurace vstupu pro taxonomii vyhodnocení.	Ne
└- typ	EvaluationTaxonomyInputType	Vstupní typ vyhodnocovací taxonomie	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	EvaluationTaxonomy

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Pravidla vyhodnocení

Pravidla vyhodnocení – seznam

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

Zobrazí seznam všech pravidel vyhodnocení.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
actionType	dotaz	Ne	řetězec Možné hodnoty: `continuousEvaluation`, `humanEvaluationPreview`	Filtrujte podle typu pravidla vyhodnocení.
jméno agenta	dotaz	Ne	řetězec	Filtrujte podle názvu agenta.
enabled	dotaz	Ne	boolean	Vyfiltrujte podle povoleného stavu.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedEvaluationRule

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Pravidla vyhodnocení – get

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

Získejte pravidlo vyhodnocení.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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í.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Vyhodnocení pravidla

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Zkušební pravidla – odstranění

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

Odstraňte pravidlo vyhodnocení.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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í.

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	Typ	Description
application/json	Azure. Core.Foundations.ErrorResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Pravidla vyhodnocení – vytvoření nebo aktualizace

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

Vytvoření nebo aktualizace zkušebního pravidla

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Nepravda	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
akce	EvaluationRuleAction	Akční model vyhodnocení.	Ano
└- typ	EvaluationRuleActionType	Typ vyhodnocovací akce.	Ano
popis	řetězec	Popis pravidla vyhodnocení	Ne
displayName	řetězec	Zobrazovaný název pravidla vyhodnocení.	Ne
enabled	boolean	Určuje, jestli je pravidlo vyhodnocení povolené. Výchozí hodnota je `true`.	Ano
eventType	EvaluationRuleEventType	Typ události pravidla vyhodnocení.	Ano
filtr	EvaluationRuleFilter	Model filtru vyhodnocení.	Ne
└agentName	řetězec	Filtrovat podle názvu agenta	Ano
id	string (jen pro čtení)	Jedinečný identifikátor pravidla vyhodnocení.	Ano
systémová data	object (jen pro čtení)	Systémová metadata pro pravidlo vyhodnocení.	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	Vyhodnocení pravidla

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Hodnotitelé

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
typ	dotaz	Ne	řetězec Možné hodnoty: `builtin`, `custom`, `all`	Vyhodnocovače filtru 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedEvaluatorVersion

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Vyhodnocovače – verze seznamu

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

Vypište všechny verze daného hodnotitele

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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	řetězec Možné hodnoty: `builtin`, `custom`, `all`	Vyhodnocovače filtru 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedEvaluatorVersion

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Vyhodnocovače – vytvoření verze

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
categories	pole EvaluatorCategory	Kategorie hodnotitele	Ano
definice	VyhodnoceníDefinition	Základní konfigurace vyhodnocovače s diskriminátorem	Ano
└data_schema	objekt	Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└init_parameters	objekt	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	Ano
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít hodnotitele v AI Foundry. Nemusí být jedinečné.	Ne
evaluator_type	Vyhodnocovací typ	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	Typ	Description
application/json	Vyhodnocovací verze

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Vyhodnocovače – získání verze

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Vyhodnocovací verze

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Vyhodnocovače – odstranění verze

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

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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

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	Typ	Description
application/json	Azure. Core.Foundations.ErrorResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Vyhodnocovače – verze aktualizace

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Evaluations=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
categories	pole EvaluatorCategory	Kategorie hodnotitele	Ne
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít hodnotitele v AI 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	Typ	Description
application/json	Vyhodnocovací verze

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Indexes

Indexy – seznam nejnovějších

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

Výpis nejnovější verze jednotlivých indexů

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedIndex

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Indexy – výpis verzí

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

Výpis všech verzí daného indexu

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedIndex

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Indexy – získání verze

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

Získejte konkrétní verzi indexu. Pokud index neexistuje, vrátí služba chybu 404 Nenalezena.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Index

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Indexy – odstranění verze

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

Odstraňte konkrétní verzi indexu. Služba vrátí hodnotu 204 Bez obsahu, pokud byl index úspěšně odstraněn nebo pokud index neexistuje.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 indexu, která se má odstranit.

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	Typ	Description
application/json	Azure. Core.Foundations.ErrorResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Indexy – vytvoření nebo aktualizace verze

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

Vytvoření nového nebo aktualizace existujícího indexu s použitím daného ID verze

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 pro vytvoření nebo aktualizaci.

Tělo žádosti

Typ obsahu: aplikace/merge-patch+json

Name	Typ	Description	Povinné
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	Typ indexu		Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	Index

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Insights

Přehledy – generování

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

Generování přehledů

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Insights=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.
Opakovatelnost –Request-ID	Nepravda	ř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	Nepravda	ř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.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
displayName	řetězec	Uživatelsky přívětivý zobrazovaný název přehledu	Ano
id	string (jen pro čtení)	Jedinečný identifikátor sestavy přehledů.	Ano
metadata	InsightsMetadata (jen pro čtení)	Metadata o poznatcích.	Ano
└- completedAt	řetězec	Časové razítko po dokončení přehledů	Ne
└createdAt	řetězec	Časové razítko při vytvoření přehledů	Ano
žádost	InsightRequest	Žádost o zprávu o přehledech.	Ano
└- typ	InsightType	Typ požadavku.	Ano
result	InsightResult (jen pro čtení)	Výsledek poznatků.	Ne
└- typ	InsightType	Typ výsledku přehledů	Ano
stav	Azure. Core.Foundations.OperationState (jen pro čtení)	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	Typ	Description
application/json	Pohled

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Přehledy – seznam

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

Výpis všech přehledů v obráceném chronologickém pořadí (nejnovější jako první)

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
typ	dotaz	Ne	řetězec Možné hodnoty: `EvaluationRunClusterInsight`, `AgentClusterInsight`, `EvaluationComparison`	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“.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Insights=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedInsight

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Přehledy – získání

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

Získejte konkrétní přehled podle ID.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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 sestavy přehledů.
includeCoordinates	dotaz	Ne	boolean	Zda se mají do odpovědi zahrnout souřadnice pro vizualizaci. Výchozí nastavení je „false“.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Insights=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Pohled

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Úložiště paměti

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
definice	MemoryStoreDefinition	Základní definice pro konfigurace paměťových úložišť.	Ano
└kind	MemoryStoreKind	Druh úložiště paměti.	Ano
popis	řetězec	Popis úložiště paměti čitelný člověkem. Omezení: maxLength: 512	Ne
metadata	objekt	Metadata libovolné hodnoty klíče, která se mají přidružit k úložišti paměti.	Ne
název	řetězec	Název úložiště paměti. Omezení: maxLength: 256	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	MemoryStoreObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Aktualizace úložiště paměti

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti, které chcete aktualizovat.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
popis	řetězec	Popis úložiště paměti čitelný člověkem. Omezení: maxLength: 512	Ne
metadata	objekt	Metadata libovolné hodnoty klíče, 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	Typ	Description
application/json	MemoryStoreObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti, které se má načíst.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	MemoryStoreObject

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti, které chcete odstranit.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DeleteMemoryStoreResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Získání výsledku aktualizace

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti.
update_id	cesta	Ano	řetězec	ID operace aktualizace paměti.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	MemoryStoreUpdateResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Odstranění pamětí oboru

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	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	Typ	Description
application/json	MemoryStoreDeleteScopeResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Hledat vzpomínky

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti, které se má prohledávat.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
items	pole OpenAI.InputItem	Položky, pro které chcete vyhledat relevantní vzpomínky.	Ne
options	MemorySearchOptions	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í žádosti o vyhledávání, které umožňuje přírůstkové vyhledávání v paměti, ze kterého poslední operace skončila.	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	Typ	Description
application/json	MemoryStoreSearchResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Aktualizace pamětí

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
název	cesta	Ano	řetězec	Název úložiště paměti, které chcete aktualizovat.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `MemoryStores=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
items	pole OpenAI.InputItem	Položky konverzace, ze kterých se mají 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, ze kterých 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	Doba časového limitu před zpracováním aktualizace paměti v sekundách. Pokud se během tohoto období obdrží nová žádost o aktualizaci, zruší aktuální požadavek a resetuje časový limit. Nastavte na hodnotu 0, aby se aktualizace okamžitě aktivovala bez zpoždění. 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	Typ	Description
application/json	MemoryStoreUpdateResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
Umístění operace	řetězec	Umístění pro monitorování stavu operace.

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Konverzace

Vytvoření konverzace

POST {endpoint}/openai/v1/conversations

Vytvořte konverzaci.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
items	pole OpenAI.InputItem		Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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	Typ	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Vypsání konverzací

GET {endpoint}/openai/v1/conversations

Vrátí seznam všech konverzací.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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	Filtrovat 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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Aktualizace konverzace

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

Aktualizujte konverzaci.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
conversation_id	cesta	Ano	řetězec	ID konverzace, která se má aktualizovat.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
metadata	OpenAI.Metadata (s možnou hodnotou null)	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

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Získání konverzace

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

Načte konverzaci.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
conversation_id	cesta	Ano	řetězec	ID konverzace, která se má načíst.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Odstranění konverzace

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

Odstraní konverzaci.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
conversation_id	cesta	Ano	řetězec	ID konverzace, která se má odstranit.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.DeletedConversationResource

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Vytváření položek konverzace

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
conversation_id	cesta	Ano	řetězec	ID konverzace, na které se má položka vytvořit.
Zahrnout	dotaz	Ne	pole	Další pole, která se mají zahrnout do odpovědi. Další informace najdete v parametru `include` pro výpis položek konverzace.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
items	pole OpenAI.Item	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	Typ	Description
application/json	OpenAI.ConversationItemList

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Výpis položek konverzace

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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	řetězec Možné hodnoty: `message`, `output_message`, , `file_search_call`, `computer_callcomputer_call_output`, `web_search_callfunction_callfunction_call_outputreasoning`, , `compactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action`	Filtrovat podle typu položky Pokud je zadáno, vrátí se pouze položky zadaného typu.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Získání položky konverzace

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.OutputItem

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Odstranit položku konverzace

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.ConversationResource

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Evals

Hodnocení – hodnocení seznamu

GET {endpoint}/openai/v1/evals

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
Po	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
limit	dotaz	Ne	integer	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žijte `created_at` pro čas vytvoření nebo `updated_at` pro čas poslední aktualizace.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

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

POST {endpoint}/openai/v1/evals

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

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
konfigurace_zdroj_dat	OpenAI.CreateEvalCustomDataSourceConfig nebo OpenAI.CreateEvalLogsDataSourceConfig nebo OpenAI.CreateEvalStoredCompletionsDataSourceConfig nebo AzureAIDataSourceConfig	Konfigurace zdroje dat používaného pro vyhodnocení se spustí. Určuje schéma dat použitých při vyhodnocení.	Ano
metadata	OpenAI.Metadata (s možnou hodnotou null)	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
properties	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 OpenAI.EvalGraderLabelModel nebo OpenAI.EvalGraderStringCheck nebo OpenAI.EvalGraderTextSimilarity nebo OpenAI.EvalGraderPython nebo OpenAI.EvalGraderScoreModel nebo EvalGraderAzureAIEvaluator	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	Typ	Description
application/json	Eval

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Evals – delete eval

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
eval_id	cesta	Ano	řetězec	ID vyhodnocení, které chcete odstranit.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DeleteEvalResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Hodnocení – získejte hodnocení

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
eval_id	cesta	Ano	řetězec	ID vyhodnocení, které se má načíst.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Eval

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Evals – update eval

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
eval_id	cesta	Ano	řetězec	ID vyhodnocení, které se má aktualizovat.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
metadata	OpenAI.Metadata (s možnou hodnotou null)	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
properties	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	Typ	Description
application/json	Eval

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Evals – spuštění seznamu

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
eval_id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
Po	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
limit	dotaz	Ne	integer	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`.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
eval_id	cesta	Ano	řetězec	ID vyhodnocení, pro které se má vytvořit běh.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
zdroj dat	OpenAI.CreateEvalJsonlRunDataSource nebo OpenAI.CreateEvalCompletionsRunDataSource nebo OpenAI.CreateEvalResponsesRunDataSource nebo EvalRunDataSource	Podrobnosti o zdroji dat spuštění	Ano
metadata	OpenAI.Metadata (s možnou hodnotou null)	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
properties	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	Typ	Description
application/json	EvalRun

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DeleteEvalRunResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Evals – get eval run

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	EvalRun

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	EvalRun

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
eval_id	cesta	Ano	řetězec
run_id	cesta	Ano	řetězec	ID spuštění pro načtení výstupních položek.
Po	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
limit	dotaz	Ne	integer	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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

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

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

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

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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.
identifikátor_výstupní_položky	cesta	Ano	řetězec	ID výstupní položky, která se má načíst.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	EvalRunOutputItem

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Fine-Tuning

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

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

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

Odpověď obsahuje podrobnosti o zařazené úloze včetně stavu úlohy a názvy dokončených jemně vyladěných modelů.

Další informace o vyladění

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
hyperparametry	OpenAI.CreateFineTuningJobRequestHyperparameters		Ne
└ batch_size	string nebo OpenAI.integer		Ne	auto
└─learning_rate_multiplier	string nebo OpenAI.numeric		Ne
└ n_epochs	string nebo OpenAI.integer		Ne	auto
integrace	pole OpenAI.CreateFineTuningJobRequestIntegrations	Seznam integrací, které lze povolit pro úlohu doladění.	Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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á doladit. Můžete vybrat jednu z možností podporované modely.	Ano
seed	OpenAI.integer (nullable)		Ne
Přípona	řetězec (s možnou hodnotou null)	Řetězec o velikosti až 64 znaků, který bude přidán k optimalizovanému názvu modelu. Například "`suffix` custom-model-name" vytvoří název modelu jako `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Omezení: minLength: 1, maxLength: 64	Ne
tréninkový soubor	řetězec	ID nahraného souboru, který obsahuje trénovací data. Jak nahrát soubor najdete v části nahrání souboru. 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 vyladěním .	Ano
validační_soubor	řetězec (s možnou hodnotou null)	ID nahraného souboru, který obsahuje ověřovací data. Pokud tento soubor zadáte, data se použijí k vygenerování ověření. Metriky jsou zaznamenávány pravidelně během dolaďování. Tyto metriky je možné zobrazit v soubor s výsledky jemného ladění. Stejná data by se neměla nacházet v trénovacích a ověřovacích souborech. Datová sada musí být naformátovaná jako soubor JSONL. Musíte soubor nahrát s tímto účelem `fine-tune`. Další podrobnosti najdete v průvodci vyladěním .	Ne

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

Vypracujte seznam úloh organizace pro jemné doladění.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
Po	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í k načtení.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

Získejte informace o procesu jemného doladění.

Další informace o vyladění

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy doladění.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění, kterou chcete zrušit.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění pro získání kontrolních bodů.
Po	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ů k načtení
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného doladění k získání událostí.
Po	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
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Pozastavení úlohy jemného ladění

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

Pozastavte spuštěnou úlohu vyladit.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění, které se má pozastavit.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Obnovení úlohy jemného ladění

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

Obnovte pozastavenou úlohu doladění.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
identifikátor_fine_tuning_jobu	cesta	Ano	řetězec	ID úlohy jemného ladění, která se má obnovit.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.FineTuningJob

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Responses

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

POST {endpoint}/openai/v1/responses

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

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
na pozadí	logická hodnota (s možnou hodnotou null)		Ne
konverzace	OpenAI.ConversationParam (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Položky z této konverzace jsou předem připravené pro `input_items` tuto žádost o odpověď. Po dokončení této odpovědi se do této konverzace automaticky přidají vstupní položky a výstupní položky z této odpovědi.	Ne
Zahrnout	pole OpenAI.IncludeEnum		Ne
vstup	OpenAI.InputParam	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 obrázků - Vstupy souborů - Stav konverzace - Volání funkcí	Ne
Pokyny	řetězec (s možnou hodnotou null)		Ne
max_output_tokens	OpenAI.integer (nullable)		Ne
maximální počet volání nástroje	OpenAI.integer (nullable)		Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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ů	logická hodnota (s možnou hodnotou null)		Ne	Pravdivé
previous_response_id	řetězec (s možnou hodnotou null)		Ne
požádat	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
reasoning	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└– úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
└─ vytvořit_shrnutí	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne
└─ souhrn	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne
safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
úroveň služby	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. – Pokud není nastaveno, 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.	Ne
uložit	logická hodnota (s možnou hodnotou null)		Ne	Pravdivé
datový proud	logická hodnota (s možnou hodnotou null)		Ne
stream_options	OpenAI.ResponseStreamOptions (s možnou hodnotou null)	Možnosti pro streamované odpovědi Toto nastavení nastavíte pouze při nastavení `stream: true`.	Ne
└include_obfuscation	boolean	Pokud ano, povolí se obfuskace streamu. Přidání obfuskace streamu náhodné znaky do `obfuscation` pole u událostí rozdílového streamování do normalizuje velikosti datových částí jako zmírnění určitých útoků na straně kanálu. Tato pole obfuskace jsou ve výchozím nastavení zahrnuta, ale přidají malou částku. režijních nákladů na datový stream. Můžete nastavit `include_obfuscation` na false pro optimalizaci šířky pásma, pokud důvěřujete síťovým propojením mezi aplikace a rozhraní OpenAI API.	Ne
structured_inputs	objekt	Strukturované vstupy odpovědi, které se mohou účastnit nahrazení šablony výzvy nebo vazby argumentů nástroje.	Ne
Teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
poslat SMS	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
tool_choice	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
tools	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
top_logprobs	OpenAI.integer (nullable)		Ne
top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
truncation	výčet	Možné hodnoty: `auto`, `disabled`	Ne
uživatel	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne

Responses

Stavový kód: 200

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

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

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Výpis odpovědí

GET {endpoint}/openai/v1/responses

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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	Filtrovat 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í.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Kompaktní konverzace odpovědí

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

Vytvoří komprimace konverzace odpovědí.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
vstup	řetězec nebo pole OpenAI.InputItem		Ne
Pokyny	řetězec (s možnou hodnotou null)		Ne
model	OpenAI.ModelIdsCompaction	ID modelu použité k vygenerování odpovědi, například `gpt-5` nebo `o3`. OpenAI nabízí širokou škálu modelů s různými možnostmi, charakteristikami výkonu a cenovými body. Projděte si průvodce modelem a projděte si dostupné modely a porovnejte je.	Ano
previous_response_id	řetězec (s možnou hodnotou null)		Ne

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.CompactResource

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

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

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
response_id	cesta	Ano	řetězec
include[]	dotaz	Ne	pole
datový proud	dotaz	Ne	boolean
starting_after	dotaz	Ne	integer

Hlavička požadavku

Name	Povinné	Typ	Description
přijmout	Nepravda	řetězec Možné hodnoty: `text/event-stream`

Responses

Stavový kód: 200

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

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

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Odstranit odpověď

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

Odstraní odpověď modelu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
response_id	cesta	Ano	řetězec	ID odpovědi, která se má odstranit.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	DeleteResponseResult

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Zrušit odpověď

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

Zruší odpověď modelu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
response_id	cesta	Ano	řetězec	ID odpovědi, která se má zrušit.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	OpenAI.Response

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Výpis vstupních položek

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
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í a`desc` pro sestupné pořadí.
Po	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.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	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	Typ	Description
application/json	ApiErrorResponse

Redteams

Redteams – seznam

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

Vytvořte seznam redteamu podle názvu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `RedTeams=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedRedTeam

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Redteams – získat

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

Získejte redteam podle názvu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
název	cesta	Ano	řetězec	Identifikátor červeného týmu.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `RedTeams=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	RedTeam

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Redteams – vytvoření

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

Vytvoří spuštění redteamu.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `RedTeams=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné	Výchozí
applicationScenario	řetězec	Scénář aplikace pro červenou operaci týmu za účelem generování konkrétních scénářů útoků	Ne
attackStrategies	pole AttackStrategy	Seznam strategií útoku nebo vnořených seznamů strategií útoku	Ne
displayName	řetězec	Název červeného týmu.	Ne
id	string (jen pro čtení)	Identifikátor červeného týmu.	Ano
numTurns	integer	Počet zaokrouhlených simulací	Ne
properties	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 Rizikové kategorie	Seznam kategorií rizik pro generování cílů útoku	Ne
simulaceOnly	boolean	Pouze simulace nebo Simulace + Vyhodnocení. Výchozí nepravda, pokud je pravda, že se ve výstupu kontroly nevyhodnocuje výsledek vyhodnocení.	Ne	Nepravda
stav	string (jen pro čtení)	Stav červeného týmu Nastavuje se podle služby a je jen pro čtení.	Ne
tags	objekt	Červené značky týmu. Na rozdíl od vlastností jsou značky plně proměnlivé.	Ne
cíl	TargetConfig	Abstraktní třída pro cílovou konfiguraci.	Ano
└- typ	řetězec	Typ konfigurace modelu	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	Typ	Description
application/json	RedTeam

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Rozvrhy

Plány – seznam

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

Zobrazí seznam všech plánů.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.
typ	dotaz	Ne	řetězec Možné hodnoty: `Evaluation`, `Insight`	Filtrujte podle typu plánu.
enabled	dotaz	Ne	boolean	Vyfiltrujte podle povoleného stavu.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Schedules=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedSchedule

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Plány – odstranění

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

Smazat plán.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Schedules=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

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	Typ	Description
application/json	Azure. Core.Foundations.ErrorResponse

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Plány – získání

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

Získejte plán podle ID.

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Schedules=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Schedule

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Plány – vytvoření nebo aktualizace

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

Vytvoření nebo aktualizace šablony operace

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Schedules=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Tělo žádosti

Typ obsahu: application/json

Name	Typ	Description	Povinné
popis	řetězec	Popis plánu	Ne
displayName	řetězec	Název plánu	Ne
enabled	boolean	Povolený stav plánu	Ano
id	string (jen pro čtení)	Identifikátor plánu.	Ano
properties	objekt	Vlastnosti plánu Na rozdíl od značek jsou vlastnosti pouze doplňky. Po přidání nelze odebrat vlastnost.	Ne
provisioningStatus	ScheduleProvisioningStatus (jen pro čtení)	Naplánujte si stav zřizování.	Ne
systémová data	object (jen pro čtení)	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	ScheduleTask	Naplánujte model úlohy.	Ano
Konfigurace └•	objekt	Konfigurace pro úlohu	Ne
└- typ	ScheduleTaskType	Typ úkolu	Ano
aktivační událost	Spouštěč	Základní model pro Trigger plánu.	Ano
└- typ	Typ spouště	Typ spouštěče.	Ano

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	Schedule

Stavový kód: 201

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

Typ obsahu	Typ	Description
application/json	Schedule

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Plány – spuštění seznamu

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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 rozhraní 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.
typ	dotaz	Ne	řetězec Možné hodnoty: `Evaluation`, `Insight`	Filtrujte podle typu plánu.
enabled	dotaz	Ne	boolean	Vyfiltrujte podle povoleného stavu.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Schedules=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	PagedScheduleRun

Stavový kód: výchozí

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

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

Hlavičky odpovědi:

Záhlaví	Typ	Description
x-ms-error-code	řetězec	Kód chyby řetězce označující, co se nepovedlo.

Plány – spuštění

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

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

Parametry identifikátoru URI

Name	In	Povinné	Typ	Description
koncový bod	cesta	Ano	řetězec	Foundry Project koncový bod ve formuláři "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{název_projektu}". 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"
schedule_id	cesta	Ano	řetězec	Jedinečný identifikátor plánu.
run_id	cesta	Ano	řetězec	Jedinečný identifikátor spuštění plánu.
verze rozhraní API	dotaz	Ano	řetězec	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Povinné	Typ	Description
Foundry-Features	Pravdivé	řetězec Možné hodnoty: `Schedules=V1Preview`	Při použití operací verze Preview nebo úpravě trvalých prostředků ve verzi Preview se vyžaduje příznak funkce.

Responses

Stavový kód: 200

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

Typ obsahu	Typ	Description
application/json	ScheduleRun

Stavový kód: výchozí

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

Typ obsahu	Typ	Description
application/json	ApiErrorResponse

Components

A2APreviewTool

Agent implementující protokol A2A.

Name	Typ	Description	Povinné
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_preview`. Možné hodnoty: `a2a_preview`	Ano

AISearchIndexResource

Zdroj indexu vyhledávání AI.

Name	Typ	Description	Povinné
filtr	řetězec	filtrovací řetězec pro vyhledávací prostředek. Další informace najdete tady.	Ne
index_asset_id	řetězec	ID assetu 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 agentu.	Ne
druh_dotazu	AzureAISearchQueryType	Dostupné typy dotazů pro nástroj Azure AI Vyhledávač.	Ne
top_k	integer	Počet dokumentů, které se mají načíst z hledání a prezentace modelu	Ne

AgentClusterInsightRequest

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

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

AgentClusterInsightResult

Poznatky z analýzy shluku agentů.

Name	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

AgentContainerObject

Podrobnosti o kontejneru konkrétní verze agenta

Name	Typ	Description	Povinné
kontejner	ContainerDetails (jen pro čtení)	Podrobné informace o kontejneru	Ne
└health_state	řetězec	Stav kontejneru.	Ano
└provisioning_error	řetězec	Chyba zřizování kontejneru, pokud existuje.	Ne
└provisioning_state	řetězec	Stav zřizování kontejneru.	Ano
└- repliky	pole ContainerReplica	Seznam replik v kontejneru	Ano
└stavy	řetězec	Stav kontejneru.	Ano
└updated_on	řetězec	Čas poslední aktualizace kontejneru.	Ano
datum_vytvoření	řetězec	Čas vytvoření kontejneru.	Ano
Error_message	string (jen pro čtení)	Chybová zpráva, pokud se kontejneru nepodařilo pracovat, pokud existuje.	Ne
id	string (jen pro čtení)	Identifikátor kontejneru.	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	AgentContainerStatus (jen pro čtení)	Stav kontejneru konkrétní verze agenta	Ano
updated_at	řetězec	Čas poslední aktualizace kontejneru.	Ano

AgentContainerOperationError

Podrobnosti o chybě operace kontejneru( pokud existuje).

Name	Typ	Description	Povinné
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.

Name	Typ	Description	Povinné
agent_id	řetězec	ID agenta.	Ano
agent_version_id	řetězec	ID verze agenta.	Ano
kontejner	AgentContainerObject	Podrobnosti o kontejneru konkrétní verze agenta	Ne
└- kontejner	ContainerDetails (jen pro čtení)	Podrobné informace o kontejneru.	Ne
└ created_at	string (jen pro čtení)	Čas vytvoření kontejneru.	Ano
└error_message	string (jen pro čtení)	Chybová zpráva, pokud se kontejneru nepodařilo pracovat, pokud existuje.	Ne
└─ id	string (jen pro čtení)	Identifikátor kontejneru.	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	AgentContainerStatus (jen pro čtení)	Stav kontejneru konkrétní verze agenta	Ano
└updated_at	string (jen pro čtení)	Čas poslední aktualizace kontejneru.	Ano
chyba	AgentContainerOperationError	Podrobnosti o chybě operace kontejneru( pokud existuje).	Ne
└ 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
id	řetězec	ID operace kontejneru. Toto ID je jedinečný identifikátor v systému.	Ano
stav	AgentContainerOperationStatus	Stav operace kontejneru pro konkrétní verzi agenta	Ano

AgentContainerOperationStatus

Stav operace kontejneru pro konkrétní verzi agenta

Property	Value
Typ	řetězec
Hodnoty	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

Stav kontejneru konkrétní verze agenta

Property	Value
Typ	ř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
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

Name	Typ	Description	Povinné
kind	AgentKind		Ano
rai_config	RaiConfig	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.	Ano

AgentKind

Property	Value
Typ	řetězec
Hodnoty	`prompt` `hosted` `container_app` `workflow`

AgentObject

Name	Typ	Description	Povinné
id	řetězec	Jedinečný identifikátor agenta.	Ano
název	řetězec	Název agenta. Omezení: maxLength: 63	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		Ano

AgentProtocol

Property	Value
Typ	řetězec
Hodnoty	`activity_protocol` `responses`

AgentReference

Name	Typ	Description	Povinné
název	řetězec	Název agenta. Omezení: maxLength: 256	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.

Name	Typ	Description	Povinné
riskCategories	pole Rizikové kategorie	Seznam kategorií rizik, které se mají vyhodnotit.	Ano
cíl	Cíl	Základní třída pro cíle s podporou diskriminátoru.	Ano
└- typ	řetězec	Typ cíle.	Ano
typ	výčet	Vstupní typ vyhodnocovací taxonomie Možné hodnoty: `agent`	Ano

AgentTaxonomyInputUpdate

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

Name	Typ	Description	Povinné
riskCategories	pole Rizikové kategorie	Seznam kategorií rizik, které se mají vyhodnotit.	Ne
cíl	TargetUpdate	Základní třída pro cíle s podporou diskriminátoru.	Ne
└- typ	řetězec	Typ cíle.	Ano
typ	výčet	Vstupní typ vyhodnocovací taxonomie Možné hodnoty: `agent`	Ano

AgentVersionObject

Name	Typ	Description	Povinné
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. Omezení: maxLength: 512	Ne
id	řetězec	Jedinečný identifikátor verze agenta.	Ano
metadata	objekt (nullable)	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. Omezení: maxLength: 256	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

AgenticIdentityPreviewCredentials

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

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: `AgenticIdentityToken_Preview`	Ano

ApiErrorResponse

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

Name	Typ	Description	Povinné	Výchozí
chyba	OpenAI.Error		Ano

ApiKeyCredentials

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

Name	Typ	Description	Povinné	Výchozí
klíč	string (jen pro čtení)	Klíč 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ě

Name	Typ	Description	Povinné
blobReference	BlobReference	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`	Ano
└- přihlašovací údaje	SasCredential	Informace o přihlašovacích údajích pro přístup k účtu úložiště	Ano
└- storageAccountArmId	řetězec	ID ARM účtu úložiště, které se má použít.	Ano

ID majetku

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

Typ: řetězec

AttackStrategy

Strategie pro útoky.

Property	Value
Description	Strategie pro útoky.
Typ	řetězec
Hodnoty	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure. Core.Foundations.Error

Objekt chyby.

Name	Typ	Description	Povinné
kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ano
Podrobnosti	pole Azure. Core.Foundations.Error	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.	Ne
innererror	Azure. Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – 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ě.

Name	Typ	Description	Povinné
chyba	Azure. Core.Foundations.Error	Objekt chyby.	Ano
└ kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ano
└- podrobnosti	pole Azure. Core.Foundations.Error	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.	Ano
└- cíl	řetězec	Cíl chyby.	Ne

Azure. Core.Foundations.InnerError

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

Name	Typ	Description	Povinné
kód	řetězec	Jedna ze serverově definovaných kódů chyb.	Ne
innererror	Azure. Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle Azure REST API – 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í.

Property	Value
Description	Výčet popisující povolené stavy operací.
Typ	ř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 specifikující Azure AI agenta.

Name	Typ	Description	Povinné
název	řetězec	Jedinečný identifikátor agenta Azure AI.	Ano
tool_descriptions	pole ToolDescription	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 specifikující Azure AI agenta.

Name	Typ	Description	Povinné
název	řetězec	Jedinečný identifikátor agenta Azure AI.	Ne
tool_descriptions	pole ToolDescription	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

AzureAIDataSourceConfig

Name	Typ	Description	Povinné
scénář	výčet	Scénář schématu dat Možné hodnoty: `red_team`, `responses`, `traces_preview`, `synthetic_data_gen_preview`	Ano
schéma	objekt	Celkové schéma JSON objektu pro položky zdroje dat spuštění.	Ano
typ	výčet	Typ objektu, který je vždy `azure_ai_source`. Možné hodnoty: `azure_ai_source`	Ano

AzureAIModelTarget

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

Name	Typ	Description	Povinné
model	řetězec	Jedinečný identifikátor modelu Azure AI.	Ne
parametry vzorkování	ModelSamplingParams	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í	Ano
└semeno	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
typ	výčet	Typ cíle, vždy `azure_ai_model`. Možné hodnoty: `azure_ai_model`	Ano

AzureAIModelTargetUpdate

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

Name	Typ	Description	Povinné
model	řetězec	Jedinečný identifikátor modelu Azure AI.	Ne
parametry vzorkování	ModelSamplingParamsUpdate	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

AzureAIResponsesEvalRunDataSource

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

Name	Typ	Description	Povinné
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	ResponseRetrievalItemGenerationParams	Představuje parametry pro generování položek načítání odpovědí.	Ano
└data_mapping	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
└- zdroj	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource	Zdroj, ze kterého se čte obsah JSONL.	Ano
└- typ	výčet	Typ parametrů generování položek, vždy `response_retrieval`. Možné hodnoty: `response_retrieval`	Ano
max_runs_hourly	integer	Maximální povolený počet spuštění vyhodnocení za hodinu.	Ano
typ	výčet	Typ zdroje dat, vždy `azure_ai_responses`. Možné hodnoty: `azure_ai_responses`	Ano

AzureAI Vyhledávací Index

Definice indexu Azure AI Vyhledávač

Name	Typ	Description	Povinné
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	výčet	Typ indexu Možné hodnoty: `AzureSearch`	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

AzureAISearchIndexUpdate

Definice indexu Azure AI Vyhledávač

Name	Typ	Description	Povinné
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	výčet	Typ indexu Možné hodnoty: `AzureSearch`	Ano

AzureAISearchQueryType

Dostupné typy dotazů pro nástroj Azure AI Vyhledávač.

Property	Value
Description	Dostupné typy dotazů pro nástroj Azure AI Vyhledávač.
Typ	řetězec
Hodnoty	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

Vstupní definice informací pro vyhledávací nástroj Azure AI, jak se používá ke konfiguraci agenta.

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

AzureAISearchToolResource

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

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

AzureFunctionBinding

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

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

AzureFunctionDefinition

Definice funkce Azure.

Name	Typ	Description	Povinné
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.	Ano
└– parametry	objekt	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON.	Ano
input_binding	AzureFunctionBinding	Struktura pro zachování názvu fronty a identifikátoru URI storage.	Ano
└storage_queue	AzureFunctionStorageQueue	Fronta úložiště.	Ano
└- typ	výčet	Typ vazby, která je vždy "storage_queue". Možné hodnoty: `storage_queue`	Ano
output_binding	AzureFunctionBinding	Struktura pro zachování názvu fronty a identifikátoru URI storage.	Ano
└storage_queue	AzureFunctionStorageQueue	Fronta úložiště.	Ano
└- typ	výčet	Typ vazby, která je vždy "storage_queue". Možné hodnoty: `storage_queue`	Ano

AzureFunctionStorageQueue

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

Name	Typ	Description	Povinné	Výchozí
queue_name	řetězec	Název fronty úložiště funkcí Azure.	Ano
queue_service_endpoint	řetězec	Identifikátor URI služby fronty Azure Storage umožňuje manipulovat s frontou.	Ano

AzureFunctionTool

Vstupní definice pro Azure Function Tool, jak se používá ke konfiguraci agenta.

Name	Typ	Description	Povinné
azure_function	AzureFunctionDefinition	Definice funkce Azure.	Ano
└– 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.	Ano
└– parametry	objekt	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON.	Ano
└input_binding	AzureFunctionBinding	Vstupní fronta úložiště Trigger služby Queue Storage spustí funkci při přidání zpráv.	Ano
└output_binding	AzureFunctionBinding	Výstupní fronta úložiště Funkce zapíše výstup do této fronty při zpracování vstupních položek.	Ano
typ	výčet	Typ objektu, který je vždy 'browser_automation'. Možné hodnoty: `azure_function`	Ano

AzureOpenAIModelConfiguration

Azure konfiguraci modelu OpenAI. Služba by vybrala verzi rozhraní API pro dotazování modelu.

Name	Typ	Description	Povinné	Výchozí
modelDeploymentName	řetězec	Název nasazení pro model AOAI Příklad: gpt-4o, pokud jsou v AIServices nebo na základě `connection_name/deployment_name` 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_Preview`	AgenticIdentityPreviewCredentials

Name	Typ	Description	Povinné	Výchozí
typ	CredentialType (jen pro čtení)	Typ přihlašovacích údajů používaný připojením	Ano

BingCustomSearchConfiguration

Konfigurace vlastního vyhledávání bing.

Name	Typ	Description	Povinné
count	integer	Počet výsledků hledání, které se mají vrátit v odpovědi rozhraní API Bingu	Ne
freshness	řetězec	Výsledky hledání můžete filtrovat podle konkrétního časového rozsahu. Tady najdete přijaté hodnoty.	Ne
instance_name	řetězec	Název vlastní instance konfigurace zadané ke konfiguraci.	Ano
Trhu	řetězec	Trh, ze kterého pocházejí výsledky.	Ne
project_connection_id	řetězec	Project ID připojení pro zemnění pomocí vyhledávání Bingem	Ano
set_lang	řetězec	Jazyk, který se má použít pro řetězce uživatelského rozhraní při volání rozhraní API Bingu.	Ne

BingCustomSearchPreviewTool

Informace o definici vstupu pro Bing vlastní vyhledávací nástroj, který slouží ke konfiguraci agenta.

Name	Typ	Description	Povinné
bing_custom_search_preview	BingCustomSearchToolParameters	Parametry vlastního vyhledávacího nástroje bing.	Ano
└search_configurations	pole BingCustomSearchConfiguration	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji. Omezení: maxItems: 1	Ano
typ	výčet	Typ objektu, který je vždy 'bing_custom_search_preview'. Možné hodnoty: `bing_custom_search_preview`	Ano

BingCustomSearchToolParameters

Parametry vlastního vyhledávacího nástroje bing.

Name	Typ	Description	Povinné	Výchozí
search_configurations	pole BingCustomSearchConfiguration	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

BingGroundingSearchConfiguration

Konfigurace hledání pro Bing uzemnění

Name	Typ	Description	Povinné
count	integer	Počet výsledků hledání, které se mají vrátit v odpovědi rozhraní API Bingu	Ne
freshness	řetězec	Výsledky hledání můžete filtrovat podle konkrétního časového rozsahu. Tady najdete přijaté hodnoty.	Ne
Trhu	řetězec	Trh, ze kterého pocházejí výsledky.	Ne
project_connection_id	řetězec	Project ID připojení pro zemnění pomocí vyhledávání Bingem	Ano
set_lang	řetězec	Jazyk, který se má použít pro řetězce uživatelského rozhraní při volání rozhraní API Bingu.	Ne

BingGroundingSearchToolParameters

Parametry bing uzemnění vyhledávacího nástroje.

Name	Typ	Description	Povinné	Výchozí
search_configurations	pole BingGroundingSearchConfiguration	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

BingGroundingTool

Informace o definici vstupu pro bing vyhledávací nástroj, který slouží ke konfiguraci agenta.

Name	Typ	Description	Povinné
bing_grounding	BingGroundingSearchToolParameters	Parametry bing uzemnění vyhledávacího nástroje.	Ano
└search_configurations	pole BingGroundingSearchConfiguration	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. Omezení: maxItems: 1	Ano
typ	výčet	Typ objektu, který je vždy "bing_grounding". Možné hodnoty: `bing_grounding`	Ano

BlobReference

Podrobnosti o referenčních informacích o objektech blob.

Name	Typ	Description	Povinné
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	SasCredential	Definice přihlašovacích údajů SAS	Ano
└– sasUri	string (jen pro čtení)	Identifikátor URI SAS	Ano
└- typ	výčet	Typ přihlašovacích údajů Možné hodnoty: `SAS`	Ano
storageAccountArmId	řetězec	ID ARM účtu úložiště, které se má použít.	Ano

BrowserAutomationPreviewTool

Informace o definici vstupu pro nástroj pro automatizaci prohlížeče, který se používá ke konfiguraci agenta.

Name	Typ	Description	Povinné
browser_automation_preview	BrowserAutomationToolParameters	Definice vstupních parametrů pro nástroj pro automatizaci prohlížeče.	Ano
└- připojení	BrowserAutomationToolConnectionParameters	Parametry připojení projektu přidružené k nástroji Automatizace prohlížeče.	Ano
typ	výčet	Typ objektu, který je vždy 'browser_automation_preview'. Možné hodnoty: `browser_automation_preview`	Ano

BrowserAutomationToolConnectionParameters

Definice vstupních parametrů pro připojení používané nástrojem pro automatizaci prohlížeče.

Name	Typ	Description	Povinné	Výchozí
project_connection_id	řetězec	ID připojení projektu k vašemu Azure prostředku Playwright.	Ano

BrowserAutomationToolParameters

Definice vstupních parametrů pro nástroj pro automatizaci prohlížeče.

Name	Typ	Description	Povinné	Výchozí
propojení	BrowserAutomationToolConnectionParameters	Definice vstupních parametrů pro připojení používané nástrojem pro automatizaci prohlížeče.	Ano
└project_connection_id	řetězec	ID připojení projektu k vašemu Azure prostředku Playwright.	Ano

CaptureStructuredOutputsTool

Nástroj pro zachycení strukturovaných výstupů

Name	Typ	Description	Povinné
outputs	StructuredOutputDefinition	Strukturovaný výstup, který může vytvořit agent.	Ano
└- popis	řetězec	Popis výstupu, který se má vygenerovat. Používá se model k určení, kdy se má výstup vygenerovat.	Ano
└– název	řetězec	Název strukturovaného výstupu.	Ano
└- schéma	objekt	Schéma JSON pro strukturovaný výstup.	Ano
└- striktní	logická hodnota (s možnou hodnotou null)	Zda se má vynucovat přísné ověřování. Výchozí `true`.	Ano
typ	výčet	Typ nástroje. Vždy `capture_structured_outputs`. Možné hodnoty: `capture_structured_outputs`	Ano

ChartCoordinate

Souřadnice pro analytický diagram.

Name	Typ	Description	Povinné
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í.

Name	Typ	Description	Povinné
obsah	řetězec	Obsah paměti.	Ano
kind	výčet	Druh položky paměti. Možné hodnoty: `chat_summary`	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

ClusterInsightResult

Postřehy ze shlukové analýzy.

Name	Typ	Description	Povinné
clusters	pole InsightCluster	Seznam clusterů identifikovaných v přehledech	Ano
souřadnice	objekt	Volitelné mapování ID na 2D souřadnice používané uživatelským rozhraním 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	InsightSummary	Shrnutí analýzy shluků chyb.	Ano
Metoda └}	řetězec	Metoda použitá pro clustering	Ano
└- sampleCount	integer	Celkový počet analyzovaných vzorků	Ano
└- uniqueClusterCount	integer	Celkový počet jedinečných clusterů	Ano
└- uniqueSubclusterCount	integer	Celkový počet jedinečných popisků podkluzu	Ano
└─ využití	ClusterTokenUsage	Využití tokenů při analýze clusteringu	Ano

ClusterTokenUsage

Použití tokenu pro clusterovou analýzu

Name	Typ	Description	Povinné
inputTokenUsage	integer	Využití vstupního tokenu	Ano
outputTokenUsage	integer	Využ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

Name	Typ	Description	Povinné
code_text	řetězec	Vložený text kódu pro vyhodnocovač	Ano
data_schema	objekt	Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
init_parameters	objekt	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	výčet	Možné hodnoty: `code`	Ano

CompletionMessageToolCallChunk

Podrobnosti volání nástroje ve zprávě

Name	Typ	Description	Povinné
funkce	FunctionToolCall	Podrobnosti o volání nástroje funkce	Ne
└argumenty	řetězec	Argumenty pro volání funkce, které byly vygenerovány modelem ve formátu JSON.	Ano
└– název	řetězec	Název funkce, kterou volat.	Ano
id	řetězec	ID volání nástroje.	Ano
typ	výčet	Typ volání nástroje, což je vždy "funkce". Možné hodnoty: `function`	Ano

Připojení

Operace odpovědi ze seznamu a získání připojení

Name	Typ	Description	Povinné
přihlašovací údaje	BaseCredentials (jen pro čtení)	Základní třída pro pověření pro připojení	Ano
└- typ	CredentialType (jen pro čtení)	Typ přihlašovacích údajů používaných připojením	Ano
id	string (jen pro čtení)	Jedinečný identifikátor připojení vygenerovaný službou	Ano
isDefault	logická hodnota (jen pro čtení)	Určuje, jestli je připojení označené jako výchozí připojení jeho typu.	Ano
metadata	object (jen pro čtení)	Metadata připojení	Ano
název	string (jen pro čtení)	Popisný název připojení poskytnutý uživatelem.	Ano
cíl	string (jen pro čtení)	Adresa URL připojení, která se má použít pro tuto službu	Ano
typ	ConnectionType (jen pro čtení)	Typ (nebo kategorie) připojení	Ano

Typ připojení

Typ (nebo kategorie) připojení

Property	Value
Description	Typ (nebo kategorie) připojení
Typ	řetězec
Hodnoty	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

Definice agenta aplikace kontejneru.

Name	Typ	Description	Povinné
container_app_resource_id	řetězec	ID prostředku aplikace kontejneru Azure, která je hostitelem tohoto agenta. Není proměnlivé napříč verzemi.	Ano
container_protocol_versions	pole ProtocolVersionRecord	Protokoly, které agent podporuje pro komunikaci příchozího přenosu dat kontejnerů.	Ano
ingress_subdomain_suffix	řetězec	Přípona, která se má použít na subdoménu aplikace při odesílání příchozího přenosu dat do agenta. Může to být popisek (např. ---current), konkrétní revize (např. --0000001) nebo prázdný, pokud chcete použít výchozí koncový bod pro aplikaci kontejneru.	Ano
kind	výčet	Možné hodnoty: `container_app`	Ano
rai_config	RaiConfig	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.	Ano

ContainerDetails

Podrobné informace o kontejneru

Name	Typ	Description	Povinné
health_state	řetězec	Stav kontejneru.	Ano
provisioning_error	řetězec	Chyba zřizování kontejneru, pokud existuje.	Ne
provisioning_state	řetězec	Stav zřizování kontejneru.	Ano
replicas	pole ContainerReplica	Seznam replik v kontejneru	Ano
stav	řetězec	Stav kontejneru.	Ano
updated_on	řetězec	Čas poslední aktualizace kontejneru.	Ano

ContainerLogKind

Typ protokolů, které se mají streamovat z kontejneru.

Property	Value
Typ	řetězec
Hodnoty	`console` `system`

ContainerReplica

Informace o replice kontejneru

Name	Typ	Description	Povinné
container_state	řetězec	Stav kontejneru repliky.	Ano
název	řetězec	Název repliky.	Ano
stav	řetězec	Stav repliky.	Ano

ContinuousEvaluationRuleAction

Akce pravidla vyhodnocení pro průběžné vyhodnocování.

Name	Typ	Description	Povinné
evalId	řetězec	Id vyhodnocení pro přidání průběžných vyhodnocení do.	Ano
maxHourlyRuns	integer	Maximální povolený počet spuštění vyhodnocení za hodinu.	Ne
typ	výčet	Možné hodnoty: `continuousEvaluation`	Ano

CosmosDBIndex

Definice indexu úložiště vektorů CosmosDB

Name	Typ	Description	Povinné
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	výčet	Typ indexu Možné hodnoty: `CosmosDBNoSqlVectorStore`	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

CosmosDBIndexUpdate

Definice indexu úložiště vektorů CosmosDB

Name	Typ	Description	Povinné
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	výčet	Typ indexu Možné hodnoty: `CosmosDBNoSqlVectorStore`	Ano

CreateAgentFromManifestRequest

Name	Typ	Description	Povinné
popis	řetězec	Popis agenta čitelný pro člověka. Omezení: maxLength: 512	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ů. Omezení: maxLength: 63	Ano
parameter_values	objekt	Vstupy manifestu, který bude mít za následek plně materializovaný agent.	Ano

CreateAgentRequest

Name	Typ	Description	Povinné
definice	AgentDefinition		Ano
└kind	AgentKind		Ano
└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. Omezení: maxLength: 512	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ů. Omezení: maxLength: 63	Ano

CreateAgentVersionFromManifestRequest

Name	Typ	Description	Povinné
popis	řetězec	Popis agenta čitelný pro člověka. Omezení: maxLength: 512	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

Name	Typ	Description	Povinné
definice	AgentDefinition		Ano
└kind	AgentKind		Ano
└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. Omezení: maxLength: 512	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í

Name	Typ	Description	Povinné
konfigurace_zdroj_dat	OpenAI.CreateEvalCustomDataSourceConfig nebo OpenAI.CreateEvalLogsDataSourceConfig nebo OpenAI.CreateEvalStoredCompletionsDataSourceConfig nebo AzureAIDataSourceConfig	Konfigurace zdroje dat používaného pro vyhodnocení se spustí. Určuje schéma dat použitých při vyhodnocení.	Ano
metadata	OpenAI.Metadata (s možnou hodnotou null)	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
properties	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 OpenAI.EvalGraderLabelModel nebo OpenAI.EvalGraderStringCheck nebo OpenAI.EvalGraderTextSimilarity nebo OpenAI.EvalGraderPython nebo OpenAI.EvalGraderScoreModel nebo EvalGraderAzureAIEvaluator	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í

Name	Typ	Description	Povinné
zdroj dat	OpenAI.CreateEvalJsonlRunDataSource nebo OpenAI.CreateEvalCompletionsRunDataSource nebo OpenAI.CreateEvalResponsesRunDataSource nebo EvalRunDataSource	Podrobnosti o zdroji dat spuštění	Ano
metadata	OpenAI.Metadata (s možnou hodnotou null)	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
properties	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

CredentialType

Typ přihlašovacích údajů používaný připojením

Property	Value
Description	Typ přihlašovacích údajů používaný připojením
Typ	řetězec
Hodnoty	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

Spouštěč založený na Cronu.

Name	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ů

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: `CustomKeys`	Ano

Tento objekt také přijímá další vlastnosti typu: string

DailyRecurrenceSchedule

Denní plán opakování.

Name	Typ	Description	Povinné	Výchozí
hours	pole celočíselného čísla	Hodiny pro plán opakování	Ano
typ	výčet	Typ denního opakování Možné hodnoty: `Daily`	Ano

DataSourceConfig

Základní třída pro spouštění zdrojů dat s nediskriminační podporou

Diskriminátor pro DataSourceConfig

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

Hodnota typu	Schema

Name	Typ	Description	Povinné	Výchozí
schéma	objekt	Celkové schéma JSON objektu pro položky zdroje dat spuštění.	Ano
typ	řetězec	Diskriminátor typu zdroje dat.	Ano

DatasetType

Výčet určující typ dat.

Property	Value
Description	Výčet určující typ dat.
Typ	ř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

Name	Typ	Description	Povinné
connectionName	řetězec	Název připojení účtu Azure Storage. Požadováno, pokud se před vytvořením datové sady nevolal startPendingUploadVersion.	Ne
dataUri	řetězec	Identifikátor URI dat (příklad) Omezení: minLength: 1, vzor: `[a-zA-Z0-9_]`	Ano
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
isReference	logická hodnota (jen pro čtení)	Označuje, jestli datová sada obsahuje odkaz na úložiště nebo jestli datová sada spravuje samotné úložiště. Pokud je hodnota true, podkladová data se při odstranění verze datové sady neodstraní.	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	DatasetType	Výčet určující typ dat.	Ano
verze	string (jen pro čtení)	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

Name	Typ	Description	Povinné
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	DatasetType	Výčet určující typ dat.	Ano

den v týdnu

Dny v týdnu pro plán opakování.

Property	Value
Description	Dny v týdnu pro plán opakování.
Typ	řetězec
Hodnoty	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Odstraněný objekt agenta

Name	Typ	Description	Povinné
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

Name	Typ	Description	Povinné
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.version.deleted. Možné hodnoty: `agent.version.deleted`	Ano
verze	řetězec	Identifikátor verze agenta.	Ano

DeleteEvalResponse

Odstraněný objekt vyhodnocení

Name	Typ	Description	Povinné
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í.

Name	Typ	Description	Povinné
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

Name	Typ	Description	Povinné
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.

Name	Typ	Description	Povinné
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

Deployment

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

Name	Typ	Description	Povinné	Výchozí
název	string (jen pro čtení)	Název nasazení	Ano
typ	DeploymentType		Ano

DeploymentType

Property	Value
Typ	řetězec
Hodnoty	`ModelDeployment`

EntraIDCredentials

Definice přihlašovacího oprávnění Entra ID

Name	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. To se mi líbí:

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

Name	Typ	Description	Povinné
datum_vytvoření	integer	Časové razítko unixu (v sekundách) pro vytvoření zkušebního období.	Ano
vytvořeno kým	řetězec	jméno osoby, která spuštění vytvořila.	Ne
konfigurace_zdroj_dat	OpenAI.CreateEvalCustomDataSourceConfig nebo OpenAI.CreateEvalLogsDataSourceConfig nebo OpenAI.CreateEvalStoredCompletionsDataSourceConfig nebo AzureAIDataSourceConfig	Konfigurace zdrojů dat používaných při vyhodnocování	Ano
id	řetězec	Jedinečný identifikátor pro vyhodnocení.	Ano
metadata	OpenAI.Metadata (s možnou hodnotou null)	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	integer		Ne
název	řetězec	Název vyhodnocení.	Ano
objekt	výčet	Typ objektu. Možné hodnoty: `eval`	Ano
properties	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 OpenAI.EvalGraderLabelModel nebo OpenAI.EvalGraderStringCheck nebo OpenAI.EvalGraderTextSimilarity nebo OpenAI.EvalGraderPython nebo OpenAI.EvalGraderScoreModel nebo EvalGraderAzureAIEvaluator	Seznam testovacích kritérií.	Ano

EvalCsvFileIdSource

Představuje odkaz na nahraný soubor CSV používaný jako zdroj pro vyhodnocovaná data.

Name	Typ	Description	Povinné	Výchozí
id	řetězec	Identifikátor nahraného souboru CSV.	Ano
typ	výčet	Typ zdroje, vždy `file_id`. Možné hodnoty: `file_id`	Ano

EvalCsvRunDataSource

Představuje zdroj dat CSV pro spuštění vyhodnocení.

Name	Typ	Description	Povinné
odeslat k provedení	EvalCsvFileIdSource	Představuje odkaz na nahraný soubor CSV používaný jako zdroj pro vyhodnocovaná data.	Ano
└─ id	řetězec	Identifikátor nahraného souboru CSV.	Ano
└- typ	výčet	Typ zdroje, vždy `file_id`. Možné hodnoty: `file_id`	Ano
typ	výčet	Typ zdroje dat, vždy `csv`. Možné hodnoty: `csv`	Ano

EvalGraderAzureAIEvaluator

Name	Typ	Description	Povinné
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. Pokud není zadána nejnovější verze.	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 `azure_ai_evaluator`. Možné hodnoty: `azure_ai_evaluator`	Ano

EvalResult

Výsledek vyhodnocení.

Name	Typ	Description	Povinné
název	řetězec	název kontroly	Ano
Předán	boolean	označuje, jestli kontrola prošla nebo selhala.	Ano
skóre	Číslo	skóre	Ano
typ	řetězec	typ kontroly	Ano

EvalRun

Schéma představující běh vyhodnocení

Name	Typ	Description	Povinné
datum_vytvoření	integer	Časové razítko unixu (v sekundách) při vytvoření zkušebního spuštění	Ano
vytvořeno kým	řetězec	jméno osoby, která spuštění vytvořila.	Ne
zdroj dat	OpenAI.CreateEvalJsonlRunDataSource nebo OpenAI.CreateEvalCompletionsRunDataSource nebo OpenAI.CreateEvalResponsesRunDataSource nebo EvalRunDataSource	Informace o zdroji dat spuštění	Ano
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 (s možnou hodnotou null)	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	integer		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 OpenAI.EvalRunPerModelUsage	Statistiky využití pro každý model během zkušebního spuštění	Ano
výsledky podle testovacích kritérií	pole OpenAI.EvalRunPerTestingCriteriaResults	Výsledky podle kritérií testování uplatněných během vyhodnocovacího běhu.	Ano
properties	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ů	OpenAI.EvalRunResultCounts		Ano
└- chyba	OpenAI.integer		Ano
└– selhalo	OpenAI.integer		Ano
└─ prošlo	OpenAI.integer		Ano
└- celkem	OpenAI.integer		Ano
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_preview`	TracesPreviewEvalRunDataSource
`azure_ai_synthetic_data_gen_preview`	SyntheticDataGenerationPreviewEvalRunDataSource
`azure_ai_responses`	AzureAIResponsesEvalRunDataSource
`azure_ai_target_completions`	TargetCompletionEvalRunDataSource
`csv`	EvalCsvRunDataSource
`azure_ai_red_team`	RedTeamEvalRunDataSource

Name	Typ	Description	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í

Name	Typ	Description	Povinné
datum_vytvoření	integer	Časové razítko unixu (v sekundách) při vytvoření zkušebního spuštění	Ano
položka_datového_zdroje	objekt	Podrobnosti o položce vstupního zdroje dat	Ano
ID položky datového zdroje	OpenAI.integer		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 EvalRunOutputItemResult	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	OpenAI.EvalRunOutputItemSample		Ano
└─ chyba	OpenAI.EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ano
└konec_duvod	řetězec		Ano
└─ vstup	pole EvalRunOutputItemSampleInput		Ano
└─ maximální_dokončovací_tokeny	OpenAI.integer		Ano
└model	řetězec		Ano
└─ výstup	pole EvalRunOutputItemSampleOutput		Ano
└semeno	OpenAI.integer		Ano
└− teplota	OpenAI.numeric		Ano
└top_p	OpenAI.numeric		Ano
└─ využití	OpenAI.EvalRunOutputItemSampleUsage		Ano
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í

Name	Typ	Description	Povinné
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
Předán	boolean	Určuje, jestli klasiátor považoval výstup za průchod.	Ano
properties	objekt	Další podrobnosti o metrice kritérií testu	Ne
důvod	řetězec	Důvod metriky kritérií testu.	Ne
vzorek	objekt (nullable)	Volitelná vzorková nebo zprostředkující data vytvořená klasifikačním nástrojem	Ne
skóre	OpenAI.numeric		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

Tento objekt také přijímá další vlastnosti.

EvalRunOutputItemSampleInput

Zpráva ve zkušebním spuštění

Name	Typ	Description	Povinné
obsah	řetězec		Ano
role	řetězec		Ano
tool_calls	pole CompletionMessageToolCallChunk	Volání nástroje provedená v rámci zprávy, pokud existuje.	Ano

EvalRunOutputItemSampleOutput

Zpráva ve zkušebním spuštění

Name	Typ	Description	Povinné
obsah	řetězec		Ne
role	řetězec		Ne
tool_calls	pole CompletionMessageToolCallChunk	Volání nástroje provedená v rámci zprávy, pokud existuje.	Ano

EvalRunResultCompareItem

Porovnání metrik léčby s výchozí hodnotou.

Name	Typ	Description	Povinné
deltaEstimate	Číslo	Odhadovaný rozdíl mezi léčbou a směrný plán.	Ano
pValue	Číslo	P-hodnota pro léčbu účinku.	Ano
léčbaEffect	TreatmentEffectType	Typ účinku ošetření.	Ano
treatmentRunId	řetězec	ID spuštění léčby.	Ano
léčbaRunSummary	EvalRunResultSummary	Souhrnná statistika metriky v běhu vyhodnocení.	Ano
└- průměr	Číslo	Průměrná hodnota metriky při vyhodnocování.	Ano
└- runId	řetězec	ID zkušebního spuštění.	Ano
└- sampleCount	integer	Počet vzorků ve zkušebním spuštění	Ano
└- standardDeviation	Číslo	Směrodatná odchylka metriky při vyhodnocování.	Ano

EvalRunResultComparison

Výsledky srovnání léčby jsou v porovnání s výchozí hodnotou.

Name	Typ	Description	Povinné
baselineRunSummary	EvalRunResultSummary	Souhrnná statistika metriky v běhu vyhodnocení.	Ano
└- průměr	Číslo	Průměrná hodnota metriky při vyhodnocování.	Ano
└- runId	řetězec	ID zkušebního spuštění.	Ano
└- sampleCount	integer	Počet vzorků ve zkušebním spuštění	Ano
└- standardDeviation	Číslo	Směrodatná odchylka metriky při vyhodnocování.	Ano
compareItems	pole EvalRunResultCompareItem	Seznamvýsledkůch	Ano
Vyhodnocení	řetězec	Název vyhodnocovače pro tato kritéria testování.	Ano
metrika	řetězec	Metrika se vyhodnocuje.	Ano
testingCriteria	řetězec	Název testovacích kritérií	Ano

EvalRunResultSummary

Souhrnná statistika metriky v běhu vyhodnocení.

Name	Typ	Description	Povinné
průměrný	Číslo	Průměrná hodnota metriky při vyhodnocování.	Ano
identifikátor spuštění	řetězec	ID zkušebního spuštění.	Ano
sampleCount	integer	Počet vzorků ve zkušebním spuštění	Ano
standardDeviation	Číslo	Směrodatná odchylka metriky při vyhodnocování.	Ano

EvaluationComparisonInsightRequest

Žádost o porovnání vyhodnocení

Name	Typ	Description	Povinné
baselineRunId	řetězec	ID spuštění podle směrného plánu pro porovnání.	Ano
evalId	řetězec	Identifikátor vyhodnocení.	Ano
treatmentRunIds	pole řetězce	Seznam ID spuštění léčby pro porovnání	Ano
typ	výčet	Typ požadavku. Možné hodnoty: `EvaluationComparison`	Ano

EvaluationComparisonInsightResult

Postřehy z porovnání hodnocení.

Name	Typ	Description	Povinné
Porovnání	pole EvalRunResultComparison	Výsledky porovnání jednotlivých testovacích běhů podle směrného plánu.	Ano
metoda	řetězec	Statistická metoda použitá k porovnání.	Ano
typ	výčet	Typ výsledku přehledů Možné hodnoty: `EvaluationComparison`	Ano

EvaluationResultSample

Ukázka z výsledku vyhodnocení.

Name	Typ	Description	Povinné
correlationInfo	objekt	Informace o korelaci ukázky analýzy	Ano
evaluationResult	EvalResult	Výsledek vyhodnocení.	Ano
└– název	řetězec	název kontroly	Ano
└─ prošlo	boolean	označuje, jestli kontrola prošla nebo selhala.	Ano
└- skóre	Číslo	skóre	Ano
└- typ	řetězec	typ kontroly	Ano
features	objekt	Funkce, které vám pomůžou s dalším filtrováním dat v uživatelském prostředí	Ano
id	řetězec	Jedinečný identifikátor ukázky analýzy.	Ano
typ	výčet	Ukázkový typ výsledku vyhodnocení Možné hodnoty: `EvaluationResultSample`	Ano

Pravidlo vyhodnocení

Model vyhodnocovacího pravidla.

Name	Typ	Description	Povinné
akce	EvaluationRuleAction	Akční model vyhodnocení.	Ano
└- typ	EvaluationRuleActionType	Typ vyhodnocovací akce.	Ano
popis	řetězec	Popis pravidla vyhodnocení	Ne
displayName	řetězec	Zobrazovaný název pravidla vyhodnocení.	Ne
enabled	boolean	Určuje, jestli je pravidlo vyhodnocení povolené. Výchozí hodnota je `true`.	Ano
eventType	EvaluationRuleEventType	Typ události pravidla vyhodnocení.	Ano
filtr	EvaluationRuleFilter	Model filtru vyhodnocení.	Ne
└agentName	řetězec	Filtrovat podle názvu agenta	Ano
id	string (jen pro čtení)	Jedinečný identifikátor pravidla vyhodnocení.	Ano
systémová data	object (jen pro čtení)	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
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

Name	Typ	Description	Povinné	Výchozí
typ	EvaluationRuleActionType	Typ vyhodnocovací akce.	Ano

EvaluationRuleActionType

Typ vyhodnocovací akce.

Property	Value
Description	Typ vyhodnocovací akce.
Typ	řetězec
Hodnoty	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

Typ události pravidla vyhodnocení.

Property	Value
Description	Typ události pravidla vyhodnocení.
Typ	řetězec
Hodnoty	`responseCompleted` `manual`

EvaluationRuleFilter

Model filtru vyhodnocení.

Name	Typ	Description	Povinné	Výchozí
jméno agenta	řetězec	Filtrovat podle názvu agenta	Ano

EvaluationRunClusterInsightRequest

Poznatky o sadě výsledků vyhodnocení

Name	Typ	Description	Povinné
evalId	řetězec	ID vyhodnocení pro přehledy	Ano
konfigurace modelu	InsightModelConfiguration	Konfigurace modelu použitého při generování náhledů.	Ne
└- modelDeploymentName	řetězec	Nasazení modelu, které se má vyhodnotit. Přijímá buď samotný název nasazení, nebo s názvem připojení jako `{connectionName}/<modelDeploymentName>`.	Ano
runIds	pole řetězce	Seznam ID spuštění vyhodnocení pro přehledy	Ano
typ	výčet	Typ požadavku na přehledy. Možné hodnoty: `EvaluationRunClusterInsight`	Ano

EvaluationRunClusterInsightResult

Poznatky z vyhodnocení spustí shlukovou analýzu.

Name	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

EvaluationScheduleTask

Vyhodnocení úlohy pro harmonogram.

Name	Typ	Description	Povinné
konfigurace	objekt	Konfigurace pro úlohu	Ne
evalId	řetězec	Identifikátor skupiny hodnocení.	Ano
evalRun	objekt	Datová část zkušebního spuštění.	Ano
typ	výčet	Možné hodnoty: `Evaluation`	Ano

EvaluationTaxonomy

Definice taxonomie hodnocení

Name	Typ	Description	Povinné
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	string (jen pro čtení)	Název prostředku	Ano
properties	objekt	Další vlastnosti pro taxonomii vyhodnocení	Ne
taxonomieKategorie	pole TaxonomyCategory	Seznam kategorií taxonomie	Ne
taxonomyInput	EvaluationTaxonomyInput	Konfigurace vstupu pro taxonomii vyhodnocení.	Ano
└- typ	EvaluationTaxonomyInputType	Vstupní typ vyhodnocovací taxonomie	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

EvaluationTaxonomyCreateOrUpdate

Definice taxonomie hodnocení

Name	Typ	Description	Povinné
popis	řetězec	Text popisu prostředku.	Ne
properties	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 TaxonomyCategory	Seznam kategorií taxonomie	Ne
taxonomyInput	EvaluationTaxonomyInput	Konfigurace vstupu pro taxonomii vyhodnocení.	Ano
└- typ	EvaluationTaxonomyInputType	Vstupní typ vyhodnocovací taxonomie	Ano

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

Name	Typ	Description	Povinné	Výchozí
typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ano

EvaluationTaxonomyInputType

Typ vstupu taxonomie vyhodnocení.

Property	Value
Description	Typ vstupu taxonomie vyhodnocení.
Typ	ř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

Name	Typ	Description	Povinné	Výchozí
typ	EvaluationTaxonomyInputType	Typ vstupu taxonomie vyhodnocení.	Ano

EvaluationTaxonomyUpdate

Definice taxonomie hodnocení

Name	Typ	Description	Povinné
popis	řetězec	Text popisu prostředku.	Ne
properties	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 TaxonomyCategory	Seznam kategorií taxonomie	Ne
taxonomyInput	EvaluationTaxonomyInputUpdate	Konfigurace vstupu pro taxonomii vyhodnocení.	Ne
└- typ	EvaluationTaxonomyInputType	Vstupní typ vyhodnocovací taxonomie	Ano

VyhodnoceníCategory

Kategorie hodnotitele

Property	Value
Description	Kategorie hodnotitele
Typ	ř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

Name	Typ	Description	Povinné
data_schema	objekt	Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
init_parameters	objekt	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	Ano

EvaluatorDefinitionType

Typ definice hodnotitele

Property	Value
Description	Typ definice hodnotitele
Typ	řetězec
Hodnoty	`prompt` `code` `prompt_and_code` `service` `openai_graders`

Metrika vyhodnocování

Metrika hodnotitele

Name	Typ	Description	Povinné
desirable_direction	Vyhodnocovací metrikaDirection	Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální	Ne
is_primary	boolean	Označuje, jestli je tato metrika primární, pokud existuje více metrik.	Ne
max_value	Číslo	Maximální hodnota metriky Pokud není zadaný, předpokládá se, že je nevázaný.	Ne
min_value	Číslo	Minimální hodnota pro metriku	Ne
typ	Vyhodnocovací typMetricType	Typ hodnotitele	Ne

Vyhodnocovací metrikaDirection

Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální

Property	Value
Description	Směr metriky označující, zda je vyšší hodnota lepší, nižší hodnota lepší nebo neutrální
Typ	řetězec
Hodnoty	`increase` `decrease` `neutral`

Vyhodnocovací typMetricType

Typ hodnotitele

Property	Value
Description	Typ hodnotitele
Typ	řetězec
Hodnoty	`ordinal` `continuous` `boolean`

Vyhodnocovací typ

Typ hodnotitele

Property	Value
Description	Typ hodnotitele
Typ	řetězec
Hodnoty	`builtin` `custom`

Vyhodnocovací verze

Definice hodnotitele

Name	Typ	Description	Povinné
categories	pole EvaluatorCategory	Kategorie hodnotitele	Ano
datum_vytvoření	string (jen pro čtení)	Datum/čas vytvoření hodnotitele	Ano
vytvořeno kým	string (jen pro čtení)	Tvůrce hodnotitele	Ano
definice	VyhodnoceníDefinition	Základní konfigurace vyhodnocovače s diskriminátorem	Ano
└data_schema	objekt	Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└init_parameters	objekt	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	Ano
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít hodnotitele v AI Foundry. Nemusí být jedinečné.	Ne
evaluator_type	Vyhodnocovací typ	Typ hodnotitele	Ano
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
metadata	objekt	Metadata o hodnotiteli	Ne
modified_at	string (jen pro čtení)	Datum a čas poslední změny hodnotitele	Ano
název	string (jen pro čtení)	Název prostředku	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

EvaluatorVersionCreate

Definice hodnotitele

Name	Typ	Description	Povinné
categories	pole EvaluatorCategory	Kategorie hodnotitele	Ano
definice	VyhodnoceníDefinition	Základní konfigurace vyhodnocovače s diskriminátorem	Ano
└data_schema	objekt	Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
└init_parameters	objekt	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	Ano
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít hodnotitele v AI Foundry. Nemusí být jedinečné.	Ne
evaluator_type	Vyhodnocovací typ	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

Name	Typ	Description	Povinné
categories	pole EvaluatorCategory	Kategorie hodnotitele	Ne
popis	řetězec	Text popisu prostředku.	Ne
display_name	řetězec	Zobrazované jméno hodnotitele. Pomáhá snadno najít hodnotitele v AI 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.

Name	Typ	Description	Povinné	Výchozí
project_connections	pole ToolProjectConnection	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

Name	Typ	Description	Povinné
connectionName	řetězec	Název připojení účtu Azure Storage. Požadováno, pokud se před vytvořením datové sady nevolal startPendingUploadVersion.	Ne
dataUri	řetězec	Identifikátor URI dat (příklad) Omezení: minLength: 1, vzor: `[a-zA-Z0-9_]`	Ano
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
isReference	logická hodnota (jen pro čtení)	Označuje, jestli datová sada obsahuje odkaz na úložiště nebo jestli datová sada spravuje samotné úložiště. Pokud je hodnota true, podkladová data se při odstranění verze datové sady neodstraní.	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	výčet	Typ datové sady Možné hodnoty: `uri_file`	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

FileDatasetVersionUpdate

Definice FileDatasetVersion

Name	Typ	Description	Povinné
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	výčet	Typ datové sady Možné hodnoty: `uri_file`	Ano

FolderDatasetVersion

Definice FileDatasetVersion

Name	Typ	Description	Povinné
connectionName	řetězec	Název připojení účtu Azure Storage. Požadováno, pokud se před vytvořením datové sady nevolal startPendingUploadVersion.	Ne
dataUri	řetězec	Identifikátor URI dat (příklad) Omezení: minLength: 1, vzor: `[a-zA-Z0-9_]`	Ano
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
isReference	logická hodnota (jen pro čtení)	Označuje, jestli datová sada obsahuje odkaz na úložiště nebo jestli datová sada spravuje samotné úložiště. Pokud je hodnota true, podkladová data se při odstranění verze datové sady neodstraní.	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	výčet	Typ datové sady Možné hodnoty: `uri_folder`	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

FolderDatasetVersionUpdate

Definice FileDatasetVersion

Name	Typ	Description	Povinné
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	výčet	Typ datové sady Možné hodnoty: `uri_folder`	Ano

FunctionToolCall

Podrobnosti o volání nástroje funkce

Name	Typ	Description	Povinné	Výchozí
arguments	řetězec	Argumenty pro volání funkce, které byly vygenerovány modelem ve formátu JSON.	Ano
název	řetězec	Název funkce, kterou volat.	Ano

HostedAgentDefinition

Definice hostovaného agenta.

Name	Typ	Description	Povinné
container_protocol_versions	pole ProtocolVersionRecord	Protokoly, které agent podporuje pro komunikaci příchozího přenosu dat kontejnerů.	Ano
cpu	ř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
bitová kopie	řetězec	ID image agenta, které platí pro agenty hostované na základě image.	Ne
kind	výčet	Možné hodnoty: `hosted`	Ano
paměť	řetězec	Konfigurace paměti pro hostovaného agenta.	Ano
rai_config	RaiConfig	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.	Ano
tools	pole OpenAI.Tool	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í.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `Hourly`	Ano

HumanEvaluationPreviewRuleAction

Akce pravidla vyhodnocení pro lidské hodnocení.

Name	Typ	Description	Povinné	Výchozí
templateId	AssetId	Identifikátor uloženého prostředku.	Ano
typ	výčet	Možné hodnoty: `humanEvaluationPreview`	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

Name	Typ	Description	Povinné
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	Typ indexu		Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

Typ indexu

Property	Value
Typ	ř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

Name	Typ	Description	Povinné
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	Typ indexu		Ano

Postřeh

Text odpovědi pro cluster insights.

Name	Typ	Description	Povinné
displayName	řetězec	Uživatelsky přívětivý zobrazovaný název přehledu	Ano
id	string (jen pro čtení)	Jedinečný identifikátor sestavy přehledů.	Ano
metadata	InsightsMetadata (jen pro čtení)	Metadata o poznatcích.	Ano
└- completedAt	řetězec	Časové razítko po dokončení přehledů	Ne
└createdAt	řetězec	Časové razítko při vytvoření přehledů	Ano
žádost	InsightRequest	Žádost o zprávu o přehledech.	Ano
└- typ	InsightType	Typ požadavku.	Ano
result	InsightResult (jen pro čtení)	Výsledek poznatků.	Ne
└- typ	InsightType	Typ výsledku přehledů	Ano
stav	Azure. Core.Foundations.OperationState (jen pro čtení)	Výčet popisující povolené stavy operací.	Ano

InsightCluster

Shluk vzorků analýzy.

Name	Typ	Description	Povinné
popis	řetězec	Popis clusteru analýzy	Ano
id	řetězec	ID clusteru analýzy.	Ano
jmenovka	řetězec	Popisek clusteru	Ano
Vzorky	pole InsightSample	Seznam ukázek, které patří do tohoto clusteru Prázdné, pokud jsou vzorky součástí podkluzů.	Ne
subClusters	pole InsightCluster	Seznam podkluzů v rámci tohoto clusteru Prázdné, pokud neexistují žádné podkluzy.	Ne
Návrh	řetězec	Návrh clusteru	Ano
suggestionTitle	řetězec	Název návrhu clusteru	Ano
weight	integer	Váha analytického clusteru. To označuje počet vzorků v clusteru.	Ano

InsightModelConfiguration

Konfigurace modelu použitého při generování náhledů.

Name	Typ	Description	Povinné	Výchozí
modelDeploymentName	řetězec	Nasazení modelu, které se má vyhodnotit. 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`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

Name	Typ	Description	Povinné	Výchozí
typ	InsightType	Žá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`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Name	Typ	Description	Povinné	Výchozí
typ	InsightType	Žá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

Name	Typ	Description	Povinné
correlationInfo	objekt	Informace o korelaci ukázky analýzy	Ano
features	objekt	Funkce, které vám pomůžou s dalším filtrováním dat v uživatelském prostředí	Ano
id	řetězec	Jedinečný identifikátor ukázky analýzy.	Ano
typ	Sampletype	Typ vzorku použitého při analýze.	Ano

InsightScheduleTask

Úkol Insight pro plán.

Name	Typ	Description	Povinné
konfigurace	objekt	Konfigurace pro úlohu	Ne
přehled	Pohled	Text odpovědi pro cluster insights.	Ano
└- displayName	řetězec	Uživatelsky přívětivý zobrazovaný název přehledu	Ano
└─ id	string (jen pro čtení)	Jedinečný identifikátor sestavy přehledů.	Ano
└– metadata	InsightsMetadata (jen pro čtení)	Metadata o sestavě přehledů	Ano
└– žádost	InsightRequest	Žádost o analýzu přehledů	Ano
└výsledek	InsightResult (jen pro čtení)	Výsledek sestavy přehledů	Ne
└stavy	Azure. Core.Foundations.OperationState (jen pro čtení)	Aktuální stav přehledů	Ano
typ	výčet	Možné hodnoty: `Insight`	Ano

InsightSummary

Shrnutí analýzy shluků chyb.

Name	Typ	Description	Povinné
metoda	řetězec	Metoda použitá pro clustering	Ano
sampleCount	integer	Celkový počet analyzovaných vzorků	Ano
uniqueClusterCount	integer	Celkový počet jedinečných clusterů	Ano
uniqueSubclusterCount	integer	Celkový počet jedinečných popisků podkluzu	Ano
využití	ClusterTokenUsage	Použití tokenu pro clusterovou analýzu	Ano
└- inputTokenUsage	integer	Využití vstupního tokenu	Ano
└- outputTokenUsage	integer	Využití výstupního tokenu	Ano
└- totalTokenUsage	integer	celkové využití tokenu	Ano

InsightType

Žádost o postřehy.

Property	Value
Description	Žádost o postřehy.
Typ	řetězec
Hodnoty	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Metadata o poznatcích.

Name	Typ	Description	Povinné	Výchozí
completedAt	řetězec	Časové razítko po dokončení přehledů	Ne
createdAt	řetězec	Časové razítko při vytvoření přehledů	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
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

Name	Typ	Description	Povinné	Výchozí
typ	ItemGenerationParamsType	Typy parametrů pro generování červených položek týmu.	Ano

ItemGenerationParamsType

Typy parametrů pro generování červených položek týmu.

Property	Value
Description	Typy parametrů pro generování červených položek týmu.
Typ	řetězec
Hodnoty	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Definace indexu Managed Azure AI Vyhledávač

Name	Typ	Description	Povinné
id	string (jen pro čtení)	ID datového zdroje, jedinečný identifikátor datového zdroje	Ne
název	string (jen pro čtení)	Název prostředku	Ano
typ	výčet	Typ indexu Možné hodnoty: `ManagedAzureSearch`	Ano
verze	string (jen pro čtení)	Verze prostředku	Ano

ManagedAzureAISearchIndexUpdate

Definace indexu Managed Azure AI Vyhledávač

Name	Typ	Description	Povinné
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	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

Name	Typ	Description	Povinné
obsah	řetězec	Obsah paměti.	Ano
kind	MemoryItemKind	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.

Property	Value
Description	Druh paměťové položky.
Typ	ř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.

Name	Typ	Description	Povinné
kind	MemoryOperationKind	Druh provozu paměti.	Ano
memory_item	MemoryItem	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.	Ano
└kind	MemoryItemKind	Druh položky paměti.	Ano
└memory_id	řetězec	Jedinečné ID paměťové položky.	Ano
└rozsah	ř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

MemoryOperationKind

Druh provozu paměti.

Property	Value
Description	Druh provozu paměti.
Typ	řetězec
Hodnoty	`create` `update` `delete`

MemorySearchItem

Načtená položka paměti z vyhledávání v paměti.

Name	Typ	Description	Povinné
memory_item	MemoryItem	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.	Ano
└kind	MemoryItemKind	Druh položky paměti.	Ano
└memory_id	řetězec	Jedinečné ID paměťové položky.	Ano
└rozsah	ř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

MemorySearchOptions

Možnosti vyhledávání v paměti.

Name	Typ	Description	Povinné	Výchozí
max_memories	integer	Maximální počet položek paměti, které se mají vrátit.	Ne

MemorySearchPreviewTool

Nástroj pro integraci pamětí do agenta.

Name	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	MemorySearchOptions	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_preview`. Možné hodnoty: `memory_search_preview`	Ano
update_delay	integer	Doba čekání před aktualizací pamětí po nečinnosti (sekundy). Výchozí hodnota 300.	Ne	300

MemorySearchToolCallItemParam

Name	Typ	Description	Povinné	Výchozí
results	pole MemorySearchItem	Výsledky vrácené z hledání v paměti.	Ne
typ	výčet	Možné hodnoty: `memory_search_call`	Ano

MemorySearchToolCallItemResource

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
results	pole MemorySearchItem	Výsledky vrácené z hledání v paměti.	Ne
stav	výčet	Stav volání nástroje pro vyhledávání paměti. Jeden z `in_progress`. `searching`, `completed`nebo `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.

Name	Typ	Description	Povinné	Výchozí
chat_model	řetězec	Název nebo identifikátor nasazení modelu dokončování chatu, který se používá ke zpracování paměti.	Ano
embedding_model	řetězec	Název nebo identifikátor nasazení modelu vložení použitého ke zpracování paměti.	Ano
kind	výčet	Druh úložiště paměti. Možné hodnoty: `default`	Ano
options	MemoryStoreDefaultOptions	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`.	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é

MemoryStoreDefaultOptions

Výchozí konfigurace úložiště paměti.

Name	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

Name	Typ	Description	Povinné	Výchozí
kind	MemoryStoreKind	Typ implementace úložiště paměti, která se má použít.	Ano

MemoryStoreDeleteScopeResponse

Odpověď pro smazání pamětí z rozsahu.

Name	Typ	Description	Povinné
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 odstraněny vzpomínky.	Ano

MemoryStoreKind

Typ implementace úložiště paměti, která se má použít.

Property	Value
Description	Typ implementace úložiště paměti, která se má použít.
Typ	řetězec
Hodnoty	`default`

MemoryStoreObject

Úložiště paměti, které může ukládat a načítat uživatelské paměti.

Name	Typ	Description	Povinné
datum_vytvoření	integer	Časové razítko unixu (sekundy) při vytvoření úložiště paměti.	Ano
definice	MemoryStoreDefinition	Základní definice pro konfigurace paměťových úložišť.	Ano
└kind	MemoryStoreKind	Druh úložiště paměti.	Ano
popis	řetězec	Popis úložiště paměti čitelný člověkem. Omezení: maxLength: 512	Ne
id	řetězec	Jedinečný identifikátor úložiště paměti.	Ano
metadata	objekt	Metadata libovolné hodnoty klíče, která se mají přidružit k úložišti paměti.	Ne
název	řetězec	Název úložiště paměti. Omezení: maxLength: 256	Ano
objekt	výčet	Typ objektu, který je vždy "memory_store". Možné hodnoty: `memory_store`	Ano
updated_at	integer	Časové razítko unixu (sekundy) při poslední aktualizaci úložiště paměti.	Ano

MemoryStoreOperationUsage

Statistika využití operace úložiště paměti.

Name	Typ	Description	Povinné
embedding_tokens	integer	Počet vložených tokenů	Ano
input_tokens	OpenAI.integer		Ano
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Ano
└─ uložené_tokény	OpenAI.integer		Ano
output_tokens	OpenAI.integer		Ano
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Ano
└─ "reasoning_tokens"	OpenAI.integer		Ano
total_tokens	OpenAI.integer		Ano

MemoryStoreSearchResponse

Odpověď na vyhledávání v paměti.

Name	Typ	Description	Povinné
Vzpomínky	pole MemorySearchItem	Související položky paměti nalezené během operace hledání.	Ano
search_id	řetězec	Jedinečné ID této žádosti o vyhledávání. Tuto hodnotu použijte jako previous_search_id v následných požadavcích k provádění přírůstkových vyhledávání.	Ano
využití	MemoryStoreOperationUsage	Statistika využití operace úložiště paměti.	Ano
└embedding_tokens	integer	Počet vložených tokenů	Ano
└input_tokens	OpenAI.integer	Počet vstupních tokenů.	Ano
└- input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Podrobný rozpis vstupních tokenů	Ano
└output_tokens	OpenAI.integer	Počet výstupních tokenů	Ano
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Podrobný rozpis výstupních tokenů	Ano
└─ celkem_tokeny	OpenAI.integer	Celkový počet použitých tokenů	Ano

MemoryStoreUpdateCompletedResult

Výsledek aktualizace paměti.

Name	Typ	Description	Povinné
memory_operations	pole MemoryOperation	Seznam jednotlivých paměťových operací, které byly provedeny během aktualizace.	Ano
využití	MemoryStoreOperationUsage	Statistika využití operace úložiště paměti.	Ano
└embedding_tokens	integer	Počet vložených tokenů	Ano
└input_tokens	OpenAI.integer	Počet vstupních tokenů.	Ano
└- input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Podrobný rozpis vstupních tokenů	Ano
└output_tokens	OpenAI.integer	Počet výstupních tokenů	Ano
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Podrobný rozpis výstupních tokenů	Ano
└─ celkem_tokeny	OpenAI.integer	Celkový počet použitých tokenů	Ano

MemoryStoreUpdateResponse

Poskytuje stav operace aktualizace úložiště paměti.

Name	Typ	Description	Povinné
chyba	OpenAI.Error		Ne
└- další informace	objekt		Ne
└ kód	řetězec (s možnou hodnotou null)		Ano
└- debugInfo	objekt		Ne
└- podrobnosti	pole OpenAI.Error		Ne
└- zpráva	řetězec		Ano
└- param	řetězec (s možnou hodnotou null)		Ne
└- typ	řetězec		Ne
result	MemoryStoreUpdateCompletedResult	Výsledek aktualizace paměti.	Ne
└memory_operations	pole MemoryOperation	Seznam jednotlivých paměťových operací, které byly provedeny během aktualizace.	Ano
└─ využití	MemoryStoreOperationUsage	Statistiky využití přidružené k operaci aktualizace paměti.	Ano
stav	MemoryStoreUpdateStatus	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 k provádění přírůstkových aktualizací.	Ano

MemoryStoreUpdateStatus

Stav operace aktualizace úložiště paměti.

Property	Value
Typ	řetězec
Hodnoty	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

Vstupní definice pro nástroj Microsoft Fabric používaná ke konfiguraci agenta.

Name	Typ	Description	Povinné
fabric_dataagent_preview	FabricDataAgentToolParameters	Parametry nástroje agenta dat prostředků Fabric.	Ano
└project_connections	pole ToolProjectConnection	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji. Omezení: maxItems: 1	Ne
typ	výčet	Typ objektu, který je vždy 'fabric_dataagent_preview'. Možné hodnoty: `fabric_dataagent_preview`	Ano

Nasazení modelu

Definice nasazení modelu

Name	Typ	Description	Povinné
capabilities	object (jen pro čtení)	Možnosti nasazeného modelu	Ano
connectionName	string (jen pro čtení)	Název připojení, ze které nasazení pochází	Ne
modelName	string (jen pro čtení)	Publisher konkrétní název nasazeného modelu	Ano
modelPublisher	string (jen pro čtení)	Název vydavatele nasazeného modelu	Ano
verze modelu	string (jen pro čtení)	Publisher verze nasazeného modelu	Ano
název	string (jen pro čtení)	Název nasazení	Ano
sku	Skladová položka (jen pro čtení)	Informace o skladové posílce	Ano
└- kapacita	integer	Kapacita skladové položky	Ano
└- rodina	řetězec	Rodina skladových položek	Ano
└– název	řetězec	Název skladové položky	Ano
└- velikost	řetězec	Velikost skladové položky	Ano
└- úroveň	řetězec	Úroveň skladové položky	Ano
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.

Name	Typ	Description	Povinné
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.

Name	Typ	Description	Povinné
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í.

Name	Typ	Description	Povinné	Výchozí
daysOfMonth	pole celočíselného čísla	Dny v měsíci pro plán opakování	Ano
typ	výčet	Typ měsíčního opakování Možné hodnoty: `Monthly`	Ano

NoAuthenticationCredentials

Přihlašovací údaje, které nevyžadují ověření

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: `None`	Ano

OAuthConsentRequestOutputItem

Požádejte uživatele o udělení souhlasu OAuth ze služby.

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
consent_link	řetězec	Odkaz, který může uživatel použít k provedení souhlasu OAuth.	Ano
id	řetězec		Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
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ěč.

Name	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

Poznámka, která se vztahuje na rozsah výstupního textu.

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.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.AnnotationType		Ano

OpenAI.AnnotationType

Property	Value
Typ	řetězec
Hodnoty	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Typ	řetězec
Hodnoty	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Hodnoty výsledku hlášené pro výstupy volání nástroje apply_patch

Property	Value
Typ	řetězec
Hodnoty	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Hodnoty stavu hlášené pro volání nástroje apply_patch

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Pokyny popisující, jak vytvořit soubor pomocí nástroje apply_patch

Name	Typ	Description	Povinné
Diff	řetězec	Rozdíl, který se má použít.	Ano
cesta	řetězec	Cesta k souboru, který chcete vytvořit.	Ano
typ	výčet	Vytvořte nový soubor s poskytnutým rozdílem. Možné hodnoty: `create_file`	Ano

OpenAI.ApplyPatchCreateFileOperationParam

Pokyny k vytvoření nového souboru prostřednictvím nástroje apply_patch

Name	Typ	Description	Povinné
Diff	řetězec	Sjednocený obsah rozdílu, který se má použít při vytváření souboru. Omezení: maxLength: 10485760	Ano
cesta	řetězec	Cesta k souboru, která se má vytvořit vzhledem k kořenovému adresáři pracovního prostoru. Omezení: minLength: 1	Ano
typ	výčet	Typ operace. Vždy `create_file`. Možné hodnoty: `create_file`	Ano

OpenAI.ApplyPatchDeleteFileOperation

Pokyny popisující, jak odstranit soubor pomocí nástroje apply_patch

Name	Typ	Description	Povinné	Výchozí
cesta	řetězec	Cesta k souboru, který chcete odstranit.	Ano
typ	výčet	Odstraňte zadaný soubor. Možné hodnoty: `delete_file`	Ano

OpenAI.ApplyPatchDeleteFileOperationParam

Pokyny k odstranění existujícího souboru prostřednictvím nástroje apply_patch

Name	Typ	Description	Povinné	Výchozí
cesta	řetězec	Cesta k souboru, který se má odstranit vzhledem k kořenovému adresáři pracovního prostoru. Omezení: minLength: 1	Ano
typ	výčet	Typ operace. Vždy `delete_file`. Možné hodnoty: `delete_file`	Ano

OpenAI.ApplyPatchFileOperation

Jednu z operací create_file, delete_file nebo update_file použitých prostřednictvím apply_patch.

Diskriminátor pro OpenAI.ApplyPatchFileOperation

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

Hodnota typu	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ApplyPatchFileOperationType		Ano

OpenAI.ApplyPatchFileOperationType

Property	Value
Typ	řetězec
Hodnoty	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Jeden z create_file, delete_file nebo update_file operací poskytovaných nástroji apply_patch.

Diskriminátor pro OpenAI.ApplyPatchOperationParam

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

Hodnota typu	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ApplyPatchOperationParamType		Ano

OpenAI.ApplyPatchOperationParamType

Property	Value
Typ	řetězec
Hodnoty	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Umožňuje asistentovi vytvářet, odstraňovat nebo aktualizovat soubory pomocí jednotných rozdílů.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ nástroje. Vždy `apply_patch`. Možné hodnoty: `apply_patch`	Ano

OpenAI.ApplyPatchUpdateFileOperation

Instrukce popisující postup aktualizace souboru pomocí nástroje apply_patch

Name	Typ	Description	Povinné
Diff	řetězec	Rozdíl, který se má použít.	Ano
cesta	řetězec	Cesta k souboru, který chcete aktualizovat.	Ano
typ	výčet	Aktualizujte existující soubor pomocí poskytnutého rozdílu. Možné hodnoty: `update_file`	Ano

OpenAI.ApplyPatchUpdateFileOperationParam

Pokyny k aktualizaci existujícího souboru prostřednictvím nástroje apply_patch

Name	Typ	Description	Povinné
Diff	řetězec	Jednotný obsah rozdílu, který se má použít u existujícího souboru. Omezení: maxLength: 10485760	Ano
cesta	řetězec	Cesta k souboru, který se má aktualizovat vzhledem k kořenovému adresáři pracovního prostoru. Omezení: minLength: 1	Ano
typ	výčet	Typ operace. Vždy `update_file`. Možné hodnoty: `update_file`	Ano

OpenAI.PřibližnáPoloha

Name	Typ	Description	Povinné
Město	řetězec (s možnou hodnotou null)		Ne
země	řetězec (s možnou hodnotou null)		Ne
oblast	řetězec (s možnou hodnotou null)		Ne
timezone	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ aproximace polohy. Vždy `approximate`. Možné hodnoty: `approximate`	Ano

OpenAI.NástrojProDokončeníChatu

Nástroj funkce, který lze použít k vygenerování odpovědi.

Name	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.ChatModel

Property Value

Typ řetězec

Hodnoty gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat-latest
gpt-5.2-pro
gpt-5.2-pro-2025-12-11
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-codex
gpt-5.1-mini
gpt-5.1-chat-latest
gpt-5
gpt-5-mini
gpt-5-nano
gpt-5-2025-08-07
gpt-5-mini-2025-08-07
gpt-5-nano-2025-08-07
gpt-5-chat-latest
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4.1-2025-04-14
gpt-4.1-mini-2025-04-14
gpt-4.1-nano-2025-04-14
o4-mini
o4-mini-2025-04-16
o3
o3-2025-04-16
o3-mini
o3-mini-2025-01-31
o1
o1-2024-12-17
o1-preview
o1-preview-2024-09-12
o1-mini
o1-mini-2024-09-12
gpt-4o
gpt-4o-2024-11-20
gpt-4o-2024-08-06
gpt-4o-2024-05-13
gpt-4o-audio-preview
gpt-4o-audio-preview-2024-10-01
gpt-4o-audio-preview-2024-12-17
gpt-4o-audio-preview-2025-06-03
gpt-4o-mini-audio-preview
gpt-4o-mini-audio-preview-2024-12-17
gpt-4o-search-preview
gpt-4o-mini-search-preview
gpt-4o-search-preview-2025-03-11
gpt-4o-mini-search-preview-2025-03-11
chatgpt-4o-latest
codex-mini-latest
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4-turbo
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-turbo-preview
gpt-4-1106-preview
gpt-4-vision-preview
gpt-4
gpt-4-0314
gpt-4-0613
gpt-4-32k
gpt-4-32k-0314
gpt-4-32k-0613
gpt-3.5-turbo
gpt-3.5-turbo-16k
gpt-3.5-turbo-0301
gpt-3.5-turbo-0613
gpt-3.5-turbo-1106
gpt-3.5-turbo-0125
gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Property	Value
Typ	řetězec
Hodnoty	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Kliknutí myší.

Name	Typ	Description	Povinné
knoflík	OpenAI.ClickButtonType		Ano
typ	výčet	Určuje typ události. U akce kliknutí je tato vlastnost vždy `click`. Možné hodnoty: `click`	Ano
x	OpenAI.integer		Ano
y	OpenAI.integer		Ano

OpenAI.CodeInterpreterContainerAuto

Konfigurace kontejneru interpretu kódu Volitelně zadejte ID souborů, na kterých se má kód spustit.

Name	Typ	Description	Povinné
identifikátory_souborů	pole řetězce	Volitelný seznam nahraných souborů, které mají být zpřístupněny vašemu kódu.	Ne
limit paměti	OpenAI.ContainerMemoryLimit (nullable)		Ne
typ	výčet	Vždy `auto`. Možné hodnoty: `auto`	Ano

OpenAI.CodeInterpreterOutputImage

Výstup obrázku z interpretu kódu.

Name	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.

Name	Typ	Description	Povinné	Výchozí
protokoly	řetězec	Výstup protokolů z interpretu kódu.	Ano
typ	výčet	Typ výstupu. Vždy `logs`. Možné hodnoty: `logs`	Ano

OpenAI.CodeInterpreterTool

Nástroj, který spouští kód Pythonu, který pomáhá vygenerovat odpověď na výzvu.

Name	Typ	Description	Povinné	Výchozí
kontejner	string nebo OpenAI.CodeInterpreterContainerAuto	Kontejner interpretu kódu. Může to být ID kontejneru nebo objekt, který určuje ID nahraných souborů, která se mají zpřístupnit vašemu kódu, spolu s volitelné `memory_limit` nastavení. Pokud není k dispozici, služba předpokládá automaticky.	Ne
typ	výčet	Typ nástroje pro interpret kódu. Vždy `code_interpreter`. Možné hodnoty: `code_interpreter`	Ano

OpenAI.CompactResource

Name	Typ	Description	Povinné
datum_vytvoření	integer	Časové razítko unixu (v sekundách) při vytvoření komprimované konverzace	Ano
id	řetězec	Jedinečný identifikátor komprimované odpovědi.	Ano
objekt	výčet	Typ objektu. Vždy `response.compaction`. Možné hodnoty: `response.compaction`	Ano
výstup	pole OpenAI.OutputItem	Komprimovaný seznam výstupních položek. Toto je seznam všech zpráv uživatelů, za kterými následuje jedna položka komprimace.	Ano
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.	Ano
└input_tokens	OpenAI.integer	Počet vstupních tokenů.	Ano
└- input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Podrobný rozpis vstupních tokenů	Ano
└output_tokens	OpenAI.integer	Počet výstupních tokenů	Ano
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Podrobný rozpis výstupních tokenů	Ano
└─ celkem_tokeny	OpenAI.integer	Celkový počet použitých tokenů	Ano

OpenAI.CompactResponseMethodPublicBody

Name	Typ	Description	Povinné
vstup	řetězec nebo pole OpenAI.InputItem		Ne
Pokyny	řetězec (s možnou hodnotou null)		Ne
model	OpenAI.ModelIdsCompaction	ID modelu použité k vygenerování odpovědi, například `gpt-5` nebo `o3`. OpenAI nabízí širokou škálu modelů s různými možnostmi, charakteristikami výkonu a cenovými body. Projděte si průvodce modelem a projděte si dostupné modely a porovnejte je.	Ano
previous_response_id	řetězec (s možnou hodnotou null)		Ne

OpenAI.ComparisonFilter

Filtr použitý k porovnání zadaného klíče atributu s danou hodnotou pomocí definované operace porovnání.

Name	Typ	Description	Povinné
klíč	řetězec	Klíč k porovnání s hodnotou.	Ano
typ	výčet	Určuje relační operátor: `eq`, `ne`, `gtgte`, `lt`, `lte`, , `in`, . `nin` - `eq`:rovná se - `ne`: nerovná se - `gt`: větší než - `gte`: větší nebo rovno - `lt`:méně než - `lte`: menší než nebo rovno - `in`:In - `nin`: není v Možné hodnoty: `eq`, `ne`, `gt`, `gte`, `ltlte`	Ano
value	string nebo OpenAI.numeric nebo boolean nebo array of OpenAI.ComparisonFilterValueItems	Hodnota, která se má porovnat s klíčem atributu; podporuje typy řetězců, čísel nebo logických hodnot.	Ano

OpenAI.ComparisonFilterValueItems

Typ: řetězec nebo OpenAI.numeric

OpenAI.CompoundFilter

Kombinování více filtrů pomocí and nebo or.

Name	Typ	Description	Povinné	Výchozí
Filtry	pole OpenAI.ComparisonFilter nebo objektu	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.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Screenshot
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ComputerActionType		Ano

OpenAI.ComputerActionType

Property	Value
Typ	řetězec
Hodnoty	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Čekající bezpečnostní kontrola pro počítačové volání.

Name	Typ	Description	Povinné
kód	řetězec (s možnou hodnotou null)		Ne
id	řetězec	ID čekající bezpečnostní kontroly.	Ano
zpráva	řetězec (s možnou hodnotou null)		Ne

OpenAI.ComputerEnvironment

Property	Value
Typ	řetězec
Hodnoty	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Snímek obrazovky počítače

Name	Typ	Description	Povinné
ID souboru	řetězec (s možnou hodnotou null)		Ano
image_url	řetězec		Ano
typ	výčet	Určuje typ události. U snímku obrazovky počítače je tato vlastnost vždy nastavena na `computer_screenshot`hodnotu . Možné hodnoty: `computer_screenshot`	Ano

OpenAI.ComputerScreenshotImage

Snímek obrazovky počítače použitý s nástrojem pro použití počítače

Name	Typ	Description	Povinné
ID souboru	řetězec	Identifikátor nahraného souboru, který obsahuje snímek obrazovky.	Ne
image_url	řetězec	Adresa URL obrázku snímku obrazovky	Ne
typ	výčet	Určuje typ události. U snímku obrazovky počítače je tato vlastnost vždy nastaveno na `computer_screenshot`. Možné hodnoty: `computer_screenshot`	Ano

Nástroj pro náhled použití počítače OpenAI

Nástroj, který řídí virtuální počítač.

Name	Typ	Description	Povinné
výška displeje	OpenAI.integer		Ano
šířka displeje	OpenAI.integer		Ano
prostředí	OpenAI.ComputerEnvironment		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.ContainerFileCitationBody

Citace pro soubor kontejneru použitý k vygenerování odpovědi modelu

Name	Typ	Description	Povinné
container_id	řetězec	ID souboru kontejneru.	Ano
end_index	OpenAI.integer		Ano
ID souboru	řetězec	ID souboru.	Ano
filename	řetězec	Název souboru citovaného kontejneru.	Ano
start_index	OpenAI.integer		Ano
typ	výčet	Typ citace souboru kontejneru. Vždy `container_file_citation`. Možné hodnoty: `container_file_citation`	Ano

OpenAI.ContainerMemoryLimit

Property	Value
Typ	řetězec
Hodnoty	`1g` `4g` `16g` `64g`

OpenAI.ConversationItem

Jedna položka v konverzaci. Sada možných typů je stejná jako output typ objektu Response.

Diskriminátor pro OpenAI.ConversationItem

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

Hodnota typu	Schema
`message`	OpenAI.ConversationItemMessage
`function_call`	OpenAI.ConversationItemFunctionToolCallResource
`function_call_output`	OpenAI.ConversationItemFunctionToolCallOutputResource
`file_search_call`	OpenAI.ConversationItemFileSearchToolCall
`web_search_call`	OpenAI.ConversationItemWebSearchToolCall
`image_generation_call`	OpenAI.ConversationItemImageGenToolCall
`computer_call`	OpenAI.ConversationItemComputerToolCall
`computer_call_output`	OpenAI.ConversationItemComputerToolCallOutputResource
`reasoning`	OpenAI.ConversationItemReasoningItemItem
`code_interpreter_call`	OpenAI.ConversationItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ConversationItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ConversationItemLocalShellToolCallOutput
`shell_call`	OpenAI.ConversationItemFunctionShellCall
`shell_call_output`	OpenAI.ConversationItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.ConversationItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ConversationItemApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ConversationItemMcpListTools
`mcp_approval_request`	OpenAI.ConversationItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ConversationItemMcpApprovalResponseResource
`mcp_call`	OpenAI.ConversationItemMcpToolCall
`custom_tool_call`	OpenAI.ConversationItemCustomToolCall
`custom_tool_call_output`	OpenAI.ConversationItemCustomToolCallOutput

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ConversationItemType		Ano

OpenAI.ConversationItemApplyPatchToolCall

Volání nástroje, které používá rozdíly souborů vytvořením, odstraněním nebo aktualizací souborů

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID volání nástroje Apply Patch. Naplněno při vrácení této položky přes rozhraní API.	Ano
operace	OpenAI.ApplyPatchFileOperation	Jednu z operací create_file, delete_file nebo update_file použitých prostřednictvím apply_patch.	Ano
└- typ	OpenAI.ApplyPatchFileOperationType		Ano
stav	OpenAI.ApplyPatchCallStatus		Ano
typ	výčet	Typ položky. Vždy `apply_patch_call`. Možné hodnoty: `apply_patch_call`	Ano

OpenAI.ConversationItemApplyPatchToolCallOutput

Výstup vygenerovaný voláním nástroje apply patch

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila výstup volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID výstupu volání nástroje Apply Patch. Naplněno při vrácení této položky přes rozhraní API.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
stav	OpenAI.ApplyPatchCallOutputStatus		Ano
typ	výčet	Typ položky. Vždy `apply_patch_call_output`. Možné hodnoty: `apply_patch_call_output`	Ano

OpenAI.ConversationItemCodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Name	Typ	Description	Povinné
kód	řetězec (s možnou hodnotou null)		Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
id	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Ano
outputs	pole OpenAI.CodeInterpreterOutputLogs nebo OpenAI.CodeInterpreterOutputImage		Ano
stav	výčet	Stav volání nástroje interpreta kódu. Platné hodnoty jsou `in_progress`, , `completedincomplete`, `interpreting`a `failed`. Možné hodnoty: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Ano
typ	výčet	Typ volání nástroje interpreta kódu. Vždy `code_interpreter_call`. Možné hodnoty: `code_interpreter_call`	Ano

OpenAI.ConversationItemComputerToolCall

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 .

Name	Typ	Description	Povinné
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
id	řetězec	Jedinečné ID počítačového volání.	Ano
pending_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	Č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	Typ hovoru počítačem. Vždy `computer_call`. Možné hodnoty: `computer_call`	Ano

OpenAI.ConversationItemComputerToolCallOutputResource

Name	Typ	Description	Povinné
acknowledged_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	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
id	řetězec	ID výstupu volání počítačového nástroje.	Ne
výstup	OpenAI.ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano
stav	výčet	Stav vstupu zprávy. jeden z `in_progress`, `completed`, nebo `incomplete`. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ne
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy `computer_call_output`. Možné hodnoty: `computer_call_output`	Ano

OpenAI.ConversationItemCustomToolCall

Volání vlastního nástroje vytvořeného modelem

Name	Typ	Description	Povinné
call_id	řetězec	Identifikátor použitý k mapování tohoto vlastního volání nástroje na výstup volání nástroje.	Ano
id	řetězec	Jedinečné ID volání vlastního nástroje na platformě OpenAI.	Ne
vstup	řetězec	Vstup pro volání vlastního nástroje vygenerovaného modelem.	Ano
název	řetězec	Název volaného vlastního nástroje.	Ano
typ	výčet	Typ volání vlastního nástroje. Vždy `custom_tool_call`. Možné hodnoty: `custom_tool_call`	Ano

OpenAI.ConversationItemCustomToolCallOutput

Výstup vlastního volání nástroje z kódu, který se odesílá zpět do modelu.

Name	Typ	Description	Povinné
call_id	řetězec	ID volání, které se používá k mapování výstupu volání tohoto vlastního nástroje na vlastní volání nástroje.	Ano
id	řetězec	Jedinečné ID výstupu volání vlastního nástroje na platformě OpenAI.	Ne
výstup	řetězec nebo pole OpenAI.FunctionAndCustomToolCallOutput	Výstup z volání vlastního nástroje vygenerovaného vaším kódem Může to být řetězec nebo seznam výstupního obsahu.	Ano
typ	výčet	Typ výstupu volání vlastního nástroje. Vždy `custom_tool_call_output`. Možné hodnoty: `custom_tool_call_output`	Ano

OpenAI.ConversationItemFileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Ano
Dotazy	pole řetězce	Dotazy používané k hledání souborů.	Ano
results	pole OpenAI.FileSearchToolCallResults		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	Typ volání nástroje pro vyhledávání souborů. Vždy `file_search_call`. Možné hodnoty: `file_search_call`	Ano

OpenAI.ConversationItemFunctionShellCall

Volání nástroje, které spouští jeden nebo více příkazů prostředí ve spravovaném prostředí.

Name	Typ	Description	Povinné
akce	OpenAI.FunctionShellAction	Spusťte příkaz prostředí.	Ano
└– příkazy	pole řetězce		Ano
└max_output_length	OpenAI.integer (nullable)		Ano
└timeout_ms	OpenAI.integer (nullable)		Ano
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID volání nástroje prostředí. Naplněno při vrácení této položky přes rozhraní API.	Ano
stav	OpenAI.LocalShellCallStatus		Ano
typ	výčet	Typ položky. Vždy `shell_call`. Možné hodnoty: `shell_call`	Ano

OpenAI.ConversationItemFunctionShellCallOutput

Výstup volání nástroje prostředí, které se vygenerovalo.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem.	Ano
vytvořeno kým	řetězec	Identifikátor objektu actor, který položku vytvořil.	Ne
id	řetězec	Jedinečné ID výstupu volání prostředí. Naplněno při vrácení této položky přes rozhraní API.	Ano
max_output_length	OpenAI.integer (nullable)		Ano
výstup	pole OpenAI.FunctionShellCallOutputContent	Pole výstupního obsahu volání prostředí	Ano
typ	výčet	Typ výstupu volání prostředí. Vždy `shell_call_output`. Možné hodnoty: `shell_call_output`	Ano

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
id	řetězec	Jedinečné ID výstupu volání funkčního nástroje. Vyplněno při této položce se vrátí přes rozhraní API.	Ne
výstup	řetězec nebo pole OpenAI.FunctionAndCustomToolCallOutput	Výstup volání funkce generované vaším kódem. Může to být řetězec nebo seznam výstupního obsahu.	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`	Ne
typ	výčet	Typ výstupu volání nástroje funkce. Vždy `function_call_output`. Možné hodnoty: `function_call_output`	Ano

OpenAI.ConversationItemFunctionToolCallResource

Name	Typ	Description	Povinné
arguments	ř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
id	řetězec	Jedinečné ID volání nástroje funkcí.	Ne
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`	Ne
typ	výčet	Typ volání funkčního nástroje. Vždy `function_call`. Možné hodnoty: `function_call`	Ano

OpenAI.ConversationItemImageGenToolCall

Požadavek na generování obrazu vytvořený modelem.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání generování image.	Ano
result	řetězec (s možnou hodnotou null)		Ano
stav	výčet	Stav volání generování image. Možné hodnoty: `in_progress`, `completed`, `generating`, `failed`	Ano
typ	výčet	Typ volání generování image. Vždy `image_generation_call`. Možné hodnoty: `image_generation_call`	Ano

OpenAI.ConversationItemList

Seznam položek konverzace

Name	Typ	Description	Povinné
data	pole OpenAI.ConversationItem	Seznam položek konverzace	Ano
first_id	řetězec	ID první položky v seznamu.	Ano
má více	boolean	Jestli je k dispozici více položek.	Ano
last_id	řetězec	ID poslední položky v seznamu.	Ano
objekt	výčet	Typ vráceného objektu musí být `list`. Možné hodnoty: `list`	Ano

OpenAI.ConversationItemLocalShellToolCall

Volání nástroje ke spuštění příkazu v místním prostředí

Name	Typ	Description	Povinné
akce	OpenAI.LocalShellExecAction	Na serveru spusťte shell příkaz.	Ano
call_id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
id	řetězec	Jedinečné ID volání místního prostředí.	Ano
stav	výčet	Stav volání místního prostředí. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ volání místního prostředí. Vždy `local_shell_call`. Možné hodnoty: `local_shell_call`	Ano

OpenAI.ConversationItemLocalShellToolCallOutput

Výstup volání lokálního shell nástroje.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
výstup	řetězec	Řetězec ve formátu JSON jako výstup z volání lokálního shellového nástroje.	Ano
stav	výčet	Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ne
typ	výčet	Typ výstupu volání místního nástroje prostředí. Vždy `local_shell_call_output`. Možné hodnoty: `local_shell_call_output`	Ano

OpenAI.ConversationItemMcpApprovalRequest

Žádost o lidské schválení vyvolání nástroje.

Name	Typ	Description	Povinné
arguments	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
id	řetězec	Jedinečné ID žádosti o schválení.	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	Typ položky. Vždy `mcp_approval_request`. Možné hodnoty: `mcp_approval_request`	Ano

OpenAI.ConversationItemMcpApprovalResponseResource

Odpověď na žádost o schválení MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec	ID žádosti o schválení, na kterou se odpovídá.	Ano
approve	boolean	Zda byla žádost schválena.	Ano
id	řetězec	Jedinečné ID odpovědi na schválení	Ano
důvod	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ položky. Vždy `mcp_approval_response`. Možné hodnoty: `mcp_approval_response`	Ano

OpenAI.ConversationItemMcpListTools

Seznam nástrojů dostupných na serveru MCP

Name	Typ	Description	Povinné
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID seznamu.	Ano
označení serveru	řetězec	Popisek serveru MCP.	Ano
tools	pole OpenAI.MCPListToolsTools	Nástroje dostupné na serveru.	Ano
typ	výčet	Typ položky. Vždy `mcp_list_tools`. Možné hodnoty: `mcp_list_tools`	Ano

OpenAI.ConversationItemMcpToolCall

Vyvolání nástroje na serveru MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec (s možnou hodnotou null)		Ne
arguments	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID volání nástroje.	Ano
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
stav	OpenAI.MCPToolCallStatus		Ne
typ	výčet	Typ položky. Vždy `mcp_call`. Možné hodnoty: `mcp_call`	Ano

OpenAI.ConversationItemMessage

Zpráva do modelu nebo z modelu.

Name	Typ	Description	Povinné
obsah	pole OpenAI.MessageContent	Obsah zprávy	Ano
id	řetězec	Jedinečné ID zprávy.	Ano
role	OpenAI.MessageRole		Ano
stav	OpenAI.MessageStatus		Ano
typ	výčet	Typ zprávy. Vždy je nastavená na `message`. Možné hodnoty: `message`	Ano

OpenAI.ConversationItemReasoningItemItem

Popis řetězce myšlenky používaného modelem odůvodnění při generování odpovědi. Pokud ručně input, nezapomeňte do rozhraní API pro odpovědi zahrnout tyto položky do rozhraní API pro odpovědi.

Name	Typ	Description	Povinné
obsah	pole OpenAI.ReasoningTextContent	Zdůvodnění textového obsahu	Ne
encrypted_content	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečný identifikátor obsahu odůvodnění.	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`	Ne
souhrn	pole OpenAI. Shrnutí	Odůvodnění souhrnného obsahu	Ano
typ	výčet	Typ objektu. Vždy `reasoning`. Možné hodnoty: `reasoning`	Ano

OpenAI.ConversationItemType

Property Value

Typ řetězec

Hodnoty message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Výsledky volání webového vyhledávacího nástroje. Další informace najdete v průvodci vyhledáváním na webu .

Name	Typ	Description	Povinné
akce	OpenAI.WebSearchActionSearch nebo OpenAI.WebSearchActionOpenPage nebo OpenAI.WebSearchActionFind	Objekt popisující konkrétní akci prováděnou v tomto volání vyhledávání na webu. Obsahuje podrobnosti o tom, jak model používal web (vyhledávání, open_page, hledání).	Ano
id	řetězec	Jedinečné ID volání webového vyhledávacího nástroje.	Ano
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	Typ volání webového vyhledávacího nástroje. Vždy `web_search_call`. Možné hodnoty: `web_search_call`	Ano

OpenAI.ConversationParam

Konverzace, do které tato odpověď patří. Položky z této konverzace jsou předem připravené pro input_items tuto žádost o odpověď. Po dokončení této odpovědi se do této konverzace automaticky přidají vstupní položky a výstupní položky z této odpovědi.

Typ: řetězec nebo OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Konverzace, do které tato odpověď patří.

Name	Typ	Description	Povinné	Výchozí
id	řetězec	Jedinečné ID konverzace.	Ano

OpenAI.ConversationReference

Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.

Name	Typ	Description	Povinné	Výchozí
id	řetězec	Jedinečné ID konverzace, ke které byla tato odpověď přidružena.	Ano

OpenAI.ConversationResource

Name	Typ	Description	Povinné
datum_vytvoření	integer	Čas vytvoření konverzace měřený v sekundách od epochy Unixu.	Ano
id	řetězec	Jedinečné ID konverzace.	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
objekt	výčet	Typ objektu, který je vždy `conversation`. Možné hodnoty: `conversation`	Ano

OpenAI.CreateChatCompletionRequestResponseFormat

Objekt určující formát, který musí model vypíše. Nastavení pro { "type": "json_schema", "json_schema": {...} } povolení strukturovaných výstupů, které zajistí, že model bude odpovídat zadanému schématu JSON. Další informace najdete v průvodci strukturovanými výstupy. 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.CreateChatCompletionRequestResponseFormat

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

Hodnota typu	Schema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.CreateChatCompletionRequestResponseFormatType		Ano

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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é nebo uživatelské zprávy, která jej k tomu instruuje.

Name	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.CreateChatCompletionRequestResponseFormatResponseFormatText

Výchozí formát odpovědi Používá se ke generování textových odpovědí.

Name	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.CreateChatCompletionRequestResponseFormatType

Property	Value
Typ	řetězec
Hodnoty	`text` `json_schema` `json_object`

OpenAI.CreateConversationBody

Name	Typ	Description	Povinné	Výchozí
items	pole OpenAI.InputItem		Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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.

Name	Typ	Description	Povinné
zprávy_vstupu	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate nebo OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	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
model	řetězec	Název modelu, který se má použít ke generování kompletací (například "o3-mini").	Ne
parametry vzorkování	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Ne
odeslat k provedení	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource nebo OpenAI.EvalStoredCompletionsSource	Určuje, co naplní `item` obor názvů ve zdroji dat tohoto spuštění.	Ano
typ	výčet	Typ spuštění zdroje dat. Vždy `completions`. Možné hodnoty: `completions`	Ano

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Typ	Description	Povinné	Výchozí
item_reference	řetězec		Ano
typ	výčet	Možné hodnoty: `item_reference`	Ano

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Typ	Description	Povinné	Výchozí
šablona	pole OpenAI.EasyInputMessage nebo OpenAI.EvalItem		Ano
typ	výčet	Možné hodnoty: `template`	Ano

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Typ	Description	Povinné	Výchozí
max_completion_tokens	OpenAI.integer		Ne
úsilí o usuzování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
formát_odpovědi	OpenAI.ResponseFormatText nebo OpenAI.ResponseFormatJsonSchema nebo OpenAI.ResponseFormatJsonObject		Ne
seed	OpenAI.integer		Ne	42
Teplota	OpenAI.numeric		Ne	1
tools	pole OpenAI.ChatCompletionTool		Ne
top_p	OpenAI.numeric		Ne	1

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í procesu

Name	Typ	Description	Povinné
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.

Name	Typ	Description	Povinné	Výchozí
odeslat k provedení	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource	Určuje, co naplní `item` obor názvů ve zdroji dat.	Ano
typ	výčet	Typ zdroje dat. Vždy `jsonl`. Možné hodnoty: `jsonl`	Ano

OpenAI.CreateEvalLogsDataSourceConfig

Konfigurace zdroje dat, která určuje vlastnost metadat protokolového dotazu. Obvykle se jedná o metadata jako usecase=chatbot nebo prompt-version=v2atd.

Name	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.

Name	Typ	Description	Povinné
zprávy_vstupu	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
model	řetězec	Název modelu, který se má použít ke generování kompletací (například "o3-mini").	Ne
parametry vzorkování	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Ne
odeslat k provedení	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource nebo OpenAI.EvalResponsesSource	Určuje, co naplní `item` obor názvů ve zdroji dat tohoto spuštění.	Ano
typ	výčet	Typ spuštění zdroje dat. Vždy `responses`. Možné hodnoty: `responses`	Ano

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Typ	Description	Povinné	Výchozí
item_reference	řetězec		Ano
typ	výčet	Možné hodnoty: `item_reference`	Ano

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Typ	Description	Povinné	Výchozí
šablona	pole objektu nebo OpenAI.EvalItem		Ano
typ	výčet	Možné hodnoty: `template`	Ano

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Typ	Description	Povinné	Výchozí
max_completion_tokens	OpenAI.integer		Ne
úsilí o usuzování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
seed	OpenAI.integer		Ne	42
Teplota	OpenAI.numeric		Ne	1
poslat SMS	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Ne
tools	pole OpenAI.Tool		Ne
top_p	OpenAI.numeric		Ne	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	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

Již nepoužíváno, nahrazeno LogsDataSourceConfig.

Name	Typ	Description	Povinné	Výchozí
metadata	objekt	Filtry metadat pro uložené zdrojové data týkající se 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

Name	Typ	Description	Povinné	Výchozí
hyperparametry	OpenAI.CreateFineTuningJobRequestHyperparameters		Ne
└ batch_size	string nebo OpenAI.integer		Ne	auto
└─learning_rate_multiplier	string nebo OpenAI.numeric		Ne
└ n_epochs	string nebo OpenAI.integer		Ne	auto
integrace	pole OpenAI.CreateFineTuningJobRequestIntegrations	Seznam integrací, které lze povolit pro úlohu doladění.	Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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á doladit. Můžete vybrat jednu z možností podporované modely.	Ano
seed	OpenAI.integer (nullable)		Ne
Přípona	řetězec (s možnou hodnotou null)	Řetězec o velikosti až 64 znaků, který bude přidán k optimalizovanému názvu modelu. Například "`suffix` custom-model-name" vytvoří název modelu jako `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Omezení: minLength: 1, maxLength: 64	Ne
tréninkový soubor	řetězec	ID nahraného souboru, který obsahuje trénovací data. Jak nahrát soubor najdete v části nahrání souboru. 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 vyladěním .	Ano
validační_soubor	řetězec (s možnou hodnotou null)	ID nahraného souboru, který obsahuje ověřovací data. Pokud tento soubor zadáte, data se použijí k vygenerování ověření. Metriky jsou zaznamenávány pravidelně během dolaďování. Tyto metriky je možné zobrazit v soubor s výsledky jemného ladění. Stejná data by se neměla nacházet v trénovacích a ověřovacích souborech. Datová sada musí být naformátovaná jako soubor JSONL. Musíte soubor nahrát s tímto účelem `fine-tune`. Další podrobnosti najdete v průvodci vyladěním .	Ne

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Typ	Povinné
velikost dávky	string nebo OpenAI.integer	Ne
násobič rychlosti učení	string nebo OpenAI.numeric	Ne
počet epoch	string nebo OpenAI.integer	Ne

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `wandb`	Ano
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Ano

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Typ	Povinné
entita	řetězec (s možnou hodnotou null)	Ne
název	řetězec (s možnou hodnotou null)	Ne
projekt	řetězec	Ano
tags	pole řetězce	Ne

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

Gramatika definovaná uživatelem

Name	Typ	Description	Povinné
definice	řetězec	Definice gramatiky.	Ano
Syntaxe	OpenAI.GrammarSyntax1		Ano
typ	výčet	Formát gramatiky Vždy `grammar`. Možné hodnoty: `grammar`	Ano

OpenAI.CustomTextFormatParam

Nekontrénovaný volný text

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Nepřetrénovaný textový formát Vždy `text`. Možné hodnoty: `text`	Ano

OpenAI.CustomToolParam

Vlastní nástroj, který zpracovává vstup pomocí zadaného formátu. Další informace o vlastních nástrojích

Name	Typ	Description	Povinné
popis	řetězec	Volitelný popis vlastního nástroje, který slouží k poskytnutí dalšího kontextu.	Ne
format	OpenAI.CustomToolParamFormat	Vstupní formát vlastního nástroje. Výchozí hodnota je nekontrénovaný text.	Ne
└- typ	OpenAI.CustomToolParamFormatType		Ano
název	řetězec	Název vlastního nástroje, který se používá k jeho identifikaci ve voláních nástrojů.	Ano
typ	výčet	Typ vlastního nástroje. Vždy `custom`. Možné hodnoty: `custom`	Ano

OpenAI.CustomToolParamFormat

Vstupní formát vlastního nástroje. Výchozí hodnota je nekontrénovaný text.

Diskriminátor pro OpenAI.CustomToolParamFormat

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

Hodnota typu	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.CustomToolParamFormatType		Ano

OpenAI.CustomToolParamFormatType

Property	Value
Typ	řetězec
Hodnoty	`text` `grammar`

OpenAI.DeletedConversationResource

Name	Typ	Description	Povinné
smazaný	boolean		Ano
id	řetězec		Ano
objekt	výčet	Možné hodnoty: `conversation.deleted`	Ano

OpenAI.DetailEnum

Property	Value
Typ	řetězec
Hodnoty	`low` `high` `auto`

OpenAI.DoubleClickAction

Akce dvojkliku.

Name	Typ	Description	Povinné
typ	výčet	Určuje typ události. U akce poklikání je tato vlastnost vždy nastavena na `double_click`. Možné hodnoty: `double_click`	Ano
x	OpenAI.integer		Ano
y	OpenAI.integer		Ano

OpenAI.Drag

Akce přetažení

Name	Typ	Description	Povinné	Výchozí
cesta	pole OpenAI.DragPoint	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 nastavena jako vždy nastaveno na `drag`. Možné hodnoty: `drag`	Ano

OpenAI.DragPoint

Dvojice souřadnic x/y, například { x: 100, y: 200 }.

Name	Typ	Description	Povinné	Výchozí
x	OpenAI.integer		Ano
y	OpenAI.integer		Ano

OpenAI.EasyInputMessage

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.

Name	Typ	Description	Povinné
obsah	string nebo OpenAI.InputMessageContentList	Text, obrázek nebo zvukový vstup do modelu, který se používá k vygenerování odpovědi. Může také obsahovat předchozí odpovědi asistenta.	Ano
role	výčet	Role vstupu zprávy. Jeden z `user`, `assistant`, `system` nebo `developer`. Možné hodnoty: `user`, `assistant`, `system`, `developer`	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`	Ne
typ	výčet	Typ vstupu zprávy. Vždy `message`. Možné hodnoty: `message`	Ano

OpenAI.Error

Name	Typ	Povinné
doplňkové informace	objekt	Ne
kód	řetězec (s možnou hodnotou null)	Ano
debugInfo	objekt	Ne
Podrobnosti	pole OpenAI.Error	Ne
zpráva	řetězec	Ano
param	řetězec (s možnou hodnotou null)	Ne
typ	řetězec	Ne

OpenAI.EvalApiError

Objekt představující chybovou odpověď z rozhraní Eval API.

Name	Typ	Description	Povinné	Výchozí
kód	řetězec	Kód chyby.	Ano
zpráva	řetězec	Chybová zpráva.	Ano

OpenAI.EvalGraderLabelModel

Name	Typ	Description	Povinné
vstup	pole OpenAI.EvalItem		Ano
labels	pole řetězce	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 řetězce	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

Name	Typ	Description	Povinné
Štítek_obrázku	ř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	OpenAI.numeric		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

Name	Typ	Description	Povinné	Výchozí
vstup	pole OpenAI.EvalItem	Vstupní zprávy vyhodnocené klasiátorem. Podporuje bloky textového, výstupního textu, vstupního obrázku a vstupního zvukového obsahu a můžou obsahovat řetězce šablony.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení.	Ano
název	řetězec	Název hodnotitele.	Ano
prah průchodu	OpenAI.numeric		Ne
oblast	pole OpenAI.numeric	Rozsah skóre. Výchozí hodnota je `[0, 1]`.	Ne
parametry vzorkování	OpenAI.EvalGraderScoreModelSamplingParams		Ne
└max_completions_tokens	OpenAI.integer (nullable)		Ne
└─ úsilí_o_uvažování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
└semeno	OpenAI.integer (nullable)		Ne
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
typ	výčet	Typ objektu, který je vždy `score_model`. Možné hodnoty: `score_model`	Ano

OpenAI.EvalGraderScoreModelSamplingParams

Name	Typ	Description	Povinné	Výchozí
max_completions_tokens	OpenAI.integer (nullable)		Ne
úsilí o usuzování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
seed	OpenAI.integer (nullable)		Ne
Teplota	OpenAI.numeric (s možnou hodnotou null)		Ne
top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1

OpenAI.EvalGraderStringCheck

Name	Typ	Description	Povinné
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`, `like`nebo `ilike`. Možné hodnoty: `eq`, `ne`, `like`, `ilike`	Ano
odkazovat	řetězec	Referenční text. 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

Name	Typ	Description	Povinné
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	OpenAI.numeric		Ano
odkazovat	řetězec	Text, který se hodnotí podle.	Ano
typ	výčet	Typ grejdru. Možné hodnoty: `text_similarity`	Ano

OpenAI.EvalItem

Name	Typ	Description	Povinné
obsah	OpenAI.EvalItemContent	Vstupy do modelu – mohou obsahovat řetězce šablony. Podporuje text, výstupní text, vstupní obrázky a vstupní zvuk, a to buď jako jednu položku, nebo pole položek.	Ano
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.EvalItemContent

Vstupy do modelu – mohou obsahovat řetězce šablony. Podporuje text, výstupní text, vstupní obrázky a vstupní zvuk, a to buď jako jednu položku, nebo pole položek.

Typ: OpenAI.EvalItemContentItem nebo OpenAI.EvalItemContentArray

Vstupy do modelu – mohou obsahovat řetězce šablony. Podporuje text, výstupní text, vstupní obrázky a vstupní zvuk, a to buď jako jednu položku, nebo pole položek.

OpenAI.EvalItemContentArray

Seznam vstupů, z nichž každý může být vstupním textem, výstupním textem, vstupním obrázkem nebo vstupním zvukovým objektem.

Pole: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Jedna položka obsahu: vstupní text, výstupní text, vstupní obrázek nebo vstupní zvuk.

Typ: OpenAI.EvalItemContentText nebo OpenAI.EvalItemContentItemObject

Jedna položka obsahu: vstupní text, výstupní text, vstupní obrázek nebo vstupní zvuk.

OpenAI.EvalItemContentItemObject

Jedna položka obsahu: vstupní text, výstupní text, vstupní obrázek nebo vstupní zvuk.

Diskriminátor pro OpenAI.EvalItemContentItemObject

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

Hodnota typu	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.EvalItemContentItemObjectType		Ano

OpenAI.EvalItemContentItemObjectInputTextContent

Textový vstup do modelu.

Name	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.EvalItemContentItemObjectType

Property	Value
Typ	řetězec
Hodnoty	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Textový výstup z modelu.

Name	Typ	Description	Povinné	Výchozí
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.EvalItemContentText

Textový vstup do modelu.

Typ: řetězec

OpenAI.EvalItemInputImage

Blok vstupu obrázku používaný v polích obsahu EvalItem.

Name	Typ	Description	Povinné
detail	řetězec	Úroveň podrobností obrázku, která se má odeslat do modelu. Jeden z `high`, `low`nebo `auto`. Výchozí hodnota je `auto`.	Ne
image_url	řetězec	Adresa URL vstupu obrázku.	Ano
typ	výčet	Typ vstupu obrázku. Vždy `input_image`. Možné hodnoty: `input_image`	Ano

OpenAI.EvalJsonlFileContentSource

Name	Typ	Description	Povinné	Výchozí
obsah	pole OpenAI.EvalJsonlFileContentSourceContent	Obsah souboru jsonl.	Ano
typ	výčet	Typ zdroje jsonl. Vždy `file_content`. Možné hodnoty: `file_content`	Ano

OpenAI.EvalJsonlFileContentSourceContent

Name	Typ	Description	Povinné	Výchozí
položka	objekt		Ano
vzorek	objekt		Ne

OpenAI.EvalJsonlFileIdSource

Name	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

Objekt EvalResponsesSource popisující konfiguraci zdroje dat běhu.

Name	Typ	Description	Povinné
vytvořeno po	OpenAI.integer (nullable)		Ne
vytvořeno před	OpenAI.integer (nullable)		Ne
hledání_instrukcí	řetězec (s možnou hodnotou null)		Ne
metadata	objekt (nullable)		Ne
model	řetězec (s možnou hodnotou null)		Ne
úsilí o usuzování	OpenAI.ReasoningEffort (nullable)	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
Teplota	OpenAI.numeric (s možnou hodnotou null)		Ne
tools	pole řetězce		Ne
top_p	OpenAI.numeric (s možnou hodnotou null)		Ne
typ	výčet	Typ spuštění zdroje dat. Vždy `responses`. Možné hodnoty: `responses`	Ano
users	pole řetězce		Ne

OpenAI.EvalRunOutputItemSample

Name	Typ	Description	Povinné
chyba	OpenAI.EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ano
důvod ukončení	řetězec		Ano
vstup	pole EvalRunOutputItemSampleInput		Ano
max_completion_tokens	OpenAI.integer		Ano
model	řetězec		Ano
výstup	pole EvalRunOutputItemSampleOutput		Ano
seed	OpenAI.integer		Ano
Teplota	OpenAI.numeric		Ano
top_p	OpenAI.numeric		Ano
využití	OpenAI.EvalRunOutputItemSampleUsage		Ano

OpenAI.EvalRunOutputItemSampleUsage

Name	Typ	Povinné
cached_tokens	OpenAI.integer	Ano
completion_tokens	OpenAI.integer	Ano
prompt_tokens	OpenAI.integer	Ano
total_tokens	OpenAI.integer	Ano

OpenAI.EvalRunPerModelUsage

Name	Typ	Povinné
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

Name	Typ	Povinné
selhalo	OpenAI.integer	Ano
Předán	OpenAI.integer	Ano
testovací_kritéria	řetězec	Ano

OpenAI.EvalRunResultCounts

Name	Typ	Povinné
chyba	OpenAI.integer	Ano
selhalo	OpenAI.integer	Ano
Předán	OpenAI.integer	Ano
Celkem	OpenAI.integer	Ano

OpenAI.EvalStoredCompletionsSource

Konfigurace StoredCompletionsRunDataSource popisující sadu filtrů

Name	Typ	Description	Povinné
vytvořeno po	OpenAI.integer (nullable)		Ne
vytvořeno před	OpenAI.integer (nullable)		Ne
limit	OpenAI.integer (nullable)		Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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 (s možnou hodnotou null)		Ne
typ	výčet	Typ zdroje. Vždy `stored_completions`. Možné hodnoty: `stored_completions`	Ano

OpenAI.FileCitationBody

Citace souboru.

Name	Typ	Description	Povinné
ID souboru	řetězec	ID souboru.	Ano
filename	řetězec	Název citovaného souboru.	Ano
index	OpenAI.integer		Ano
typ	výčet	Typ citace souboru. Vždy `file_citation`. Možné hodnoty: `file_citation`	Ano

OpenAI.FilePath

Cesta k souboru.

Name	Typ	Description	Povinné
ID souboru	řetězec	ID souboru.	Ano
index	OpenAI.integer		Ano
typ	výčet	Typ cesty k souboru. Vždy `file_path`. Možné hodnoty: `file_path`	Ano

OpenAI.FileSearchTool

Nástroj, který hledá relevantní obsah z nahraných souborů.

Name	Typ	Description	Povinné
Filtry	OpenAI.Filters (s možnou hodnotou null)		Ne
max_počet_výsledků	OpenAI.integer		Ne
možnosti hodnocení	OpenAI.RankingOptions		Ne
└hybrid_search	OpenAI.HybridSearchOptions	Váhy, které určují, jak vzájemné pořadí fúzních fúzních zůstatků odpovídá sémantické vkládání shody versus řídké shody klíčových slov, když je povolené hybridní vyhledávání.	Ne
└- ranker	OpenAI.RankerVersionType	Ranker, který se má použít pro vyhledávání souborů.	Ne
└ score_threshold	OpenAI.numeric	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 řetězce	ID vektorových úložišť, která se mají prohledávat.	Ano

OpenAI.FileSearchToolCallResults

Name	Typ	Description	Povinné
attributes	OpenAI.VectorStoreFileAttributes (nullable)	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ím počtem délka 512 znaků, logických hodnot nebo čísel	Ne
ID souboru	řetězec		Ne
filename	řetězec		Ne
skóre	Číslo		Ne
poslat SMS	řetězec		Ne

OpenAI Filtry

Typ: OpenAI.ComparisonFilter nebo OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Hyperparametry používané pro úlohu vyladění DPO.

Name	Typ	Description	Povinné
velikost dávky	string nebo OpenAI.integer	Počet příkladů v každé dávce Větší velikost dávky znamená, že parametry modelu se aktualizují méně často, ale s nižší odchylkou.	Ne
beta verze	string nebo OpenAI.numeric	Hodnota beta pro metodu DPO. Vyšší hodnota beta zvýší váhu sankce mezi zásadou a referenčním modelem.	Ne
násobič rychlosti učení	string nebo OpenAI.numeric	Faktor škálování pro rychlost učení. Menší rychlost učení může být užitečná, aby se zabránilo přeučení.	Ne
počet epoch	string nebo OpenAI.integer	Počet epoch pro trénování modelu. Epocha označuje jeden celý cyklus skrze trénovací datovou sadu.	Ne

OpenAI.FineTuneDPOMethod

Konfigurace pro metodu jemného ladění DPO

Name	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í.

Name	Typ	Description	Povinné
dpo	OpenAI.FineTuneDPOMethod	Konfigurace pro metodu jemného ladění DPO	Ne
posílení	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`, `dpo`nebo `reinforcement`. Možné hodnoty: `supervised`, `dpo`, `reinforcement`	Ano

OpenAI.FineTuneReinforcementHyperparameters

Hyperparametry používané pro úlohu jemného ladění výztuže.

Name	Typ	Description	Povinné
velikost dávky	string nebo OpenAI.integer	Počet příkladů v každé dávce Větší velikost dávky znamená, že parametry modelu se aktualizují méně často, ale s nižší odchylkou.	Ne
compute_multiplier	string nebo OpenAI.numeric	Násobitel množství výpočetních prostředků používaných k prozkoumání vyhledávacího prostoru během trénování	Ne
eval_interval	string nebo OpenAI.integer	Počet trénovacích kroků mezi jednotlivými běhy vyhodnocení.	Ne
eval_samples	string nebo OpenAI.integer	Počet zkušebních ukázek, které se mají vygenerovat v jednotlivých krocích trénování	Ne
násobič rychlosti učení	string nebo OpenAI.numeric	Faktor škálování pro rychlost učení. Menší rychlost učení může být užitečná, aby se zabránilo přeučení.	Ne
počet epoch	string nebo OpenAI.integer	Počet epoch pro trénování modelu. Epocha označuje jeden celý cyklus skrze trénovací datovou sadu.	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

Name	Typ	Description	Povinné	Výchozí
posuzovatel	OpenAI.GraderStringCheck nebo OpenAI.GraderTextSimilarity nebo OpenAI.GraderPython nebo OpenAI.GraderScoreModel nebo OpenAI.GraderMulti	Grader použitý pro jemně vyladěnou úlohu.	Ano
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í.

Name	Typ	Description	Povinné
velikost dávky	string nebo OpenAI.integer	Počet příkladů v každé dávce Větší velikost dávky znamená, že parametry modelu se aktualizují méně často, ale s nižší odchylkou.	Ne
násobič rychlosti učení	string nebo OpenAI.numeric	Faktor škálování pro rychlost učení. Menší rychlost učení může být užitečná, aby se zabránilo přeučení.	Ne
počet epoch	string nebo OpenAI.integer	Počet epoch pro trénování modelu. Epocha označuje jeden celý cyklus skrze trénovací datovou sadu.	Ne

OpenAI.FineTuneSupervisedMethod

Konfigurace pro metodu jemného ladění pod dohledem

Name	Typ	Description	Povinné	Výchozí
hyperparametry	OpenAI.FineTuneSupervisedHyperparameters	Hyperparametry používané pro úlohu jemného ladění.	Ne

OpenAI.FineTuningIntegration

Name	Typ	Description	Povinné
typ	výčet	Typ integrace povolené pro úlohu jemného ladění Možné hodnoty: `wandb`	Ano
wandb	OpenAI.FineTuningIntegrationWandb		Ano
└– entita	řetězec (s možnou hodnotou null)		Ne
└– název	řetězec (s možnou hodnotou null)		Ne
└─ projekt	řetězec		Ano
└– značky	pole řetězce		Ne

OpenAI.FineTuningIntegrationWandb

Name	Typ	Povinné
entita	řetězec (s možnou hodnotou null)	Ne
název	řetězec (s možnou hodnotou null)	Ne
projekt	řetězec	Ano
tags	pole řetězce	Ne

OpenAI.FineTuningJob

Objekt fine_tuning.job představuje jemně vyladěnou úlohu, která byla vytvořena prostřednictvím rozhraní API.

Name	Typ	Description	Povinné	Výchozí
datum_vytvoření	integer	Časové razítko Unix (v sekundách) pro okamžik, kdy byla úloha jemného ladění vytvořena.	Ano
chyba	OpenAI.FineTuningJobError (nullable)		Ano
└ kód	řetězec		Ano
└- zpráva	řetězec		Ano
└- param	řetězec (s možnou hodnotou null)		Ano
odhadované dokončení	integer		Ne
jemně vyladěný model	řetězec (s možnou hodnotou null)		Ano
dokončeno v	integer		Ano
hyperparametry	OpenAI.FineTuningJobHyperparameters		Ano
└ batch_size	string nebo OpenAI.integer		Ne	auto
└─learning_rate_multiplier	string nebo OpenAI.numeric		Ne
└ n_epochs	string nebo OpenAI.integer		Ne	auto
id	řetězec	Identifikátor objektu, na který lze odkazovat v koncových bodech rozhraní API.	Ano
integrace	pole OpenAI.FineTuningIntegration		Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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	Základní model, který je v procesu dolaďování.	Ano
objekt	výčet	Typ objektu, který je vždy „fine_tuning.job“. Možné hodnoty: `fine_tuning.job`	Ano
identifikátor_organizace	řetězec	Organizace, která řídí úlohu doladění.	Ano
výsledkové_soubory	pole řetězce	ID zkompilovaných souborů výsledků pro úlohu jemného doladění. Výsledky můžete načíst pomocí rozhraní Files API.	Ano
seed	OpenAI.integer		Ano
stav	výčet	Aktuální stav fine-tuning úlohy, která může být buď `validating_files`, `queued`, `running`, `succeeded`, `failed` nebo `cancelled`. Možné hodnoty: `validating_files`, `queued`, `running`, `succeeded`, `failedcancelled`	Ano
trénované tokeny	OpenAI.integer (nullable)		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
validační_soubor	řetězec (s možnou hodnotou null)		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í.

Name	Typ	Description	Povinné
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	OpenAI.FineTuningJobCheckpointMetrics		Ano
└full_valid_loss	OpenAI.numeric		Ne
└─ plná přesnost průměrného platného tokenu	OpenAI.numeric		Ne
└─ Krok	OpenAI.numeric		Ne
└ train_loss	OpenAI.numeric		Ne
└─ train_mean_token_accuracy (průměrná přesnost tokenu během tréninku)	OpenAI.numeric		Ne
└- valid_loss	OpenAI.numeric		Ne
└─ platná_střední_přesnost_tokenu	OpenAI.numeric		Ne
objekt	výčet	Vždy se jedná o typ objektu "fine_tuning.job.checkpoint". Možné hodnoty: `fine_tuning.job.checkpoint`	Ano
číslo_kroku	OpenAI.integer		Ano

OpenAI.FineTuningJobCheckpointMetrics

Name	Typ	Povinné
full_valid_loss	OpenAI.numeric	Ne
full_valid_mean_token_accuracy	OpenAI.numeric	Ne
krokovat	OpenAI.numeric	Ne
train_loss	OpenAI.numeric	Ne
train_mean_token_accuracy	OpenAI.numeric	Ne
valid_loss	OpenAI.numeric	Ne
valid_mean_token_accuracy	OpenAI.numeric	Ne

OpenAI.FineTuningJobError

Name	Typ	Povinné
kód	řetězec	Ano
zpráva	řetězec	Ano
param	řetězec (s možnou hodnotou null)	Ano

OpenAI.FineTuningJobEvent

Vyladění objektu události úlohy

Name	Typ	Description	Povinné
datum_vytvoření	integer	Časové razítko Unix (v sekundách) pro okamžik, kdy byla úloha jemného ladění vytvořena.	Ano
data	OpenAI.FineTuningJobEventData		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.FineTuningJobEventData

Typ: objekt

OpenAI.FineTuningJobHyperparameters

Name	Typ	Povinné
velikost dávky	string nebo OpenAI.integer	Ne
násobič rychlosti učení	string nebo OpenAI.numeric	Ne
počet epoch	string nebo OpenAI.integer	Ne

OpenAI.FunctionAndCustomToolCallOutput

Diskriminátor pro OpenAI.FunctionAndCustomToolCallOutput

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

Hodnota typu	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.FunctionAndCustomToolCallOutputType		Ano

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Vstup souboru do modelu.

Name	Typ	Description	Povinné
file_data	řetězec	Obsah souboru, který se má odeslat do modelu.	Ne
ID souboru	řetězec (s možnou hodnotou null)		Ne
file_url	řetězec	Adresa URL 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.FunctionAndCustomToolCallOutputInputImageContent

Vstup obrázku do modelu. Přečtěte si o vstupech obrázků.

Name	Typ	Description	Povinné
detail	OpenAI.ImageDetail		Ano
ID souboru	řetězec (s možnou hodnotou null)		Ne
image_url	řetězec		Ne
typ	výčet	Typ vstupní položky. Vždy `input_image`. Možné hodnoty: `input_image`	Ano

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Textový vstup do modelu.

Name	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.FunctionAndCustomToolCallOutputType

Property	Value
Typ	řetězec
Hodnoty	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

Name	Typ	Description	Povinné
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
parameters	OpenAI.FunctionParameters	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu. Vynechání `parameters` definuje funkci s prázdným seznamem parametrů.	Ne
přísné	logická hodnota (s možnou hodnotou null)		Ne

OpenAI.FunctionParameters

Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON. Příklady najdete v příručce a referenční informace ke schématu JSON pro dokumentaci k formátu. Vynechání parameters definuje funkci s prázdným seznamem parametrů.

Typ: objekt

OpenAI.FunctionShellAction

Spusťte příkaz prostředí.

Name	Typ	Povinné
commands	pole řetězce	Ano
max_output_length	OpenAI.integer (nullable)	Ano
časový limit_ms	OpenAI.integer (nullable)	Ano

OpenAI.FunctionShellActionParam

Příkazy a omezení popisující, jak spustit volání nástroje prostředí

Name	Typ	Description	Povinné
commands	pole řetězce	Seřazené příkazy prostředí pro spuštění prostředí	Ano
max_output_length	OpenAI.integer (nullable)		Ne
časový limit_ms	OpenAI.integer (nullable)		Ne

OpenAI.FunctionShellCallItemStatus

Hodnoty stavu hlášené pro volání nástroje prostředí

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Obsah výstupu volání nástroje prostředí, který byl vygenerován.

Name	Typ	Description	Povinné
vytvořeno kým	řetězec	Identifikátor objektu actor, který položku vytvořil.	Ne
výsledek	OpenAI.FunctionShellCallOutputOutcome	Představuje výstupní výsledek (s ukončovacím kódem) nebo výstup časového limitu výstupního bloku volání prostředí.	Ano
└- typ	OpenAI.FunctionShellCallOutputOutcomeType		Ano
Stderr	řetězec	Standardní výstup chyby, který byl zachycen.	Ano
stdout	řetězec	Standardní výstup, který byl zachycen.	Ano

OpenAI.FunctionShellCallOutputContentParam

Zachycený výstup volání nástroje stdout a stderr pro část výstupu volání nástroje prostředí

Name	Typ	Description	Povinné
výsledek	OpenAI.FunctionShellCallOutputOutcomeParam	Výsledek ukončení nebo časového limitu přidružený k tomuto volání prostředí.	Ano
└- typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ano
Stderr	řetězec	Zachycený výstup stderru pro volání prostředí Omezení: maxLength: 10485760	Ano
stdout	řetězec	Zachycený výstup výstupu stdout pro volání prostředí Omezení: maxLength: 10485760	Ano

OpenAI.FunctionShellCallOutputExitOutcome

Označuje, že příkazy prostředí byly dokončeny a vrátily ukončovací kód.

Name	Typ	Description	Povinné	Výchozí
exit_code	OpenAI.integer		Ano
typ	výčet	Typ výsledku. Vždy `exit`. Možné hodnoty: `exit`	Ano

OpenAI.FunctionShellCallOutputExitOutcomeParam

Označuje, že příkazy prostředí byly dokončeny a vrátily ukončovací kód.

Name	Typ	Description	Povinné	Výchozí
exit_code	OpenAI.integer		Ano
typ	výčet	Typ výsledku. Vždy `exit`. Možné hodnoty: `exit`	Ano

OpenAI.FunctionShellCallOutputOutcome

Představuje výstupní výsledek (s ukončovacím kódem) nebo výstup časového limitu výstupního bloku volání prostředí.

Diskriminátor pro OpenAI.FunctionShellCallOutputOutcome

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

Hodnota typu	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.FunctionShellCallOutputOutcomeType		Ano

OpenAI.FunctionShellCallOutputOutcomeParam

Výsledek ukončení nebo časového limitu přidružený k tomuto volání prostředí.

Diskriminátor pro OpenAI.FunctionShellCallOutputOutcomeParam

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

Hodnota typu	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ano

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Value
Typ	řetězec
Hodnoty	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Typ	řetězec
Hodnoty	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Označuje, že volání prostředí překročilo nakonfigurovaný časový limit.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ výsledku. Vždy `timeout`. Možné hodnoty: `timeout`	Ano

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Označuje, že volání prostředí překročilo nakonfigurovaný časový limit.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ výsledku. Vždy `timeout`. Možné hodnoty: `timeout`	Ano

OpenAI.FunctionShellToolParam

Nástroj, který umožňuje modelu spouštět příkazy prostředí.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ nástroje prostředí. Vždy `shell`. Možné hodnoty: `shell`	Ano

OpenAI.FunctionTool

Ve vašem vlastním kódu definuje funkci, kterou může model volitelně volat.

Name	Typ	Description	Povinné
popis	řetězec (s možnou hodnotou null)		Ne
název	řetězec	Název funkce, kterou volat.	Ano
parameters	objekt (nullable)		Ano
přísné	logická hodnota (s možnou hodnotou null)		Ano
typ	výčet	Typ nástroje funkce. Vždy `function`. Možné hodnoty: `function`	Ano

OpenAI.GraderLabelModel

Objekt LabelModelGrader, který používá model k přiřazení popisků ke každé položce v vyhodnocení.

Name	Typ	Description	Povinné
vstup	pole OpenAI.EvalItem		Ano
labels	pole řetězce	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 řetězce	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ýstupy více hodnotitelů, aby vytvořil jediný výsledek.

Name	Typ	Description	Povinné
vypočítat_výstup	řetězec	Vzorec pro výpočet výstupu na základě výsledků hodnocení.	Ano
Grejdry	OpenAI.GraderStringCheck nebo OpenAI.GraderTextSimilarity nebo OpenAI.GraderPython nebo OpenAI.GraderScoreModel nebo OpenAI.GraderLabelModel		Ano
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.

Name	Typ	Description	Povinné
Štítek_obrázku	ř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.

Name	Typ	Description	Povinné	Výchozí
vstup	pole OpenAI.EvalItem	Vstupní zprávy vyhodnocené klasiátorem. Podporuje bloky textového, výstupního textu, vstupního obrázku a vstupního zvukového obsahu a můžou obsahovat řetězce šablony.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení.	Ano
název	řetězec	Název hodnotitele.	Ano
oblast	pole OpenAI.numeric	Rozsah skóre. Výchozí hodnota je `[0, 1]`.	Ne
parametry vzorkování	OpenAI.EvalGraderScoreModelSamplingParams		Ne
└max_completions_tokens	OpenAI.integer (nullable)		Ne
└─ úsilí_o_uvažování	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
└semeno	OpenAI.integer (nullable)		Ne
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
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.

Name	Typ	Description	Povinné
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`, `like`nebo `ilike`. Možné hodnoty: `eq`, `ne`, `like`, `ilike`	Ano
odkazovat	řetězec	Referenční text. 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.

Name	Typ	Description	Povinné
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.GrammarSyntax1

Property	Value
Typ	řetězec
Hodnoty	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Typ	Description	Povinné	Výchozí
embedding_weight	OpenAI.numeric		Ano
text_weight	OpenAI.numeric		Ano

OpenAI.ImageDetail

Property	Value
Typ	řetězec
Hodnoty	`low` `high` `auto`

OpenAI.ImageGenTool

Nástroj, který generuje obrázky pomocí modelů obrázků GPT.

Platné modely:

gpt-image-1
gpt-image-1-mini

Name	Typ	Description	Povinné	Výchozí
na pozadí	výčet	Typ pozadí pro vygenerovaný obrázek Jeden z `transparent`. `opaque`nebo `auto`. Výchozí hodnota: `auto`. Možné hodnoty: `transparent`, `opaque`, `auto`	Ne
input_fidelity	OpenAI.InputFidelity (nullable)	Určete, kolik úsilí bude model vyvíjet, aby odpovídal stylu a funkcím, zejména obličejových rysů, vstupních obrázků. Tento parametr je podporován pouze pro `gpt-image-1`. Nepodporováno pro `gpt-image-1-mini`. Podporuje `high` a `low`. Výchozí hodnota je `low`.	Ne
vstupní_obrázková_maska	OpenAI.ImageGenToolInputImageMask		Ne
└ file_id	řetězec		Ne
└─ image_url	řetězec		Ne
model	řetězec (viz následující platné modely)		Ne
Moderování	výčet	Úroveň moderování pro vygenerovanou image Výchozí hodnota: `auto`. Možné hodnoty: `auto`, `low`	Ne
komprese_výstupu	OpenAI.integer		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	OpenAI.integer		Ne
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` `1536x1024`nebo `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.ImageGenToolInputImageMask

Name	Typ	Description	Povinné	Výchozí
ID souboru	řetězec		Ne
image_url	řetězec		Ne

OpenAI.IncludeEnum

Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou:

web_search_call.action.sources: Zahrňte zdroje volání webového vyhledávacího nástroje.
code_interpreter_call.outputs: Zahrnuje výsledky provedení kódu Pythonu v položkách volání nástroje pro interpretaci kódu.
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 logprobs se zprávami asistenta.
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).

Property	Value
Description	Zadejte další výstupní data, která se mají zahrnout do odpovědi modelu. Aktuálně podporované hodnoty jsou:

web_search_call.action.sources: Zahrňte zdroje volání webového vyhledávacího nástroje.
code_interpreter_call.outputs: Zahrnuje výsledky provedení kódu Pythonu v položkách volání nástroje pro interpretaci kódu.
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 logprobs se zprávami asistenta.
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). | | Typ | řetězec | | Hodnoty | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

Zvukový vstup do modelu.

Name	Typ	Description	Povinné	Výchozí
input_audio	OpenAI.InputAudioInputAudio		Ano
typ	výčet	Typ vstupní položky. Vždy `input_audio`. Možné hodnoty: `input_audio`	Ano

OpenAI.InputAudioInputAudio

Name	Typ	Description	Povinné	Výchozí
data	řetězec		Ano
format	výčet	Možné hodnoty: `mp3`, `wav`	Ano

OpenAI.InputContent

Diskriminátor pro OpenAI.InputContent

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

Hodnota typu	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.InputContentType		Ano

OpenAI.InputContentInputFileContent

Vstup souboru do modelu.

Name	Typ	Description	Povinné
file_data	řetězec	Obsah souboru, který se má odeslat do modelu.	Ne
ID souboru	řetězec (s možnou hodnotou null)		Ne
file_url	řetězec	Adresa URL 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.InputContentInputImageContent

Vstup obrázku do modelu. Přečtěte si o vstupech obrázků.

Name	Typ	Description	Povinné
detail	OpenAI.ImageDetail		Ano
ID souboru	řetězec (s možnou hodnotou null)		Ne
image_url	řetězec		Ne
typ	výčet	Typ vstupní položky. Vždy `input_image`. Možné hodnoty: `input_image`	Ano

OpenAI.InputContentInputTextContent

Textový vstup do modelu.

Name	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.InputContentType

Property	Value
Typ	řetězec
Hodnoty	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Určete, kolik úsilí bude model vyvíjet, aby odpovídal stylu a funkcím, zejména obličejových rysů, vstupních obrázků. Tento parametr je podporován pouze pro gpt-image-1. Nepodporováno pro gpt-image-1-mini. Podporuje high a low. Výchozí hodnota je low.

Property	Value
Typ	řetězec
Hodnoty	`high` `low`

OpenAI.InputFileContent

Vstup souboru do modelu.

Name	Typ	Description	Povinné
file_data	řetězec	Obsah souboru, který se má odeslat do modelu.	Ne
ID souboru	řetězec (s možnou hodnotou null)		Ne
file_url	řetězec	Adresa URL 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.InputFileContentParam

Vstup souboru do modelu.

Name	Typ	Description	Povinné
file_data	řetězec (s možnou hodnotou null)		Ne
ID souboru	řetězec (s možnou hodnotou null)		Ne
file_url	řetězec		Ne
filename	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ vstupní položky. Vždy `input_file`. Možné hodnoty: `input_file`	Ano

OpenAI.InputImageContent

Vstup obrázku do modelu. Přečtěte si o vstupech obrázků.

Name	Typ	Description	Povinné
detail	OpenAI.ImageDetail		Ano
ID souboru	řetězec (s možnou hodnotou null)		Ne
image_url	řetězec		Ne
typ	výčet	Typ vstupní položky. Vždy `input_image`. Možné hodnoty: `input_image`	Ano

OpenAI.InputImageContentParamAutoParam

Vstup obrázku do modelu. Informace o vstupech obrázků

Name	Typ	Description	Povinné
detail	OpenAI.DetailEnum (s možnou hodnotou null)		Ne
ID souboru	řetězec (s možnou hodnotou null)		Ne
image_url	řetězec		Ne
typ	výčet	Typ vstupní položky. Vždy `input_image`. Možné hodnoty: `input_image`	Ano

OpenAI.InputItem

Položka představující část kontextu pro odpověď, která se má vygenerovat modelem. Může obsahovat text, obrázky a zvukové vstupy a také předchozí odpovědi asistenta a výstupy volání nástroje.

Diskriminátor pro OpenAI.InputItem

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

Hodnota typu	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItemItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.InputItemType		Ano

OpenAI.InputItemApplyPatchToolCallItemParam

Volání nástroje představující požadavek na vytvoření, odstranění nebo aktualizaci souborů pomocí diff oprav.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
operace	OpenAI.ApplyPatchOperationParam	Jeden z create_file, delete_file nebo update_file operací poskytovaných nástroji apply_patch.	Ano
└- typ	OpenAI.ApplyPatchOperationParamType		Ano
stav	OpenAI.ApplyPatchCallStatusParam	Hodnoty stavu hlášené pro volání nástroje apply_patch	Ano
typ	výčet	Typ položky. Vždy `apply_patch_call`. Možné hodnoty: `apply_patch_call`	Ano

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Streamovaný výstup vygenerovaný voláním nástroje apply patch

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
výstup	řetězec (s možnou hodnotou null)		Ne
stav	OpenAI.ApplyPatchCallOutputStatusParam	Hodnoty výsledku hlášené pro výstupy volání nástroje apply_patch	Ano
typ	výčet	Typ položky. Vždy `apply_patch_call_output`. Možné hodnoty: `apply_patch_call_output`	Ano

OpenAI.InputItemCodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Name	Typ	Description	Povinné
kód	řetězec (s možnou hodnotou null)		Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
id	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Ano
outputs	pole OpenAI.CodeInterpreterOutputLogs nebo OpenAI.CodeInterpreterOutputImage		Ano
stav	výčet	Stav volání nástroje interpreta kódu. Platné hodnoty jsou `in_progress`, , `completedincomplete`, `interpreting`a `failed`. Možné hodnoty: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Ano
typ	výčet	Typ volání nástroje interpreta kódu. Vždy `code_interpreter_call`. Možné hodnoty: `code_interpreter_call`	Ano

OpenAI.InputItemCompactionSummaryItemParam

Komprimace položky vygenerované rozhranímv1/responses/compact API

Name	Typ	Description	Povinné
encrypted_content	řetězec	Šifrovaný obsah souhrnu komprimace. Omezení: maxLength: 10485760	Ano
id	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ položky. Vždy `compaction`. Možné hodnoty: `compaction`	Ano

OpenAI.InputItemComputerCallOutputItemParam

Výstup z volání počítačového nástroje.

Name	Typ	Description	Povinné
acknowledged_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam		Ne
call_id	řetězec	ID volání počítačového nástroje, které vytvořilo výstup. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
výstup	OpenAI.ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano
stav	OpenAI.FunctionCallItemStatus (nullable)		Ne
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy `computer_call_output`. Možné hodnoty: `computer_call_output`	Ano

OpenAI.InputItemComputerToolCall

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 .

Name	Typ	Description	Povinné
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
id	řetězec	Jedinečné ID počítačového volání.	Ano
pending_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	Č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	Typ hovoru počítačem. Vždy `computer_call`. Možné hodnoty: `computer_call`	Ano

OpenAI.InputItemCustomToolCall

Volání vlastního nástroje vytvořeného modelem

Name	Typ	Description	Povinné
call_id	řetězec	Identifikátor použitý k mapování tohoto vlastního volání nástroje na výstup volání nástroje.	Ano
id	řetězec	Jedinečné ID volání vlastního nástroje na platformě OpenAI.	Ne
vstup	řetězec	Vstup pro volání vlastního nástroje vygenerovaného modelem.	Ano
název	řetězec	Název volaného vlastního nástroje.	Ano
typ	výčet	Typ volání vlastního nástroje. Vždy `custom_tool_call`. Možné hodnoty: `custom_tool_call`	Ano

OpenAI.InputItemCustomToolCallOutput

Výstup vlastního volání nástroje z kódu, který se odesílá zpět do modelu.

Name	Typ	Description	Povinné
call_id	řetězec	ID volání, které se používá k mapování výstupu volání tohoto vlastního nástroje na vlastní volání nástroje.	Ano
id	řetězec	Jedinečné ID výstupu volání vlastního nástroje na platformě OpenAI.	Ne
výstup	řetězec nebo pole OpenAI.FunctionAndCustomToolCallOutput	Výstup z volání vlastního nástroje vygenerovaného vaším kódem Může to být řetězec nebo seznam výstupního obsahu.	Ano
typ	výčet	Typ výstupu volání vlastního nástroje. Vždy `custom_tool_call_output`. Možné hodnoty: `custom_tool_call_output`	Ano

OpenAI.InputItemFileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Ano
Dotazy	pole řetězce	Dotazy používané k hledání souborů.	Ano
results	pole OpenAI.FileSearchToolCallResults		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	Typ volání nástroje pro vyhledávání souborů. Vždy `file_search_call`. Možné hodnoty: `file_search_call`	Ano

OpenAI.InputItemFunctionCallOutputItemParam

Výstup z volání funkčního nástroje.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
výstup	řetězec nebo pole OpenAI.InputTextContentParam nebo OpenAI.InputImageContentParamAutoParam nebo OpenAI.InputFileContentParam	Text, obrázek nebo výstup souboru volání nástroje funkcí	Ano
stav	OpenAI.FunctionCallItemStatus (nullable)		Ne
typ	výčet	Typ výstupu volání nástroje funkce. Vždy `function_call_output`. Možné hodnoty: `function_call_output`	Ano

OpenAI.InputItemFunctionShellCallItemParam

Nástroj představující požadavek na spuštění jednoho nebo více příkazů prostředí.

Name	Typ	Description	Povinné
akce	OpenAI.FunctionShellActionParam	Příkazy a omezení popisující, jak spustit volání nástroje prostředí	Ano
└– příkazy	pole řetězce	Seřazené příkazy prostředí pro spuštění prostředí	Ano
└max_output_length	OpenAI.integer (nullable)		Ne
└timeout_ms	OpenAI.integer (nullable)		Ne
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
stav	OpenAI.FunctionShellCallItemStatus (nullable)	Hodnoty stavu hlášené pro volání nástroje prostředí	Ne
typ	výčet	Typ položky. Vždy `shell_call`. Možné hodnoty: `shell_call`	Ano

OpenAI.InputItemFunctionShellCallOutputItemParam

Streamované výstupní položky generované voláním nástroje prostředí.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
max_output_length	OpenAI.integer (nullable)		Ne
výstup	pole OpenAI.FunctionShellCallOutputContentParam	Zachycené bloky výstupu stdout a stderr spolu s přidruženými výsledky	Ano
typ	výčet	Typ položky. Vždy `shell_call_output`. Možné hodnoty: `shell_call_output`	Ano

OpenAI.InputItemFunctionToolCall

Volání nástroje ke spuštění funkce Další informace najdete v průvodci voláním funkcí .

Name	Typ	Description	Povinné
arguments	ř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
id	řetězec	Jedinečné ID volání nástroje funkcí.	Ne
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`	Ne
typ	výčet	Typ volání funkčního nástroje. Vždy `function_call`. Možné hodnoty: `function_call`	Ano

OpenAI.InputItemImageGenToolCall

Požadavek na generování obrazu vytvořený modelem.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání generování image.	Ano
result	řetězec (s možnou hodnotou null)		Ano
stav	výčet	Stav volání generování image. Možné hodnoty: `in_progress`, `completed`, `generating`, `failed`	Ano
typ	výčet	Typ volání generování image. Vždy `image_generation_call`. Možné hodnoty: `image_generation_call`	Ano

OpenAI.InputItemLocalShellToolCall

Volání nástroje ke spuštění příkazu v místním prostředí

Name	Typ	Description	Povinné
akce	OpenAI.LocalShellExecAction	Na serveru spusťte shell příkaz.	Ano
call_id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
id	řetězec	Jedinečné ID volání místního prostředí.	Ano
stav	výčet	Stav volání místního prostředí. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ volání místního prostředí. Vždy `local_shell_call`. Možné hodnoty: `local_shell_call`	Ano

OpenAI.InputItemLocalShellToolCallOutput

Výstup volání lokálního shell nástroje.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
výstup	řetězec	Řetězec ve formátu JSON jako výstup z volání lokálního shellového nástroje.	Ano
stav	výčet	Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ne
typ	výčet	Typ výstupu volání místního nástroje prostředí. Vždy `local_shell_call_output`. Možné hodnoty: `local_shell_call_output`	Ano

OpenAI.InputItemMcpApprovalRequest

Žádost o lidské schválení vyvolání nástroje.

Name	Typ	Description	Povinné
arguments	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
id	řetězec	Jedinečné ID žádosti o schválení.	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	Typ položky. Vždy `mcp_approval_request`. Možné hodnoty: `mcp_approval_request`	Ano

OpenAI.InputItemMcpApprovalResponse

Odpověď na žádost o schválení MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec	ID žádosti o schválení, na kterou se odpovídá.	Ano
approve	boolean	Zda byla žádost schválena.	Ano
id	řetězec (s možnou hodnotou null)		Ne
důvod	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ položky. Vždy `mcp_approval_response`. Možné hodnoty: `mcp_approval_response`	Ano

OpenAI.InputItemMcpListTools

Seznam nástrojů dostupných na serveru MCP

Name	Typ	Description	Povinné
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID seznamu.	Ano
označení serveru	řetězec	Popisek serveru MCP.	Ano
tools	pole OpenAI.MCPListToolsTools	Nástroje dostupné na serveru.	Ano
typ	výčet	Typ položky. Vždy `mcp_list_tools`. Možné hodnoty: `mcp_list_tools`	Ano

OpenAI.InputItemMcpToolCall

Vyvolání nástroje na serveru MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec (s možnou hodnotou null)		Ne
arguments	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID volání nástroje.	Ano
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
stav	OpenAI.MCPToolCallStatus		Ne
typ	výčet	Typ položky. Vždy `mcp_call`. Možné hodnoty: `mcp_call`	Ano

OpenAI.InputItemOutputMessage

Výstupní zpráva z modelu

Name	Typ	Description	Povinné
obsah	pole OpenAI.OutputMessageContent	Obsah výstupní zprávy.	Ano
id	řetězec	Jedinečné ID výstupní zprávy.	Ano
role	výčet	Role výstupní zprávy. Vždy `assistant`. Možné hodnoty: `assistant`	Ano
stav	výčet	Stav vstupu zprávy. jeden z `in_progress`, `completed`, nebo `incomplete`. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ výstupní zprávy. Vždy `message`. Možné hodnoty: `output_message`	Ano

OpenAI.InputItemReasoningItemItem

Name	Typ	Description	Povinné
obsah	pole OpenAI.ReasoningTextContent	Zdůvodnění textového obsahu	Ne
encrypted_content	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečný identifikátor obsahu odůvodnění.	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`	Ne
souhrn	pole OpenAI. Shrnutí	Odůvodnění souhrnného obsahu	Ano
typ	výčet	Typ objektu. Vždy `reasoning`. Možné hodnoty: `reasoning`	Ano

OpenAI.InputItemType

Property Value

Typ řetězec

Hodnoty message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference

OpenAI.InputItemWebSearchToolCall

Výsledky volání webového vyhledávacího nástroje. Další informace najdete v průvodci vyhledáváním na webu .

Name	Typ	Description	Povinné
akce	OpenAI.WebSearchActionSearch nebo OpenAI.WebSearchActionOpenPage nebo OpenAI.WebSearchActionFind	Objekt popisující konkrétní akci prováděnou v tomto volání vyhledávání na webu. Obsahuje podrobnosti o tom, jak model používal web (vyhledávání, open_page, hledání).	Ano
id	řetězec	Jedinečné ID volání webového vyhledávacího nástroje.	Ano
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	Typ volání webového vyhledávacího nástroje. Vždy `web_search_call`. Možné hodnoty: `web_search_call`	Ano

OpenAI.InputMessage

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.

Name	Typ	Description	Povinné
obsah	OpenAI.InputMessageContentList	Seznam jedné nebo více vstupních položek modelu obsahující jiný obsah types.	Ano
role	výčet	Role vstupu zprávy. Jeden z `user`, `system`nebo `developer`. Možné hodnoty: `user`, `system`, `developer`	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`	Ne
typ	výčet	Typ vstupu zprávy. Vždy je nastavená na `message`. Možné hodnoty: `message`	Ano

OpenAI.InputMessageContentList

Seznam jedné nebo více vstupních položek modelu, který obsahuje různé typy obsahu.

Pole: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Typ	Description	Povinné
obsah	OpenAI.InputMessageContentList	Seznam jedné nebo více vstupních položek modelu obsahující jiný obsah types.	Ano
id	řetězec	Jedinečné ID vstupu zprávy.	Ano
role	výčet	Role vstupu zprávy. Jeden z `user`, `system`nebo `developer`. Možné hodnoty: `user`, `system`, `developer`	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`	Ne
typ	výčet	Typ vstupu zprávy. Vždy je nastavená na `message`. Možné hodnoty: `message`	Ano

OpenAI.InputParam

Textové, obrázkové nebo souborové vstupy do modelu, které se používají k vygenerování odpovědi. Další informace:

Typ: řetězec nebo pole OpenAI.InputItem

Textové, obrázkové nebo souborové vstupy do modelu, které se používají k vygenerování odpovědi. Další informace:

OpenAI.InputTextContent

Textový vstup do modelu.

Name	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.InputTextContentParam

Textový vstup do modelu.

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Textový vstup do modelu. Omezení: maxLength: 10485760	Ano
typ	výčet	Typ vstupní položky. Vždy `input_text`. Možné hodnoty: `input_text`	Ano

OpenAI.Item

Položka obsahu použitá k vygenerování odpovědi

Diskriminátor pro OpenAI.Item

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

Hodnota typu	Schema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ItemType		Ano

OpenAI.ItemApplyPatchToolCallItemParam

Volání nástroje představující požadavek na vytvoření, odstranění nebo aktualizaci souborů pomocí diff oprav.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
operace	OpenAI.ApplyPatchOperationParam	Jeden z create_file, delete_file nebo update_file operací poskytovaných nástroji apply_patch.	Ano
└- typ	OpenAI.ApplyPatchOperationParamType		Ano
stav	OpenAI.ApplyPatchCallStatusParam	Hodnoty stavu hlášené pro volání nástroje apply_patch	Ano
typ	výčet	Typ položky. Vždy `apply_patch_call`. Možné hodnoty: `apply_patch_call`	Ano

OpenAI.ItemApplyPatchToolCallOutputItemParam

Streamovaný výstup vygenerovaný voláním nástroje apply patch

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
výstup	řetězec (s možnou hodnotou null)		Ne
stav	OpenAI.ApplyPatchCallOutputStatusParam	Hodnoty výsledku hlášené pro výstupy volání nástroje apply_patch	Ano
typ	výčet	Typ položky. Vždy `apply_patch_call_output`. Možné hodnoty: `apply_patch_call_output`	Ano

OpenAI.ItemCodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Name	Typ	Description	Povinné
kód	řetězec (s možnou hodnotou null)		Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
id	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Ano
outputs	pole OpenAI.CodeInterpreterOutputLogs nebo OpenAI.CodeInterpreterOutputImage		Ano
stav	výčet	Stav volání nástroje interpreta kódu. Platné hodnoty jsou `in_progress`, , `completedincomplete`, `interpreting`a `failed`. Možné hodnoty: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Ano
typ	výčet	Typ volání nástroje interpreta kódu. Vždy `code_interpreter_call`. Možné hodnoty: `code_interpreter_call`	Ano

OpenAI.ItemCompactionSummaryItemParam

Komprimace položky vygenerované rozhranímv1/responses/compact API

Name	Typ	Description	Povinné
encrypted_content	řetězec	Šifrovaný obsah souhrnu komprimace. Omezení: maxLength: 10485760	Ano
id	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ položky. Vždy `compaction`. Možné hodnoty: `compaction`	Ano

OpenAI.ItemComputerCallOutputItemParam

Výstup z volání počítačového nástroje.

Name	Typ	Description	Povinné
acknowledged_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam		Ne
call_id	řetězec	ID volání počítačového nástroje, které vytvořilo výstup. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
výstup	OpenAI.ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano
stav	OpenAI.FunctionCallItemStatus (nullable)		Ne
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy `computer_call_output`. Možné hodnoty: `computer_call_output`	Ano

OpenAI.ItemComputerToolCall

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 .

Name	Typ	Description	Povinné
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
id	řetězec	Jedinečné ID počítačového volání.	Ano
pending_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	Č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	Typ hovoru počítačem. Vždy `computer_call`. Možné hodnoty: `computer_call`	Ano

OpenAI.ItemCustomToolCall

Volání vlastního nástroje vytvořeného modelem

Name	Typ	Description	Povinné
call_id	řetězec	Identifikátor použitý k mapování tohoto vlastního volání nástroje na výstup volání nástroje.	Ano
id	řetězec	Jedinečné ID volání vlastního nástroje na platformě OpenAI.	Ne
vstup	řetězec	Vstup pro volání vlastního nástroje vygenerovaného modelem.	Ano
název	řetězec	Název volaného vlastního nástroje.	Ano
typ	výčet	Typ volání vlastního nástroje. Vždy `custom_tool_call`. Možné hodnoty: `custom_tool_call`	Ano

OpenAI.ItemCustomToolCallOutput

Výstup vlastního volání nástroje z kódu, který se odesílá zpět do modelu.

Name	Typ	Description	Povinné
call_id	řetězec	ID volání, které se používá k mapování výstupu volání tohoto vlastního nástroje na vlastní volání nástroje.	Ano
id	řetězec	Jedinečné ID výstupu volání vlastního nástroje na platformě OpenAI.	Ne
výstup	řetězec nebo pole OpenAI.FunctionAndCustomToolCallOutput	Výstup z volání vlastního nástroje vygenerovaného vaším kódem Může to být řetězec nebo seznam výstupního obsahu.	Ano
typ	výčet	Typ výstupu volání vlastního nástroje. Vždy `custom_tool_call_output`. Možné hodnoty: `custom_tool_call_output`	Ano

OpenAI.ItemFileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Ano
Dotazy	pole řetězce	Dotazy používané k hledání souborů.	Ano
results	pole OpenAI.FileSearchToolCallResults		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	Typ volání nástroje pro vyhledávání souborů. Vždy `file_search_call`. Možné hodnoty: `file_search_call`	Ano

OpenAI.ItemFunctionCallOutputItemParam

Výstup z volání funkčního nástroje.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
výstup	řetězec nebo pole OpenAI.InputTextContentParam nebo OpenAI.InputImageContentParamAutoParam nebo OpenAI.InputFileContentParam	Text, obrázek nebo výstup souboru volání nástroje funkcí	Ano
stav	OpenAI.FunctionCallItemStatus (nullable)		Ne
typ	výčet	Typ výstupu volání nástroje funkce. Vždy `function_call_output`. Možné hodnoty: `function_call_output`	Ano

OpenAI.ItemFunctionShellCallItemParam

Nástroj představující požadavek na spuštění jednoho nebo více příkazů prostředí.

Name	Typ	Description	Povinné
akce	OpenAI.FunctionShellActionParam	Příkazy a omezení popisující, jak spustit volání nástroje prostředí	Ano
└– příkazy	pole řetězce	Seřazené příkazy prostředí pro spuštění prostředí	Ano
└max_output_length	OpenAI.integer (nullable)		Ne
└timeout_ms	OpenAI.integer (nullable)		Ne
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
stav	OpenAI.FunctionShellCallItemStatus (nullable)	Hodnoty stavu hlášené pro volání nástroje prostředí	Ne
typ	výčet	Typ položky. Vždy `shell_call`. Možné hodnoty: `shell_call`	Ano

OpenAI.ItemFunctionShellCallOutputItemParam

Streamované výstupní položky generované voláním nástroje prostředí.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem. Omezení: minLength: 1, maxLength: 64	Ano
id	řetězec (s možnou hodnotou null)		Ne
max_output_length	OpenAI.integer (nullable)		Ne
výstup	pole OpenAI.FunctionShellCallOutputContentParam	Zachycené bloky výstupu stdout a stderr spolu s přidruženými výsledky	Ano
typ	výčet	Typ položky. Vždy `shell_call_output`. Možné hodnoty: `shell_call_output`	Ano

OpenAI.ItemFunctionToolCall

Volání nástroje ke spuštění funkce Další informace najdete v průvodci voláním funkcí .

Name	Typ	Description	Povinné
arguments	ř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
id	řetězec	Jedinečné ID volání nástroje funkcí.	Ne
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`	Ne
typ	výčet	Typ volání funkčního nástroje. Vždy `function_call`. Možné hodnoty: `function_call`	Ano

OpenAI.ItemImageGenToolCall

Požadavek na generování obrazu vytvořený modelem.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání generování image.	Ano
result	řetězec (s možnou hodnotou null)		Ano
stav	výčet	Stav volání generování image. Možné hodnoty: `in_progress`, `completed`, `generating`, `failed`	Ano
typ	výčet	Typ volání generování image. Vždy `image_generation_call`. Možné hodnoty: `image_generation_call`	Ano

OpenAI.ItemLocalShellToolCall

Volání nástroje ke spuštění příkazu v místním prostředí

Name	Typ	Description	Povinné
akce	OpenAI.LocalShellExecAction	Na serveru spusťte shell příkaz.	Ano
call_id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
id	řetězec	Jedinečné ID volání místního prostředí.	Ano
stav	výčet	Stav volání místního prostředí. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ volání místního prostředí. Vždy `local_shell_call`. Možné hodnoty: `local_shell_call`	Ano

OpenAI.ItemLocalShellToolCallOutput

Výstup volání lokálního shell nástroje.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
výstup	řetězec	Řetězec ve formátu JSON jako výstup z volání lokálního shellového nástroje.	Ano
stav	výčet	Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ne
typ	výčet	Typ výstupu volání místního nástroje prostředí. Vždy `local_shell_call_output`. Možné hodnoty: `local_shell_call_output`	Ano

OpenAI.ItemMcpApprovalRequest

Žádost o lidské schválení vyvolání nástroje.

Name	Typ	Description	Povinné
arguments	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
id	řetězec	Jedinečné ID žádosti o schválení.	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	Typ položky. Vždy `mcp_approval_request`. Možné hodnoty: `mcp_approval_request`	Ano

OpenAI.ItemMcpApprovalResponse

Odpověď na žádost o schválení MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec	ID žádosti o schválení, na kterou se odpovídá.	Ano
approve	boolean	Zda byla žádost schválena.	Ano
id	řetězec (s možnou hodnotou null)		Ne
důvod	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ položky. Vždy `mcp_approval_response`. Možné hodnoty: `mcp_approval_response`	Ano

OpenAI.ItemMcpListTools

Seznam nástrojů dostupných na serveru MCP

Name	Typ	Description	Povinné
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID seznamu.	Ano
označení serveru	řetězec	Popisek serveru MCP.	Ano
tools	pole OpenAI.MCPListToolsTools	Nástroje dostupné na serveru.	Ano
typ	výčet	Typ položky. Vždy `mcp_list_tools`. Možné hodnoty: `mcp_list_tools`	Ano

OpenAI.ItemMcpToolCall

Vyvolání nástroje na serveru MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec (s možnou hodnotou null)		Ne
arguments	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID volání nástroje.	Ano
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
stav	OpenAI.MCPToolCallStatus		Ne
typ	výčet	Typ položky. Vždy `mcp_call`. Možné hodnoty: `mcp_call`	Ano

OpenAI.ItemOutputMessage

Výstupní zpráva z modelu

Name	Typ	Description	Povinné
obsah	pole OpenAI.OutputMessageContent	Obsah výstupní zprávy.	Ano
id	řetězec	Jedinečné ID výstupní zprávy.	Ano
role	výčet	Role výstupní zprávy. Vždy `assistant`. Možné hodnoty: `assistant`	Ano
stav	výčet	Stav vstupu zprávy. jeden z `in_progress`, `completed`, nebo `incomplete`. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ výstupní zprávy. Vždy `message`. Možné hodnoty: `output_message`	Ano

OpenAI.ItemReasoningItem

Name	Typ	Description	Povinné
obsah	pole OpenAI.ReasoningTextContent	Zdůvodnění textového obsahu	Ne
encrypted_content	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečný identifikátor obsahu odůvodnění.	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`	Ne
souhrn	pole OpenAI. Shrnutí	Odůvodnění souhrnného obsahu	Ano
typ	výčet	Typ objektu. Vždy `reasoning`. Možné hodnoty: `reasoning`	Ano

OpenAI.ItemReferenceParam

Interní identifikátor položky, na kterou se má odkazovat.

Name	Typ	Description	Povinné	Výchozí
id	řetězec	ID položky, na kterou chcete odkazovat.	Ano
typ	výčet	Typ položky, na kterou chcete odkazovat. Vždy `item_reference`. 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
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ItemResourceType		Ano

OpenAI.ItemResourceApplyPatchToolCall

Volání nástroje, které používá rozdíly souborů vytvořením, odstraněním nebo aktualizací souborů

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID volání nástroje Apply Patch. Naplněno při vrácení této položky přes rozhraní API.	Ano
operace	OpenAI.ApplyPatchFileOperation	Jednu z operací create_file, delete_file nebo update_file použitých prostřednictvím apply_patch.	Ano
└- typ	OpenAI.ApplyPatchFileOperationType		Ano
stav	OpenAI.ApplyPatchCallStatus		Ano
typ	výčet	Typ položky. Vždy `apply_patch_call`. Možné hodnoty: `apply_patch_call`	Ano

OpenAI.ItemResourceApplyPatchToolCallOutput

Výstup vygenerovaný voláním nástroje apply patch

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila výstup volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID výstupu volání nástroje Apply Patch. Naplněno při vrácení této položky přes rozhraní API.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
stav	OpenAI.ApplyPatchCallOutputStatus		Ano
typ	výčet	Typ položky. Vždy `apply_patch_call_output`. Možné hodnoty: `apply_patch_call_output`	Ano

OpenAI.ItemResourceCodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Name	Typ	Description	Povinné
kód	řetězec (s možnou hodnotou null)		Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
id	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Ano
outputs	pole OpenAI.CodeInterpreterOutputLogs nebo OpenAI.CodeInterpreterOutputImage		Ano
stav	výčet	Stav volání nástroje interpreta kódu. Platné hodnoty jsou `in_progress`, , `completedincomplete`, `interpreting`a `failed`. Možné hodnoty: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Ano
typ	výčet	Typ volání nástroje interpreta kódu. Vždy `code_interpreter_call`. Možné hodnoty: `code_interpreter_call`	Ano

OpenAI.ItemResourceComputerToolCall

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 .

Name	Typ	Description	Povinné
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
id	řetězec	Jedinečné ID počítačového volání.	Ano
pending_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	Č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	Typ hovoru počítačem. Vždy `computer_call`. Možné hodnoty: `computer_call`	Ano

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Typ	Description	Povinné
acknowledged_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	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
id	řetězec	ID výstupu volání počítačového nástroje.	Ne
výstup	OpenAI.ComputerScreenshotImage	Snímek obrazovky počítače použitý s nástrojem pro použití počítače	Ano
stav	výčet	Stav vstupu zprávy. jeden z `in_progress`, `completed`, nebo `incomplete`. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ne
typ	výčet	Typ výstupu volání počítačového nástroje. Vždy `computer_call_output`. Možné hodnoty: `computer_call_output`	Ano

OpenAI.ItemResourceFileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Ano
Dotazy	pole řetězce	Dotazy používané k hledání souborů.	Ano
results	pole OpenAI.FileSearchToolCallResults		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	Typ volání nástroje pro vyhledávání souborů. Vždy `file_search_call`. Možné hodnoty: `file_search_call`	Ano

OpenAI.ItemResourceFunctionShellCall

Volání nástroje, které spouští jeden nebo více příkazů prostředí ve spravovaném prostředí.

Name	Typ	Description	Povinné
akce	OpenAI.FunctionShellAction	Spusťte příkaz prostředí.	Ano
└– příkazy	pole řetězce		Ano
└max_output_length	OpenAI.integer (nullable)		Ano
└timeout_ms	OpenAI.integer (nullable)		Ano
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID volání nástroje prostředí. Naplněno při vrácení této položky přes rozhraní API.	Ano
stav	OpenAI.LocalShellCallStatus		Ano
typ	výčet	Typ položky. Vždy `shell_call`. Možné hodnoty: `shell_call`	Ano

OpenAI.ItemResourceFunctionShellCallOutput

Výstup volání nástroje prostředí, které se vygenerovalo.

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem.	Ano
vytvořeno kým	řetězec	Identifikátor objektu actor, který položku vytvořil.	Ne
id	řetězec	Jedinečné ID výstupu volání prostředí. Naplněno při vrácení této položky přes rozhraní API.	Ano
max_output_length	OpenAI.integer (nullable)		Ano
výstup	pole OpenAI.FunctionShellCallOutputContent	Pole výstupního obsahu volání prostředí	Ano
typ	výčet	Typ výstupu volání prostředí. Vždy `shell_call_output`. Možné hodnoty: `shell_call_output`	Ano

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Typ	Description	Povinné
call_id	řetězec	Jedinečné ID volání nástroje funkcí vygenerované modelem.	Ano
id	řetězec	Jedinečné ID výstupu volání funkčního nástroje. Vyplněno při této položce se vrátí přes rozhraní API.	Ne
výstup	řetězec nebo pole OpenAI.FunctionAndCustomToolCallOutput	Výstup volání funkce generované vaším kódem. Může to být řetězec nebo seznam výstupního obsahu.	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`	Ne
typ	výčet	Typ výstupu volání nástroje funkce. Vždy `function_call_output`. Možné hodnoty: `function_call_output`	Ano

OpenAI.ItemResourceFunctionToolCallResource

Name	Typ	Description	Povinné
arguments	ř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
id	řetězec	Jedinečné ID volání nástroje funkcí.	Ne
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`	Ne
typ	výčet	Typ volání funkčního nástroje. Vždy `function_call`. Možné hodnoty: `function_call`	Ano

OpenAI.ItemResourceImageGenToolCall

Požadavek na generování obrazu vytvořený modelem.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání generování image.	Ano
result	řetězec (s možnou hodnotou null)		Ano
stav	výčet	Stav volání generování image. Možné hodnoty: `in_progress`, `completed`, `generating`, `failed`	Ano
typ	výčet	Typ volání generování image. Vždy `image_generation_call`. Možné hodnoty: `image_generation_call`	Ano

OpenAI.ItemResourceLocalShellToolCall

Volání nástroje ke spuštění příkazu v místním prostředí

Name	Typ	Description	Povinné
akce	OpenAI.LocalShellExecAction	Na serveru spusťte shell příkaz.	Ano
call_id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
id	řetězec	Jedinečné ID volání místního prostředí.	Ano
stav	výčet	Stav volání místního prostředí. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ volání místního prostředí. Vždy `local_shell_call`. Možné hodnoty: `local_shell_call`	Ano

OpenAI.ItemResourceLocalShellToolCallOutput

Výstup volání lokálního shell nástroje.

Name	Typ	Description	Povinné
id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
výstup	řetězec	Řetězec ve formátu JSON jako výstup z volání lokálního shellového nástroje.	Ano
stav	výčet	Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ne
typ	výčet	Typ výstupu volání místního nástroje prostředí. Vždy `local_shell_call_output`. Možné hodnoty: `local_shell_call_output`	Ano

OpenAI.ItemResourceMcpApprovalRequest

Žádost o lidské schválení vyvolání nástroje.

Name	Typ	Description	Povinné
arguments	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
id	řetězec	Jedinečné ID žádosti o schválení.	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	Typ položky. Vždy `mcp_approval_request`. Možné hodnoty: `mcp_approval_request`	Ano

OpenAI.ItemResourceMcpApprovalResponseResource

Odpověď na žádost o schválení MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec	ID žádosti o schválení, na kterou se odpovídá.	Ano
approve	boolean	Zda byla žádost schválena.	Ano
id	řetězec	Jedinečné ID odpovědi na schválení	Ano
důvod	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ položky. Vždy `mcp_approval_response`. Možné hodnoty: `mcp_approval_response`	Ano

OpenAI.ItemResourceMcpListTools

Seznam nástrojů dostupných na serveru MCP

Name	Typ	Description	Povinné
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID seznamu.	Ano
označení serveru	řetězec	Popisek serveru MCP.	Ano
tools	pole OpenAI.MCPListToolsTools	Nástroje dostupné na serveru.	Ano
typ	výčet	Typ položky. Vždy `mcp_list_tools`. Možné hodnoty: `mcp_list_tools`	Ano

OpenAI.ItemResourceMcpToolCall

Vyvolání nástroje na serveru MCP.

Name	Typ	Description	Povinné
approval_request_id	řetězec (s možnou hodnotou null)		Ne
arguments	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID volání nástroje.	Ano
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
stav	OpenAI.MCPToolCallStatus		Ne
typ	výčet	Typ položky. Vždy `mcp_call`. Možné hodnoty: `mcp_call`	Ano

OpenAI.ItemResourceOutputMessage

Výstupní zpráva z modelu

Name	Typ	Description	Povinné
obsah	pole OpenAI.OutputMessageContent	Obsah výstupní zprávy.	Ano
id	řetězec	Jedinečné ID výstupní zprávy.	Ano
role	výčet	Role výstupní zprávy. Vždy `assistant`. Možné hodnoty: `assistant`	Ano
stav	výčet	Stav vstupu zprávy. jeden z `in_progress`, `completed`, nebo `incomplete`. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ výstupní zprávy. Vždy `message`. Možné hodnoty: `output_message`	Ano

OpenAI.ItemResourceType

Property Value

Typ řetězec

Hodnoty message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Výsledky volání webového vyhledávacího nástroje. Další informace najdete v průvodci vyhledáváním na webu .

Name	Typ	Description	Povinné
akce	OpenAI.WebSearchActionSearch nebo OpenAI.WebSearchActionOpenPage nebo OpenAI.WebSearchActionFind	Objekt popisující konkrétní akci prováděnou v tomto volání vyhledávání na webu. Obsahuje podrobnosti o tom, jak model používal web (vyhledávání, open_page, hledání).	Ano
id	řetězec	Jedinečné ID volání webového vyhledávacího nástroje.	Ano
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	Typ volání webového vyhledávacího nástroje. Vždy `web_search_call`. Možné hodnoty: `web_search_call`	Ano

OpenAI.ItemType

Property Value

Typ řetězec

OpenAI.ItemWebSearchToolCall

Výsledky volání webového vyhledávacího nástroje. Další informace najdete v průvodci vyhledáváním na webu .

Name	Typ	Description	Povinné
akce	OpenAI.WebSearchActionSearch nebo OpenAI.WebSearchActionOpenPage nebo OpenAI.WebSearchActionFind	Objekt popisující konkrétní akci prováděnou v tomto volání vyhledávání na webu. Obsahuje podrobnosti o tom, jak model používal web (vyhledávání, open_page, hledání).	Ano
id	řetězec	Jedinečné ID volání webového vyhledávacího nástroje.	Ano
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	Typ volání webového vyhledávacího nástroje. Vždy `web_search_call`. Možné hodnoty: `web_search_call`	Ano

OpenAI.KeyPressAction

Kolekce klávesových stisků, které model chce provést.

Name	Typ	Description	Povinné	Výchozí
keys	pole řetězce	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 keypress je tato vlastnost vždy nastavena na `keypress`. Možné hodnoty: `keypress`	Ano

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Typ	Description	Povinné
data	pole OpenAI.FineTuningJobCheckpoint		Ano
first_id	řetězec (s možnou hodnotou null)		Ne
má více	boolean		Ano
last_id	řetězec (s možnou hodnotou null)		Ne
objekt	výčet	Možné hodnoty: `list`	Ano

OpenAI.ListFineTuningJobEventsResponse

Name	Typ	Description	Povinné
data	pole OpenAI.FineTuningJobEvent		Ano
má více	boolean		Ano
objekt	výčet	Možné hodnoty: `list`	Ano

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Typ	Description	Povinné
data	pole OpenAI.FineTuningJob		Ano
má více	boolean		Ano
objekt	výčet	Možné hodnoty: `list`	Ano

OpenAI.LocalShellCallStatus

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Na serveru spusťte shell příkaz.

Name	Typ	Description	Povinné
command	pole řetězce	Příkaz, který se má spustit.	Ano
env	objekt	Proměnné prostředí, které je třeba pro příkaz nastavit.	Ano
časový limit_ms	OpenAI.integer (nullable)		Ne
typ	výčet	Typ místní akce shellu. Vždy `exec`. Možné hodnoty: `exec`	Ano
uživatel	řetězec (s možnou hodnotou null)		Ne
pracovní adresář	řetězec (s možnou hodnotou null)		Ne

OpenAI.LocalShellToolParam

Nástroj, který umožňuje modelu spouštět shell příkazy v místním prostředí.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Typ místního shellového nástroje. Vždy `local_shell`. Možné hodnoty: `local_shell`	Ano

OpenAI.LogProb

Logaritmická pravděpodobnost tokenu.

Name	Typ	Povinné
bytes	pole OpenAI.integer	Ano
logprob	OpenAI.numeric	Ano
token	řetězec	Ano
top_logprobs	pole OpenAI.TopLogProb	Ano

OpenAI.MCPListToolsTool

Nástroj dostupný na serveru MCP.

Name	Typ	Description	Povinné
annotations	OpenAI.MCPListToolsToolAnnotations (nullable)		Ne
popis	řetězec (s možnou hodnotou null)		Ne
input_schema	OpenAI.MCPListToolsToolsToolInputSchema		Ano
název	řetězec	Název nástroje.	Ano

OpenAI.MCPListToolsToolAnnotations

Typ: objekt

OpenAI.MCPListToolsToolsToolInputSchema

Typ: objekt

OpenAI.MCPTool

Udělte modelu přístup k dalším nástrojům prostřednictvím vzdálených serverů MCP (Model Context Protocol). Přečtěte si další informace o MCP.

Name	Typ	Description	Povinné
povolené_nástroje	pole řetězce nebo OpenAI.MCPToolFilter		Ne
autorizace	řetězec	Přístupový token OAuth, který lze použít se vzdáleným serverem MCP, a to buď s vlastní adresou URL serveru MCP nebo konektorem služby. Vaše aplikace musí zpracovat tok autorizace OAuth a zadat token zde.	Ne
connector_id	výčet	Identifikátor konektorů služeb, jako jsou ty, které jsou k dispozici v ChatGPT. Jeden z `server_url` nebo `connector_id` musí být poskytnuty. Další informace o službě tady jsou konektory. Aktuálně podporované `connector_id` hodnoty jsou: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Kalendář Google: `connector_googlecalendar` - Disk Google: `connector_googledrive` – Microsoft Teams: `connector_microsoftteams` – Outlook Kalendář: `connector_outlookcalendar` - Outlook e-mail: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Možné hodnoty: `connector_dropbox`, `connector_gmail`, , `connector_googlecalendarconnector_googledrive`, `connector_microsoftteamsconnector_outlookcalendar`, `connector_outlookemailconnector_sharepoint`	Ne
headers	objekt (nullable)		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)		Ne
server_description	řetězec	Volitelný popis serveru MCP, který slouží k poskytnutí dalšího kontextu.	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. Jedna z `server_url` nebo `connector_id` musí být Poskytovány.	Ne
typ	výčet	Typ nástroje MCP. Vždy `mcp`. Možné hodnoty: `mcp`	Ano

OpenAI.MCPToolCallStatus

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Objekt filtru, který určuje, které nástroje jsou povolené.

Name	Typ	Description	Povinné	Výchozí
Read_only	boolean	Určuje, zda nástroj upravuje data nebo je jen pro čtení. Pokud Server MCP je opatřen poznámkami ,`readOnlyHint` bude odpovídat tomuto filtru.	Ne
tool_names	pole řetězce	Seznam povolených názvů nástrojů	Ne

OpenAI.MCPToolRequireApproval

Name	Typ	Description	Povinné	Výchozí
Vždy	OpenAI.MCPToolFilter	Objekt filtru, který určuje, které nástroje jsou povolené.	Ne
nikdy	OpenAI.MCPToolFilter	Objekt filtru, který určuje, které nástroje jsou povolené.	Ne

OpenAI.MessageContent

Část obsahu, která tvoří vstupní nebo výstupní položku.

Diskriminátor pro OpenAI.MessageContent

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

Hodnota typu	Schema
`text`	OpenAI.TextContent
`summary_text`	OpenAI.SummaryTextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.MessageContentType		Ano

OpenAI.MessageContentInputFileContent

Vstup souboru do modelu.

Name	Typ	Description	Povinné
file_data	řetězec	Obsah souboru, který se má odeslat do modelu.	Ne
ID souboru	řetězec (s možnou hodnotou null)		Ne
file_url	řetězec	Adresa URL 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.MessageContentInputImageContent

Vstup obrázku do modelu. Přečtěte si o vstupech obrázků.

Name	Typ	Description	Povinné
detail	OpenAI.ImageDetail		Ano
ID souboru	řetězec (s možnou hodnotou null)		Ne
image_url	řetězec		Ne
typ	výčet	Typ vstupní položky. Vždy `input_image`. Možné hodnoty: `input_image`	Ano

OpenAI.MessageContentInputTextContent

Textový vstup do modelu.

Name	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.MessageContentOutputTextContent

Textový výstup z modelu.

Name	Typ	Description	Povinné
annotations	pole OpenAI.Annotation	Poznámky textového výstupu.	Ano
logaritmované pravděpodobnosti	pole OpenAI.LogProb		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.MessageContentReasoningTextContent

Zdůvodnění textu z modelu

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Zdůvodnění textu z modelu	Ano
typ	výčet	Typ textu zdůvodnění. Vždy `reasoning_text`. Možné hodnoty: `reasoning_text`	Ano

OpenAI.MessageContentRefusalContent

Odmítnutí modelu.

Name	Typ	Description	Povinné	Výchozí
odmítnutí	řetězec	Vysvětlení zamítnutí od modelu.	Ano
typ	výčet	Typ odmítnutí. Vždy `refusal`. Možné hodnoty: `refusal`	Ano

OpenAI.MessageContentType

Property	Value
Typ	řetězec
Hodnoty	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessageRole

Property	Value
Typ	řetězec
Hodnoty	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

Property	Value
Typ	řetězec
Hodnoty	`in_progress` `completed` `incomplete`

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.ModelIdsCompaction

ID modelu použité k vygenerování odpovědi, například gpt-5 nebo o3. OpenAI nabízí širokou škálu modelů s různými možnostmi, charakteristikami výkonu a cenovými body. Projděte si průvodce modelem a projděte si dostupné modely a porovnejte je.

Typ: OpenAI.ModelIdsResponses nebo řetězec

OpenAI.ModelIdsResponses

Property	Value
Typ	řetězec
Hodnoty	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

Typ: řetězec nebo OpenAI.ChatModel

OpenAI.Move

Akce přesunutí myší.

Name	Typ	Description	Povinné
typ	výčet	Určuje typ události. U akce pohybu je tato vlastnost vždy nastaveno na `move`. Možné hodnoty: `move`	Ano
x	OpenAI.integer		Ano
y	OpenAI.integer		Ano

OpenAI.OutputContent

Diskriminátor pro OpenAI.OutputContent

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

Hodnota typu	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.OutputContentType		Ano

OpenAI.OutputContentOutputTextContent

Textový výstup z modelu.

Name	Typ	Description	Povinné
annotations	pole OpenAI.Annotation	Poznámky textového výstupu.	Ano
logaritmované pravděpodobnosti	pole OpenAI.LogProb		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.OutputContentReasoningTextContent

Zdůvodnění textu z modelu

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Zdůvodnění textu z modelu	Ano
typ	výčet	Typ textu zdůvodnění. Vždy `reasoning_text`. Možné hodnoty: `reasoning_text`	Ano

OpenAI.OutputContentRefusalContent

Odmítnutí modelu.

Name	Typ	Description	Povinné	Výchozí
odmítnutí	řetězec	Vysvětlení zamítnutí od modelu.	Ano
typ	výčet	Typ odmítnutí. Vždy `refusal`. Možné hodnoty: `refusal`	Ano

OpenAI.OutputContentType

Property	Value
Typ	řetězec
Hodnoty	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Diskriminátor pro OpenAI.OutputItem

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

Hodnota typu	Schema
`structured_outputs`	StructuredOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
typ	OpenAI.OutputItemType		Ano

OpenAI.OutputItemApplyPatchToolCall

Volání nástroje, které používá rozdíly souborů vytvořením, odstraněním nebo aktualizací souborů

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID volání nástroje Apply Patch. Naplněno při vrácení této položky přes rozhraní API.	Ano
operace	OpenAI.ApplyPatchFileOperation	Jednu z operací create_file, delete_file nebo update_file použitých prostřednictvím apply_patch.	Ano
└- typ	OpenAI.ApplyPatchFileOperationType		Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
stav	OpenAI.ApplyPatchCallStatus		Ano
typ	výčet	Typ položky. Vždy `apply_patch_call`. Možné hodnoty: `apply_patch_call`	Ano

OpenAI.OutputItemApplyPatchToolCallOutput

Výstup vygenerovaný voláním nástroje apply patch

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Jedinečné ID volání nástroje Apply Patch vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila výstup volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID výstupu volání nástroje Apply Patch. Naplněno při vrácení této položky přes rozhraní API.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
stav	OpenAI.ApplyPatchCallOutputStatus		Ano
typ	výčet	Typ položky. Vždy `apply_patch_call_output`. Možné hodnoty: `apply_patch_call_output`	Ano

OpenAI.OutputItemCodeInterpreterToolCall

Volání nástroje ke spuštění kódu

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
kód	řetězec (s možnou hodnotou null)		Ano
container_id	řetězec	ID kontejneru použitého ke spuštění kódu.	Ano
id	řetězec	Jedinečné ID volání nástroje interpretu kódu.	Ano
outputs	pole OpenAI.CodeInterpreterOutputLogs nebo OpenAI.CodeInterpreterOutputImage		Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
stav	výčet	Stav volání nástroje interpreta kódu. Platné hodnoty jsou `in_progress`, , `completedincomplete`, `interpreting`a `failed`. Možné hodnoty: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Ano
typ	výčet	Typ volání nástroje interpreta kódu. Vždy `code_interpreter_call`. Možné hodnoty: `code_interpreter_call`	Ano

OpenAI.OutputItemCompactionBody

Komprimace položky vygenerované rozhranímv1/responses/compact API

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
vytvořeno kým	řetězec	Identifikátor objektu actor, který položku vytvořil.	Ne
encrypted_content	řetězec	Šifrovaný obsah, který byl vytvořen komprimace.	Ano
id	řetězec	Jedinečné ID položky komprimace.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
typ	výčet	Typ položky. Vždy `compaction`. Možné hodnoty: `compaction`	Ano

OpenAI.OutputItemComputerToolCall

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 .

Name	Typ	Description	Povinné
akce	OpenAI.ComputerAction		Ano
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Identifikátor použitý při odpovídání na volání nástroje s výstupem.	Ano
id	řetězec	Jedinečné ID počítačového volání.	Ano
pending_safety_checks	pole OpenAI.ComputerCallSafetyCheckParam	Čekající bezpečnostní kontroly volání počítače.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
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 hovoru počítačem. Vždy `computer_call`. Možné hodnoty: `computer_call`	Ano

OpenAI.OutputItemCustomToolCall

Volání vlastního nástroje vytvořeného modelem

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Identifikátor použitý k mapování tohoto vlastního volání nástroje na výstup volání nástroje.	Ano
id	řetězec	Jedinečné ID volání vlastního nástroje na platformě OpenAI.	Ne
vstup	řetězec	Vstup pro volání vlastního nástroje vygenerovaného modelem.	Ano
název	řetězec	Název volaného vlastního nástroje.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
typ	výčet	Typ volání vlastního nástroje. Vždy `custom_tool_call`. Možné hodnoty: `custom_tool_call`	Ano

OpenAI.OutputItemFileSearchToolCall

Výsledky volání nástroje pro vyhledávání souborů. Další informace najdete v průvodci hledáním souborů .

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
id	řetězec	Jedinečné ID volání nástroje pro vyhledávání souborů.	Ano
Dotazy	pole řetězce	Dotazy používané k hledání souborů.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
results	pole OpenAI.FileSearchToolCallResults		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	Typ volání nástroje pro vyhledávání souborů. Vždy `file_search_call`. Možné hodnoty: `file_search_call`	Ano

OpenAI.OutputItemFunctionShellCall

Volání nástroje, které spouští jeden nebo více příkazů prostředí ve spravovaném prostředí.

Name	Typ	Description	Povinné
akce	OpenAI.FunctionShellAction	Spusťte příkaz prostředí.	Ano
└– příkazy	pole řetězce		Ano
└max_output_length	OpenAI.integer (nullable)		Ano
└timeout_ms	OpenAI.integer (nullable)		Ano
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem.	Ano
vytvořeno kým	řetězec	ID entity, která vytvořila volání tohoto nástroje.	Ne
id	řetězec	Jedinečné ID volání nástroje prostředí. Naplněno při vrácení této položky přes rozhraní API.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
stav	OpenAI.LocalShellCallStatus		Ano
typ	výčet	Typ položky. Vždy `shell_call`. Možné hodnoty: `shell_call`	Ano

OpenAI.OutputItemFunctionShellCallOutput

Výstup volání nástroje prostředí, které se vygenerovalo.

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Jedinečné ID volání nástroje prostředí vygenerované modelem.	Ano
vytvořeno kým	řetězec	Identifikátor objektu actor, který položku vytvořil.	Ne
id	řetězec	Jedinečné ID výstupu volání prostředí. Naplněno při vrácení této položky přes rozhraní API.	Ano
max_output_length	OpenAI.integer (nullable)		Ano
výstup	pole OpenAI.FunctionShellCallOutputContent	Pole výstupního obsahu volání prostředí	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
typ	výčet	Typ výstupu volání prostředí. Vždy `shell_call_output`. Možné hodnoty: `shell_call_output`	Ano

OpenAI.OutputItemFunctionToolCall

Volání nástroje ke spuštění funkce Další informace najdete v průvodci voláním funkcí .

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
arguments	ř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
id	řetězec	Jedinečné ID volání nástroje funkcí.	Ne
název	řetězec	Název funkce, která se má spustit.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
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`	Ne
typ	výčet	Typ volání funkčního nástroje. Vždy `function_call`. Možné hodnoty: `function_call`	Ano

OpenAI.OutputItemImageGenToolCall

Požadavek na generování obrazu vytvořený modelem.

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
id	řetězec	Jedinečné ID volání generování image.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
result	řetězec (s možnou hodnotou null)		Ano
stav	výčet	Stav volání generování image. Možné hodnoty: `in_progress`, `completed`, `generating`, `failed`	Ano
typ	výčet	Typ volání generování image. Vždy `image_generation_call`. Možné hodnoty: `image_generation_call`	Ano

OpenAI.OutputItemLocalShellToolCall

Volání nástroje ke spuštění příkazu v místním prostředí

Name	Typ	Description	Povinné
akce	OpenAI.LocalShellExecAction	Na serveru spusťte shell příkaz.	Ano
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
call_id	řetězec	Jedinečné ID volání místního nástroje příkazového řádku vygenerované modelem.	Ano
id	řetězec	Jedinečné ID volání místního prostředí.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
stav	výčet	Stav volání místního prostředí. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ volání místního prostředí. Vždy `local_shell_call`. Možné hodnoty: `local_shell_call`	Ano

OpenAI.OutputItemMcpApprovalRequest

Žádost o lidské schválení vyvolání nástroje.

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
arguments	řetězec	Řetězec JSON s argumenty pro nástroj.	Ano
id	řetězec	Jedinečné ID žádosti o schválení.	Ano
název	řetězec	Název nástroje, který se má spustit.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
označení serveru	řetězec	Popisek MCP serveru, který provádí požadavek.	Ano
typ	výčet	Typ položky. Vždy `mcp_approval_request`. Možné hodnoty: `mcp_approval_request`	Ano

OpenAI.OutputItemMcpListTools

Seznam nástrojů dostupných na serveru MCP

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID seznamu.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
označení serveru	řetězec	Popisek serveru MCP.	Ano
tools	pole OpenAI.MCPListToolsTools	Nástroje dostupné na serveru.	Ano
typ	výčet	Typ položky. Vždy `mcp_list_tools`. Možné hodnoty: `mcp_list_tools`	Ano

OpenAI.OutputItemMcpToolCall

Vyvolání nástroje na serveru MCP.

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
approval_request_id	řetězec (s možnou hodnotou null)		Ne
arguments	řetězec	Řetězec JSON s argumenty předanými nástroji.	Ano
chyba	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečné ID volání nástroje.	Ano
název	řetězec	Název nástroje, který byl spuštěn.	Ano
výstup	řetězec (s možnou hodnotou null)		Ne
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
označení serveru	řetězec	Popisek serveru MCP, na kterém je nástroj spuštěný.	Ano
stav	OpenAI.MCPToolCallStatus		Ne
typ	výčet	Typ položky. Vždy `mcp_call`. Možné hodnoty: `mcp_call`	Ano

OpenAI.OutputItemOutputMessage

Výstupní zpráva z modelu

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
obsah	pole OpenAI.OutputMessageContent	Obsah výstupní zprávy.	Ano
id	řetězec	Jedinečné ID výstupní zprávy.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
role	výčet	Role výstupní zprávy. Vždy `assistant`. Možné hodnoty: `assistant`	Ano
stav	výčet	Stav vstupu zprávy. jeden z `in_progress`, `completed`, nebo `incomplete`. Naplněno při vrácení vstupních položek přes rozhraní API. Možné hodnoty: `in_progress`, `completed`, `incomplete`	Ano
typ	výčet	Typ výstupní zprávy. Vždy `message`. Možné hodnoty: `output_message`	Ano

OpenAI.OutputItemReasoningItem

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
obsah	pole OpenAI.ReasoningTextContent	Zdůvodnění textového obsahu	Ne
encrypted_content	řetězec (s možnou hodnotou null)		Ne
id	řetězec	Jedinečný identifikátor obsahu odůvodnění.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
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`	Ne
souhrn	pole OpenAI. Shrnutí	Odůvodnění souhrnného obsahu	Ano
typ	výčet	Typ objektu. Vždy `reasoning`. Možné hodnoty: `reasoning`	Ano

OpenAI.OutputItemType

Property Value

Typ řetězec

Hodnoty output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Výsledky volání webového vyhledávacího nástroje. Další informace najdete v průvodci vyhledáváním na webu .

Name	Typ	Description	Povinné
akce	OpenAI.WebSearchActionSearch nebo OpenAI.WebSearchActionOpenPage nebo OpenAI.WebSearchActionFind	Objekt popisující konkrétní akci prováděnou v tomto volání vyhledávání na webu. Obsahuje podrobnosti o tom, jak model používal web (vyhledávání, open_page, hledání).	Ano
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
id	řetězec	Jedinečné ID volání webového vyhledávacího nástroje.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	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	Typ volání webového vyhledávacího nástroje. Vždy `web_search_call`. Možné hodnoty: `web_search_call`	Ano

OpenAI.OutputMessageContent

Diskriminátor pro OpenAI.OutputMessageContent

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

Hodnota typu	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.OutputMessageContentType		Ano

OpenAI.OutputMessageContentOutputTextContent

Textový výstup z modelu.

Name	Typ	Description	Povinné
annotations	pole OpenAI.Annotation	Poznámky textového výstupu.	Ano
logaritmované pravděpodobnosti	pole OpenAI.LogProb		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.OutputMessageContentRefusalContent

Odmítnutí modelu.

Name	Typ	Description	Povinné	Výchozí
odmítnutí	řetězec	Vysvětlení zamítnutí od modelu.	Ano
typ	výčet	Typ odmítnutí. Vždy `refusal`. Možné hodnoty: `refusal`	Ano

OpenAI.OutputMessageContentType

Property	Value
Typ	řetězec
Hodnoty	`output_text` `refusal`

OpenAI.Prompt

Odkaz na šablonu promptu a její proměnné Další informace.

Name	Typ	Description	Povinné
id	řetězec	Jedinečný identifikátor šablony výzvy, která se má použít.	Ano
variables	OpenAI.ResponsePromptVariables (nullable)	Volitelná mapa hodnot pro nahrazení proměnných ve vaší aplikaci. výzva Hodnoty nahrazení můžou být řetězce nebo jiné. Vstupní typy odpovědí, jako jsou obrázky nebo soubory.	Ne
verze	řetězec (s možnou hodnotou null)		Ne

OpenAI.RankerVersionType

Property	Value
Typ	řetězec
Hodnoty	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Typ	Description	Povinné
hybrid_search	OpenAI.HybridSearchOptions		Ne
└embedding_weight	OpenAI.numeric	Váha vkládání do reciproční fúze hodnocení.	Ano
└text_weight	OpenAI.numeric	Váha textu v reciproční fúzi hodnocení.	Ano
nástroj pro hodnocení	OpenAI.RankerVersionType		Ne
práh skóre	OpenAI.numeric		Ne

OpenAI.Reasoning

pouze modely gpt-5 a o-series Možnosti konfigurace pro zdůvodnění modelů

Name	Typ	Description	Povinné
úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
generate_summary	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne
souhrn	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne

OpenAI.ReasoningEffort

Omezuje úsilí na odůvodnění modelů odůvodnění. Aktuálně podporované hodnoty jsou none, minimallowmediumhigha .xhigh 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 výchozí hodnota none, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou gpt-5.1none, low, mediuma high. 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 výchozím nastavením medium zdůvodnění úsilí a nepodporují none.
Ve gpt-5-pro výchozím nastavení modelu (a pouze podporuje) high úsilí o odůvodnění.
xhigh je podporován pro všechny modely po gpt-5.1-codex-max.

Property	Value
Typ	řetězec
Nullable	Ano
Hodnoty	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Zdůvodnění textu z modelu

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Zdůvodnění textu z modelu	Ano
typ	výčet	Typ textu zdůvodnění. Vždy `reasoning_text`. Možné hodnoty: `reasoning_text`	Ano

OpenAI.Response

Name	Typ	Description	Povinné	Výchozí
agent_reference	AgentReference (s možnou hodnotou null)		Ano
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
na pozadí	logická hodnota (s možnou hodnotou null)		Ne
dokončeno v	integer		Ne
konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└─ id	řetězec	Jedinečné ID konverzace, ke které byla tato odpověď přidružena.	Ano
datum_vytvoření	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└ kód	OpenAI.ResponseErrorCode	Kód chyby pro odpověď.	Ano
└- zpráva	řetězec	Popis chyby čitelný člověkem.	Ano
id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└důvod	výčet	Možné hodnoty: `max_output_tokens`, `content_filter`	Ne
Pokyny	řetězec nebo pole OpenAI.InputItem		Ano
max_output_tokens	OpenAI.integer (nullable)		Ne
maximální počet volání nástroje	OpenAI.integer (nullable)		Ne
metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		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 (s možnou hodnotou null)		Ne
požádat	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
reasoning	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└– úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
└─ vytvořit_shrnutí	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne
└─ souhrn	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne
safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
úroveň služby	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. – Pokud není nastaveno, 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.	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
Teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
poslat SMS	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
tool_choice	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
tools	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
top_logprobs	OpenAI.integer (nullable)		Ne
top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
truncation	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne

OpenAI.ResponseAudioDeltaEvent

Vygenerováno, pokud je k dispozici částečná zvuková odpověď.

Name	Typ	Description	Povinné
delta	řetězec	Blok odeslaných zvukových bajtů zakódovaných pomocí Base64.	Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.audio.delta`. Možné hodnoty: `response.audio.delta`	Ano

OpenAI.ResponseAudioDoneEvent

Po dokončení zvukové odpovědi dojde k vysílání.

Name	Typ	Description	Povinné	Výchozí
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.audio.done`. Možné hodnoty: `response.audio.done`	Ano

OpenAI.ResponseAudioTranscriptDeltaEvent

Vygenerováno, pokud je k dispozici částečný přepis zvuku.

Name	Typ	Description	Povinné
delta	řetězec	Částečný přepis zvukové odpovědi.	Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.audio.transcript.delta`. Možné hodnoty: `response.audio.transcript.delta`	Ano

OpenAI.ResponseAudioTranscriptDoneEvent

Emitování nastane po dokončení úplného přepisu zvuku.

Name	Typ	Description	Povinné	Výchozí
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.audio.transcript.done`. Možné hodnoty: `response.audio.transcript.done`	Ano

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Vygeneruje se při streamování částečného fragmentu kódu interpretem kódu.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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á.

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky volání nástroje interpreta kódu.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné	Výchozí
response	OpenAI.Response		Ano
└agent_reference	AgentReference (s možnou hodnotou null)	Agent použitý pro tuto odpověď	Ano
└pozadí	logická hodnota (s možnou hodnotou null)		Ne
└completed_at	celé číslo (s možnou hodnotou null)		Ne
└- konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└ created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
└─ chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└─ id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
└─neúplné_detaily	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└- pokyny	řetězec nebo pole OpenAI.InputItem (nullable)		Ano
└ max_output_tokens	OpenAI.integer (nullable)		Ne
└max_tool_calls	OpenAI.integer (nullable)		Ne
└– metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
└─ výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		Ne
└─ paralelní volání nástrojů	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
└─ předchozí_id_odpovědi	řetězec (s možnou hodnotou null)		Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
└prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
└prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
└— odůvodnění	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
└service_tier	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. – Pokud není nastaveno, 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.	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
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└- text	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
└ nástroje	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
└ top_logprobs	OpenAI.integer (nullable)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└– zkrácení	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		Ano
item_id	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Ano
output_index	OpenAI.integer		Ano
part	OpenAI.OutputContent		Ano
└- typ	OpenAI.OutputContentType		Ano
sequence_number	OpenAI.integer		Ano
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á.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		Ano
item_id	řetězec	ID výstupní položky, do které byla část obsahu přidána.	Ano
output_index	OpenAI.integer		Ano
part	OpenAI.OutputContent		Ano
└- typ	OpenAI.OutputContentType		Ano
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné	Výchozí
response	OpenAI.Response		Ano
└agent_reference	AgentReference (s možnou hodnotou null)	Agent použitý pro tuto odpověď	Ano
└pozadí	logická hodnota (s možnou hodnotou null)		Ne
└completed_at	celé číslo (s možnou hodnotou null)		Ne
└- konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└ created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
└─ chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└─ id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
└─neúplné_detaily	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└- pokyny	řetězec nebo pole OpenAI.InputItem (nullable)		Ano
└ max_output_tokens	OpenAI.integer (nullable)		Ne
└max_tool_calls	OpenAI.integer (nullable)		Ne
└– metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
└─ výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		Ne
└─ paralelní volání nástrojů	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
└─ předchozí_id_odpovědi	řetězec (s možnou hodnotou null)		Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
└prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
└prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
└— odůvodnění	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
└service_tier	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. – Pokud není nastaveno, 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.	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
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└- text	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
└ nástroje	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
└ top_logprobs	OpenAI.integer (nullable)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└– zkrácení	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.created`. Možné hodnoty: `response.created`	Ano

OpenAI.ResponseCustomToolCallInputDeltaEvent

Událost představující rozdílovou (částečnou aktualizaci) vstupu vlastního volání nástroje

Name	Typ	Description	Povinné
delta	řetězec	Přírůstková vstupní data (delta) pro volání vlastního nástroje.	Ano
item_id	řetězec	Jedinečný identifikátor položky rozhraní API přidružené k této události.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Identifikátor typu události. Možné hodnoty: `response.custom_tool_call_input.delta`	Ano

OpenAI.ResponseCustomToolCallInputDoneEvent

Událost označující, že vstup pro volání vlastního nástroje je dokončený.

Name	Typ	Description	Povinné
vstup	řetězec	Úplná vstupní data pro volání vlastního nástroje.	Ano
item_id	řetězec	Jedinečný identifikátor položky rozhraní API přidružené k této události.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Identifikátor typu události. Možné hodnoty: `response.custom_tool_call_input.done`	Ano

OpenAI.ResponseError

Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.

Name	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ěď.

Property	Value
Typ	ř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ě.

Name	Typ	Description	Povinné
kód	řetězec (s možnou hodnotou null)		Ano
zpráva	řetězec	Chybová zpráva.	Ano
param	řetězec (s možnou hodnotou null)		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné	Výchozí
response	OpenAI.Response		Ano
└agent_reference	AgentReference (s možnou hodnotou null)	Agent použitý pro tuto odpověď	Ano
└pozadí	logická hodnota (s možnou hodnotou null)		Ne
└completed_at	celé číslo (s možnou hodnotou null)		Ne
└- konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└ created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
└─ chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└─ id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
└─neúplné_detaily	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└- pokyny	řetězec nebo pole OpenAI.InputItem (nullable)		Ano
└ max_output_tokens	OpenAI.integer (nullable)		Ne
└max_tool_calls	OpenAI.integer (nullable)		Ne
└– metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
└─ výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		Ne
└─ paralelní volání nástrojů	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
└─ předchozí_id_odpovědi	řetězec (s možnou hodnotou null)		Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
└prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
└prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
└— odůvodnění	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
└service_tier	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. – Pokud není nastaveno, 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.	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
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└- text	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
└ nástroje	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
└ top_logprobs	OpenAI.integer (nullable)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└– zkrácení	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne
sequence_number	OpenAI.integer		Ano
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).

Name	Typ	Description	Povinné
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	ID výstupní položky, kterou je inicializováno volání hledání souborů.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.file_search_call.searching`. Možné hodnoty: `response.file_search_call.searching`	Ano

OpenAI.ResponseFormatJsonObject

Name	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

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ých výstupech.

Name	Typ	Description	Povinné
JSON schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Ano
└- popis	řetězec		Ne
└– název	řetězec		Ano
└- schéma	OpenAI.ResponseFormatJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON. Tady se dozvíte, jak se vytvářejí schémata JSON.	Ne
└- striktní	logická hodnota (s možnou hodnotou null)		Ne
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy `json_schema`. Možné hodnoty: `json_schema`	Ano

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Typ	Description	Povinné
popis	řetězec		Ne
název	řetězec		Ano
schéma	OpenAI.ResponseFormatJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON. Tady se dozvíte, jak se vytvářejí schémata JSON.	Ne
přísné	logická hodnota (s možnou hodnotou null)		Ne

OpenAI.ResponseFormatJsonSchemaSchema

Schéma pro formát odpovědi popsané jako objekt schématu JSON. Tady se dozvíte, jak se vytvářejí schémata JSON.

Typ: objekt

OpenAI.ResponseFormatText

Výchozí formát odpovědi Používá se ke generování textových odpovědí.

Name	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.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
arguments	řetězec	Argumenty volání funkce.	Ano
item_id	řetězec	ID položky.	Ano
název	řetězec	Název funkce, která byla volána.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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).

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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ů.

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	Jedinečný identifikátor položky generování obrázku, která je zpracovávána.	Ano
output_index	OpenAI.integer		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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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ěď.

Name	Typ	Description	Povinné	Výchozí
response	OpenAI.Response		Ano
└agent_reference	AgentReference (s možnou hodnotou null)	Agent použitý pro tuto odpověď	Ano
└pozadí	logická hodnota (s možnou hodnotou null)		Ne
└completed_at	celé číslo (s možnou hodnotou null)		Ne
└- konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└ created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
└─ chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└─ id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
└─neúplné_detaily	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└- pokyny	řetězec nebo pole OpenAI.InputItem (nullable)		Ano
└ max_output_tokens	OpenAI.integer (nullable)		Ne
└max_tool_calls	OpenAI.integer (nullable)		Ne
└– metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
└─ výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		Ne
└─ paralelní volání nástrojů	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
└─ předchozí_id_odpovědi	řetězec (s možnou hodnotou null)		Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
└prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
└prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
└— odůvodnění	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
└service_tier	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. – Pokud není nastaveno, 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.	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
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└- text	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
└ nástroje	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
└ top_logprobs	OpenAI.integer (nullable)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└– zkrácení	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.in_progress`. Možné hodnoty: `response.in_progress`	Ano

OpenAI.ResponseIncompleteDetails

Name	Typ	Description	Povinné	Výchozí
důvod	výčet	Možné hodnoty: `max_output_tokens`, `content_filter`	Ne

OpenAI.ResponseIncompleteEvent

Událost, která se vygeneruje, když se odpověď dokončí jako neúplná.

Name	Typ	Description	Povinné	Výchozí
response	OpenAI.Response		Ano
└agent_reference	AgentReference (s možnou hodnotou null)	Agent použitý pro tuto odpověď	Ano
└pozadí	logická hodnota (s možnou hodnotou null)		Ne
└completed_at	celé číslo (s možnou hodnotou null)		Ne
└- konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└ created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
└─ chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└─ id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
└─neúplné_detaily	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└- pokyny	řetězec nebo pole OpenAI.InputItem (nullable)		Ano
└ max_output_tokens	OpenAI.integer (nullable)		Ne
└max_tool_calls	OpenAI.integer (nullable)		Ne
└– metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
└─ výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		Ne
└─ paralelní volání nástrojů	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
└─ předchozí_id_odpovědi	řetězec (s možnou hodnotou null)		Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
└prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
└prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
└— odůvodnění	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
└service_tier	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. – Pokud není nastaveno, 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.	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
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└- text	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
└ nástroje	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
└ top_logprobs	OpenAI.integer (nullable)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└– zkrácení	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.incomplete`. Možné hodnoty: `response.incomplete`	Ano

OpenAI.ResponseLogProb

Logprob je logaritmická pravděpodobnost, že model přiřazuje k vytvoření konkrétního tokenu na dané pozici v sekvenci. Méně negativní (vyšší) hodnoty logprob označují větší spolehlivost modelu v této volbě tokenu.

Name	Typ	Description	Povinné
logprob	OpenAI.numeric		Ano
token	řetězec	Možný textový token.	Ano
top_logprobs	pole OpenAI.ResponseLogProbTopLogprobs	Pravděpodobnost protokolu 20 nejpravděpodobnějších tokenů.	Ne

OpenAI.ResponseLogProbTopLogprobs

Name	Typ	Description	Povinné	Výchozí
logprob	OpenAI.numeric		Ne
token	řetězec		Ne

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Emituje se v případě, že dojde ke změně (částečné aktualizaci) v argumentech volání nástroje MCP.

Name	Typ	Description	Povinné
delta	řetězec	Řetězec JSON obsahující částečnou aktualizaci 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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
arguments	řetězec	Řetězec JSON obsahující finalizované argumenty 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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky volání nástroje MCP, která byla dokončena.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky volání nástroje MCP, která selhala.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky volání nástroje MCP, která vytvořila tento výstup.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky volání nástroje MCP, která selhala.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné
item_id	řetězec	ID zpracovávané položky volání nástroje MCP.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
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.

Name	Typ	Description	Povinné
položka	OpenAI.OutputItem		Ano
└agent_reference	AgentReference	Agent, který položku vytvořil.	Ne
└response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
└- typ	OpenAI.OutputItemType		Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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á.

Name	Typ	Description	Povinné
položka	OpenAI.OutputItem		Ano
└agent_reference	AgentReference	Agent, který položku vytvořil.	Ne
└response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
└- typ	OpenAI.OutputItemType		Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.output_item.done`. Možné hodnoty: `response.output_item.done`	Ano

OpenAI.ResponseOutputTextAnnotationAddedEvent

Vygenerováno při přidání poznámky do výstupního textového obsahu.

Name	Typ	Description	Povinné
poznámka	OpenAI.Annotation	Poznámka, která se vztahuje na rozsah výstupního textu.	Ano
└- typ	OpenAI.AnnotationType		Ano
annotation_index	OpenAI.integer		Ano
content_index	OpenAI.integer		Ano
item_id	řetězec	Jedinečný identifikátor položky, do které se přidává poznámka.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy 'response.output_text.annotation.added'. Možné hodnoty: `response.output_text.annotation.added`	Ano

OpenAI.ResponsePromptVariables

Volitelná mapa hodnot pro nahrazení proměnných ve vašem dotazu. 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í.

Name	Typ	Description	Povinné	Výchozí
response	OpenAI.Response		Ano
└agent_reference	AgentReference (s možnou hodnotou null)	Agent použitý pro tuto odpověď	Ano
└pozadí	logická hodnota (s možnou hodnotou null)		Ne
└completed_at	celé číslo (s možnou hodnotou null)		Ne
└- konverzace	OpenAI.ConversationReference (s možnou hodnotou null)	Konverzace, do které tato odpověď patří. Do této konverzace se automaticky přidaly vstupní položky a výstupní položky z této odpovědi.	Ne
└ created_at	integer	Časové razítko unixu (v sekundách) doby vytvoření této odpovědi	Ano
└─ chyba	OpenAI.ResponseError (s možnou hodnotou null)	Objekt chyby vrácený v případě, že se modelu nepodaří vygenerovat odpověď.	Ano
└─ id	řetězec	Jedinečný identifikátor pro tuto odpověď.	Ano
└─neúplné_detaily	OpenAI.ResponseIncompleteDetails (nullable)		Ano
└- pokyny	řetězec nebo pole OpenAI.InputItem (nullable)		Ano
└ max_output_tokens	OpenAI.integer (nullable)		Ne
└max_tool_calls	OpenAI.integer (nullable)		Ne
└– metadata	OpenAI.Metadata (s možnou hodnotou null)	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`	Ano
└─ výstup	pole OpenAI.OutputItem	Pole položek obsahu vygenerovaných modelem - Délka a pořadí položek v `output` poli je závislé. na odpovědi modelu. Namísto toho, abyste přistupovali 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 (s možnou hodnotou null)		Ne
└─ paralelní volání nástrojů	boolean	Jestli chcete modelu povolit paralelní spouštění volání nástrojů.	Ano	Pravdivé
└─ předchozí_id_odpovědi	řetězec (s možnou hodnotou null)		Ne
└─ výzva	OpenAI.Prompt	Odkaz na šablonu promptu a její proměnné Další informace.	Ne
└prompt_cache_key	řetězec	Rozhraní OpenAI používá k ukládání odpovědí do mezipaměti pro podobné požadavky za účelem optimalizace míry dosažení míry dosažení mezipaměti. Pole `user` nahradí. Další informace.	Ne
└prompt_cache_retention	výčet	Možné hodnoty: `in-memory`, `24h`	Ne
└— odůvodnění	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└safety_identifier	řetězec	Stabilní identifikátor používaný k detekci uživatelů vaší aplikace, kteří můžou narušit zásady použití OpenAI. ID by měla být řetězec, který jednoznačně identifikuje každého uživatele. Doporučujeme zatřiďovat jejich uživatelské jméno nebo e-mailovou adresu, aby se nám neposílaly žádné identifikační informace. Další informace.	Ne
└service_tier	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. – Pokud není nastaveno, 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.	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
└− teplota	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└- text	OpenAI.ResponseTextParam	Možnosti konfigurace textové odpovědi z modelu Může být prostý text nebo strukturovaná data JSON. Další informace: - Textové vstupy a výstupy - Strukturované výstupy	Ne
└─ volba_nástroje	OpenAI.ToolChoiceOptions nebo OpenAI.ToolChoiceParam		Ne
└ nástroje	OpenAI.ToolsArray	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` . Podporujeme následující kategorie nástrojů: - Integrované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo hledání souborů. Další informace o integrované nástroje. - Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinované konektory, jako je Disk Google a SharePoint. Další informace o Nástroje MCP. - Volání funkcí (vlastní nástroje):: Funkce, které jsou definovány vámi, povolení volání vlastního kódu s argumenty silného typu a výstupy. Další informace o volání funkce. Můžete také použít vlastní nástroje pro volání vlastního kódu.	Ne
└ top_logprobs	OpenAI.integer (nullable)		Ne
└top_p	OpenAI.numeric (s možnou hodnotou null)		Ne	1
└– zkrácení	výčet	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	string (zastaralé)	Toto pole se nahrazuje znakem `safety_identifier` a `prompt_cache_key`. Místo toho se používá `prompt_cache_key` k údržbě optimalizací ukládání do mezipaměti. Stabilní identifikátor pro koncové uživatele. Používá se ke zvýšení míry dosažení mezipaměti lepším rozdělením podobných požadavků a k tomu, aby OpenAI detekuje a zabránilo zneužití. Další informace.	Ne
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy "response.queued". Možné hodnoty: `response.queued`	Ano

OpenAI.ResponseReasoningSummaryPartAddedEvent

Při přidání nové části souhrnu odůvodnění se vygeneruje.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky, ke které je tato souhrnná část přidružena.	Ano
output_index	OpenAI.integer		Ano
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Ano
└- text	řetězec		Ano
└- typ	výčet	Možné hodnoty: `summary_text`	Ano
sequence_number	OpenAI.integer		Ano
summary_index	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.reasoning_summary_part.added`. Možné hodnoty: `response.reasoning_summary_part.added`	Ano

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec		Ano
typ	výčet	Možné hodnoty: `summary_text`	Ano

OpenAI.ResponseReasoningSummaryPartDoneEvent

Po dokončení části s odůvodněním se emituje.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky, ke které je tato souhrnná část přidružena.	Ano
output_index	OpenAI.integer		Ano
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Ano
└- text	řetězec		Ano
└- typ	výčet	Možné hodnoty: `summary_text`	Ano
sequence_number	OpenAI.integer		Ano
summary_index	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.reasoning_summary_part.done`. Možné hodnoty: `response.reasoning_summary_part.done`	Ano

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec		Ano
typ	výčet	Možné hodnoty: `summary_text`	Ano

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Vyvoláno při přidání změny do textu shrnutí s odůvodněním.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
summary_index	OpenAI.integer		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í.

Name	Typ	Description	Povinné
item_id	řetězec	ID položky, ke které je tento souhrnný text přidružený.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
summary_index	OpenAI.integer		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.ResponseReasoningTextDeltaEvent

Vygenerováno při přidání rozdílu do textu s odůvodněním.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		Ano
delta	řetězec	Rozdíl textu, který byl přidán do obsahu odůvodnění.	Ano
item_id	řetězec	ID položky, ke které je přidružena rozdílová hodnota textu z tohoto důvodu.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.reasoning_text.delta`. Možné hodnoty: `response.reasoning_text.delta`	Ano

OpenAI.ResponseReasoningTextDoneEvent

Vygeneruje se při dokončení textu zdůvodnění.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		Ano
item_id	řetězec	ID položky, ke které je tento text odůvodnění přidružený.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
poslat SMS	řetězec	Celý text dokončeného obsahu odůvodnění.	Ano
typ	výčet	Typ události. Vždy `response.reasoning_text.done`. Možné hodnoty: `response.reasoning_text.done`	Ano

OpenAI.ResponseRefusalDeltaEvent

Vygenerováno v případě částečného odmítnutí textu.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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í.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		Ano
item_id	řetězec	ID výstupní položky, kterou je zamítnutý text finalizován.	Ano
output_index	OpenAI.integer		Ano
odmítnutí	řetězec	Text odmítnutí, který je finalizován.	Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.refusal.done`. Možné hodnoty: `response.refusal.done`	Ano

OpenAI.ResponseStreamOptions

Možnosti pro streamované odpovědi Toto nastavení nastavíte pouze při nastavení stream: true.

Name	Typ	Description	Povinné	Výchozí
zahrnout_zatemnění	boolean	Pokud ano, povolí se obfuskace streamu. Přidání obfuskace streamu náhodné znaky do `obfuscation` pole u událostí rozdílového streamování do normalizuje velikosti datových částí jako zmírnění určitých útoků na straně kanálu. Tato pole obfuskace jsou ve výchozím nastavení zahrnuta, ale přidají malou částku. režijních nákladů na datový stream. Můžete nastavit `include_obfuscation` na false pro optimalizaci šířky pásma, pokud důvěřujete síťovým propojením mezi aplikace a rozhraní OpenAI API.	Ne

OpenAI.ResponseTextDeltaEvent

Emitováno, když je k dispozici dodatečný textový delta.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		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
logaritmované pravděpodobnosti	pole OpenAI.ResponseLogProb	Pravděpodobnosti protokolu tokenů v rozdílu.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.

Name	Typ	Description	Povinné
content_index	OpenAI.integer		Ano
item_id	řetězec	ID výstupní položky, kterou je textový obsah finalizován.	Ano
logaritmované pravděpodobnosti	pole OpenAI.ResponseLogProb	Pravděpodobnosti protokolu tokenů v rozdílu.	Ano
output_index	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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.ResponseTextParam

Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON. Další informace:

Name	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
podrobnosti	OpenAI.Verbosity	Omezuje úroveň podrobností odpovědi modelu. Nižší hodnoty budou mít za následek stručnější odpovědi, zatímco vyšší hodnoty budou mít za následek více podrobných odpovědí. Aktuálně podporované hodnoty jsou `low`, `medium`a `high`.	Ne

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ů.

Name	Typ	Povinné
input_tokens	OpenAI.integer	Ano
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Ano
└─ uložené_tokény	OpenAI.integer	Ano
output_tokens	OpenAI.integer	Ano
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Ano
└─ "reasoning_tokens"	OpenAI.integer	Ano
total_tokens	OpenAI.integer	Ano

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Povinné	Výchozí
cached_tokens	OpenAI.integer		Ano

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Povinné	Výchozí
důvodové_tokeny	OpenAI.integer		Ano

OpenAI.ResponseWebSearchCallCompletedEvent

Vygenerováno při dokončení volání vyhledávání na webu.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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

Vygenerováno při zahájení volání vyhledávání na webu.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		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

Vygenerováno při spuštění volání webového vyhledávání.

Name	Typ	Description	Povinné
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	OpenAI.integer		Ano
sequence_number	OpenAI.integer		Ano
typ	výčet	Typ události. Vždy `response.web_search_call.searching`. Možné hodnoty: `response.web_search_call.searching`	Ano

OpenAI.Screenshot

Akce snímku obrazovky

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Určuje typ události. Tato vlastnost platí pro akci pořízení snímku obrazovky. vždy nastaveno na `screenshot`. Možné hodnoty: `screenshot`	Ano

OpenAI.Scroll

Akce scrollování

Name	Typ	Description	Povinné
scroll_x	OpenAI.integer		Ano
scroll_y	OpenAI.integer		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	OpenAI.integer		Ano
y	OpenAI.integer		Ano

OpenAI.SearchContextSize

Property	Value
Typ	řetězec
Hodnoty	`low` `medium` `high`

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.
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.

Property	Value
Typ	řetězec
Nullable	Ano
Hodnoty	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

Při provádění volání nástroje vynutí model volat nástroj apply_patch.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Nástroj, který se má volat. Vždy `apply_patch`. Možné hodnoty: `apply_patch`	Ano

OpenAI.SpecificFunctionShellParam

Vynutí, aby model volal nástroj prostředí, když je požadováno volání nástroje.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Nástroj, který se má volat. Vždy `shell`. Možné hodnoty: `shell`	Ano

OpenAI.Summary

Souhrnný text z modelu.

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Shrnutí výstupu odůvodnění z modelu doposud.	Ano
typ	výčet	Typ objektu. Vždy `summary_text`. Možné hodnoty: `summary_text`	Ano

OpenAI.SummaryTextContent

Souhrnný text z modelu.

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec	Shrnutí výstupu odůvodnění z modelu doposud.	Ano
typ	výčet	Typ objektu. Vždy `summary_text`. Možné hodnoty: `summary_text`	Ano

OpenAI.TextContent

Textový obsah.

Name	Typ	Description	Povinné	Výchozí
poslat SMS	řetězec		Ano
typ	výčet	Možné hodnoty: `text`	Ano

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" } pro povolení staršího režimu JSON, což zajistí, že zpráva, kterou model vygeneruje, 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
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.TextResponseFormatConfigurationType		Ano

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	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.TextResponseFormatConfigurationResponseFormatText

Výchozí formát odpovědi Používá se ke generování textových odpovědí.

Name	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.TextResponseFormatConfigurationType

Property	Value
Typ	řetězec
Hodnoty	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

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ých výstupech.

Name	Typ	Description	Povinné
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	OpenAI.ResponseFormatJsonSchemaSchema	Schéma pro formát odpovědi popsané jako objekt schématu JSON. Tady se dozvíte, jak se vytvářejí schémata JSON.	Ano
přísné	logická hodnota (s možnou hodnotou null)		Ne
typ	výčet	Typ formátu odpovědi, který se definuje. Vždy `json_schema`. Možné hodnoty: `json_schema`	Ano

OpenAI.Tool

Nástroj, který lze použít k vygenerování odpovědi.

Diskriminátor pro nástroj OpenAI

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

Hodnota typu	Schema
`bing_grounding`	BingGroundingTool
`fabric_dataagent_preview`	MicrosoftFabricPreviewTool
`sharepoint_grounding_preview`	SharepointPreviewTool
`azure_ai_search`	AzureAISearchTool
`openapi`	OpenApiTool
`bing_custom_search_preview`	BingCustomSearchPreviewTool
`browser_automation_preview`	BrowserAutomationPreviewTool
`azure_function`	AzureFunctionTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2APreviewTool
`memory_search_preview`	MemorySearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ToolType		Ano

OpenAI.ToolChoiceAllowed

Omezuje nástroje dostupné pro model na předem definovanou sadu.

Name	Typ	Description	Povinné
mode	výčet	Omezuje nástroje dostupné pro model na předem definovanou sadu. `auto` umožňuje modelu vybírat z povolených nástrojů a generovat zpráva. `required` vyžaduje, aby model volal jeden nebo více povolených nástrojů. Možné hodnoty: `auto`, `required`	Ano
tools	pole objektu	Seznam definic nástrojů, které by měl model volat. U rozhraní API pro odpovědi může seznam definic nástrojů vypadat takto: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Ano
typ	výčet	Povolený typ konfigurace nástroje Vždy `allowed_tools`. Možné hodnoty: `allowed_tools`	Ano

OpenAI.ToolChoiceCodeInterpreter

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Přečtěte si další informace o integrovaných nástrojích.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `code_interpreter`	Ano

OpenAI.ToolChoiceComputerUsePreview

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Přečtěte si další informace o integrovaných nástrojích.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `computer_use_preview`	Ano

OpenAI.ToolChoiceCustom

Tuto možnost použijte, pokud chcete model vynutit volání konkrétního vlastního nástroje.

Name	Typ	Description	Povinné	Výchozí
název	řetězec	Název vlastního nástroje, který se má volat.	Ano
typ	výčet	Pro vlastní volání nástrojů je typ vždy `custom`. Možné hodnoty: `custom`	Ano

OpenAI.ToolChoiceFileSearch

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Přečtěte si další informace o integrovaných nástrojích.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `file_search`	Ano

OpenAI.ToolChoiceFunction

Tuto možnost použijte k vynucení volání konkrétní funkce modelu.

Name	Typ	Description	Povinné	Výchozí
název	řetězec	Název funkce, kterou volat.	Ano
typ	výčet	Pro volání funkce je typ vždy `function`. Možné hodnoty: `function`	Ano

OpenAI.ToolChoiceImageGeneration

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Přečtěte si další informace o integrovaných nástrojích.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `image_generation`	Ano

OpenAI.ToolChoiceMCP

Tuto možnost použijte k vynucení volání konkrétního nástroje na vzdáleném serveru MCP.

Name	Typ	Description	Povinné
název	řetězec (s možnou hodnotou null)		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.ToolChoiceOptions

Určuje, který nástroj model volá, pokud nějaký existuje. 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í použít několik nástrojů.

Property	Value
Typ	řetězec
Hodnoty	`none` `auto` `required`

OpenAI.ToolChoiceParam

Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru tools se dozvíte, jak určit nástroje, které model může volat.

Diskriminátor pro OpenAI.ToolChoiceParam

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

Hodnota typu	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`function`	OpenAI.ToolChoiceFunction
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

Name	Typ	Description	Povinné	Výchozí
typ	OpenAI.ToolChoiceParamType		Ano

OpenAI.ToolChoiceParamType

Property	Value
Typ	řetězec
Hodnoty	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Přečtěte si další informace o integrovaných nástrojích.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `web_search_preview`	Ano

OpenAI.ToolChoiceWebSearchPreview20250311

Označuje, že model by měl k vygenerování odpovědi použít integrovaný nástroj. Přečtěte si další informace o integrovaných nástrojích.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `web_search_preview_2025_03_11`	Ano

OpenAI.ToolType

Property Value

Typ řetězec

Hodnoty function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

OpenAI.ToolsArray

Pole nástrojů, které může model volat při generování odpovědi. Pomocí nastavení parametru tool_choice můžete určit, který nástroj chcete použít. Podporujeme následující kategorie nástrojů:

Předdefinované nástroje: Nástroje, které poskytuje OpenAI, které rozšiřují možnosti modelu, jako je vyhledávání na webu nebo vyhledávání souborů. Přečtěte si další informace o integrovaných nástrojích.
Nástroje MCP: Integrace se systémy třetích stran prostřednictvím vlastních serverů MCP nebo předdefinovaných konektorů, jako je Disk Google a SharePoint. Přečtěte si další informace o nástrojích MCP.
Volání funkcí (vlastní nástroje): Funkce, které jsou definované vámi, umožňují modelu volat vlastní kód se silnými argumenty a výstupy. Přečtěte si další informace o volání funkcí. K volání vlastního kódu můžete použít také vlastní nástroje.

Pole: OpenAI.Tool

OpenAI.TopLogProb

Nejvyšší logaritmická pravděpodobnost tokenu.

Name	Typ	Povinné
bytes	pole OpenAI.integer	Ano
logprob	OpenAI.numeric	Ano
token	řetězec	Ano

OpenAI.Type

Akce pro zadávání textu.

Name	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.UpdateConversationBody

Name	Typ	Description	Povinné	Výchozí
metadata	OpenAI.Metadata (s možnou hodnotou null)	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

OpenAI.UrlCitationBody

Citace webového prostředku použitého k vygenerování odpovědi modelu

Name	Typ	Description	Povinné
end_index	OpenAI.integer		Ano
start_index	OpenAI.integer		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.VectorStoreFileAttributes

Typ: objekt

OpenAI.Verbosity

Omezuje úroveň podrobností odpovědi modelu. Nižší hodnoty budou mít za následek stručnější odpovědi, zatímco vyšší hodnoty budou mít za následek více podrobných odpovědí. Aktuálně podporované hodnoty jsou low, mediuma high.

Property	Value
Typ	řetězec
Nullable	Ano
Hodnoty	`low` `medium` `high`

OpenAI.Wait

Akce čekání.

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Určuje typ události. Pro akci čekání je tato vlastnost vždy nastaveno na `wait`. Možné hodnoty: `wait`	Ano

OpenAI.WebSearchActionFind

Typ akce "find": Vyhledá vzor na načtené stránce.

Name	Typ	Description	Povinné
vzor	řetězec	Vzor nebo text, který chcete vyhledat na stránce.	Ano
typ	výčet	Typ akce. Možné hodnoty: `find_in_page`	Ano
url	řetězec	Adresa URL stránky, na které byl hledán vzor.	Ano

OpenAI.WebSearchActionOpenPage

Typ akce "open_page" – Otevře konkrétní adresu URL z výsledků hledání.

Name	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.WebSearchActionSearch

Typ akce "search" – provede vyhledávací dotaz na webu.

Name	Typ	Description	Povinné
Dotazy	pole řetězce	Vyhledávací dotazy.	Ne
dotaz	string (zastaralé)	[ZASTARALÉ] Vyhledávací dotaz.	Ano
Zdrojů	pole OpenAI.WebSearchActionSearchSources	Zdroje použité ve vyhledávání.	Ne
typ	výčet	Typ akce. Možné hodnoty: `search`	Ano

OpenAI.WebSearchActionSearchSources

Name	Typ	Description	Povinné	Výchozí
typ	výčet	Možné hodnoty: `url`	Ano
url	řetězec		Ano

OpenAI.WebSearchApproximateLocation

Přibližné umístění uživatele

Name	Typ	Description	Povinné
Město	řetězec (s možnou hodnotou null)		Ne
země	řetězec (s možnou hodnotou null)		Ne
oblast	řetězec (s možnou hodnotou null)		Ne
timezone	řetězec (s možnou hodnotou null)		Ne
typ	výčet	Typ aproximace polohy. Vždy `approximate`. Možné hodnoty: `approximate`	Ne

OpenAI.WebSearchPreviewTool

Tento nástroj vyhledává na webu relevantní výsledky pro odpověď. Přečtěte si další informace o nástroji pro vyhledávání webu .

Name	Typ	Description	Povinné
velikost_kontextu_vyhledávání	OpenAI.SearchContextSize		Ne
typ	výčet	Typ vyhledávacího nástroje pro web. Jeden z `web_search_preview` nebo `web_search_preview_2025_03_11`. Možné hodnoty: `web_search_preview`	Ano
uživatelská_lokalita	OpenAI.ApproximateLocation (s možnou hodnotou null)		Ne
└city	řetězec (s možnou hodnotou null)		Ne
└zemi	řetězec (s možnou hodnotou null)		Ne
└region	řetězec (s možnou hodnotou null)		Ne
└™ časové pásmo	řetězec (s možnou hodnotou null)		Ne
└- typ	výčet	Typ aproximace polohy. Vždy `approximate`. Možné hodnoty: `approximate`	Ano

OpenAI.WebSearchTool

Hledejte na internetu zdroje související s tímto zadáním. Přečtěte si další informace o nástroji pro vyhledávání webu .

Name	Typ	Description	Povinné
custom_search_configuration	WebSearchConfiguration	Konfigurace vyhledávání na webu pro bing vlastní vyhledávání	Ne
└instance_name	řetězec	Název vlastní instance konfigurace zadané ke konfiguraci.	Ano
└project_connection_id	řetězec	Project ID připojení pro uzemnění s využitím vlastního vyhledávání Bingu	Ano
Filtry	OpenAI.WebSearchToolFilters (nullable)		Ne
└allowed_domains	pole řetězce (s možnou hodnotou null)		Ne
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`, `medium`nebo `high`. `medium` je výchozí hodnota. Možné hodnoty: `low`, `medium`, `high`	Ne
typ	výčet	Typ vyhledávacího nástroje pro web. Jeden z `web_search` nebo `web_search_2025_08_26`. Možné hodnoty: `web_search`	Ano
uživatelská_lokalita	OpenAI.WebSearchApproximateLocation (nullable)	Přibližné umístění uživatele	Ne
└city	řetězec (s možnou hodnotou null)		Ne
└zemi	řetězec (s možnou hodnotou null)		Ne
└region	řetězec (s možnou hodnotou null)		Ne
└™ časové pásmo	řetězec (s možnou hodnotou null)		Ne
└- typ	výčet	Typ aproximace polohy. Vždy `approximate`. Možné hodnoty: `approximate`	Ne

OpenAI.WebSearchToolFilters

Name	Typ	Description	Povinné	Výchozí
allowed_domains	pole řetězce		Ne

OpenAI.integer

Typ: celé číslo

Formát: int64

OpenAI.numeric

Typ: číslo

Formát: double

OpenApiAnonymousAuthDetails

Podrobnosti zabezpečení pro anonymní ověřování OpenApi

Name	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

Name	Typ	Description	Povinné	Výchozí
typ	OpenApiAuthType	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 AI 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í)
Project Connection (vyžaduje project_connection_id na koncový bod podle nastavení v AI Foundry)
Managed_Identity (vyžaduje cílovou skupinu pro ověření na základě identity)

Property	Value
Description	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 AI Foundry) – Managed_Identity (vyžaduje cílovou skupinu pro ověřování na základě identit).
Typ	řetězec
Hodnoty	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Informace o definici vstupu pro funkci openapi.

Name	Typ	Description	Povinné
auth	OpenApiAuthDetails	podrobnosti o ověřování pro OpenApiFunctionDefinition	Ano
└- typ	OpenApiAuthType	Typ ověřování musí být anonymní, project_connection/managed_identity	Ano
default_params	pole řetězce	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 objektu	Seznam definic funkcí používaných nástrojem OpenApi	Ne
název	řetězec	Název funkce, která se má volat.	Ano
spec	objekt	Obrazec funkce openapi, který je popsán jako objekt schématu JSON.	Ano

OpenApiManagedAuthDetails

Podrobnosti zabezpečení pro ověřování managed_identity OpenApi

Name	Typ	Description	Povinné
security_scheme	OpenApiManagedSecurityScheme	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	Ano
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

Name	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

Name	Typ	Description	Povinné
security_scheme	OpenApiProjectConnectionSecurityScheme	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	Ano
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

Name	Typ	Description	Povinné	Výchozí
project_connection_id	řetězec	PROJECT ID připojení pro typ ověřování připojení Project	Ano

OpenApiTool

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

Name	Typ	Description	Povinné
openapi	OpenApiFunctionDefinition	Informace o definici vstupu pro funkci openapi.	Ano
└- ověřování	OpenApiAuthDetails	Podrobnosti o ověřování rozhraní API	Ano
└default_params	pole řetězce	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 objektu (jen pro čtení)	Seznam definic funkcí používaných nástrojem OpenApi	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.	Ano
└– parametry	objekt	Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON.	Ano
└– název	řetězec	Název funkce, která se má volat.	Ano
└specifikace	objekt	Obrazec funkce openapi, který je popsán jako objekt schématu JSON.	Ano
typ	výčet	Typ objektu, který je vždy 'openapi'. Možné hodnoty: `openapi`	Ano

Pořadí stránek

Property	Value
Typ	řetězec
Hodnoty	`asc` `desc`

PagedConnection

Stránkovaná kolekce položek připojení

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole připojení	Položky připojení na této stránce	Ano

PagedDatasetVersion

Stránkovaná kolekce položek DatasetVersion

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole DatasetVersion	Položky DatasetVersion na této stránce	Ano

PagedDeployment

Stránkovaná kolekce položek nasazení

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole nasazení	Položky nasazení na této stránce	Ano

PagedEvaluationRule

Sbíraná sbírka položek Hodnotících pravidel

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole EvaluationRule	Položky Vyhodnocenírule na této stránce	Ano

PagedEvaluationTaxonomy

Stránkovaná sbírka položek EvaluationTaxonomy

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole EvaluationTaxonomy	Položky EvaluationTaxonomy na této stránce	Ano

PagedEvaluatorVersion

Stránkovaná sbírka položek EvaluatorVersion

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole EvaluatorVersion	Položky EvaluatorVersion na této stránce	Ano

PagedIndex

Stránkovaná kolekce položek indexu

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole indexu	Položky rejstříku na této stránce	Ano

PagedInsight

Stránkovaná kolekce položek Přehledu

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole přehledu	Položky přehledu na této stránce	Ano

PagedRedTeam

Stránkovaná kolekce položek RedTeamu

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole RedTeamu	Položky RedTeamu na této stránce	Ano

PagedSchedule

Stránkovaná kolekce položek plánu

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole plánu	Položky plánu na této stránce	Ano

PagedScheduleRun

Stránkovaná kolekce položek ScheduleRun

Name	Typ	Description	Povinné	Výchozí
další odkaz	řetězec	Odkaz na další stránku položek	Ne
value	pole ScheduleRun	Položky ScheduleRun na této stránce	Ano

PendingUploadRequest

Představuje požadavek na čekající nahrání.

Name	Typ	Description	Povinné
connectionName	řetězec	Název připojení účtu služby Azure Storage, který se má použít pro generová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í

Name	Typ	Description	Povinné
blobReference	BlobReference	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`	Ano
└- přihlašovací údaje	SasCredential	Informace o přihlašovacích údajích pro přístup k účtu úložiště	Ano
└- storageAccountArmId	řetězec	ID ARM účtu úložiště, které se má použít.	Ano
pendingUploadId	řetězec	ID této žádosti o nahrání.	Ano
pendingUploadType	výčet	BlobReference je jediný podporovaný typ. 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

Name	Typ	Description	Povinné	Výchozí
Pokyny	řetězec (s možnou hodnotou null)	Zpráva systému (nebo vývojáře) vložená do kontextu modelu.	Ne
kind	výčet	Možné hodnoty: `prompt`	Ano
model	řetězec	Nasazení modelu, které se má použít pro tohoto agenta.	Ano
rai_config	RaiConfig	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.	Ano
reasoning	OpenAI.Reasoning (s možnou hodnotou null)	pouze modely gpt-5 a o-series Možnosti konfigurace pro modely odůvodnění.	Ne
└– úsilí	OpenAI.ReasoningEffort	Omezuje úsilí na odůvodňování modely odůvodnění. Aktuálně podporované hodnoty jsou `none`, `minimallowmediumhigh`a .`xhigh` Snižování zdůvodnění může vést k rychlejším odpovědím a menšímu počtu použitých tokenů. o odůvodnění v odpovědi - `gpt-5.1` výchozí hodnota `none`, která neprovádí odůvodnění. Podporované hodnoty odůvodnění jsou `gpt-5.1none`, `low`, `medium`a `high`. 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` výchozím nastavením `medium` zdůvodnění úsilí a nepodporují `none`. – Ve `gpt-5-pro` výchozím nastavení modelu (a pouze podporuje) `high` zdůvodnění. - `xhigh` je podporován pro všechny modely po `gpt-5.1-codex-max`.	Ne
└─ vytvořit_shrnutí	výčet	Možné hodnoty: `auto`, `concise`, `detailed`	Ne
└─ souhrn	výčet	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 změnit buď toto, nebo `top_p`, ne však obojí.	Ne	1
poslat SMS	PromptAgentDefinitionTextOptions	Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON.	Ne
└─ Formát	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
tool_choice	string nebo OpenAI.ToolChoiceParam	Způsob, jakým má model vybrat nástroj (nebo nástroje), který se má použít při generování odpovědi V parametru `tools` se dozvíte, jak určit nástroje, které model může volat.	Ne
tools	pole OpenAI.Tool	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 změnit buď toto, nebo `temperature`, ne však obojí.	Ne	1

PromptAgentDefinitionTextOptions

Možnosti konfigurace textové odpovědi z modelu Může to být prostý text nebo strukturovaná data JSON.

Name	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

PromptBasedEvaluatorDefinition

Hodnotitel založený na výzvě

Name	Typ	Description	Povinné
data_schema	objekt	Schéma JSON (Draft 2020-12) pro vstupní data hodnotitele. To zahrnuje parametry jako typ, vlastnosti, povinné.	Ne
init_parameters	objekt	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
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.

Name	Typ	Description	Povinné	Výchozí
protokol	AgentProtocol		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).

Name	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

Name	Typ	Description	Povinné	Výchozí
typ	RecurrenceType	Typ opakování.	Ano

RecurrenceTrigger

Spouštěč založený na opakování.

Name	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
schedule	RecurrenceSchedule	Model plánu opakování.	Ano
└- typ	RecurrenceType	Typ opakování pro plán opakování	Ano
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í.

Property	Value
Description	Typ opakování.
Typ	řetězec
Hodnoty	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Podrobnosti o červeném týmu.

Name	Typ	Description	Povinné	Výchozí
applicationScenario	řetězec	Scénář aplikace pro červenou operaci týmu za účelem generování konkrétních scénářů útoků	Ne
attackStrategies	pole AttackStrategy	Seznam strategií útoku nebo vnořených seznamů strategií útoku	Ne
displayName	řetězec	Název červeného týmu.	Ne
id	string (jen pro čtení)	Identifikátor červeného týmu.	Ano
numTurns	integer	Počet zaokrouhlených simulací	Ne
properties	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 Rizikové kategorie	Seznam kategorií rizik pro generování cílů útoku	Ne
simulaceOnly	boolean	Pouze simulace nebo Simulace + Vyhodnocení. Výchozí nepravda, pokud je pravda, že se ve výstupu kontroly nevyhodnocuje výsledek vyhodnocení.	Ne	Nepravda
stav	string (jen pro čtení)	Stav červeného týmu Nastavuje se podle služby a je jen pro čtení.	Ne
tags	objekt	Červené značky týmu. Na rozdíl od vlastností jsou značky plně proměnlivé.	Ne
cíl	TargetConfig	Abstraktní třída pro cílovou konfiguraci.	Ano
└- typ	řetězec	Typ konfigurace modelu	Ano

RedTeamEvalRunDataSource

Name	Typ	Description	Povinné
item_generation_params	ItemGenerationParams	Představuje sadu parametrů použitých k řízení operací generování položek.	Ano
└- typ	ItemGenerationParamsType	Typ parametrů generování položek, které se mají použít.	Ano
cíl	Cíl	Základní třída pro cíle s podporou diskriminátoru.	Ano
└- typ	řetězec	Typ cíle.	Ano
typ	výčet	Typ zdroje dat. Vždy `azure_ai_red_team`. Možné hodnoty: `azure_ai_red_team`	Ano

RedTeamItemGenerationParams

Name	Typ	Description	Povinné	Výchozí
attack_strategies	pole AttackStrategy	Kolekce strategií útoku, které se mají použít.	Ano
num_turns	integer	Počet otáček povolených ve hře.	Ano	20
typ	výčet	Typ parametrů generování položek. Možné hodnoty: `red_team`	Ano

RedTeamSeedPromptsItemGenerationParams

Představuje parametry pro generování položek červených počátečních hodnot týmu.

Name	Typ	Description	Povinné	Výchozí
attack_strategies	pole AttackStrategy	Kolekce strategií útoku, které se mají použít.	Ano
num_turns	integer	Počet otáček povolených ve hře.	Ano	20
odeslat k provedení	OpenAI.EvalJsonlFileContentSource		Ano
└- obsah	pole OpenAI.EvalJsonlFileContentSourceContent	Obsah souboru jsonl.	Ano
└- typ	výčet	Typ zdroje jsonl. Vždy `file_content`. Možné hodnoty: `file_content`	Ano
typ	výčet	Typ parametrů generování položek, vždy `red_team_seed_prompts`. Možné hodnoty: `red_team_seed_prompts`	Ano

RedTeamTaxonomyItemGenerationParams

Představuje parametry pro generování položek taxonomie červeného týmu.

Name	Typ	Description	Povinné	Výchozí
attack_strategies	pole AttackStrategy	Kolekce strategií útoku, které se mají použít.	Ano
num_turns	integer	Počet otáček povolených ve hře.	Ano	20
odeslat k provedení	OpenAI.EvalJsonlFileContentSource		Ano
└- obsah	pole OpenAI.EvalJsonlFileContentSourceContent	Obsah souboru jsonl.	Ano
└- typ	výčet	Typ zdroje jsonl. Vždy `file_content`. Možné hodnoty: `file_content`	Ano
typ	výčet	Typ parametrů generování položek, vždy `red_team_taxonomy`. Možné hodnoty: `red_team_taxonomy`	Ano

ResponseRetrievalItemGenerationParams

Představuje parametry pro generování položek načítání odpovědí.

Name	Typ	Description	Povinné
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í	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource	Zdroj, ze kterého se čte obsah JSONL.	Ano
typ	výčet	Typ parametrů generování položek, vždy `response_retrieval`. Možné hodnoty: `response_retrieval`	Ano

RiskCategory

Kategorie rizika pro cíl útoku.

Property	Value
Description	Kategorie rizika pro cíl útoku.
Typ	řetězec
Hodnoty	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SasCredentials

Definice přihlašovacích údajů sdíleného přístupového podpisu (SAS)

Name	Typ	Description	Povinné	Výchozí
SAS	string (jen pro čtení)	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.

Property	Value
Description	Typ vzorku použitého při analýze.
Typ	řetězec
Hodnoty	`EvaluationResultSample`

SasCredential

Definice přihlašovacích údajů SAS

Name	Typ	Description	Povinné	Výchozí
sasUri	string (jen pro čtení)	Identifikátor URI SAS	Ano
typ	výčet	Typ přihlašovacích údajů Možné hodnoty: `SAS`	Ano

Schedule

Model plánu.

Name	Typ	Description	Povinné
popis	řetězec	Popis plánu	Ne
displayName	řetězec	Název plánu	Ne
enabled	boolean	Povolený stav plánu	Ano
id	string (jen pro čtení)	Identifikátor plánu.	Ano
properties	objekt	Vlastnosti plánu Na rozdíl od značek jsou vlastnosti pouze doplňky. Po přidání nelze odebrat vlastnost.	Ne
provisioningStatus	ScheduleProvisioningStatus (jen pro čtení)	Naplánujte si stav zřizování.	Ne
systémová data	object (jen pro čtení)	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	ScheduleTask	Naplánujte model úlohy.	Ano
Konfigurace └•	objekt	Konfigurace pro úlohu	Ne
└- typ	ScheduleTaskType	Typ úkolu	Ano
aktivační událost	Spouštěč	Základní model pro Trigger plánu.	Ano
└- typ	Typ spouště	Typ spouštěče.	Ano

ScheduleProvisioningStatus

Naplánujte si stav zřizování.

Property	Value
Description	Naplánujte si stav zřizování.
Typ	řetězec
Hodnoty	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Naplánujte si model spuštění.

Name	Typ	Description	Povinné
chyba	string (jen pro čtení)	Informace o chybě pro spuštění plánu	Ne
id	string (jen pro čtení)	Identifikátor spuštění plánu.	Ano
properties	object (jen pro čtení)	Vlastnosti spuštění plánu	Ano
scheduleId	řetězec	Identifikátor plánu.	Ano
úspěch	logická hodnota (jen pro čtení)	Aktivace stavu úspěchu spuštění plánu	Ano
triggerTime	řetězec	Čas aktivace časového 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

Name	Typ	Description	Povinné	Výchozí
konfigurace	objekt	Konfigurace pro úlohu	Ne
typ	ScheduleTaskType	Typ úkolu	Ano

ScheduleTaskType

Typ úkolu

Property	Value
Description	Typ úkolu
Typ	řetězec
Hodnoty	`Evaluation` `Insight`

SharepointGroundingToolParameters

Parametry nástroje pro uzemnění služby SharePoint.

Name	Typ	Description	Povinné	Výchozí
project_connections	pole ToolProjectConnection	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

SharepointPreviewTool

Informace o definici vstupu pro nástroj služby SharePoint, jak slouží ke konfiguraci agenta.

Name	Typ	Description	Povinné
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parametry nástroje pro uzemnění služby SharePoint.	Ano
└project_connections	pole ToolProjectConnection	Připojení project připojená k tomuto nástroji. Může existovat maximálně 1 připojení. prostředek připojený k nástroji. Omezení: maxItems: 1	Ne
typ	výčet	Typ objektu, který je vždy 'sharepoint_grounding_preview'. Možné hodnoty: `sharepoint_grounding_preview`	Ano

Sku

Informace o skladové posílce

Name	Typ	Description	Povinné
kapacita	integer	Kapacita skladové položky	Ano
family	řetězec	Rodina skladových položek	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.

Name	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	objekt	Schéma JSON pro strukturovaný vstup (volitelné).	Ne

StructuredOutputDefinition

Strukturovaný výstup, který může vytvořit agent.

Name	Typ	Description	Povinné
popis	řetězec	Popis výstupu, který se má vygenerovat. Používá se model k určení, kdy se má výstup vygenerovat.	Ano
název	řetězec	Název strukturovaného výstupu.	Ano
schéma	objekt	Schéma JSON pro strukturovaný výstup.	Ano
přísné	logická hodnota (s možnou hodnotou null)	Zda se má vynucovat přísné ověřování. Výchozí `true`.	Ano

StructuredOutputsOutputItem

Name	Typ	Description	Povinné
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
výstup		Strukturovaný výstup zachycený během odpovědi.	Ano
response_id	řetězec	Odpověď, na které je položka vytvořena.	Ne
typ	výčet	Možné hodnoty: `structured_outputs`	Ano

SyntheticDataGenerationPreviewEvalRunDataSource

Představuje zdroj dat pro zkušební spuštění, která se vyhodnocují na základě vygenerovaných syntetických dat pro účely testování.

Name	Typ	Description	Povinné
zprávy_vstupu	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Ne
Šablona └─	pole objektu nebo OpenAI.EvalItem		Ano
└- typ	výčet	Možné hodnoty: `template`	Ano
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Ano
└model_deployment_name	řetězec	Název nasazení modelu, který se má použít ke generování syntetických dat.	Ano
└output_dataset_id	string (jen pro čtení)	Identifikátor výstupní datové sady, kde jsou uložena generovaná syntetická data. Vygenerovaná data jsou soubor jsonl s ID sloupců, dotazem a test_description.	Ne
└output_dataset_name	řetězec	Název výstupní datové sady, ve které budou uložena generovaná syntetická data. Pokud není k dispozici, služba automaticky vygeneruje název datové sady.	Ne
└─ výzva	řetězec	Výzva používaná ke generování syntetických dat. Tato možnost je v případě, že cíl je typu azure_ai_agent s pokyny nakonfigurovanými v agentovi.	Ne
└samples_count	integer	Maximální počet vzorků dat, které se mají vygenerovat.	Ano
└zdroje	pole OpenAI.EvalJsonlFileIdSource	Volitelné soubory zdroje obsahu počátečních dat pro generování dat.	Ano
└- typ	výčet	Typ parametrů generování položek. Možné hodnoty: `synthetic_data_gen_preview`	Ano
cíl	Cíl	Základní třída pro cíle s podporou diskriminátoru.	Ano
└- typ	řetězec	Typ cíle.	Ano
typ	výčet	Typ zdroje dat, vždy `azure_ai_synthetic_data_gen_preview`. Možné hodnoty: `azure_ai_synthetic_data_gen_preview`	Ano

SyntheticDataGenerationPreviewItemGenerationParams

Name	Typ	Description	Povinné
model_deployment_name	řetězec	Název nasazení modelu, který se má použít ke generování syntetických dat.	Ano
output_dataset_id	string (jen pro čtení)	Identifikátor výstupní datové sady, kde jsou uložena generovaná syntetická data. Vygenerovaná data jsou soubor jsonl s ID sloupců, dotazem a test_description.	Ne
output_dataset_name	řetězec	Název výstupní datové sady, ve které budou uložena generovaná syntetická data. Pokud není k dispozici, služba automaticky vygeneruje název datové sady.	Ne
požádat	řetězec	Výzva používaná ke generování syntetických dat. Tato možnost je v případě, že cíl je typu azure_ai_agent s pokyny nakonfigurovanými v agentovi.	Ne
samples_count	integer	Maximální počet vzorků dat, které se mají vygenerovat.	Ano
Zdrojů	pole OpenAI.EvalJsonlFileIdSource	Volitelné soubory zdroje obsahu počátečních dat pro generování dat.	Ano
typ	výčet	Typ parametrů generování položek. Možné hodnoty: `synthetic_data_gen_preview`	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

Name	Typ	Description	Povinné	Výchozí
typ	řetězec	Typ cíle.	Ano

TargetCompletionEvalRunDataSource

Představuje zdroj dat pro konfiguraci vyhodnocení dokončení na základě cíle.

Name	Typ	Description	Povinné
zprávy_vstupu	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Ne
└ item_reference	řetězec		Ano
└- typ	výčet	Možné hodnoty: `item_reference`	Ano
odeslat k provedení	OpenAI.EvalJsonlFileContentSource nebo OpenAI.EvalJsonlFileIdSource	Zdrojová konfigurace pro vložená nebo souborová data.	Ano
cíl	Cíl	Základní třída pro cíle s podporou diskriminátoru.	Ano
└- typ	řetězec	Typ cíle.	Ano
typ	výčet	Typ zdroje dat, vždy `azure_ai_target_completions`. 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

Name	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_agent`	AzureAIAgentTargetUpdate

Name	Typ	Description	Povinné	Výchozí
typ	řetězec	Typ cíle.	Ano

TaxonomyCategory

Definice kategorie taxonomie.

Name	Typ	Description	Povinné
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
properties	objekt	Další vlastnosti pro kategorii taxonomie	Ne
riskCategory	RiskCategory	Kategorie rizika pro cíl útoku.	Ano
Podkategorie	pole TaxonomySubCategory	Seznam dílčích kategorií taxonomie	Ano

TaxonomieSubCategory

Definice podkategorie Taxonomie.

Name	Typ	Description	Povinné
popis	řetězec	Popis podkategorie taxonomie	Ne
enabled	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
properties	objekt	Další vlastnosti podkategorie taxonomie	Ne

Popis toolDescription

Popis nástroje, který může agent použít.

Name	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.

Name	Typ	Description	Povinné	Výchozí
project_connection_id	řetězec	Připojení projektu v toolProjectConnectionList připojené k tomuto nástroji.	Ano

TracesPreviewEvalRunDataSource

Představuje zdroj dat pro zkušební spuštění, která pracují s trasováními agentů uloženými v Application Insights.

Name	Typ	Description	Povinné	Výchozí
agent_id	řetězec	ID agenta použité k filtrování trasování pro vyhodnocení.	Ne
agent_name	řetězec	Název agenta použitý k filtrování trasování pro vyhodnocení.	Ne
čas ukončení	integer	Časové razítko unixu (v sekundách) označující konec okna dotazu trasování. Ve výchozím nastavení je nastaven aktuální čas.	Ne
ingestion_delay_seconds	integer	Zpoždění, které se má použít pro příjem dat při dotazování trasování.	Ne	300
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 U plánovaných vyhodnocení se to odvodí z intervalu opakování.	Ne	168
max_traces	integer	Omezení vzorkování použité u trasování načtených pro vyhodnocení	Ne	1000
trace_ids	pole řetězce	Kolekce identifikátorů trasování agenta, které by se měly vyhodnotit.	Ne
typ	výčet	Typ zdroje dat, vždy `azure_ai_traces_preview`. Možné hodnoty: `azure_ai_traces_preview`	Ano

TreatmentEffectType

Typ účinku ošetření.

Property	Value
Description	Typ účinku ošetření.
Typ	řetězec
Hodnoty	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

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

Name	Typ	Description	Povinné	Výchozí
typ	Typ spouště	Typ spouštěče.	Ano

Typ triggeru

Typ spouštěče.

Property	Value
Description	Typ spouštěče.
Typ	řetězec
Hodnoty	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Name	Typ	Description	Povinné
popis	řetězec	Popis agenta čitelný pro člověka. Omezení: maxLength: 512	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

Name	Typ	Description	Povinné
definice	AgentDefinition		Ano
└kind	AgentKind		Ano
└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. Omezení: maxLength: 512	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

Name	Typ	Description	Povinné
metadata	OpenAI.Metadata (s možnou hodnotou null)	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
properties	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.

Name	Typ	Description	Povinné
obsah	řetězec	Obsah paměti.	Ano
kind	výčet	Druh položky paměti. Možné hodnoty: `user_profile`	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

WebSearchConfiguration

Konfigurace vyhledávání na webu pro bing vlastní vyhledávání

Name	Typ	Description	Povinné	Výchozí
instance_name	řetězec	Název vlastní instance konfigurace zadané ke konfiguraci.	Ano
project_connection_id	řetězec	Project ID připojení pro uzemnění s využitím vlastního vyhledávání Bingu	Ano

TýdennírecurrenceSchedule

Týdenní plán opakování.

Name	Typ	Description	Povinné	Výchozí
dnůTýdne	pole DayOfWeek	Dny v týdnu pro plán opakování.	Ano
typ	výčet	Typ týdenního opakování Možné hodnoty: `Weekly`	Ano

WorkflowActionOutputItem

Name	Typ	Description	Povinné
action_id	řetězec	Jedinečný identifikátor akce.	Ano
agent_reference	AgentReference		Ne
└– název	řetězec	Název agenta. Omezení: maxLength: 256	Ano
└- typ	výčet	Možné hodnoty: `agent_reference`	Ano
└- verze	řetězec	Identifikátor verze agenta.	Ne
kind	ř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
response_id	řetězec	Odpověď, na které je položka vytvořena.	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.

Name	Typ	Description	Povinné
kind	výčet	Možné hodnoty: `workflow`	Ano
rai_config	RaiConfig	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.	Ano
pracovní postup	řetězec	Definice SOUBORU YAML CSDL pracovního postupu.	Ne

integer

Typ: celé číslo

Formát: int64

Poslední aktualizace v 2026-06-12