Microsoft Foundry

API 版本： v1

Authentication

流動： 隱含

授權網址：https://login.microsoftonline.com/common/oauth2/v2.0/authorize

內窺鏡：

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

Agents

代理 - 創建代理

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

創造代理人。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview、、 HostedAgents=V1PreviewWorkflowAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
定義	代理定義		Yes
└─ 善良	特工種類		Yes
└─ rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	唯一能識別代理人的名字。 名稱可用來擷取/更新/刪除代理程式。 - 必須以字母數字字元開頭和結尾， - 中間可包含連字號 - 字元不得超過63個字元。 限制： 最大長度：63	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	代理物件

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理人 - 名單代理人

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

傳回所有客服專員的清單。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
類型	查詢	否	字串 可能的值：prompt、、hosted、 container_appworkflow	按種類過濾代理。 如果未提供，則會傳回所有代理程式。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理人——找代理人

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

擷取代理程式。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	要擷取的代理程式名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	代理物件

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理 - 更新代理

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

如果代理程式定義有任何變更，則透過新增版本來更新代理程式。 如果沒有變更，則傳回現有的代理程式版本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	要擷取的代理程式名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview、、 HostedAgents=V1PreviewWorkflowAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
定義	代理定義		Yes
└─ 善良	特工種類		Yes
└─ rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	代理物件

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理 - 刪除代理

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

刪除代理程式。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	要刪除的代理程式名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	刪除代理回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理 - 從清單更新代理

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

若代理定義有任何變更，會從清單更新代理，新增新版本。 如果沒有變更，則傳回現有的代理程式版本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	要更新的代理人姓名。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
manifest_id	字串	用來匯入代理版本的清單 ID。	Yes
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
parameter_values	物件	清單的輸入將導致一個完全具現化的特工。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	代理物件

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理程式 - 建立代理版本

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

建立一個新的代理版本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	唯一能識別代理人的名字。 名稱可用來擷取/更新/刪除代理程式。 - 必須以字母數字字元開頭和結尾， - 中間可包含連字號 - 字元不得超過63個字元。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview、、 HostedAgents=V1PreviewWorkflowAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
定義	代理定義		Yes
└─ 善良	特工種類		Yes
└─ rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	AgentVersionObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理 - 列表代理版本

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

傳回代理程式的版本清單。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	用來取得版本的代理人名稱。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理 - 取得代理版本

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

擷取代理程式的特定版本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	要擷取的代理程式名稱。
agent_version	路徑	Yes	字串	要取回的代理人版本。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	AgentVersionObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理程式 - 刪除代理版本

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

刪除代理程式的特定版本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	要刪除的代理程式名稱。
agent_version	路徑	Yes	字串	要刪除的代理版本
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	DeleteAgentVersionResponse

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理 - 從 manifest 建立代理版本

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

從資訊清單建立新的代理程式版本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	唯一能識別代理人的名字。 名稱可用來擷取/更新/刪除代理程式。 - 必須以字母數字字元開頭和結尾， - 中間可包含連字號 - 字元不得超過63個字元。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
manifest_id	字串	用來匯入代理版本的清單 ID。	Yes
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
parameter_values	物件	清單的輸入將導致一個完全具現化的特工。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	AgentVersionObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理人 - 從清單建立代理人

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

從資訊清單建立代理程式。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
manifest_id	字串	用來匯入代理版本的清單 ID。	Yes
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	唯一能識別代理人的名字。 名稱可用來擷取/更新/刪除代理程式。 - 必須以字母數字字元開頭和結尾， - 中間可包含連字號 - 字元不得超過63個字元。 限制： 最大長度：63	Yes
parameter_values	物件	清單的輸入將導致一個完全具現化的特工。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	代理物件

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理人容器

代理容器 - 列表代理容器操作

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

列出代理的容器操作。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 取得代理容器操作

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

查詢一個客服的貨櫃操作狀態。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
operation_id	路徑	Yes	字串	作業標識碼。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	AgentContainerOperationObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 取得代理容器

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

為特定版本的代理人準備一個容器。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	AgentContainerObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 列出代理版本容器操作

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

列出特定版本代理的容器操作。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 刪除代理容器

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

刪除特定版本代理的容器。 如果容器不存在，操作將 no-op。 這項行動持續時間較長。 遵循 Azure REST API 中長跑操作的設計指引。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態代碼： 202

說明：申請已接受處理，但尚未完成處理。

內容類型	Type	說明
application/json	AgentContainerOperationObject

回應標頭：

Header	類型	Description
運作地點	字串

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 串流代理容器日誌

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

容器日誌條目以文字區塊形式從容器串流出來。 每個區塊都是 UTF-8 字串，根據串流的容器日誌類型，可能是純文字的日誌行或 JSON 格式的日誌條目。 用戶端應將每個區塊視為不透明文字，必要時根據日誌需求嘗試解析為 JSON。

系統日誌格式為 JSON，結構如下：{“TimeStamp”：“2025-12-15T16：51：33Z”，“Type”：“Normal”，“ContainerAppName”：null，“RevisionName”：null，“RevisionName”：null，“ReplicaName”：null，“Msg”：“連接事件收集器...”，“Reason”：StartingGettingEvents“，”EventSource“：”ContainerAppController“，”Count“：1} {”TimeStamp“：”2025-12-15T16：51：34Z“，”Type“：”Normal“，”ContainerAppName“：null，”RevisionName“：null，”ReplicaName“：null，”Msg“：”成功連接事件server“，”Reason“：ConnectedToEventsServer”，“EventSource”：“ContainerAppController”，“Count”：1}

對於主控台日誌，格式為容器的標準/標準輸出（stdout/stderr）所發出的純文字。 2025-12-15T08：43：48.72656 連接容器「agent-container」......2025-12-15T08：43：48.75451 成功連接至容器：「agent-container」 [修訂版：'je90fe655aa742ef9a188b9fd14d6764--7tca06b'， 複本：'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08： 33：59.0671054Z 標準 F 資訊： 127.0.0.1：42588 - “GET /readiness HTTP/1.1” 200 OK 2025-12-15T08：34：29.0649033Z 標準 F 資訊： 127.0.0.1：60246 - “GET /readiness HTTP/1.1” 200 OK 2025-12-15T08：34：59.06444467Z stdout F INFO： 127.0.0.1：43994 - “GET /readiness HTTP/1.1” 200 OK

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
類型	查詢	否	字串 可能的值： console、 system	控制台回傳容器的標準/標準/標準，系統回傳容器應用程式的事件串流。 預設主機
replica_name	查詢	否	字串	若被省略，伺服器會選擇第一個副本作為控制台日誌。 必須鎖定特定複製品。
尾巴	查詢	否	整數	返回的尾部線數。 強制執行至1-300。 預設為 20
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 啟動代理容器

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

為特定版本的代理人建立一個容器。 如果容器已經在運轉，操作就會 no-op。 這項行動持續時間較長。 遵循 Azure REST API 中長跑操作的設計指引。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
max_replicas	整數	複本數目上限。 預設值為 1。	否	1
min_replicas	整數	複本數目下限。 預設值為 1。	否	1

回覆

狀態代碼： 202

說明：申請已接受處理，但尚未完成處理。

內容類型	Type	說明
application/json	AgentContainerOperationObject

回應標頭：

Header	類型	Description
運作地點	字串

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 停止代理容器

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

為特定版本的代理人暫停一個容器。 如果貨櫃未運轉或已停止，操作將 no-op。 這項行動持續時間較長。 遵循 Azure REST API 中長跑操作的設計指引。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態代碼： 202

說明：申請已接受處理，但尚未完成處理。

內容類型	Type	說明
application/json	AgentContainerOperationObject

回應標頭：

Header	類型	Description
運作地點	字串

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

代理容器 - 更新代理容器

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

更新容器以符合特定版本的代理程式。 如果容器沒有運轉，操作就會 no-op。 這項行動持續時間較長。 遵循 Azure REST API 中長跑操作的設計指引。 https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
agent_name	路徑	Yes	字串	代理程式的名稱。
agent_version	路徑	Yes	字串	那個特工的版本。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：ContainerAgents=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
max_replicas	整數	複本數目上限。	否
min_replicas	整數	複本數目下限。	否

回覆

狀態代碼： 202

說明：申請已接受處理，但尚未完成處理。

內容類型	Type	說明
application/json	AgentContainerOperationObject

回應標頭：

Header	類型	Description
運作地點	字串

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

連接

連接列表

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

在 project 中列出所有連線，但不要填寫連線憑證

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
connectionType	查詢	否	字串 可能的值：AzureOpenAI、、、AzureBlob、AzureStorageAccountCognitiveSearch、CosmosDB、ApiKey、 AppConfigAppInsightsCustomKeysRemoteTool_Preview	列出此特定類型的連接
defaultConnection	查詢	否	布爾值	列出預設連接的連接

請求標頭

名稱	為必填項目	類型	Description
x-ms-client-request-id	否	字串	要求不透明、全域唯一、用戶端產生的字串標識碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	分頁連線

回應標頭：

Header	類型	Description
x-ms-client-request-id		要求不透明、全域唯一、用戶端產生的字串標識碼。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

連接 - 取得

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

按名稱獲取連接，無需填充連接憑證

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	由使用者提供的連接的友好名稱。

請求標頭

名稱	為必填項目	類型	Description
x-ms-client-request-id	否	字串	要求不透明、全域唯一、用戶端產生的字串標識碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	連線

回應標頭：

Header	類型	Description
x-ms-client-request-id		要求不透明、全域唯一、用戶端產生的字串標識碼。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

人脈——取得資歷

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

按名稱獲取連接及其連接憑證

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	由使用者提供的連接的友好名稱。

請求標頭

名稱	為必填項目	類型	Description
x-ms-client-request-id	否	字串	要求不透明、全域唯一、用戶端產生的字串標識碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	連線

回應標頭：

Header	類型	Description
x-ms-client-request-id		要求不透明、全域唯一、用戶端產生的字串標識碼。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

數據集

資料集 - 列出最新資料

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

列出每個 DatasetVersion 的最新版本

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedDatasetVersion

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

資料集 - 列表版本

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

列出給定 DatasetVersion 的所有版本

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedDatasetVersion

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

Datasets - 取得版本

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

獲取 DatasetVersion 的特定版本。 如果 DatasetVersion 不存在，則服務將返回 404 Not Found 錯誤。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要檢索的 DatasetVersion 的特定版本 ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	資料集版本

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

Datasets - 刪除版本

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

刪除 DatasetVersion 的特定版本。 如果 DatasetVersion 已成功刪除或 DatasetVersion 不存在，則服務將返回 204 No Content。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要刪除的 DatasetVersion 的版本。

回覆

狀態代碼： 204

描述：沒有內容可傳送此要求，但標頭可能很有用。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

Datasets - 建立或更新版本

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

使用給定版本ID創建新的 DatasetVersion 或更新現有 DatasetVersion

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要創建或更新的 DatasetVersion 的特定版本 ID。

請求主體

Content-Type： application/merge-patch+json

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	資料集類型	要判斷數據類型的列舉。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	資料集版本

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	資料集版本

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

資料集 - 取得憑證

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

取得 SAS 憑證以access與 Dataset 版本相關的 storage 帳號。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要作的 DatasetVersion 的特定版本 ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	AssetCredentialResponse

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

資料集 - 開始，等待上傳版本

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

開始特定版本的數據集的新上傳或獲取現有待上傳的數據集。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要作的 DatasetVersion 的特定版本 ID。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
connectionName （連接名稱）	字串	Azure Storage Account connection name to create temporary SAS token	否
待處理上傳ID	字串	如果未提供 PendingUploadId，則將使用隨機 GUID。	否
pendingUploadType	列舉	BlobReference 是唯一支持的類型。 可能的值：BlobReference	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	待上載回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

部署

部署列表

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

列出 project 中所有已部署的模型

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
模型出版商	查詢	否	字串	Model publisher 用來篩選模型
modelName	查詢	否	字串	型號名稱（publisher 特定名稱）用來篩選模型
deploymentType	查詢	否	字串 可能的值：ModelDeployment	篩選清單的部署類型

請求標頭

名稱	為必填項目	類型	Description
x-ms-client-request-id	否	字串	要求不透明、全域唯一、用戶端產生的字串標識碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	分頁部署

回應標頭：

Header	類型	Description
x-ms-client-request-id		要求不透明、全域唯一、用戶端產生的字串標識碼。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

部署 - 取得

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

取得已部署的模型。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	部署的名稱

請求標頭

名稱	為必填項目	類型	Description
x-ms-client-request-id	否	字串	要求不透明、全域唯一、用戶端產生的字串標識碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	Deployment

回應標頭：

Header	類型	Description
x-ms-client-request-id		要求不透明、全域唯一、用戶端產生的字串標識碼。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估分類法

評估分類法列表

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

清單評估分類法

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
輸入名稱	查詢	否	字串	依評估輸入名稱篩選。
輸入類型	查詢	否	字串	依分類輸入類型篩選。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	頁碼評價分類法

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估分類法 - 取得

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

獲取按名稱運行的評估。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估分類學

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估分類法 - 刪除

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

依名稱刪除評估分類。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態代碼： 204

描述：沒有內容可傳送此要求，但標頭可能很有用。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估分類法 - 建立

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

建立評估分類法。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	評估分類法的名稱。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
properties	物件	評估分類的其他屬性。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
分類分類	分類分類陣列	分類類別列表。	否
分類學輸入	評估分類學輸入	評估分類法的輸入組態。	Yes
\---- 類型	評估分類學輸入類型	評估分類法的輸入類型。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估分類學

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	評估分類學

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估分類法 - 更新

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

更新評估分類法。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	評估分類法的名稱。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
properties	物件	評估分類的其他屬性。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
分類分類	分類分類陣列	分類類別列表。	否
分類學輸入	評估分類系統輸入更新	評估分類法的輸入組態。	否
\---- 類型	評估分類學輸入類型	評估分類法的輸入類型。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估分類學

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評鑑規則

評估規則 - 列表

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

列出所有評估規則。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
actionType	查詢	否	字串 可能的值： continuousEvaluation、 humanEvaluationPreview	依評估規則的類型進行篩選。
代理名稱	查詢	否	字串	按代理程式名稱過濾。
enabled	查詢	否	布爾值	依已啟用狀態進行篩選。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedEvaluationRule

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估規則 - 取得

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

取得評估規則。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	評估規則的唯一識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估規則

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估規則 - 刪除

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

刪除評估規則。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	評估規則的唯一識別碼。

回覆

狀態代碼： 204

描述：沒有內容可傳送此要求，但標頭可能很有用。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估規則 - 建立或更新

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

建立或更新評估規則。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	評估規則的唯一識別碼。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	否	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
動作	評估規則行動	評估行動模型。	Yes
\---- 類型	評估規則行動類型	評估動作的類型。	Yes
說明	字串	評估規則的描述。	否
顯示名稱	字串	評估規則的顯示名稱。	否
enabled	布爾值	指出是否已啟用評估規則。 預設值是「true」。	Yes
eventType	評估規則事件類型	評估規則事件的類型。	Yes
篩選	EvaluationRuleFilter	評估篩選器模型。	否
└─ 代理人姓名	字串	按客服專員名稱過濾。	Yes
id	字串（唯讀）	評估規則的唯一識別碼。	Yes
系統數據	物件（唯讀）	評估規則的系統中繼資料。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估規則

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	評估規則

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估工具

評估器 - 列出最新版本

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

列出每個評估器的最新版本

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
型別	查詢	否	字串 可能的值：builtin、、 customall	依類型篩選評估器。 可能的值：'all'、'custom'、'builtin'。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，預設值為 20。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedEvaluatorVersion

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估器 - 列表版本

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

列出指定評估器的所有版本

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
型別	查詢	否	字串 可能的值：builtin、、 customall	依類型篩選評估器。 可能的值：'all'、'custom'、'builtin'。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，預設值為 20。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedEvaluatorVersion

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估者 - 建立版本

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

建立具有自動遞增版本識別碼的新 EvaluatorVersion

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
categories	EvaluatorCategory 的陣列	評估者的類別	Yes
定義	評估者定義	具有鑑別器的基本評估器配置	Yes
└─ data_schema	物件	評估者輸入資料的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
└─ init_parameters	物件	評估者輸入參數的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
└─ 度量	物件	此評估器產生的輸出指標清單	否
\---- 類型	EvaluatorDefinitionType	評估者定義的類型	Yes
說明	字串	資產描述文字。	否
display_name	字串	評估者的顯示名稱。 在 AI Foundry 中很容易找到評估者。 它不需要是唯一的。	否
evaluator_type	EvaluatorType	評估者的類型	Yes
中繼資料	物件	評估者的中繼資料	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否

回覆

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	評估者版本

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估者 - 取得版本

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

取得 EvaluatorVersion 的特定版本。 如果 EvaluatorVersion 不存在，服務會傳回 404 找不到錯誤。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要取回的 EvaluatorVersion 特定版本 ID。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估者版本

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估者 - 刪除版本

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

刪除 EvaluatorVersion 的特定版本。 如果 EvaluatorVersion 已成功刪除，或 EvaluatorVersion 不存在，服務會傳回 204 無內容。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	EvaluatorVersion 的刪除版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態代碼： 204

描述：沒有內容可傳送此要求，但標頭可能很有用。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

評估者 - 更新版本

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

使用指定的版本識別碼更新現有的 EvaluatorVersion

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	EvaluatorVersion 的版本要更新。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Evaluations=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
categories	EvaluatorCategory 的陣列	評估者的類別	否
說明	字串	資產描述文字。	否
display_name	字串	評估者的顯示名稱。 在 AI Foundry 中很容易找到評估者。 它不需要是唯一的。	否
中繼資料	物件	評估者的中繼資料	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	評估者版本

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

索引

索引 - 列出最新資料

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

列出每個索引的最新版本

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	頁碼索引

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

索引-列表版本

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

列出給定索引的所有版本

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	頁碼索引

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

索引 - 取得版本

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

獲取索引的特定版本。 如果索引不存在，則服務將返回 404 Not Found 錯誤。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要檢索的 Index 的特定版本 ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	指數

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

索引 - 刪除版本

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

刪除索引的特定版本。 如果索引已成功刪除或索引不存在，則服務將返回 204 無內容。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要刪除的 Index 的版本。

回覆

狀態代碼： 204

描述：沒有內容可傳送此要求，但標頭可能很有用。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

索引 - 建立或更新版本

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

使用給定版本ID創建新索引或更新現有索引

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	資源的名稱
版本	路徑	Yes	字串	要創建或更新的索引的特定版本ID。

請求主體

Content-Type： application/merge-patch+json

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	IndexType		Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	指數

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	指數

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

Insights

洞察 - 產生

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

產生見解

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Insights=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。
重複性-Request-ID	否	字串	用戶端產生的唯一識別碼，可確保要求冪等性。 使用相同的 ID 進行重試，以防止重複評估。
重複性-First-Sent	否	字串	時間戳記，指出首次起始此請求的時間。 與 repeatability-request-id 結合使用，以進行冪等控制。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
顯示名稱	字串	深入解析的使用者易記顯示名稱。	Yes
id	字串（唯讀）	深入解析報表的唯一識別碼。	Yes
中繼資料	InsightsMetadata （唯讀）	有關見解的中繼資料。	Yes
└─ 完成於	字串	深入解析完成的時間戳記。	否
└─ 創造於	字串	建立見解的時間戳記。	Yes
要求	洞察請求	深入解析報告的要求。	Yes
\---- 類型	洞察類型	請求的類型。	Yes
結果	InsightResult （唯讀）	見解的結果。	否
\---- 類型	洞察類型	深入解析結果的類型。	Yes
狀態	Azure。Core.Foundations.OperationState（唯讀）	列舉描述允許的作業狀態。	Yes

回覆

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	眼光

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

見解 - 列表

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

按時間倒序列出所有見解（最新到先）。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
型別	查詢	否	字串 可能的值：EvaluationRunClusterInsight、、 AgentClusterInsightEvaluationComparison	依分析類型篩選。
已評估	查詢	否	字串	依評估識別碼篩選。
runId	查詢	否	字串	依評估執行識別碼進行篩選。
代理名稱	查詢	否	字串	按代理程式名稱過濾。
include座標	查詢	否	布爾值	是否要在回應中包含視覺化的座標。 預設為 False。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Insights=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	頁洞洞察

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

洞察 - 取得

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

依 ID 取得特定深入解析。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	深入解析報表的唯一識別碼。
include座標	查詢	否	布爾值	是否要在回應中包含視覺化的座標。 預設為 False。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Insights=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	眼光

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

記憶體儲存

建立記憶體儲存

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

建立記憶體存放區。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
定義	MemoryStoreDefinition	記憶體存放區組態的基本定義。	Yes
└─ 善良	記憶儲存類型	記憶體儲存的類型。	Yes
說明	字串	記憶體存放區的人類可讀描述。 限制： max長度：512	否
中繼資料	物件	與記憶體存放區相關聯的任意索引鍵值中繼資料。	否
名稱	字串	記憶體存放區的名稱。 限制： 最大長度：256	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	MemoryStoreObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列出記憶體儲存器

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

列出所有記憶體儲存區。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

更新記憶體儲存

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

更新記憶體存放區。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	要更新的記憶體儲存名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	記憶體存放區的人類可讀描述。 限制： max長度：512	否
中繼資料	物件	與記憶體存放區相關聯的任意索引鍵值中繼資料。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	MemoryStoreObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取得記憶體儲存

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

擷取記憶體存放區。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	要取回的記憶體儲存名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	MemoryStoreObject

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

刪除記憶體儲存

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

刪除記憶體儲存區。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	要刪除的記憶體儲存名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	刪除記憶儲存回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取得更新結果

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

取得記憶體儲存更新結果。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	記憶體存放區的名稱。
update_id	路徑	Yes	字串	記憶體更新操作的 ID。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	記憶儲存更新回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

刪除示波器記憶體

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

從記憶體存放區中刪除與特定範圍相關聯的所有記憶體。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	記憶體存放區的名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
範圍	字串	命名空間負責邏輯地分組並隔離可刪除的記憶，例如使用者 ID。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	MemoryStoreDeleteScopeResponse

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

搜尋記憶

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

根據對話上下文從記憶存儲中搜索相關記憶。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	要搜尋的記憶體儲存名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
items	OpenAI.InputItem 的陣列	要搜尋相關記憶的項目。	否
options	記憶搜尋選項	記憶體搜尋選項。	否
└─ max_memories	整數	要傳回的記憶體項目數目上限。	否
previous_search_id	字串	上一個搜尋請求的唯一 ID，可從上次操作中斷的地方進行增量記憶體搜尋。	否
範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	記憶儲存搜尋回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

更新記憶

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

使用對話記憶更新記憶體儲存。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
名稱	路徑	Yes	字串	要更新的記憶體儲存名稱。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：MemoryStores=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
items	OpenAI.InputItem 的陣列	從中提取記憶的對話項目。	否
previous_update_id	字串	上一個更新請求的唯一 ID，從上次操作中斷的地方啟用增量記憶體更新。	否
範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes
update_delay	整數	處理記憶體更新之前的逾時期間（以秒為單位）。 如果在此期間收到新的更新請求，它將取消當前請求並重置超時。 設定為 0 可立即觸發更新，而不會延遲。 預設為 300 （5 分鐘）。	否	300

回覆

狀態代碼： 202

說明：申請已接受處理，但尚未完成處理。

內容類型	Type	說明
application/json	記憶儲存更新回應

回應標頭：

Header	類型	Description
運作地點	字串	監視作業狀態的位置。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

對話

創造對話

POST {endpoint}/openai/v1/conversations

建立對話。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
items	OpenAI.InputItem 的陣列		否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ConversationResource

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

清單對話

GET {endpoint}/openai/v1/conversations

回傳所有對話清單。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
agent_name	查詢	否	字串	按客服專員名稱過濾。 若提供，僅與指定代理人相關的物品會被退還。
agent_id	查詢	否	字串	請依代理人 name:version編號（格式為 ）篩選。 若提供，僅會退還與指定代理人編號相關的項目。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

更新對話

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

更新對話。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	對話的ID更新。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ConversationResource

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

開始對話

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

恢復一段對話。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	對話的ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ConversationResource

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

刪除對話

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

刪除對話。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	刪除對話的ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.DeletedConversationResource

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

建立對話項目

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

在對話中建立與指定ID相關的物品。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	需要建立該項目的對話ID。
include	查詢	否	陣列	要包含在回應中的其他欄位。 更多資訊請參閱 include 「對話項目列表」的參數。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
items	OpenAI.Item 的陣列	要加入對話的項目。 你一次最多可以加20個項目。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ConversationItemList

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列出對話項目

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

列出所有對話項目與該ID的對話。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	需要列出這些項目的對話ID。
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
item_type	查詢	否	字串 可能值：， ， ， messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_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	依商品類型篩選。 若提供，僅會歸還指定類型的物品。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取得話題話題

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

從與指定ID的對話中取得單一物品。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	包含該物品的對話 ID。
item_id	路徑	Yes	字串	要取回對話項目的ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.OutputItem

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

刪除對話項目

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

刪除對話中與指定 ID 的項目。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
conversation_id	路徑	Yes	字串	需要刪除該項目的對話 ID。
item_id	路徑	Yes	字串	要刪除的對話項目的ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ConversationResource

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估

評估 - 列表評估

GET {endpoint}/openai/v1/evals

列出所有評估 列出 一個 project 的評估。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
之後	查詢	否	字串	上一個分頁要求中最後一個執行識別碼。
limit	查詢	否	整數	要擷取的執行數目。
順序	查詢	否	字串 可能的值： asc、 desc	執行依時間戳記的排序次序。 用於 asc 遞增順序或 desc 遞減順序。 預設為 asc。
排序依據	查詢	否	字串 可能的值： created_at、 updated_at	Evals 可以按照建立時間或上次更新時間進行排序。 用於 created_at 建立時間或 updated_at 上次更新時間。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 建立評估

POST {endpoint}/openai/v1/evals

建立評估 建立評估結構，用以測試模型的表現。 評估是一組測試標準及資料來源的設定，決定評估所用資料的結構結構。 建立評估之後，您可以在不同的模型和模型參數上執行評估。 我們支持數種類型的評分者和數據源。 欲了解更多資訊，請參閱

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
資料來源配置	OpenAI.CreateEvalCustomDataSourceConfig 或 OpenAI.CreateEvalLogsDataSourceConfig 或 OpenAI.CreateEvalStoredCompletionsDataSourceConfig 或 AzureAIDataSourceConfig	評估時所用資料來源的配置。 決定評估中使用的資料架構。	Yes
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	評估的名稱。	否
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否
測試標準	OpenAI.EvalGraderLabelModel 或 OpenAI.EvalGraderStringCheck 或 OpenAI.EvalGraderTextSimilarity 或 OpenAI.EvalGraderPython 或 OpenAI.EvalGraderScoreModel 或 EvalGraderAzureAIEvaluator 的 array	此群組內所有評估回合的評分者清單。 評分者可以使用雙大括號表示法參考數據源中的變數，例如 {{item.variable_name}}。 若要參考模型的輸出，請使用 sample 命名空間 （ie， {{sample.output_text}}）。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	Eval

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 刪除評估

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

刪除評估 刪除評估。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要刪除之評估的識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	刪除評估回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 取得評估

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

以身分證進行評估。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要擷取之評估的識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	Eval

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 更新評估

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

更新評估 更新評估的某些屬性。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要更新之評估的識別碼。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串		否
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	Eval

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 列表運行

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

取得跑道清單以供評估。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要擷取執行之評估的識別碼。
之後	查詢	否	字串	上一個分頁要求中最後一個執行識別碼。
limit	查詢	否	整數	要擷取的執行數目。
順序	查詢	否	字串 可能的值： asc、 desc	執行依時間戳記的排序次序。 用於 asc 遞增順序或 desc 遞減順序。 預設為 asc。
狀態	查詢	否	字串 可能的值：queued， in_progress， completed， canceledfailed ， 。 依狀態執行篩選。 其中之一queued為 ， in_progress， failed， completedcanceled， ， 。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 建立評估跑

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

建立評估跑

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要為其建立執行之評估的識別碼。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
資料來源	OpenAI.CreateEvalJsonlRunDataSource 或 OpenAI.CreateEvalCompletionsRunDataSource 或 OpenAI.CreateEvalResponsesRunDataSource 或 EvalRunDataSource	關於這次跑步數據來源的詳細資訊。	Yes
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	執行步驟名稱。	否
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	EvalRun

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 刪除評估跑

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

刪除評估執行 刪除評估執行。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要從中刪除執行之評估的識別碼。
run_id	路徑	Yes	字串	要刪除的執行識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	刪除評估執行回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 取得評估跑

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

進行評估跑，按ID進行評估。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要擷取執行之評估的識別碼。
run_id	路徑	Yes	字串	要擷取的執行識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	EvalRun

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 取消評估跑

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

取消評估跑 取消正在進行的評估跑。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	您要取消其執行之評估的識別碼。
run_id	路徑	Yes	字串	要取消的執行識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	EvalRun

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 取得評估結果項目

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

取得評估跑的產出項目：評估跑的產出項目清單。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串
run_id	路徑	Yes	字串	要擷取輸出項目的執行識別碼。
之後	查詢	否	字串	上一個分頁要求中最後一個執行識別碼。
limit	查詢	否	整數	要擷取的執行數目。
順序	查詢	否	字串 可能的值： asc、 desc	執行依時間戳記的排序次序。 用於 asc 遞增順序或 desc 遞減順序。 預設為 asc。
狀態	查詢	否	字串 可能的值： fail、 pass	依狀態篩選輸出專案。 用 failed 來篩選失敗輸出 項目或 pass 是透過傳遞輸出項目來篩選。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

評估 - 取得評估跑出的項目

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

取得評估執行的輸出項目，透過 ID 取得評估執行的輸出項目。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
評估編號	路徑	Yes	字串	要擷取執行之評估的識別碼。
run_id	路徑	Yes	字串	要擷取的執行識別碼。
輸出項目ID (output_item_id)	路徑	Yes	字串	要擷取之輸出項目的標識碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	EvalRunOutputItem

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

Fine-Tuning

建立微調工作

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

建立微調任務，並開始從指定數據集建立新模型的過程。

回應包含已排入佇列作業的詳細資訊，包括作業狀態，以及完成後微調模型的名稱。

了解更多關於微調

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
超參數	OpenAI.CreateFineTuningJobRequestHyperparameters		否
批次大小	string 或 OpenAI.integer		否	自動
└─ 學習率乘數	字串或 OpenAI.numeric		否
└─ n_epochs	string 或 OpenAI.integer		否	自動
整合	array of OpenAI.CreateFineTuningJobRequestIntegrations	可以啟用於微調作業的整合項目清單。	否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
方法	OpenAI.FineTuneMethod	用於微調的方法。	否
型號	字串 （請參閱下面的有效模型）	要微調的模型名稱。 您可以選取其中一個 支援型號。	Yes
seed	OpenAI.integer （nullable）		否
suffix	字串（可空）	最多64個字元的字串，將會新增至微調的模型名稱。 例如，"custom-model-name" 的 suffix 會產生像 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel 這樣的模型名稱。 限制條件： 最小長度：1，最大長度：64	否
訓練檔案	字串	包含定型資料的已上傳檔案識別碼。 如需如何上傳檔案，請參閱上傳檔案。 您的數據集必須格式化為 JSONL 檔案。 此外，您必須以用途 fine-tune 上傳您的檔案。 檔案內容應依模型是否使用 聊天、 完成 格式，或微調方法使用 偏好格式 而有所不同。 更多細節請參閱 微調指南。	Yes
驗證檔案	字串（可空）	包含驗證數據的上傳檔案識別碼。 如果您提供此檔案，則會使用數據來產生驗證 在微調期間定期回報計量。 這些計量可在下項中檢視： 微調參數結果檔案。 定型和驗證檔案中不應該有相同的數據。 您的數據集必須格式化為 JSONL 檔案。 您必須以用途 fine-tune 上傳您的檔案。 更多細節請參閱 微調指南。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.FineTuningJob

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列出分頁微調工作

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

列出組織的微調任務

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
之後	查詢	否	字串	上一個分頁要求中最後一個作業的識別碼。
limit	查詢	否	整數	要擷取的微調作業數目。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取回微調工作

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

取得微調作業的相關資訊。

了解更多關於微調

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
微調作業識別碼	路徑	Yes	字串	微調作業的識別碼。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.FineTuningJob

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取消微調工作

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

立即取消微調作業。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
微調作業識別碼	路徑	Yes	字串	要取消之微調作業的 ID。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.FineTuningJob

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列表微調工作檢查點

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

列出微調工作的檢查點。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
微調作業識別碼	路徑	Yes	字串	要為其取得檢查點的微調作業的 ID。
之後	查詢	否	字串	上一個分頁要求中最後一個檢查點識別碼的識別碼。
limit	查詢	否	整數	要擷取的檢查點數目。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列出微調工作事件

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

獲取細緻的狀態更新，幫助你進行微調工作。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
微調作業識別碼	路徑	Yes	字串	要為其取得事件的微調作業的 ID。
之後	查詢	否	字串	上一個分頁要求中最後一個事件的識別碼。
limit	查詢	否	整數	要擷取的事件數目。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.ListFineTuningJobEventsResponse

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

暫停微調工作

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

暫停正在進行的微調工作。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
微調作業識別碼	路徑	Yes	字串	要暫停之微調作業的 ID。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.FineTuningJob

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

履歷微調工作

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

繼續暫停的微調作業。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
微調作業識別碼	路徑	Yes	字串	要繼續之微調作業的 ID。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.FineTuningJob

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

回覆

建立回應 - 建立回應串流

POST {endpoint}/openai/v1/responses

建立模型回應。 建立模型回應（串流回應）。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
背景	布林值（可空）		否
交談	OpenAI.ConversationParam （可空除）	這個回應所屬的對話。 本次對話內容在回應請求前加上 input_items 。 此回應的輸入項目與輸出項目會在回應結束後自動加入此對話中。	否
include	OpenAI.IncludeEnum 的陣列		否
輸入	OpenAI.InputParam	用來讓模型產生回應的文字、影像或檔案輸入。 瞭解詳情： - 文字輸入與輸出 - 影像輸入 - 檔案輸入 - 對話狀態 - 函式呼叫	否
instructions	字串（可空）		否
max_output_tokens	OpenAI.integer （nullable）		否
最大工具呼叫次數	OpenAI.integer （nullable）		否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
型號	字串	用於生成此回應的模型部署。	否
平行工具呼叫	布林值（可空）		否	對
previous_response_id	字串（可空）		否
提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
reasoning	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─努力	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
└─ 產生摘要	列舉	可能的值：auto、、 concisedetailed	否
‧---- 摘要	列舉	可能的值：auto、、 concisedetailed	否
safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
服務層級	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
儲存	布林值（可空）		否	對
串流	布林值（可空）		否
stream_options	OpenAI.ResponseStreamOptions （可空除）	串流回應的選項。 只有當您設定 stream: true 時，才需要設定此選項。	否
└─ include_obfuscation	布爾值	當 true 時，將會啟用串流模糊化。 串流混淆加法 隨機字元到 obfuscation 一個欄位，串流 delta 事件到 將有效載荷大小標準化，以防範某些側通道攻擊。 這些混淆欄位預設包含，但會增加少量 將開銷轉移到資料流。 你可以設定 include_obfuscation 為 false 是為了優化頻寬，前提是你信任網路連結 你的應用程式和 OpenAI API 一起。	否
structured_inputs	物件	回應的結構化輸入可參與提示模板替換或工具參數綁定。	否
溫度	OpenAI.numeric （可空）		否	1
收發簡訊	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
truncation	列舉	可能的值： auto、 disabled	否
使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.回應
text/event-stream	OpenAI.CreateResponse串流回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列表回應

GET {endpoint}/openai/v1/responses

回傳所有回應清單。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。
agent_name	查詢	否	字串	按客服專員名稱過濾。 若提供，僅與指定代理人相關的物品會被退還。
agent_id	查詢	否	字串	請依代理人 name:version編號（格式為 ）篩選。 若提供，僅會退還與指定代理人編號相關的項目。
conversation_id	查詢	否	字串	請依對話ID篩選。 若提供，僅會回覆與指定對話相關的回應。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

緊湊回應對話

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

產生回應對話的壓縮。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
輸入	OpenAI.InputItem 的字串或陣列		否
instructions	字串（可空）		否
型號	OpenAI.ModelIdsCompaction	用於產生回應的型號識別碼，如 gpt-5 或 o3。 OpenAI 提供多種不同功能、效能特性及價格區間的模型。 請參閱 模型指南 ，瀏覽並比較可用模型。	Yes
previous_response_id	字串（可空）		否

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.CompactResource

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取得回應 - 取得回應串流

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

擷取具有指定標識碼的模型回應。 取得具有指定 ID 的模型回應（串流回應）。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
response_id	路徑	Yes	字串
include[]	查詢	否	陣列
串流	查詢	否	布爾值
starting_after	查詢	否	整數

請求標頭

名稱	為必填項目	類型	Description
接受	否	字串 可能的值：text/event-stream

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.回應
text/event-stream	OpenAI.CreateResponse串流回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

刪除回應

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

刪除模型回應。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
response_id	路徑	Yes	字串	要刪除的回應識別碼。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	刪除回應結果

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

取消回應

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

取消模型回應。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
response_id	路徑	Yes	字串	回覆取消的ID。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	OpenAI.回應

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

列出輸入項目

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

傳回指定回應的輸入項目清單。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
response_id	路徑	Yes	字串
limit	查詢	否	整數	要傳回的物件數目限制。 限制的範圍可以介於 1 到 100 之間，以及 預設值為 20。
順序	查詢	否	字串 可能的值： asc、 desc	依 created_at 物件的時間戳排序順序。 asc 表示遞增順序，desc則表示遞減順序 表示遞減順序。
之後	查詢	否	字串	用於分頁的游標。 after 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 隨後的呼叫可以包含像是 after=obj_foo 的參數，以便擷取清單的下一頁。
before	查詢	否	字串	用於分頁的游標。 before 是在清單中定義您的位置的物件識別碼。 例如，如果您提出清單要求並收到 100 個物件 (以 obj_foo 結尾)，您的 後續呼叫可以包含 before=obj_foo，以便擷取清單的上一頁。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	物件	這是請求清單的回應資料。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

紅隊

紅隊 - 列表

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

按名稱列出 redteam。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：RedTeams=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedRedTeam

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

紅隊 - 取得

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

按名稱獲取 redteam。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
名稱	路徑	Yes	字串	紅隊運行的標識碼。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：RedTeams=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	紅隊

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

紅隊 - 創造

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

創建 redteam 運行。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：RedTeams=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
應用場景	字串	應用場景為紅隊作，生成場景特定的攻擊。	否
攻擊策略	攻擊策略陣列	攻擊策略清單或攻擊策略的嵌套清單。	否
顯示名稱	字串	紅隊運行的名稱。	否
id	字串（唯讀）	紅隊運行的標識碼。	Yes
數字轉	整數	類比輪次數。	否
properties	物件	紅隊的屬性。 不同於標籤，屬性是僅限新增的。 新增之後，就無法移除屬性。	否
風險類別	風險類別陣列	要為其產生攻擊目標的風險類別清單。	否
模擬	布爾值	僅模擬或模擬 + 評估。 默認為 false，如果為 true，則掃描輸出對話而不是評估結果。	否	否
狀態	字串（唯讀）	紅隊的狀態。 它由服務設置，並且是唯讀的。	否
tags	物件	紅隊的標籤。 與屬性不同，標籤是完全可變的。	否
目標	TargetConfig	目標配置的抽象類。	Yes
\---- 類型	字串	模型配置的類型。	Yes

回覆

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	紅隊

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

附表

賽程表 - 列表

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

列出所有時間表。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
型別	查詢	否	字串 可能的值： Evaluation、 Insight	依照排班類型篩選。
enabled	查詢	否	布爾值	依已啟用狀態進行篩選。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Schedules=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedSchedule

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

排程 - 刪除

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

刪除排程。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	排程的識別碼。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Schedules=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態代碼： 204

描述：沒有內容可傳送此要求，但標頭可能很有用。

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

時間表 - 取得

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

通過 ID 獲取時間表。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	排程的識別碼。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Schedules=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	Schedule

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

排程 - 建立或更新

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

建立或更新作業範本。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	排程的識別碼。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Schedules=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

請求主體

Content-Type：application/json

名稱	類型	Description	為必填項目	預設值
說明	字串	排程的描述。	否
顯示名稱	字串	排程的名稱。	否
enabled	布爾值	排程的已啟用狀態。	Yes
id	字串（唯讀）	排程的識別碼。	Yes
properties	物件	Schedule 的屬性。 不同於標籤，屬性是僅限新增的。 新增之後，就無法移除屬性。	否
provisioning狀態	ScheduleProvisioningStatus （唯讀）	排程佈建狀態。	否
系統數據	物件（唯讀）	資源的系統中繼資料。	Yes
tags	物件	Schedule 的標籤。 與屬性不同，標籤是完全可變的。	否
工作	ScheduleTask	排程任務模型。	Yes
└─ 配置	物件	工作的設定。	否
\---- 類型	排程任務類型	任務的類型。	Yes
觸發	Trigger	排程觸發程式的基礎模型。	Yes
\---- 類型	TriggerType	觸發程式的類型。	Yes

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	Schedule

狀態代碼： 201

描述：要求已成功，因此已建立新的資源。

內容類型	Type	說明
application/json	Schedule

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

賽程表 - 清單跑

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

列出所有排程執行。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
API版本	查詢	Yes	字串	用於此作業的 API 版本。
id	路徑	Yes	字串	排程的識別碼。
型別	查詢	否	字串 可能的值： Evaluation、 Insight	依照排班類型篩選。
enabled	查詢	否	布爾值	依已啟用狀態進行篩選。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Schedules=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	PagedScheduleRun

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	Azure。Core.Foundations.ErrorResponse

回應標頭：

Header	類型	Description
X-MS-錯誤代碼	字串	字串錯誤代碼，指出發生了什麼問題。

排程 - 開始跑

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

取得依 ID 執行的排程。

URI 參數

名稱	In	為必填項目	類型	Description
端點	路徑	Yes	字串	Foundry Project 端點的形式為 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}“。 如果你在 Foundry Hub 只有一個 Project，或是想鎖定預設的 Project 在你的 Hub 裡，請使用以下表單 “https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project」
schedule_id	路徑	Yes	字串	排程的唯一識別碼。
run_id	路徑	Yes	字串	排程執行的唯一識別碼。
API版本	查詢	Yes	字串	用於此作業的 API 版本。

請求標頭

名稱	為必填項目	類型	Description
Foundry-Features	對	字串 可能的值：Schedules=V1Preview	使用預覽操作或修改持久預覽資源時，必須選擇功能旗標。

回覆

狀態碼：200

描述：要求已成功。

內容類型	Type	說明
application/json	排程

狀態碼：預設值

描述：非預期的錯誤回應。

內容類型	Type	說明
application/json	ApiErrorResponse

元件

A2APreview工具

實作 A2A 通訊協定的代理程式。

名稱	類型	Description	為必填項目	預設值
agent_card_path	字串	代理程式卡相對於 的 base_url路徑。 如果未提供，則預設為 /.well-known/agent-card.json	否
base_url	字串	代理程式的基底 URL。	否
project_connection_id	字串	A2A 伺服器 project 中的連線 ID。 連線會儲存連線至 A2A 伺服器所需的驗證和其他連線詳細資料。	否
型別	列舉	工具的類型。 一律為 "a2a_preview。 可能的值：a2a_preview	Yes

AISearchIndexResource

AI 搜尋索引資源。

名稱	類型	Description	為必填項目	預設值
篩選	字串	搜索資源的 filter 字串。 了解更多請見。	否
index_asset_id	字串	為搜索資源的資產 ID 編製索引。	否
索引名稱	字串	附加至此代理程式之 IndexResource 中的索引名稱。	否
project_connection_id	字串	連結至此代理程式的 IndexResource 中的索引連線識別碼。	否
查詢類型	AzureAISearchQueryType	Azure AI Search 工具可用的查詢類型。	否
top_k	整數	要從搜尋中擷取並呈現至模型的檔數目。	否

AgentClusterInsightRequest

對代理評估結果集的見解

名稱	類型	Description	為必填項目	預設值
代理名稱	字串	代理程式的識別碼。	Yes
modelConfiguration	InsightModelConfiguration	深入解析產生中使用的模型的組態。	否
└─ modelDeploymentName	字串	要評估的模型部署。 可接受僅部署名稱，或連同連線名稱為 {connectionName}/<modelDeploymentName>。	Yes
型別	列舉	請求的類型。 可能的值：AgentClusterInsight	Yes

AgentClusterInsightResult

來自代理程式叢集分析的見解。

名稱	類型	Description	為必填項目	預設值
clusterInsight	ClusterInsightResult	來自叢集分析的見解。	Yes
型別	列舉	深入解析結果的類型。 可能的值：AgentClusterInsight	Yes

AgentContainerObject

特定版本代理人容器的細節。

名稱	類型	Description	為必填項目	預設值
容器	ContainerDetails （唯讀）	關於該容器的詳細資訊。	否
└─ health_state	字串	容器的健康狀況。	Yes
└─ provisioning_error	字串	容器的配置錯誤（如果有的話）。	否
└─ provisioning_state	字串	容器的配置狀態。	Yes
└─ 複製品	容器複製的陣列	容器裡的複製品清單。	Yes
└─ 狀態	字串	貨櫃的狀態。	Yes
└─ updated_on	字串	容器的最後更新時間。	Yes
建立於	字串	容器的製作時間。	Yes
error_message	字串（唯讀）	如果容器無法運作，則會顯示錯誤訊息。	否
id	字串（唯讀）	容器的識別碼。	否
max_replicas	整數	容器的最大複製數量。 預設 為 1。	否
min_replicas	整數	容器的最低複製數量。 預設 為 1。	否
物件	列舉	物件類型，永遠是 'agent.container'。 可能的值：agent.container	Yes
狀態	AgentContainerStatus （唯讀）	特定版本代理容器的狀態。	Yes
updated_at	字串	容器的最後更新時間。	Yes

AgentContainerOperationError（代理容器操作錯誤）

容器操作的錯誤細節（如果有的話）。

名稱	類型	Description	為必填項目	預設值
字碼	字串	容器操作的錯誤代碼（如果有的話）。	Yes
訊息	字串	容器操作的錯誤訊息（如果有的話）。	Yes
型別	字串	容器操作的錯誤類型（如果有的話）。	Yes

AgentContainerOperationObject

針對特定版本代理的容器操作。

名稱	類型	Description	為必填項目	預設值
agent_id	字串	代理程式的識別碼。	Yes
agent_version_id	字串	特工版本的ID。	Yes
容器	AgentContainerObject	特定版本代理人容器的細節。	否
└─ 容器	ContainerDetails （唯讀）	詳細的容器資訊。	否
└─ created_at	字串（唯讀）	容器的製作時間。	Yes
└─ error_message	字串（唯讀）	如果容器無法運作，則會顯示錯誤訊息。	否
‧----識別碼	字串（唯讀）	容器的識別碼。	否
└─ max_replicas	整數	容器的最大複製數量。 預設 為 1。	否
└─ min_replicas	整數	容器的最低複製數量。 預設 為 1。	否
└─ 物件	列舉	物件類型，永遠是 'agent.container'。 可能的值：agent.container	Yes
└─ 狀態	AgentContainerStatus （唯讀）	特定版本代理人容器的狀態。	Yes
└─ updated_at	字串（唯讀）	容器的最後更新時間。	Yes
錯誤	AgentContainerOperationError（代理容器操作錯誤）	容器操作的錯誤細節（如果有的話）。	否
└─ 程式碼	字串	容器操作的錯誤代碼（如果有的話）。	Yes
|---- 訊息	字串	容器操作的錯誤訊息（如果有的話）。	Yes
\---- 類型	字串	容器操作的錯誤類型（如果有的話）。	Yes
id	字串	貨櫃作業的識別碼。 此識別碼是系統中唯一的識別碼。	Yes
狀態	AgentContainerOperationStatus（代理容器操作狀態）	特定版本代理的容器操作狀態。	Yes

AgentContainerOperationStatus（代理容器操作狀態）

特定版本代理的容器操作狀態。

房產	價值觀
Type	字串
價值	NotStarted InProgress Succeeded Failed

AgentContainerStatus

特定版本代理容器的狀態。

房產	價值觀
Type	字串
價值	Starting Running Stopping Stopped Failed Deleting Deleted Updating

代理定義

代理定義的判別器

此元件會使用 屬性 kind 來區分不同的類型：

類型值	Schema
prompt	PromptAgentDefinition
workflow	工作流程代理定義
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

名稱	類型	Description	為必填項目	預設值
類型	特工種類		Yes
rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
└─ rai_policy_name	字串	要套用的 RAI 原則名稱。	Yes

特工種類

房產	價值觀
Type	字串
價值	prompt hosted container_app workflow

代理物件

名稱	類型	Description	為必填項目	預設值
id	字串	代理程式的唯一識別碼。	Yes
名稱	字串	代理程式的名稱。 限制： 最大長度：63	Yes
物件	列舉	物件類型，一律為「代理程式」。 可能的值：agent	Yes
versions	物件	代理程式的最新版本。	Yes
└─ 最新	AgentVersionObject		Yes

代理協定

房產	價值觀
Type	字串
價值	activity_protocol responses

代理程式參考

名稱	類型	Description	為必填項目	預設值
名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
型別	列舉	可能的值：agent_reference	Yes
版本	字串	代理程式的版本識別碼。	否

代理分類學輸入

當輸入類型為代理程式時，評估分類的輸入組態。

名稱	類型	Description	為必填項目	預設值
風險類別	風險類別陣列	要評估的風險類別清單。	Yes
目標	目標	具有鑑別器支援的目標基底類別。	Yes
\---- 類型	字串	目標的類型。	Yes
型別	列舉	評估分類法的輸入類型。 可能的值：agent	Yes

AgentTaxonomyInputUpdate

當輸入類型為代理程式時，評估分類的輸入組態。

名稱	類型	Description	為必填項目	預設值
風險類別	風險類別陣列	要評估的風險類別清單。	否
目標	目標更新	具有鑑別器支援的目標基底類別。	否
\---- 類型	字串	目標的類型。	Yes
型別	列舉	評估分類法的輸入類型。 可能的值：agent	Yes

AgentVersionObject

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立代理程式時的 Unix 時間戳記 （秒）。	Yes
定義	代理定義		Yes
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
id	字串	代理程式版本的唯一識別碼。	Yes
中繼資料	物件（可空除）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	Yes
名稱	字串	代理程式的名稱。 名稱可用來擷取/更新/刪除代理程式。 限制： 最大長度：256	Yes
物件	列舉	物件類型，一律為 'agent.version'。 可能的值：agent.version	Yes
版本	字串	代理程式的版本識別碼。 代理程式是不可變的，每次更新都會建立新版本，同時保持名稱不變。	Yes

AgenticIdentityPreviewCredentials

代理程式身分認證定義

名稱	類型	Description	為必填項目	預設值
型別	列舉	認證類型 可能的值：AgenticIdentityToken_Preview	Yes

ApiErrorResponse

API 失敗的錯誤回應。

名稱	類型	Description	為必填項目	預設值
錯誤	OpenAI.錯誤		Yes

ApiKeyCredentials

API Key 憑證定義

名稱	類型	Description	為必填項目	預設值
Key	字串（唯讀）	API 金鑰	否
型別	列舉	認證類型 可能的值：ApiKey	Yes

AssetCredentialResponse

表示對 blob 的引用以供使用

名稱	類型	Description	為必填項目	預設值
blobReference	BlobReference	Blob 引用詳細資訊。	Yes
└─ blobUri	字串	用戶端上傳數據的 Blob URI 路徑。 範例：https://blob.windows.core.net/Container/Path	Yes
└─ 資格	SasCredential	用憑證資訊來access storage帳號。	Yes
└─ storageAccountArmId	字串	要用的 storage 帳號的 ARM ID。	Yes

資產識別碼

已儲存資產的識別碼。

類型：字串

攻擊策略

攻擊策略。

房產	價值觀
說明	攻擊策略。
Type	字串
價值	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.核心.基礎.錯誤

error 物件。

名稱	類型	Description	為必填項目	預設值
字碼	字串	其中一組伺服器定義的錯誤碼。	Yes
details	Azure 陣列。Core.Foundations.Error	導致此錯誤之特定錯誤的詳細數據陣列。	否
inner錯誤	Azure。Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 指引 - https://aka.ms/AzureRestApiGuidelines#handling-errors。	否
└─ 程式碼	字串	其中一組伺服器定義的錯誤碼。	否
└─ 內誤	Azure。Core.Foundations.InnerError	內部錯誤。	否
訊息	字串	錯誤的人類可讀取表示法。	Yes
目標	字串	錯誤的目標。	否

Azure.核心。基礎。錯誤回應

包含錯誤詳細數據的回應。

名稱	類型	Description	為必填項目	預設值
錯誤	Azure。Core.Foundations.Error	error 物件。	Yes
└─ 程式碼	字串	其中一組伺服器定義的錯誤碼。	Yes
|---- 詳細數據	Azure 陣列。Core.Foundations.Error	導致此錯誤之特定錯誤的詳細數據陣列。	否
└─ 內誤	Azure。Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。	否
|---- 訊息	字串	錯誤的人類可讀取表示法。	Yes
└─ 目標	字串	錯誤的目標。	否

Azure.核心.基礎.內部錯誤

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 指引 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱	類型	Description	為必填項目	預設值
字碼	字串	其中一組伺服器定義的錯誤碼。	否
inner錯誤	Azure。Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 指引 - https://aka.ms/AzureRestApiGuidelines#handling-errors。	否
└─ 程式碼	字串	其中一組伺服器定義的錯誤碼。	否
└─ 內誤	Azure。Core.Foundations.InnerError	內部錯誤。	否

Azure.核心。基礎。操作狀態

列舉描述允許的作業狀態。

房產	價值觀
說明	列舉描述允許的作業狀態。
Type	字串
價值	NotStarted Running Succeeded Failed Canceled

Azure.Core.uuid

通用唯一識別碼

類型：字串

格式：uuid

AzureAIAgentTarget

代表指定 Azure AI 代理的目標。

名稱	類型	Description	為必填項目	預設值
名稱	字串	Azure AI 代理的唯一識別碼。	Yes
tool_descriptions	工具描述陣列	用於控制文字產生期間代理程式取樣行為的參數。	否
型別	列舉	目標的類型，一律 azure_ai_agent。 可能的值：azure_ai_agent	Yes
版本	字串	Azure AI 代理的版本。	否

AzureAIAgentTargetUpdate

代表指定 Azure AI 代理的目標。

名稱	類型	Description	為必填項目	預設值
名稱	字串	Azure AI 代理的唯一識別碼。	否
tool_descriptions	工具描述陣列	用於控制文字產生期間代理程式取樣行為的參數。	否
型別	列舉	目標的類型，一律 azure_ai_agent。 可能的值：azure_ai_agent	Yes
版本	字串	Azure AI 代理的版本。	否

AzureAIDataSourceConfig

名稱	類型	Description	為必填項目	預設值
情節	列舉	資料結構情境。 可能的值：red_team、、responses、 traces_previewsynthetic_data_gen_preview	Yes
結構描述	物件	執行資料來源項目的整體物件 JSON 架構。	Yes
型別	列舉	物件類型，一律為 azure_ai_source。 可能的值：azure_ai_source	Yes

AzureAIModelTarget

代表一個目標，指定一個 Azure AI 模型用於需要模型選擇的操作。

名稱	類型	Description	為必填項目	預設值
型號	字串	Azure AI 模型的唯一識別碼。	否
採樣參數	模型取樣參數	代表一組用於控制語言模型在文字生成過程中取樣行為的參數。	否
max_completion_tokens（最大完成標記）	整數	完成過程中允許的最大代幣數量。	Yes
~---- 種子	整數	這是可重現性的隨機種子。	Yes
‧---- 溫度	數字	取樣的溫度參數。	Yes
top_p	數字	核取樣的top-p參數。	Yes
型別	列舉	目標的類型，一律 azure_ai_model。 可能的值：azure_ai_model	Yes

AzureAIModelTargetUpdate

代表一個目標，指定一個 Azure AI 模型用於需要模型選擇的操作。

名稱	類型	Description	為必填項目	預設值
型號	字串	Azure AI 模型的唯一識別碼。	否
採樣參數	ModelSamplingParamsUpdate	代表一組用於控制語言模型在文字生成過程中取樣行為的參數。	否
max_completion_tokens（最大完成標記）	整數	完成過程中允許的最大代幣數量。	否
~---- 種子	整數	這是可重現性的隨機種子。	否
‧---- 溫度	數字	取樣的溫度參數。	否
top_p	數字	核取樣的top-p參數。	否
型別	列舉	目標的類型，一律 azure_ai_model。 可能的值：azure_ai_model	Yes

AzureAIResponsesEvalRunDataSource

代表針對持續評估情境的特定評估執行資料來源。

名稱	類型	Description	為必填項目	預設值
event_configuration_id	字串	與此評估執行相關聯的事件配置名稱。	Yes
item_generation_params	回應檢索項目生成參數	代表回應檢索題目產生的參數。	Yes
└─ data_mapping	物件	從來源欄位映射到response_id欄位，這是擷取聊天歷史所必需的。	Yes
└─ max_num_turns	整數	評估聊天歷史的最大回合數。	Yes
‧---- 來源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	JSONL 內容讀取的來源。	Yes
\---- 類型	列舉	物品生成參數的類型總是 response_retrieval。 可能的值：response_retrieval	Yes
max_runs_hourly	整數	每小時允許的評估執行次數上限。	Yes
型別	列舉	資料來源類型總是 azure_ai_responses。 可能的值：azure_ai_responses	Yes

AzureAI搜尋索引

Azure AI Search 索引定義

名稱	類型	Description	為必填項目	預設值
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	列舉	索引類型 可能的值：AzureSearch	Yes
版本	字串（唯讀）	資源的版本	Yes

AzureAISearchIndexUpdate

Azure AI Search 索引定義

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	列舉	索引類型 可能的值：AzureSearch	Yes

AzureAISearchQueryType

Azure AI Search 工具可用的查詢類型。

房產	價值觀
說明	Azure AI Search 工具可用的查詢類型。
Type	字串
價值	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

輸入定義資訊用於配置代理時使用的 Azure AI search 工具。

名稱	類型	Description	為必填項目	預設值
azure_ai_search	AzureAISearchToolResource	azure_ai_search 工具所使用的一組索引資源。	Yes
└─ 索引	AISearchIndexResource 陣列	附加至此代理程式的索引。 索引最多可為 1 資源附帶於代理人。 限制： maxItems：1	Yes
型別	列舉	物件類型，一律為 'azure_ai_search'。 可能的值：azure_ai_search	Yes

AzureAISearchToolResource

azure_ai_search 工具所使用的一組索引資源。

名稱	類型	Description	為必填項目	預設值
指標	AISearchIndexResource 陣列	附加至此代理程式的索引。 索引最多可為 1 資源附帶於代理人。	Yes

AzureFunctionBinding

這是用來保留 storage 隊列名稱和 URI 的結構。

名稱	類型	Description	為必填項目	預設值
storage_queue	AzureFunctionStorageQueue	這是用來保留 storage 隊列名稱和 URI 的結構。	Yes
└─ queue_name	字串	Azure 函式 storage queue 的名稱。	Yes
└─ queue_service_endpoint	字串	URI 連接到 Azure Storage Queue 服務，讓你可以操作佇列。	Yes
型別	列舉	系結的類型，一律為 'storage_queue'。 可能的值：storage_queue	Yes

AzureFunctionDefinition

Azure 函數的定義。

名稱	類型	Description	為必填項目	預設值
函式	物件	azure 函式及其參數的定義。	Yes
└─ 描述	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	否
\---- 名稱	字串	要呼叫之函式的名稱。	Yes
└─ 參數	物件	函式接受的參數，描述為 JSON 結構描述物件。	Yes
input_binding	AzureFunctionBinding	這是用來保留 storage 隊列名稱和 URI 的結構。	Yes
└─ storage_queue	AzureFunctionStorageQueue	Storage queue。	Yes
\---- 類型	列舉	系結的類型，一律為 'storage_queue'。 可能的值：storage_queue	Yes
output_binding	AzureFunctionBinding	這是用來保留 storage 隊列名稱和 URI 的結構。	Yes
└─ storage_queue	AzureFunctionStorageQueue	Storage queue。	Yes
\---- 類型	列舉	系結的類型，一律為 'storage_queue'。 可能的值：storage_queue	Yes

AzureFunctionStorageQueue

這是用來保留 storage 隊列名稱和 URI 的結構。

名稱	類型	Description	為必填項目	預設值
queue_name	字串	Azure 函式 storage queue 的名稱。	Yes
queue_service_endpoint	字串	URI 連接到 Azure Storage Queue 服務，讓你可以操作佇列。	Yes

AzureFunctionTool

輸入定義資訊，用於配置代理程式的 Azure 函式工具。

名稱	類型	Description	為必填項目	預設值
azure_function	AzureFunctionDefinition	Azure 函數的定義。	Yes
└─ 函數	物件	azure 函式及其參數的定義。	Yes
└─ 描述	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	否
\---- 名稱	字串	要呼叫之函式的名稱。	Yes
└─ 參數	物件	函式接受的參數，描述為 JSON 結構描述物件。	Yes
└─ input_binding	AzureFunctionBinding	Input storage queue。 Queue storage 觸發器會在訊息加入時執行一個函式。	Yes
└─ output_binding	AzureFunctionBinding	storage隊列輸出。 函式會在處理輸入專案時，將輸出寫入此佇列。	Yes
型別	列舉	物件類型，一律為 'browser_automation'。 可能的值：azure_function	Yes

AzureOpenAIModelConfiguration

Azure OpenAI model configuration. API 版本將由服務選擇以查詢模型。

名稱	類型	Description	為必填項目	預設值
modelDeploymentName	字串	AOAI 模型的部署名稱。 示例：gpt-4o，如果在 AIServices 或基於連接（ connection_name/deployment_name 例如 my-aoai-connection/gpt-4o）。	Yes
型別	列舉	可能的值：AzureOpenAIModel	Yes

基地憑證

連接憑證的基類

BaseCredentials 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SAS信用
None	無認證憑證
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

名稱	類型	Description	為必填項目	預設值
型別	憑證類型 （唯讀）	連接使用的憑證類型	Yes

BingCustomSearchConfiguration

一個 bing 自訂搜尋設定。

名稱	類型	Description	為必填項目	預設值
計數	整數	bing API 回應中應回傳的搜尋結果數量	否
freshness	字串	按特定時間範圍篩選搜尋結果。 請參見 accepted values。	否
instance_name	字串	提供給組態的自定義組態實例名稱。	Yes
市	字串	結果來源的市場。	否
project_connection_id	字串	Project 連接 ID 用於 bing 搜尋接地	Yes
set_lang	字串	呼叫 Bing API 時使用者介面字串的語言。	否

BingCustomSearchPreviewTool

Bing 自訂搜尋工具的輸入定義資訊，用於設定代理。

名稱	類型	Description	為必填項目	預設值
bing_custom_search_preview	BingCustomSearchToolParameters（必應客串搜尋工具參數）	bing 自訂搜尋工具的參數。	Yes
└─ search_configurations	BingCustomSearchConfiguration 的陣列	這個工具上的 project 連結。 最多只能有 1 個連線 資源附帶於工具上。 限制： maxItems：1	Yes
型別	列舉	物件類型，永遠是「bing_custom_search_preview」。 可能的值：bing_custom_search_preview	Yes

BingCustomSearchToolParameters（必應客串搜尋工具參數）

bing 自訂搜尋工具的參數。

名稱	類型	Description	為必填項目	預設值
search_configurations	BingCustomSearchConfiguration 的陣列	這個工具上的 project 連結。 最多只能有 1 個連線 資源附帶於工具上。	Yes

BingGroundingSearchConfiguration

搜尋 Bing 接地設定

名稱	類型	Description	為必填項目	預設值
計數	整數	bing API 回應中應回傳的搜尋結果數量	否
freshness	字串	按特定時間範圍篩選搜尋結果。 請參見 accepted values。	否
市	字串	結果來源的市場。	否
project_connection_id	字串	Project 連接 ID 用於 bing 搜尋接地	Yes
set_lang	字串	呼叫 Bing API 時使用者介面字串的語言。	否

BingGroundingSearchToolParameters（BingGroundingSearchToolParameters）

bing 接地搜尋工具的參數。

名稱	類型	Description	為必填項目	預設值
search_configurations	BingGroundingSearchConfiguration 陣列	附加到此工具的搜尋配置。 最多可有1個 可搜尋附在工具上的設定資源。	Yes

BingGroundingTool

bing 接地搜尋工具的輸入定義資訊，用於設定代理。

名稱	類型	Description	為必填項目	預設值
bing_grounding	BingGroundingSearchToolParameters（BingGroundingSearchToolParameters）	bing 接地搜尋工具的參數。	Yes
└─ search_configurations	BingGroundingSearchConfiguration 陣列	附加到此工具的搜尋配置。 最多可有1個 可搜尋附在工具上的設定資源。 限制： maxItems：1	Yes
型別	列舉	物件類型，一律為 'bing_grounding'。 可能的值：bing_grounding	Yes

BlobReference

Blob 引用詳細資訊。

名稱	類型	Description	為必填項目	預設值
blobUri	字串	用戶端上傳數據的 Blob URI 路徑。 範例：https://blob.windows.core.net/Container/Path	Yes
認證	SasCredential	SAS 憑證定義	Yes
└─ 薩斯·烏里	字串（唯讀）	SAS uri	Yes
\---- 類型	列舉	憑證類型 可能的值：SAS	Yes
儲存帳號ArmID	字串	要用的 storage 帳號的 ARM ID。	Yes

BrowserAutomationPreviewTool

瀏覽器自動化工具的輸入定義資訊，用於設定代理程式。

名稱	類型	Description	為必填項目	預設值
browser_automation_preview	BrowserAutomationToolParameters（瀏覽器自動化工具參數）	瀏覽器自動化工具的輸入參數定義。	Yes
└─ 連結	BrowserAutomationToolConnectionParameters（瀏覽器自動化工具連接參數）	該 project 連接參數與瀏覽器自動化工具相關聯。	Yes
型別	列舉	物件類型，永遠是「browser_automation_preview」。 可能的值：browser_automation_preview	Yes

BrowserAutomationToolConnectionParameters（瀏覽器自動化工具連接參數）

「瀏覽器自動化工具」所使用連線的輸入參數定義。

名稱	類型	Description	為必填項目	預設值
project_connection_id	字串	project 連接到 Azure Playwright 資源的 ID。	Yes

BrowserAutomationToolParameters（瀏覽器自動化工具參數）

瀏覽器自動化工具的輸入參數定義。

名稱	類型	Description	為必填項目	預設值
連接	BrowserAutomationToolConnectionParameters（瀏覽器自動化工具連接參數）	「瀏覽器自動化工具」所使用連線的輸入參數定義。	Yes
└─ project_connection_id	字串	project 連接到 Azure Playwright 資源的 ID。	Yes

CaptureStructuredOutputsTool

用於捕獲結構化輸出的工具

名稱	類型	Description	為必填項目	預設值
輸出	StructuredOutputDefinition	一個由代理人能產生的結構化輸出。	Yes
└─ 描述	字串	要發出的輸出描述。 模型用來判斷何時發出輸出。	Yes
\---- 名稱	字串	結構化輸出的名稱。	Yes
└─ 綱要	物件	結構化輸出的 JSON 結構描述。	Yes
└─ 嚴格	布林值（可空）	是否強制執行嚴格驗證。 預設 true。	Yes
型別	列舉	工具的類型。 一律為 capture_structured_outputs。 可能的值：capture_structured_outputs	Yes

圖表座標

分析圖表的座標。

名稱	類型	Description	為必填項目	預設值
size	整數	圖表元素的大小。	Yes
x	整數	X 軸座標。	Yes
y	整數	Y 軸座標。	Yes

聊天摘要記憶項目

包含從對話中提取的摘要的記憶項目。

名稱	類型	Description	為必填項目	預設值
內容	字串	記憶體的內容。	Yes
類型	列舉	記憶項目的種類。 可能的值：chat_summary	Yes
memory_id	字串	記憶體項目的唯一 ID。	Yes
範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes
updated_at	整數	記憶體項目的最後更新時間。	Yes

ClusterInsightResult

來自叢集分析的見解。

名稱	類型	Description	為必填項目	預設值
集群	InsightCluster 陣列	深入解析中識別的叢集清單。	Yes
座標	物件	選擇性地將 ID 對應至 UX 用於視覺化的 2D 座標。 映射鍵是字串識別碼（例如叢集 ID 或範例 ID） 而這些值則是用於渲染在 2D 圖表上的座標與視覺大小。 除非用戶端請求座標（例如， 通過傳遞 includeCoordinates=true 為查詢參數）。 範例： <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> 座標僅用於用戶端視覺化，並非如此 修改正典洞見結果。	否
摘要	洞察摘要	錯誤叢集分析的摘要。	Yes
└─ 方法	字串	用於叢集的方法。	Yes
└─ 樣本計數	整數	分析的樣本總數。	Yes
└─ uniqueClusterCount	整數	唯一叢集總數。	Yes
└─ uniqueSubclusterCount	整數	唯一子叢集標籤的總數。	Yes
|---- 使用方式	ClusterTokenUsage	執行叢集分析時的權杖使用量	Yes

ClusterTokenUsage

叢集分析的記號使用量

名稱	類型	Description	為必填項目	預設值
inputTokenUsage	整數	輸入權杖使用方式	Yes
outputTokenUsage	整數	輸出權杖使用情況	Yes
totalTokenUsage	整數	權杖使用量總計	Yes

CodeBasedEvaluatorDefinition

使用 python 程式碼的程式碼型評估器定義

名稱	類型	Description	為必填項目	預設值
code_text	字串	評估工具的內嵌程式碼文字	Yes
data_schema	物件	評估者輸入資料的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
init_parameters	物件	評估者輸入參數的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
計量	物件	此評估器產生的輸出指標清單	否
型別	列舉	可能的值：code	Yes

完成訊息工具呼叫

工具呼叫細節可在訊息中呈現。

名稱	類型	Description	為必填項目	預設值
函式	FunctionToolCall	函式工具呼叫的細節。	否
└─ 論點	字串	呼叫函數所使用的引數，由模型以 JSON 格式產生。	Yes
\---- 名稱	字串	要呼叫的函式名稱。	Yes
id	字串	工具呼叫的識別碼。	Yes
型別	列舉	工具呼叫的類型，永遠是「函數」。 可能的值：function	Yes

連線

來自清單的回應和獲取連接作

名稱	類型	Description	為必填項目	預設值
憑證	BaseCredentials （唯讀）	連接憑證的基類	Yes
\---- 類型	憑證類型 （唯讀）	連接使用的憑據類型	Yes
id	字串（唯讀）	由服務生成的連接的唯一標識碼	Yes
isDefault	布林值（唯讀）	是否將連接標記為其類型的預設連接	Yes
中繼資料	物件（唯讀）	連接的元數據	Yes
名稱	字串（唯讀）	由使用者提供的連接的友好名稱。	Yes
目標	字串（唯讀）	要用於此服務的連線 URL	Yes
型別	ConnectionType （唯讀）	線上類型（或類別）	Yes

連接類型

線上類型（或類別）

房產	價值觀
說明	線上類型（或類別）
Type	字串
價值	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

容器應用程式代理程式定義。

名稱	類型	Description	為必填項目	預設值
container_app_resource_id	字串	這是承載此代理的 Azure 容器應用程式的資源 ID。 不可跨版本變更。	Yes
container_protocol_versions	協定版本記錄陣列	代理程式支援容器輸入通訊的通訊協定。	Yes
ingress_subdomain_suffix	字串	將輸入傳送至代理程式時套用至應用程式子網域的尾碼。 這可以是標籤 （例如，'---current'）、特定修訂 （例如，'--0000001'），也可以是空的，以使用容器應用程式的預設端點。	Yes
類型	列舉	可能的值：container_app	Yes
rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
└─ rai_policy_name	字串	要套用的 RAI 原則名稱。	Yes

容器詳細資料

關於該容器的詳細資訊。

名稱	類型	Description	為必填項目	預設值
health_state	字串	容器的健康狀況。	Yes
provisioning_error	字串	容器的配置錯誤（如果有的話）。	否
provisioning_state	字串	容器的配置狀態。	Yes
replicas	容器複製的陣列	容器裡的複製品清單。	Yes
狀態	字串	貨櫃的狀態。	Yes
updated_on	字串	容器的最後更新時間。	Yes

容器LogKind

從容器串流的原木類型。

房產	價值觀
Type	字串
價值	console system

容器複製品

關於容器複製品的資訊。

名稱	類型	Description	為必填項目	預設值
container_state	字串	複製品的容器狀態。	Yes
名稱	字串	複本的名稱。	Yes
狀態	字串	複製品的狀態。	Yes

連續評估規則動作

持續評估的評估規則動作。

名稱	類型	Description	為必填項目	預設值
已評估	字串	評估識別碼，以新增持續評估執行。	Yes
最大小時跑量	整數	每小時允許的評估執行次數上限。	否
型別	列舉	可能的值：continuousEvaluation	Yes

CosmosDB索引

CosmosDB 向量存儲索引定義

名稱	類型	Description	為必填項目	預設值
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	列舉	索引類型 可能的值：CosmosDBNoSqlVectorStore	Yes
版本	字串（唯讀）	資源的版本	Yes

CosmosDBIndexUpdate

CosmosDB 向量存儲索引定義

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	列舉	索引類型 可能的值：CosmosDBNoSqlVectorStore	Yes

CreateAgentFromManifestRequest

名稱	類型	Description	為必填項目	預設值
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
manifest_id	字串	用來匯入代理版本的清單 ID。	Yes
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	唯一能識別代理人的名字。 名稱可用來擷取/更新/刪除代理程式。 - 必須以字母數字字元開頭和結尾， - 中間可包含連字號 - 字元不得超過63個字元。 限制： 最大長度：63	Yes
parameter_values	物件	清單的輸入將導致一個完全具現化的特工。	Yes

CreateAgentRequest

名稱	類型	Description	為必填項目	預設值
定義	代理定義		Yes
└─ 善良	特工種類		Yes
└─ rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	唯一能識別代理人的名字。 名稱可用來擷取/更新/刪除代理程式。 - 必須以字母數字字元開頭和結尾， - 中間可包含連字號 - 字元不得超過63個字元。 限制： 最大長度：63	Yes

CreateAgentVersionFromManifestRequest

名稱	類型	Description	為必填項目	預設值
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
manifest_id	字串	用來匯入代理版本的清單 ID。	Yes
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
parameter_values	物件	清單的輸入將導致一個完全具現化的特工。	Yes

CreateAgentVersionRequest

名稱	類型	Description	為必填項目	預設值
定義	代理定義		Yes
└─ 善良	特工種類		Yes
└─ rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否

CreateEvalRequest

名稱	類型	Description	為必填項目	預設值
資料來源配置	OpenAI.CreateEvalCustomDataSourceConfig 或 OpenAI.CreateEvalLogsDataSourceConfig 或 OpenAI.CreateEvalStoredCompletionsDataSourceConfig 或 AzureAIDataSourceConfig	評估時所用資料來源的配置。 決定評估中使用的資料架構。	Yes
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	評估的名稱。	否
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否
測試標準	OpenAI.EvalGraderLabelModel 或 OpenAI.EvalGraderStringCheck 或 OpenAI.EvalGraderTextSimilarity 或 OpenAI.EvalGraderPython 或 OpenAI.EvalGraderScoreModel 或 EvalGraderAzureAIEvaluator 的 array	此群組內所有評估回合的評分者清單。 評分者可以使用雙大括號表示法參考數據源中的變數，例如 {{item.variable_name}}。 若要參考模型的輸出，請使用 sample 命名空間 （ie， {{sample.output_text}}）。	Yes

CreateEvalRunRequest

名稱	類型	Description	為必填項目	預設值
資料來源	OpenAI.CreateEvalJsonlRunDataSource 或 OpenAI.CreateEvalCompletionsRunDataSource 或 OpenAI.CreateEvalResponsesRunDataSource 或 EvalRunDataSource	關於這次跑步數據來源的詳細資訊。	Yes
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串	執行步驟名稱。	否
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否

憑證類型

連接使用的憑證類型

房產	價值觀
說明	連接使用的憑證類型
Type	字串
價值	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

基於 Cron 的觸發器。

名稱	類型	Description	為必填項目	預設值
endTime	字串	ISO 8601 格式的 cron 排程結束時間。	否
運算式	字串	Cron 運算式，定義排程頻率。	Yes
startTime	字串	ISO 8601 格式的 cron 排程的開始時間。	否
timeZone	字串	cron 排程的時區。	否	UTC
型別	列舉	可能的值：Cron	Yes

CustomCredential

自定義憑證定義

名稱	類型	Description	為必填項目	預設值
型別	列舉	認證類型 可能的值：CustomKeys	Yes

此物件也接受其他屬性，例如 string

每日重複排程

每日重複時間表。

名稱	類型	Description	為必填項目	預設值
營業時間	整數陣列	週期性排程的時數。	Yes
型別	列舉	每日重複類型。 可能的值：Daily	Yes

DataSourceConfig

執行資料來源的基底類別，支援判別器。

DataSourceConfig 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema

名稱	類型	Description	為必填項目	預設值
結構描述	物件	執行資料來源項目的整體物件 JSON 架構。	Yes
型別	字串	資料來源類型是判別器。	Yes

資料集類型

要判斷數據類型的列舉。

房產	價值觀
說明	要判斷數據類型的列舉。
Type	字串
價值	uri_file uri_folder

資料集版本

DatasetVersion 定義

資料集版本判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
uri_file	FileDataset版本
uri_folder	資料夾資料集版本

名稱	類型	Description	為必填項目	預設值
connectionName （連接名稱）	字串	Azure Storage Account connection name 。 如果在創建 Dataset 之前未調用 startPendingUploadVersion，則為必需	否
dataUri	字串	資料的 URI （範例） 限制條件： 最小長度：1，模式： [a-zA-Z0-9_]	Yes
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
is參考	布林值（唯讀）	表示資料集是否持有對 storage 的參考，或是資料集本身管理 storage。 如果為 true，則刪除資料集版本時不會刪除基礎數據	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	資料集類型	要判斷數據類型的列舉。	Yes
版本	字串（唯讀）	資源的版本	Yes

DatasetVersionUpdate

DatasetVersion 定義

DatasetVersionUpdate 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	資料集類型	要判斷數據類型的列舉。	Yes

星期

週期性排程的星期幾。

房產	價值觀
說明	週期性排程的星期幾。
Type	字串
價值	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

刪除代理回應

已刪除的代理程式物件

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值	代理程式是否已成功刪除。	Yes
名稱	字串	代理程式的名稱。	Yes
物件	列舉	物件類型。 一律為「agent.deleted」。 可能的值：agent.deleted	Yes

DeleteAgentVersionResponse

已刪除的代理程式版本物件

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值	代理程式是否已成功刪除。	Yes
名稱	字串	代理程式的名稱。	Yes
物件	列舉	物件類型。 永遠都是「agent.version.deleted」。 可能的值：agent.version.deleted	Yes
版本	字串	代理程式的版本識別碼。	Yes

刪除評估回應

已刪除的評估物件

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值	評估是否成功刪除。	Yes
評估編號	字串	評估的身份證。	Yes
物件	列舉	物件類型。 總是用「eval.deleted」。 可能的值：eval.deleted	Yes

刪除評估執行回應

執行 Object 的刪除評估。

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值	評估是否成功刪除。	否
物件	列舉	物件類型。 總是用「eval.deleted」。 可能的值：eval.deleted	否
run_id	字串	評估的身份證。	否

刪除記憶儲存回應

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值	記憶體儲存是否已成功刪除。	Yes
名稱	字串	記憶體存放區的名稱。	Yes
物件	列舉	物件類型。 一律「memory_store.已刪除」。 可能的值：memory_store.deleted	Yes

刪除回應結果

這是刪除回應操作的結果。

名稱	類型	Description	為必填項目	預設值
已刪除	列舉	永遠回傳 true。 可能的值：True	Yes
id	字串	作業標識碼。	Yes
物件	列舉	一定要回覆「回覆」。 可能的值：response	Yes

部署

模型部署定義

部署判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
ModelDeployment	模型部署

名稱	類型	Description	為必填項目	預設值
名稱	字串（唯讀）	部署的名稱	Yes
型別	部署類型		Yes

部署類型

房產	價值觀
Type	字串
價值	ModelDeployment

EntraIDCredentials

EntraID 憑證定義

名稱	類型	Description	為必填項目	預設值
型別	列舉	認證類型 可能的值：AAD	Yes

Eval

具有數據源組態和測試準則的 Eval 物件。 Eval 代表一項需要完成以整合您的 LLM 的任務。 例如：

• 改善聊天機器人的品質
• 查看聊天機器人如何處理客戶支援
• 檢查 o4-mini 在我的使用案例是否比 gpt-4o 更好

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立 eval 時的 Unix 時間戳 （以秒為單位）。	Yes
創建者	字串	創作這段作品的人的名字。	否
資料來源配置	OpenAI.CreateEvalCustomDataSourceConfig 或 OpenAI.CreateEvalLogsDataSourceConfig 或 OpenAI.CreateEvalStoredCompletionsDataSourceConfig 或 AzureAIDataSourceConfig	評估執行時所使用的資料來源配置。	Yes
id	字串	評估的唯一標識碼。	Yes
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	Yes
modified_at	integer		否
名稱	字串	評估的名稱。	Yes
物件	列舉	物件類型。 可能的值：eval	Yes
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否
測試標準	OpenAI.EvalGraderLabelModel 或 OpenAI.EvalGraderStringCheck 或 OpenAI.EvalGraderTextSimilarity 或 OpenAI.EvalGraderPython 或 OpenAI.EvalGraderScoreModel 或 EvalGraderAzureAIEvaluator 的 array	測試準則的清單。	Yes

EvalCsvFileIdSource

代表一個已上傳的 CSV 檔案參考，作為評估資料的來源。

名稱	類型	Description	為必填項目	預設值
id	字串	上傳的 CSV 檔案識別碼。	Yes
型別	列舉	來源類型，總是 file_id。 可能的值：file_id	Yes

EvalCsvRunDataSource

代表用於評估執行的 CSV 資料來源。

名稱	類型	Description	為必填項目	預設值
來源	EvalCsvFileIdSource	代表一個已上傳的 CSV 檔案參考，作為評估資料的來源。	Yes
‧----識別碼	字串	上傳的 CSV 檔案識別碼。	Yes
\---- 類型	列舉	來源類型，總是 file_id。 可能的值：file_id	Yes
型別	列舉	資料來源類型總是 csv。 可能的值：csv	Yes

EvalGraderAzureAIEvaluator

名稱	類型	Description	為必填項目	預設值
data_mapping	物件	要用於評估的模型。 必須支援結構化輸出。	否
evaluator_name	字串	評估員的名字。	Yes
evaluator_version	字串	評估者的版本。 如果未特別說明，請使用最新版本。	否
initialization_parameters	物件	評估的初始化參數。 必須支援結構化輸出。	否
名稱	字串	評分者的名稱。	Yes
型別	列舉	物件類型，一律為 azure_ai_evaluator。 可能的值：azure_ai_evaluator	Yes

評估結果

評估結果。

名稱	類型	Description	為必填項目	預設值
名稱	字串	支票名稱	Yes
通過	布爾值	指出檢查是否通過或失敗	Yes
分數	數字	分數	Yes
型別	字串	檢查類型	Yes

EvalRun

表示評估回合的架構。

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立評估回合時的 Unix 時間戳（以秒為單位）。	Yes
創建者	字串	創作這段作品的人的名字。	否
資料來源	OpenAI.CreateEvalJsonlRunDataSource 或 OpenAI.CreateEvalCompletionsRunDataSource 或 OpenAI.CreateEvalResponsesRunDataSource 或 EvalRunDataSource	關於本次賽事數據來源的資訊。	Yes
錯誤	OpenAI.EvalApiError	物件，表示來自 Eval API 的錯誤回應。	Yes
評估編號	字串	相關聯評估的識別碼。	Yes
id	字串	評估執行的唯一識別碼。	Yes
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	Yes
型號	字串	如果適用，則評估的模型。	Yes
modified_at	integer		否
名稱	字串	評估回合的名稱。	Yes
物件	列舉	物件的類型。 一律為 「eval.run」。。 可能的值：eval.run	Yes
每模型使用	array of OpenAI.EvalRunPerModelUsage	評估執行期間每個模型的使用量統計數據。	Yes
根據測試標準結果	OpenAI.EvalRunPerTestingCriteria 結果陣列	評估執行期間所套用的每個測試準則的結果。	Yes
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否
report_url	字串	在 UI 儀錶板上生成的評估執行報表 URL。	Yes
結果計數	OpenAI.EvalRunResultCounts		Yes
|---- 錯誤	OpenAI.integer		Yes
----- 失敗	OpenAI.integer		Yes
通過	OpenAI.integer		Yes
|---- 總計	OpenAI.integer		Yes
狀態	字串	評估回合的狀態。	Yes

EvalRunDataSource

執行資料來源的基底類別，支援判別器。

EvalRunDataSource 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	目標完成評估跑數據源
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

名稱	類型	Description	為必填項目	預設值
型別	字串	資料來源類型是判別器。	Yes

EvalRunOutputItem

表示評估執行輸出項目的結構。

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立評估回合時的 Unix 時間戳（以秒為單位）。	Yes
資料來源項目	物件	輸入數據源項目的詳細數據。	Yes
資料源項目識別	OpenAI.integer		Yes
評估編號	字串	評估群組的標識碼。	Yes
id	字串	用於評估執行結果項目的唯一標識碼。	Yes
物件	列舉	物件的類型。 一律為 「eval.run.output_item」。。 可能的值：eval.run.output_item	Yes
results	EvalRunOutputItemResult 的陣列	此輸出項目的評分結果清單。	Yes
run_id	字串	與此輸出項目相關聯的評估回合識別碼。	Yes
樣本	OpenAI.EvalRunOutputItemSample		Yes
-------- 錯誤	OpenAI.EvalApiError	物件，表示來自 Eval API 的錯誤回應。	Yes
finish_reason	字串		Yes
└─ 輸入	EvalRunOutputItemSampleInput 的陣列		Yes
max_completion_tokens（最大完成標記）	OpenAI.integer		Yes
└─ 模型	字串		Yes
└─ 輸出	EvalRunOutputItemSampleOutput 的陣列		Yes
~---- 種子	OpenAI.integer		Yes
‧---- 溫度	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
|---- 使用方式	OpenAI.EvalRunOutputItemSampleUsage		Yes
狀態	字串	評估回合的狀態。	Yes

EvalRunOutputItemResult

評估跑輸出項目的單一評分結果。

名稱	類型	Description	為必填項目	預設值
標籤	字串	與測試標準指標相關的標籤（例如「通過」、「失敗」、「良好」、「差」）。	否
計量	字串	指標名稱（例如「流暢度」、「f1_score」）。	否
名稱	字串	評分者的名稱。	Yes
通過	布爾值	評分機是否認為輸出通過。	Yes
properties	物件	關於測試標準指標的更多細節。	否
reason	字串	測試標準的理由是指標。	否
樣本	物件（可空除）	評分機產生的可選樣本或中間資料。	否
分數	OpenAI.numeric		Yes
閾值	數字	用來判定此測試標準通過/不通過的門檻（如果是數值標準）。	否
型別	字串	評分器類型（例如「string-check-grader」）。	否

此物件同時接受額外的屬性。

EvalRunOutputItemSampleInput

評估跑中的訊息。

名稱	類型	Description	為必填項目	預設值
內容	字串		Yes
角色	字串		Yes
tool_calls	完成訊息工具CallChunk 的陣列	訊息中是否有工具呼叫（如果有的話）。	Yes

EvalRunOutputItemSampleOutput

評估跑中的訊息。

名稱	類型	Description	為必填項目	預設值
內容	字串		否
角色	字串		否
tool_calls	完成訊息工具CallChunk 的陣列	訊息中是否有工具呼叫（如果有的話）。	Yes

EvalRunResultCompareItem

治療與基線的度量比較。

名稱	類型	Description	為必填項目	預設值
delta估計	數字	治療與基線之間的估計差異。	Yes
pValue	數字	治療效果的 P 值。	Yes
治療效果	治療效果類型	治療效果類型。	Yes
治療 RunId（處理）	字串	處理執行 ID。	Yes
治療 運行摘要	評估結果摘要	評估執行中計量的摘要統計資料。	Yes
└─ 普通	數字	評估執行中指標的平均值。	Yes
└─ runId（跑動）	字串	評估執行識別碼。	Yes
└─ 樣本計數	整數	評估執行中的樣本數。	Yes
└─ 標準差	數字	評估執行中計量的標準差。	Yes

評估結果比較

治療運行與基線的比較結果。

名稱	類型	Description	為必填項目	預設值
基線 運行摘要	評估結果摘要	評估執行中計量的摘要統計資料。	Yes
└─ 普通	數字	評估執行中指標的平均值。	Yes
└─ runId（跑動）	字串	評估執行識別碼。	Yes
└─ 樣本計數	整數	評估執行中的樣本數。	Yes
└─ 標準差	數字	評估執行中計量的標準差。	Yes
比較項目	array of EvalRunResultCompareItem	每次治療執行的比較結果清單。	Yes
評估員	字串	此測試標準的評估者名稱。	Yes
計量	字串	正在評估的指標。	Yes
測試標準	字串	測試標準的名稱。	Yes

評估結果摘要

評估執行中計量的摘要統計資料。

名稱	類型	Description	為必填項目	預設值
平均值	數字	評估執行中指標的平均值。	Yes
runId	字串	評估執行識別碼。	Yes
樣本計數	整數	評估執行中的樣本數。	Yes
標準偏差	數字	評估執行中計量的標準差。	Yes

評估比較洞察請求

評估比較請求

名稱	類型	Description	為必填項目	預設值
baselineRunId（基準線RunId）	字串	用於比較的基準執行識別碼。	Yes
已評估	字串	評估的識別碼。	Yes
處理RunIds	字串陣列	用於比較的治療執行 ID 清單。	Yes
型別	列舉	請求的類型。 可能的值：EvaluationComparison	Yes

評估比較洞察結果

評估比較的見解。

名稱	類型	Description	為必填項目	預設值
比較	EvalRunResultComparison 的陣列	每個治療的比較結果與基線相比。	Yes
方法	字串	用於比較的統計方法。	Yes
型別	列舉	深入解析結果的類型。 可能的值：EvaluationComparison	Yes

評估結果範例

評估結果中的樣本。

名稱	類型	Description	為必填項目	預設值
相關資訊	物件	分析樣本相關性的相關資訊。	Yes
評價結果	評估結果	評估結果。	Yes
\---- 名稱	字串	支票名稱	Yes
通過	布爾值	指出檢查是否通過或失敗	Yes
└─ 配樂	數字	分數	Yes
\---- 類型	字串	檢查類型	Yes
features	物件	有助於在 UX 中對資料進行額外篩選的功能。	Yes
id	字串	分析樣本的唯一識別碼。	Yes
型別	列舉	評估結果樣本類型 可能的值：EvaluationResultSample	Yes

評估規則

評估規則模型。

名稱	類型	Description	為必填項目	預設值
動作	評估規則行動	評估行動模型。	Yes
\---- 類型	評估規則行動類型	評估動作的類型。	Yes
說明	字串	評估規則的描述。	否
顯示名稱	字串	評估規則的顯示名稱。	否
enabled	布爾值	指出是否已啟用評估規則。 預設值是「true」。	Yes
eventType	評估規則事件類型	評估規則事件的類型。	Yes
篩選	EvaluationRuleFilter	評估篩選器模型。	否
└─ 代理人姓名	字串	按客服專員名稱過濾。	Yes
id	字串（唯讀）	評估規則的唯一識別碼。	Yes
系統數據	物件（唯讀）	評估規則的系統中繼資料。	Yes

評估規則行動

評估行動模型。

評估判別者規則行動

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
continuousEvaluation	連續評估規則動作
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

名稱	類型	Description	為必填項目	預設值
型別	評估規則行動類型	評估動作的類型。	Yes

評估規則行動類型

評估動作的類型。

房產	價值觀
說明	評估動作的類型。
Type	字串
價值	continuousEvaluation humanEvaluationPreview

評估規則事件類型

評估規則事件的類型。

房產	價值觀
說明	評估規則事件的類型。
Type	字串
價值	responseCompleted manual

EvaluationRuleFilter

評估篩選器模型。

名稱	類型	Description	為必填項目	預設值
代理名稱	字串	按客服專員名稱過濾。	Yes

EvaluationRunClusterInsightRequest

對評估結果集的見解

名稱	類型	Description	為必填項目	預設值
已評估	字串	深入解析的評估識別碼。	Yes
modelConfiguration	InsightModelConfiguration	深入解析產生中使用的模型的組態。	否
└─ modelDeploymentName	字串	要評估的模型部署。 可接受僅部署名稱，或連同連線名稱為 {connectionName}/<modelDeploymentName>。	Yes
runIds	字串陣列	深入解析的評估執行識別碼清單。	Yes
型別	列舉	深入解析請求的類型。 可能的值：EvaluationRunClusterInsight	Yes

EvaluationRunClusterInsightResult

來自評估的深入解析會執行叢集分析。

名稱	類型	Description	為必填項目	預設值
clusterInsight	ClusterInsightResult	來自叢集分析的見解。	Yes
型別	列舉	深入解析結果的類型。 可能的值：EvaluationRunClusterInsight	Yes

評估排程任務

排程的評估任務。

名稱	類型	Description	為必填項目	預設值
組態	物件	工作的設定。	否
已評估	字串	評估群組的識別碼。	Yes
evalRun	物件	評估執行承載。	Yes
型別	列舉	可能的值：Evaluation	Yes

評估分類學

評估分類定義

名稱	類型	Description	為必填項目	預設值
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
名稱	字串（唯讀）	資源的名稱	Yes
properties	物件	評估分類的其他屬性。	否
分類分類	分類分類陣列	分類類別列表。	否
分類學輸入	評估分類學輸入	評估分類法的輸入組態。	Yes
\---- 類型	評估分類學輸入類型	評估分類法的輸入類型。	Yes
版本	字串（唯讀）	資源的版本	Yes

EvaluationTaxonomyCreateOrUpdate

評估分類定義

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
properties	物件	評估分類的其他屬性。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
分類分類	分類分類陣列	分類類別列表。	否
分類學輸入	評估分類學輸入	評估分類法的輸入組態。	Yes
\---- 類型	評估分類學輸入類型	評估分類法的輸入類型。	Yes

評估分類學輸入

評估分類法的輸入組態。

評估判別器分類學輸入

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
agent	代理分類學輸入

名稱	類型	Description	為必填項目	預設值
型別	評估分類學輸入類型	評估分類輸入的類型。	Yes

評估分類學輸入類型

評估分類輸入的類型。

房產	價值觀
說明	評估分類輸入的類型。
Type	字串
價值	agent policy

評估分類系統輸入更新

評估分類法的輸入組態。

評估判別器分類法輸入更新

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
agent	AgentTaxonomyInputUpdate

名稱	類型	Description	為必填項目	預設值
型別	評估分類學輸入類型	評估分類輸入的類型。	Yes

評估分類學更新

評估分類定義

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
properties	物件	評估分類的其他屬性。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
分類分類	分類分類陣列	分類類別列表。	否
分類學輸入	評估分類系統輸入更新	評估分類法的輸入組態。	否
\---- 類型	評估分類學輸入類型	評估分類法的輸入類型。	Yes

評估者類別

評估者的類別

房產	價值觀
說明	評估者的類別
Type	字串
價值	quality safety agents

評估者定義

具有鑑別器的基本評估器配置

評估者的判別器定義

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

名稱	類型	Description	為必填項目	預設值
data_schema	物件	評估者輸入資料的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
init_parameters	物件	評估者輸入參數的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
計量	物件	此評估器產生的輸出指標清單	否
型別	EvaluatorDefinitionType	評估者定義的類型	Yes

EvaluatorDefinitionType

評估者定義的類型

房產	價值觀
說明	評估者定義的類型
Type	字串
價值	prompt code prompt_and_code service openai_graders

評估器度量

評估者指標

名稱	類型	Description	為必填項目	預設值
desirable_direction	評估者度量方向	指標的方向，指出值越高越好、值越低越好，還是中性	否
is_primary	布爾值	指出當有多個度量時，此度量是否為主要度量。	否
max_value	數字	指標的最大值。 如果未指定，則假設它是無界限的。	否
min_value	數字	指標的最小值	否
型別	EvaluatorMetricType	評估者的類型	否

評估者度量方向

指標的方向，指出值越高越好、值越低越好，還是中性

房產	價值觀
說明	指標的方向，指出值越高越好、值越低越好，還是中性
Type	字串
價值	increase decrease neutral

EvaluatorMetricType

評估者的類型

房產	價值觀
說明	評估者的類型
Type	字串
價值	ordinal continuous boolean

EvaluatorType

評估者的類型

房產	價值觀
說明	評估者的類型
Type	字串
價值	builtin custom

評估者版本

評估者定義

名稱	類型	Description	為必填項目	預設值
categories	EvaluatorCategory 的陣列	評估者的類別	Yes
建立於	字串（唯讀）	評估者的建立日期/時間	Yes
創建者	字串（唯讀）	評估器的創建者	Yes
定義	評估者定義	具有鑑別器的基本評估器配置	Yes
└─ data_schema	物件	評估者輸入資料的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
└─ init_parameters	物件	評估者輸入參數的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
└─ 度量	物件	此評估器產生的輸出指標清單	否
\---- 類型	EvaluatorDefinitionType	評估者定義的類型	Yes
display_name	字串	評估者的顯示名稱。 在 AI Foundry 中很容易找到評估者。 它不需要是唯一的。	否
evaluator_type	EvaluatorType	評估者的類型	Yes
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
中繼資料	物件	評估者的中繼資料	否
modified_at	字串（唯讀）	評估者的上次修改日期/時間	Yes
名稱	字串（唯讀）	資源的名稱	Yes
版本	字串（唯讀）	資源的版本	Yes

EvaluatorVersionCreate

評估者定義

名稱	類型	Description	為必填項目	預設值
categories	EvaluatorCategory 的陣列	評估者的類別	Yes
定義	評估者定義	具有鑑別器的基本評估器配置	Yes
└─ data_schema	物件	評估者輸入資料的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
└─ init_parameters	物件	評估者輸入參數的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
└─ 度量	物件	此評估器產生的輸出指標清單	否
\---- 類型	EvaluatorDefinitionType	評估者定義的類型	Yes
說明	字串	資產描述文字。	否
display_name	字串	評估者的顯示名稱。 在 AI Foundry 中很容易找到評估者。 它不需要是唯一的。	否
evaluator_type	EvaluatorType	評估者的類型	Yes
中繼資料	物件	評估者的中繼資料	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否

EvaluatorVersionUpdate

評估者定義

名稱	類型	Description	為必填項目	預設值
categories	EvaluatorCategory 的陣列	評估者的類別	否
說明	字串	資產描述文字。	否
display_name	字串	評估者的顯示名稱。 在 AI Foundry 中很容易找到評估者。 它不需要是唯一的。	否
中繼資料	物件	評估者的中繼資料	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否

FabricDataAgentToolParameters（織物資料代理工具參數）

Fabric 數據代理工具參數。

名稱	類型	Description	為必填項目	預設值
project_connections	ToolProjectConnection 的陣列	這個工具上的 project 連結。 最多只能有 1 個連線 資源附帶於工具上。	否

FileDataset版本

FileDatasetVersion 定義

名稱	類型	Description	為必填項目	預設值
connectionName （連接名稱）	字串	Azure Storage Account connection name 。 如果在創建 Dataset 之前未調用 startPendingUploadVersion，則為必需	否
dataUri	字串	資料的 URI （範例） 限制條件： 最小長度：1，模式： [a-zA-Z0-9_]	Yes
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
is參考	布林值（唯讀）	表示資料集是否持有對 storage 的參考，或是資料集本身管理 storage。 如果為 true，則刪除資料集版本時不會刪除基礎數據	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	列舉	數據集類型 可能的值：uri_file	Yes
版本	字串（唯讀）	資源的版本	Yes

FileDatasetVersionUpdate

FileDatasetVersion 定義

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	列舉	數據集類型 可能的值：uri_file	Yes

資料夾資料集版本

FileDatasetVersion 定義

名稱	類型	Description	為必填項目	預設值
connectionName （連接名稱）	字串	Azure Storage Account connection name 。 如果在創建 Dataset 之前未調用 startPendingUploadVersion，則為必需	否
dataUri	字串	資料的 URI （範例） 限制條件： 最小長度：1，模式： [a-zA-Z0-9_]	Yes
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
is參考	布林值（唯讀）	表示資料集是否持有對 storage 的參考，或是資料集本身管理 storage。 如果為 true，則刪除資料集版本時不會刪除基礎數據	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	列舉	數據集類型 可能的值：uri_folder	Yes
版本	字串（唯讀）	資源的版本	Yes

FolderDatasetVersionUpdate

FileDatasetVersion 定義

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	列舉	數據集類型 可能的值：uri_folder	Yes

FunctionToolCall

函式工具呼叫的細節。

名稱	類型	Description	為必填項目	預設值
arguments	字串	呼叫函數所使用的引數，由模型以 JSON 格式產生。	Yes
名稱	字串	要呼叫的函式名稱。	Yes

HostedAgentDefinition

託管代理程式定義。

名稱	類型	Description	為必填項目	預設值
container_protocol_versions	協定版本記錄陣列	代理程式支援容器輸入通訊的通訊協定。	Yes
cpu	字串	託管代理程式的 CPU 組態。	Yes
environment_variables	物件	要在託管代理程式容器中設定的環境變數。	否
圖片	字串	代理的影像識別碼，適用於基於映像的託管代理。	否
類型	列舉	可能的值：hosted	Yes
記憶體	字串	託管代理程式的記憶體組態。	Yes
rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
└─ rai_policy_name	字串	要套用的 RAI 原則名稱。	Yes
工具	OpenAI.Tool 的陣列	託管代理程式模型在產生回應時可能呼叫的一系列工具。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。	否

每小時重複排程

每小時週期計劃。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：Hourly	Yes

HumanEvaluationPreviewRuleAction

人工評估的評估規則動作。

名稱	類型	Description	為必填項目	預設值
樣板ID	資產	已儲存資產的識別碼。	Yes
型別	列舉	可能的值：humanEvaluationPreview	Yes

Index

索引資源定義

指數的判別子

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

名稱	類型	Description	為必填項目	預設值
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	IndexType		Yes
版本	字串（唯讀）	資源的版本	Yes

IndexType

房產	價值觀
Type	字串
價值	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

索引更新

索引資源定義

IndexUpdate 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	IndexType		Yes

洞察力

叢集深入解析的回應內文。

名稱	類型	Description	為必填項目	預設值
顯示名稱	字串	深入解析的使用者易記顯示名稱。	Yes
id	字串（唯讀）	深入解析報表的唯一識別碼。	Yes
中繼資料	InsightsMetadata （唯讀）	有關見解的中繼資料。	Yes
└─ 完成於	字串	深入解析完成的時間戳記。	否
└─ 創造於	字串	建立見解的時間戳記。	Yes
要求	洞察請求	深入解析報告的要求。	Yes
\---- 類型	洞察類型	請求的類型。	Yes
結果	InsightResult （唯讀）	見解的結果。	否
\---- 類型	洞察類型	深入解析結果的類型。	Yes
狀態	Azure。Core.Foundations.OperationState（唯讀）	列舉描述允許的作業狀態。	Yes

洞察集群

分析樣本的叢集。

名稱	類型	Description	為必填項目	預設值
說明	字串	分析叢集的描述。	Yes
id	字串	分析叢集的識別碼。	Yes
標籤	字串	叢集的標籤	Yes
取樣	InsightSample 陣列	屬於此叢集的範例清單。 如果樣本是子叢集的一部分，則為空。	否
子星團	InsightCluster 陣列	此叢集內的子叢集清單。 如果不存在子叢集，則為空。	否
意	字串	對集群的建議	Yes
建議標題	字串	叢集建議的標題	Yes
weight	整數	分析叢集的權重。 這表示叢集中的樣本數。	Yes

InsightModelConfiguration

深入解析產生中使用的模型的組態。

名稱	類型	Description	為必填項目	預設值
modelDeploymentName	字串	要評估的模型部署。 可接受僅部署名稱，或連同連線名稱為 {connectionName}/<modelDeploymentName>。	Yes

洞察請求

深入解析報告的要求。

InsightRequest 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	評估比較洞察請求

名稱	類型	Description	為必填項目	預設值
型別	洞察類型	見解的要求。	Yes

洞察結果

見解的結果。

InsightResult 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
EvaluationComparison	評估比較洞察結果
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

名稱	類型	Description	為必填項目	預設值
型別	洞察類型	見解的要求。	Yes

洞察範例

分析樣本。

InsightSample 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
EvaluationResultSample	評估結果範例

名稱	類型	Description	為必填項目	預設值
相關資訊	物件	分析樣本相關性的相關資訊。	Yes
features	物件	有助於在 UX 中對資料進行額外篩選的功能。	Yes
id	字串	分析樣本的唯一識別碼。	Yes
型別	取樣類型	分析中使用的樣本類型。	Yes

洞察排程任務

排程的洞察任務。

名稱	類型	Description	為必填項目	預設值
組態	物件	工作的設定。	否
深入解析	眼光	叢集深入解析的回應內文。	Yes
└─ 顯示名稱	字串	深入解析的使用者易記顯示名稱。	Yes
‧----識別碼	字串（唯讀）	深入解析報表的唯一識別碼。	Yes
~---- 元數據	InsightsMetadata （唯讀）	深入解析報表的中繼資料。	Yes
└─ 請求	洞察請求	請求深入分析。	Yes
└─ 結果	InsightResult （唯讀）	深入解析報告的結果。	否
└─ 狀態	Azure。Core.Foundations.OperationState（唯讀）	見解的當前狀態。	Yes
型別	列舉	可能的值：Insight	Yes

洞察摘要

錯誤叢集分析的摘要。

名稱	類型	Description	為必填項目	預設值
方法	字串	用於叢集的方法。	Yes
樣本計數	整數	分析的樣本總數。	Yes
uniqueClusterCount	整數	唯一叢集總數。	Yes
uniqueSubclusterCount	整數	唯一子叢集標籤的總數。	Yes
使用方式	ClusterTokenUsage	叢集分析的記號使用量	Yes
└─ inputTokenUsage	整數	輸入權杖使用方式	Yes
└─ outputTokenUsage	整數	輸出權杖使用情況	Yes
└─ totalTokenUsage	整數	權杖使用量總計	Yes

洞察類型

見解的要求。

房產	價值觀
說明	見解的要求。
Type	字串
價值	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

洞察中繼資料

有關見解的中繼資料。

名稱	類型	Description	為必填項目	預設值
完成於	字串	深入解析完成的時間戳記。	否
創建於	字串	建立見解的時間戳記。	Yes

ItemGenerationParams

代表用於控制物品產生操作的參數集合。

ItemGenerationParams 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	回應檢索項目生成參數

名稱	類型	Description	為必填項目	預設值
型別	ItemGenerationParamsType	紅隊物品生成的參數類型。	Yes

ItemGenerationParamsType

紅隊物品生成的參數類型。

房產	價值觀
說明	紅隊物品生成的參數類型。
Type	字串
價值	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition

名稱	類型	Description	為必填項目	預設值
id	字串（唯讀）	資產 ID，資產的唯一標識符	否
名稱	字串（唯讀）	資源的名稱	Yes
型別	列舉	索引類型 可能的值：ManagedAzureSearch	Yes
版本	字串（唯讀）	資源的版本	Yes

ManagedAzureAISearchIndexUpdate

Managed Azure AI Search Index Definition

名稱	類型	Description	為必填項目	預設值
說明	字串	資產描述文字。	否
tags	物件	標記字典。 標記可以新增、移除和更新。	否
型別	列舉	索引類型 可能的值：ManagedAzureSearch	Yes

記憶體項目

儲存在記憶體存放區中的單一記憶體項目，包含內容和中繼資料。

記憶項目的判別器

此元件會使用 屬性 kind 來區分不同的類型：

類型值	Schema
user_profile	使用者設定記憶項目
chat_summary	聊天摘要記憶項目

名稱	類型	Description	為必填項目	預設值
內容	字串	記憶體的內容。	Yes
類型	記憶物品種類	記憶體項目種類。	Yes
memory_id	字串	記憶體項目的唯一 ID。	Yes
範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes
updated_at	整數	記憶體項目的最後更新時間。	Yes

記憶物品種類

記憶體項目種類。

房產	價值觀
說明	記憶體項目種類。
Type	字串
價值	user_profile chat_summary

記憶體操作

代表對記憶體項目執行的單一記憶體作業 （建立、更新或刪除）。

名稱	類型	Description	為必填項目	預設值
類型	記憶體操作類型	記憶體操作種類。	Yes
memory_item	記憶項目	儲存在記憶體存放區中的單一記憶體項目，包含內容和中繼資料。	Yes
\---- 內容	字串	記憶體的內容。	Yes
└─ 善良	記憶物品種類	記憶項目的種類。	Yes
└─ memory_id	字串	記憶體項目的唯一 ID。	Yes
└─ 範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes
└─ updated_at	整數	記憶體項目的最後更新時間。	Yes

記憶體操作類型

記憶體操作種類。

房產	價值觀
說明	記憶體操作種類。
Type	字串
價值	create update delete

記憶搜尋項目

從記憶體搜尋擷取的記憶體項目。

名稱	類型	Description	為必填項目	預設值
memory_item	記憶項目	儲存在記憶體存放區中的單一記憶體項目，包含內容和中繼資料。	Yes
\---- 內容	字串	記憶體的內容。	Yes
└─ 善良	記憶物品種類	記憶項目的種類。	Yes
└─ memory_id	字串	記憶體項目的唯一 ID。	Yes
└─ 範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes
└─ updated_at	整數	記憶體項目的最後更新時間。	Yes

記憶搜尋選項

記憶體搜尋選項。

名稱	類型	Description	為必填項目	預設值
max_memories	整數	要傳回的記憶體項目數目上限。	否

記憶體搜尋預覽工具

將記憶整合到智能體中的工具。

名稱	類型	Description	為必填項目	預設值
memory_store_name	字串	要使用的記憶體存放區名稱。	Yes
範圍	字串	用來分組及隔離記憶體的命名空間，例如使用者 ID。 限制可以檢索或更新的記憶。 使用特殊變數 {{$userId}} 將記憶體範圍限定為目前登入的使用者。	Yes
search_options	記憶搜尋選項	記憶體搜尋選項。	否
└─ max_memories	整數	要傳回的記憶體項目數目上限。	否
型別	列舉	工具的類型。 一律為 memory_search_preview。 可能的值：memory_search_preview	Yes
update_delay	整數	閒置後更新記憶體之前的等待時間（秒）。 預設值為 300。	否	300

MemorySearchToolCallItemParam

名稱	類型	Description	為必填項目	預設值
results	MemorySearchItem 陣列	從記憶體搜尋傳回的結果。	否
型別	列舉	可能的值：memory_search_call	Yes

記憶搜尋工具呼叫項目資源

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
response_id	字串	該項目所建立的回應。	否
results	MemorySearchItem 陣列	從記憶體搜尋傳回的結果。	否
狀態	列舉	記憶體搜尋工具呼叫的狀態。 下列其中一項：in_progress searching， completed， incompletefailed或 ， 可能的值：in_progress、searching、completed、incomplete、failed	Yes
型別	列舉	可能的值：memory_search_call	Yes

MemoryStoreDefaultDefinition

預設記憶體存放區實作。

名稱	類型	Description	為必填項目	預設值
chat_model	字串	用於記憶體處理的聊天完成模型部署的名稱或識別碼。	Yes
embedding_model	字串	用於記憶體處理的內嵌模型部署的名稱或識別碼。	Yes
類型	列舉	記憶體儲存的類型。 可能的值：default	Yes
options	MemoryStoreDefaultOptions	預設記憶體存放區組態。	否
└─ chat_summary_enabled	布爾值	是否啟用聊天摘要擷取與storage。 預設值是「true」。	Yes	對
└─ user_profile_details	字串	要擷取和儲存的特定類別或類型的使用者設定檔資訊。	否
└─ user_profile_enabled	布爾值	是否啟用使用者設定檔擷取與storage。 預設值是「true」。	Yes	對

MemoryStoreDefaultOptions

預設記憶體存放區組態。

名稱	類型	Description	為必填項目	預設值
chat_summary_enabled	布爾值	是否啟用聊天摘要擷取與storage。 預設值是「true」。	Yes	對
user_profile_details	字串	要擷取和儲存的特定類別或類型的使用者設定檔資訊。	否
user_profile_enabled	布爾值	是否啟用使用者設定檔擷取與storage。 預設值是「true」。	Yes	對

MemoryStoreDefinition

記憶體存放區組態的基本定義。

MemoryStoreDefinition 的判別器

此元件會使用 屬性 kind 來區分不同的類型：

類型值	Schema
default	MemoryStoreDefaultDefinition

名稱	類型	Description	為必填項目	預設值
類型	記憶儲存類型	要使用的記憶體存放區實作類型。	Yes

MemoryStoreDeleteScopeResponse

從範圍中刪除記憶體的回應。

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值	刪除作業是否成功。	Yes
名稱	字串	記憶體存放區的名稱。	Yes
物件	列舉	物件類型。 一律為「memory_store.scope.deleted」。 可能的值：memory_store.scope.deleted	Yes
範圍	字串	刪除記憶體的範圍。	Yes

記憶儲存類型

要使用的記憶體存放區實作類型。

房產	價值觀
說明	要使用的記憶體存放區實作類型。
Type	字串
價值	default

MemoryStoreObject

可以儲存和檢索使用者記憶的記憶體儲存。

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立記憶體存放區時的 Unix 時間戳記 （秒）。	Yes
定義	MemoryStoreDefinition	記憶體存放區組態的基本定義。	Yes
└─ 善良	記憶儲存類型	記憶體儲存的類型。	Yes
說明	字串	記憶體存放區的人類可讀描述。 限制： max長度：512	否
id	字串	記憶體存放區的唯一識別碼。	Yes
中繼資料	物件	與記憶體存放區相關聯的任意索引鍵值中繼資料。	否
名稱	字串	記憶體存放區的名稱。 限制： 最大長度：256	Yes
物件	列舉	物件類型，一律為 'memory_store'。 可能的值：memory_store	Yes
updated_at	整數	記憶體存放區上次更新時的 Unix 時間戳記 （秒）。	Yes

記憶體儲存操作使用法

記憶體存放區作業的使用統計資料。

名稱	類型	Description	為必填項目	預設值
embedding_tokens	整數	內嵌權杖的數目。	Yes
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
cached_tokens	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.回應使用輸出代幣詳情		Yes
└─ 推理詞元	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

記憶儲存搜尋回應

記憶體搜尋回應。

名稱	類型	Description	為必填項目	預設值
回憶	MemorySearchItem 陣列	在搜尋作業期間找到的相關記憶體項目。	Yes
search_id	字串	此搜尋請求的唯一 ID。 在後續要求中previous_search_id使用此值來執行增量搜尋。	Yes
使用方式	記憶體儲存操作使用法	記憶體存放區作業的使用統計資料。	Yes
└─ embedding_tokens	整數	內嵌權杖的數目。	Yes
└─ 輸入標記 (input_tokens)	OpenAI.integer	輸入令牌的數目。	Yes
輸入標記細節	OpenAI.ResponseUsageInputTokensDetails	輸入權杖的詳細明細。	Yes
└─ output_tokens（輸出符號）	OpenAI.integer	輸出令牌的數目。	Yes
└─ output_tokens_details	OpenAI.回應使用輸出代幣詳情	輸出權杖的詳細明細。	Yes
total_tokens	OpenAI.integer	使用的令牌總數。	Yes

MemoryStoreUpdateCompletedResult

記憶體更新結果。

名稱	類型	Description	為必填項目	預設值
memory_operations	MemoryOperation 陣列	更新期間執行的個別記憶體作業清單。	Yes
使用方式	記憶體儲存操作使用法	記憶體存放區作業的使用統計資料。	Yes
└─ embedding_tokens	整數	內嵌權杖的數目。	Yes
└─ 輸入標記 (input_tokens)	OpenAI.integer	輸入令牌的數目。	Yes
輸入標記細節	OpenAI.ResponseUsageInputTokensDetails	輸入權杖的詳細明細。	Yes
└─ output_tokens（輸出符號）	OpenAI.integer	輸出令牌的數目。	Yes
└─ output_tokens_details	OpenAI.回應使用輸出代幣詳情	輸出權杖的詳細明細。	Yes
total_tokens	OpenAI.integer	使用的令牌總數。	Yes

記憶儲存更新回應

提供記憶體存放區更新作業的狀態。

名稱	類型	Description	為必填項目	預設值
錯誤	OpenAI.錯誤		否
└─ 附加資訊	物件		否
└─ 程式碼	字串（可空）		Yes
└─ debugInfo	物件		否
|---- 詳細數據	OpenAI.Error 的陣列		否
|---- 訊息	字串		Yes
└─ 參數	字串（可空）		否
\---- 類型	字串		否
結果	MemoryStoreUpdateCompletedResult	記憶體更新結果。	否
└─ memory_operations	MemoryOperation 陣列	更新期間執行的個別記憶體作業清單。	Yes
|---- 使用方式	記憶體儲存操作使用法	與記憶體更新作業相關聯的使用統計資料。	Yes
狀態	MemoryStoreUpdateStatus	記憶體存放區更新作業的狀態。	Yes
superseded_by	字串	當狀態為「取代」時，作業被取代的update_id。	否
update_id	字串	此更新請求的唯一 ID。 在後續請求中使用此值作為previous_update_id，以執行增量更新。	Yes

MemoryStoreUpdateStatus

記憶體存放區更新作業的狀態。

房產	價值觀
Type	字串
價值	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

Microsoft Fabric 工具的輸入定義資訊，用於配置代理。

名稱	類型	Description	為必填項目	預設值
fabric_dataagent_preview	FabricDataAgentToolParameters（織物資料代理工具參數）	Fabric 數據代理工具參數。	Yes
└─ project_connections	ToolProjectConnection 的陣列	這個工具上的 project 連結。 最多只能有 1 個連線 資源附帶於工具上。 限制： maxItems：1	否
型別	列舉	物件類型，永遠是「fabric_dataagent_preview」。 可能的值：fabric_dataagent_preview	Yes

模型部署

模型部署定義

名稱	類型	Description	為必填項目	預設值
capabilities	物件（唯讀）	已部署模型的功能	Yes
connectionName （連接名稱）	字串（唯讀）	部署來自的連接的名稱	否
modelName	字串（唯讀）	Publisher 特定型號名稱	Yes
模型出版商	字串（唯讀）	已部署模型的 publisher 名稱	Yes
modelVersion	字串（唯讀）	Publisher 專屬版本的已部署模型	Yes
名稱	字串（唯讀）	部署的名稱	Yes
sku	Sku （唯讀）	Sku 資訊	Yes
└─ 容量	整數	Sku 容量	Yes
└─ 家族	字串	Sku 家族	Yes
\---- 名稱	字串	Sku 名稱	Yes
└─ 尺寸	字串	Sku 大小	Yes
└─ 層級	字串	Sku 層	Yes
型別	列舉	部署的類型 可能的值：ModelDeployment	Yes

模型取樣參數

代表一組用於控制語言模型在文字生成過程中取樣行為的參數。

名稱	類型	Description	為必填項目	預設值
max_completion_tokens	整數	完成過程中允許的最大代幣數量。	Yes
seed	整數	這是可重現性的隨機種子。	Yes
溫度	數字	取樣的溫度參數。	Yes
top_p	數字	核取樣的top-p參數。	Yes

ModelSamplingParamsUpdate

代表一組用於控制語言模型在文字生成過程中取樣行為的參數。

名稱	類型	Description	為必填項目	預設值
max_completion_tokens	整數	完成過程中允許的最大代幣數量。	否
seed	整數	這是可重現性的隨機種子。	否
溫度	數字	取樣的溫度參數。	否
top_p	數字	核取樣的top-p參數。	否

每月重複排程

每月週期排程。

名稱	類型	Description	為必填項目	預設值
daysOfMonth	整數陣列	週期排程的月份天數。	Yes
型別	列舉	每月週期性類型。 可能的值：Monthly	Yes

無認證憑證

不需要身份驗證的憑據

名稱	類型	Description	為必填項目	預設值
型別	列舉	證書類型 可能的值：None	Yes

OAuthConsentRequestOutputItem

向服務請求使用者執行 OAuth 同意。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
consent_link	字串	使用者可用來執行 OAuth 同意的連結。	Yes
id	字串		Yes
response_id	字串	該項目所建立的回應。	否
伺服器標籤	字串	OAuth 同意請求的伺服器標籤。	Yes
型別	列舉	可能的值：oauth_consent_request	Yes

一次觸發

一次性觸發。

名稱	類型	Description	為必填項目	預設值
timeZone	字串	一次性觸發器的時區。	否	UTC
觸發	字串	ISO 8601 格式的一次性觸發的日期和時間。	Yes
型別	列舉	可能的值：OneTime	Yes

OpenAI.Annotation

一個適用於輸出文字範圍的註解。

OpenAI.Annotation 的鑑別子

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

房產	價值觀
Type	字串
價值	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

房產	價值觀
Type	字串
價值	completed failed

OpenAI.ApplyPatchCallOutputStatusParam

apply_patch工具呼叫輸出的結果值報告。

房產	價值觀
Type	字串
價值	completed failed

OpenAI.ApplyPatchCallStatus（開放AI）。ApplyPatchCallStatus（查詢狀態）

房產	價值觀
Type	字串
價值	in_progress completed

OpenAI.ApplyPatchCallStatusParam

apply_patch工具呼叫的狀態值報告。

房產	價值觀
Type	字串
價值	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

說明如何透過 apply_patch 工具建立檔案的說明。

名稱	類型	Description	為必填項目	預設值
差異	字串	申請差異很大。	Yes
路徑	字串	檔案建立的路徑。	Yes
型別	列舉	用提供的差異建立一個新檔案。 可能的值：create_file	Yes

OpenAI.ApplyPatchCreateFileOperationParam

透過 apply_patch 工具建立新檔案的說明。

名稱	類型	Description	為必填項目	預設值
差異	字串	建立檔案時要套用統一差異內容。 限制條件： maxLength： 10485760	Yes
路徑	字串	相對於工作區根目錄建立的檔案路徑。 限制條件： 最小長度：1	Yes
型別	列舉	作業類型。 一律為 create_file。 可能的值：create_file	Yes

OpenAI.ApplyPatchDeleteFileOperation

說明如何透過apply_patch工具刪除檔案。

名稱	類型	Description	為必填項目	預設值
路徑	字串	檔案的路徑。	Yes
型別	列舉	刪除指定的檔案。 可能的值：delete_file	Yes

OpenAI.ApplyPatchDeleteFileOperationParam

透過 apply_patch 工具刪除現有檔案的說明。

名稱	類型	Description	為必填項目	預設值
路徑	字串	相對於工作區根目錄，檔案要刪除的路徑。 限制條件： 最小長度：1	Yes
型別	列舉	作業類型。 一律為 delete_file。 可能的值：delete_file	Yes

OpenAI.ApplyPatchFileOperation

其中一種create_file、delete_file或update_file操作透過apply_patch應用。

OpenAI 的判別器。ApplyPatchFileOperation

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

房產	價值觀
Type	字串
價值	create_file delete_file update_file

OpenAI.ApplyPatchOperationParam

這是提供給apply_patch工具的create_file、delete_file或update_file操作之一。

OpenAI 的判別器。ApplyPatchOperationParam

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

房產	價值觀
Type	字串
價值	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

允許助理使用統一差異來建立、刪除或更新檔案。

名稱	類型	Description	為必填項目	預設值
型別	列舉	工具的類型。 一律為 apply_patch。 可能的值：apply_patch	Yes

OpenAI.ApplyPatchUpdateFileOperation

說明如何透過 apply_patch 工具更新檔案的說明。

名稱	類型	Description	為必填項目	預設值
差異	字串	申請差異很大。	Yes
路徑	字串	檔案更新路徑。	Yes
型別	列舉	用提供的差異檔更新現有檔案。 可能的值：update_file	Yes

OpenAI.ApplyPatchUpdateFileOperationParam

透過apply_patch工具更新現有檔案的說明。

名稱	類型	Description	為必填項目	預設值
差異	字串	統一差異內容套用到現有檔案。 限制條件： maxLength： 10485760	Yes
路徑	字串	檔案相對於工作區根的更新路徑。 限制條件： 最小長度：1	Yes
型別	列舉	作業類型。 一律為 update_file。 可能的值：update_file	Yes

OpenAI.ApproximateLocation（大致位置）

名稱	類型	Description	為必填項目	預設值
城市	字串（可空）		否
country	字串（可空）		否
區域	字串（可空）		否
timezone	字串（可空）		否
型別	列舉	位置近似的類型。 一律為 approximate。 可能的值：approximate	Yes

OpenAI.ChatCompletionTool（聊天完成工具）

一個可以用來產生回應的功能工具。

名稱	類型	Description	為必填項目	預設值
函式	OpenAI.FunctionObject		Yes
型別	列舉	工具的類型。 目前僅支援 function。 可能的值：function	Yes

OpenAI.ChatModel

房產	價值觀
Type	字串
價值	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

房產	價值觀
Type	字串
價值	left right wheel back forward

OpenAI.ClickParam

按一下動作。

名稱	類型	Description	為必填項目	預設值
按鈕	OpenAI.ClickButtonType		Yes
型別	列舉	指定事件類型。 對於點擊動作，這個性質總是 click。 可能的值：click	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.CodeInterpreterContainerAuto

程式代碼解釋器容器的設定。 選擇性地指定要執行程式碼之檔案的識別碼。

名稱	類型	Description	為必填項目	預設值
文件識別碼	字串陣列	一個上傳的檔案選擇性清單，可提供給您的程式使用。	否
記憶體限制	OpenAI.ContainerMemoryLimit （可空）		否
型別	列舉	一律為 auto。 可能的值：auto	Yes

OpenAI.CodeInterpreterOutputImage

程式碼解釋器生成的圖像輸出。

名稱	類型	Description	為必填項目	預設值
型別	列舉	輸出的類型。 一律為 image。 可能的值：image	Yes
URL	字串	程式代碼解釋器中影像輸出的 URL。	Yes

OpenAI.CodeInterpreterOutputLogs

程式碼解釋器的日誌輸出。

名稱	類型	Description	為必填項目	預設值
記錄	字串	程式碼解釋器的日誌輸出。	Yes
型別	列舉	輸出的類型。 一律為 logs。 可能的值：logs	Yes

OpenAI.CodeInterpreterTool

執行 Python 程式代碼以協助產生提示回應的工具。

名稱	類型	Description	為必填項目	預設值
容器	string 或 OpenAI.CodeInterpreterContainerAuto	程式碼解譯器容器。 可以是容器 ID 或物件 指定上傳的檔案 ID，以供你的程式碼使用，並附帶 可選 memory_limit 設定。 如果沒有提供，服務就會自動處理。	否
型別	列舉	程式代碼解釋器工具的類型。 一律為 code_interpreter。 可能的值：code_interpreter	Yes

OpenAI.CompactResource

名稱	類型	Description	為必填項目	預設值
建立於	整數	Unix 時間戳記（以秒計）顯示壓縮對話建立時的狀態。	Yes
id	字串	壓縮回應的唯一識別碼。	Yes
物件	列舉	物件類型。 一律為 response.compaction。 可能的值：response.compaction	Yes
輸出	OpenAI.OutputItem 的陣列	輸出項目的壓縮清單。 這是所有使用者訊息的清單，後面接著一個壓縮項目。	Yes
使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	Yes
└─ 輸入標記 (input_tokens)	OpenAI.integer	輸入令牌的數目。	Yes
輸入標記細節	OpenAI.ResponseUsageInputTokensDetails	輸入權杖的詳細明細。	Yes
└─ output_tokens（輸出符號）	OpenAI.integer	輸出令牌的數目。	Yes
└─ output_tokens_details	OpenAI.回應使用輸出代幣詳情	輸出權杖的詳細明細。	Yes
total_tokens	OpenAI.integer	使用的令牌總數。	Yes

OpenAI.CompactResponseMethodPublicBody

名稱	類型	Description	為必填項目	預設值
輸入	OpenAI.InputItem 的字串或陣列		否
instructions	字串（可空）		否
型號	OpenAI.ModelIdsCompaction	用於產生回應的型號識別碼，如 gpt-5 或 o3。 OpenAI 提供多種不同功能、效能特性及價格區間的模型。 請參閱 模型指南 ，瀏覽並比較可用模型。	Yes
previous_response_id	字串（可空）		否

OpenAI.ComparisonFilter

篩選器用於使用定義的比較操作將指定的屬性鍵與給定值進行比較。

名稱	類型	Description	為必填項目	預設值
Key	字串	用來與值比較的鍵。	Yes
型別	列舉	指定比較運算子：eq， ne， gtgteltltein。 nin - eq：等於 - ne：不等於 - gt：大於 - gte：大於或等於 - lt：小於 - lte：小於或等於 - in： 在 - nin：不在 可能的值：eq、、、negtgte、lt、lte	Yes
value	字串、OpenAI.numeric、布林值或 OpenAI.ComparisonFilterValueItems 陣列	要與屬性索引鍵比較的值;支援字串、數字或布爾型別。	Yes

OpenAI.ComparisonFilterValueItems

類型：字串或 OpenAI.numeric

OpenAI.CompoundFilter

使用 and 或 or結合多個篩選。

名稱	類型	Description	為必填項目	預設值
filters	OpenAI.ComparisonFilter 或物件的陣列	要組合的濾鏡陣列。 項目可以是 ComparisonFilter 或 CompoundFilter。	Yes
型別	列舉	工作類型： and 或 or。 可能的值： and、 or	Yes

OpenAI.ComputerAction

OpenAI.ComputerAction 的鑑別子

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
click	OpenAI.ClickParam
double_click	OpenAI.雙擊動作
drag	OpenAI.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.截圖
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI。等等

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionType

房產	價值觀
Type	字串
價值	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

電腦呼叫的擱置安全性檢查。

名稱	類型	Description	為必填項目	預設值
字碼	字串（可空）		否
id	字串	擱置安全性檢查的識別碼。	Yes
訊息	字串（可空）		否

OpenAI.ComputerEnvironment

房產	價值觀
Type	字串
價值	windows mac linux ubuntu browser

OpenAI.Computer截圖內容

一張電腦截圖。

名稱	類型	Description	為必填項目	預設值
檔案識別碼 (file_id)	字串（可空）		Yes
image_url	字串		Yes
型別	列舉	指定事件類型。 針對電腦螢幕快照，這個屬性一律設定為 computer_screenshot。 可能的值：computer_screenshot	Yes

OpenAI.Computer截圖圖片

計算機螢幕快照影像，與計算機使用工具搭配使用。

名稱	類型	Description	為必填項目	預設值
檔案識別碼 (file_id)	字串	包含螢幕快照之已上傳檔案的標識碼。	否
image_url	字串	螢幕快照影像的 URL。	否
型別	列舉	指定事件類型。 對於電腦截圖，這個屬性是 總是設定為 computer_screenshot。 可能的值：computer_screenshot	Yes

OpenAI.電腦使用預覽工具

控制虛擬電腦的工具。

名稱	類型	Description	為必填項目	預設值
顯示高度	OpenAI.integer		Yes
顯示寬度	OpenAI.integer		Yes
環境	OpenAI.ComputerEnvironment		Yes
型別	列舉	計算機使用工具的類型。 一律為 computer_use_preview。 可能的值：computer_use_preview	Yes

OpenAI.ContainerFileCitationBody

一個用於產生模型回應的容器檔案引用。

名稱	類型	Description	為必填項目	預設值
container_id	字串	容器檔案的 ID。	Yes
end_index	OpenAI.integer		Yes
檔案識別碼 (file_id)	字串	檔案的識別碼。	Yes
filename	字串	引用容器檔案的檔名。	Yes
start_index	OpenAI.integer		Yes
型別	列舉	容器檔案引用的類型。 一律為 container_file_citation。 可能的值：container_file_citation	Yes

OpenAI.ContainerMemoryLimit（開放式儲存容器記憶限制）

房產	價值觀
Type	字串
價值	1g 4g 16g 64g

OpenAI.ConversationItem

對話中的單一項目。 可能的類型集合與output回應物件的類型相同。

OpenAI 的識別器。ConversationItem

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput（開放AI）項目功能（ShellCallOutput）
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（開放AI.ConversationItemcustomToolCallOutput）

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ConversationItemType		Yes

OpenAI.ConversationItemApplyPatchToolCall

一個工具呼叫，透過建立、刪除或更新檔案來套用檔案差異。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。	Yes
創建者	字串	創建這個工具呼叫的實體的 ID。	否
id	字串	套用補丁工具呼叫的唯一 ID。 透過 API 傳回此項目時填入。	Yes
作業	OpenAI.ApplyPatchFileOperation	其中一種create_file、delete_file或update_file操作透過apply_patch應用。	Yes
\---- 類型	OpenAI.ApplyPatchFileOperationType		Yes
狀態	OpenAI.ApplyPatchCallStatus（開放AI）。ApplyPatchCallStatus（查詢狀態）		Yes
型別	列舉	項目的類型。 一律為 apply_patch_call。 可能的值：apply_patch_call	Yes

OpenAI.ConversationItemApplyPatchToolCallOutput

由 apply patch tool 呼叫所輸出的輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。	Yes
創建者	字串	建立此工具的實體 ID 呼叫輸出。	否
id	字串	apply patch 工具呼叫輸出的唯一 ID。 透過 API 傳回此項目時填入。	Yes
輸出	字串（可空）		否
狀態	OpenAI.ApplyPatchCallOutputStatus		Yes
型別	列舉	項目的類型。 一律為 apply_patch_call_output。 可能的值：apply_patch_call_output	Yes

OpenAI.ConversationItemCodeInterpreterToolCall

執行程式代碼的工具呼叫。

名稱	類型	Description	為必填項目	預設值
字碼	字串（可空）		Yes
container_id	字串	用來執行程式代碼之容器的標識碼。	Yes
id	字串	程式代碼解釋器工具呼叫的唯一標識符。	Yes
輸出	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的陣列		Yes
狀態	列舉	程式代碼解釋器工具呼叫的狀態。 有效值為 in_progress、completed、incomplete、interpreting 和 failed。 可能的值：in_progress、completed、incomplete、interpreting、failed	Yes
型別	列舉	程式代碼解釋器工具呼叫的類型。 一律為 code_interpreter_call。 可能的值：code_interpreter_call	Yes

OpenAI.ConversationItemComputerToolCall

對電腦使用工具發出的工具呼叫。 更多資訊請參閱 computer 使用指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.ComputerAction		Yes
call_id	字串	使用輸出回應工具呼叫時所使用的識別碼。	Yes
id	字串	計算機呼叫的唯一標識碼。	Yes
pending_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	電腦呼叫的擱置安全性檢查。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	計算機呼叫的類型。 一律為 computer_call。 可能的值：computer_call	Yes

OpenAI.ConversationItemComputerToolCallOutputResource

名稱	類型	Description	為必填項目	預設值
acknowledged_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	API 報告的安全檢查已得到以下項目的認可： 開發人員。	否
call_id	字串	產生輸出之計算機工具呼叫的標識碼。	Yes
id	字串	計算機工具呼叫輸出的識別碼。	否
輸出	OpenAI.Computer截圖圖片	計算機螢幕快照影像，與計算機使用工具搭配使用。	Yes
狀態	列舉	訊息輸入的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回輸入項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	計算機工具呼叫輸出的類型。 一律為 computer_call_output。 可能的值：computer_call_output	Yes

OpenAI.ConversationItemCustomToolCall

呼叫模型建立的自訂工具。

名稱	類型	Description	為必填項目	預設值
call_id	字串	一個用於將此自訂工具呼叫映射到工具呼叫輸出的識別碼。	Yes
id	字串	OpenAI 平台自訂工具呼叫的唯一 ID。	否
輸入	字串	模型產生的自訂工具呼叫輸入。	Yes
名稱	字串	正在被呼叫的自訂工具名稱。	Yes
型別	列舉	自訂工具呼叫的類型。 一律為 custom_tool_call。 可能的值：custom_tool_call	Yes

OpenAI.ConversationItemCustomToolCallOutput（開放AI.ConversationItemcustomToolCallOutput）

你程式碼中自訂工具呼叫的輸出，會回傳給模型。

名稱	類型	Description	為必填項目	預設值
call_id	字串	呼叫 ID，用來將這個自訂工具呼叫輸出對應到自訂工具呼叫。	Yes
id	字串	OpenAI 平台中自訂工具呼叫輸出的唯一 ID。	否
輸出	OpenAI.FunctionAndCustomToolCallOutput 的字串或陣列	你的程式碼產生的自訂工具呼叫輸出。 可以是字串或輸出內容的清單。	Yes
型別	列舉	自訂工具呼叫輸出的類型。 一律為 custom_tool_call_output。 可能的值：custom_tool_call_output	Yes

OpenAI.ConversationItemFileSearchToolCall

檔案搜尋工具呼叫的結果。 更多資訊請參閱 file 搜尋指南。

名稱	類型	Description	為必填項目	預設值
id	字串	檔案搜尋工具呼叫的唯一標識符。	Yes
queries	字串陣列	用來搜尋檔案的查詢。	Yes
results	OpenAI.FileSearchToolCallResults 的陣列		否
狀態	列舉	檔案搜尋工具呼叫的狀態。 下列其中一項：in_progress searching、 或 incomplete、 failed 可能的值：in_progress、searching、completed、incomplete、failed	Yes
型別	列舉	檔案搜尋工具呼叫的類型。 一律為 file_search_call。 可能的值：file_search_call	Yes

OpenAI.ConversationItemFunctionShellCall

一個在受管理環境中執行一個或多個 shell 指令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.FunctionShellAction	執行一個殼狀指令。	Yes
└─ 指令	字串陣列		Yes
└─ max_output_length	OpenAI.integer （nullable）		Yes
└─ timeout_ms	OpenAI.integer （nullable）		Yes
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。	Yes
創建者	字串	創建這個工具呼叫的實體的 ID。	否
id	字串	shell 工具呼叫的唯一 ID。 透過 API 傳回此項目時填入。	Yes
狀態	OpenAI.LocalShellCallStatus（開放人工智慧）LocalShellCallStatus（狀態）		Yes
型別	列舉	項目的類型。 一律為 shell_call。 可能的值：shell_call	Yes

OpenAI.ConversationItemFunctionShellCallOutput（開放AI）項目功能（ShellCallOutput）

是 shell 工具呼叫所發出的輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。	Yes
創建者	字串	創建該項目的演員識別碼。	否
id	字串	shell呼叫輸出的唯一ID。 透過 API 傳回此項目時填入。	Yes
max_output_length	OpenAI.integer （nullable）		Yes
輸出	OpenAI.FunctionShellCallOutputContent 的陣列	一個包含 shell 呼叫輸出內容的陣列	Yes
型別	列舉	shell呼叫輸出的類型。 一律為 shell_call_output。 可能的值：shell_call_output	Yes

OpenAI.ConversationItemFunctionToolCallOutputResource

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函式工具呼叫輸出的唯一標識碼。 當這個項目時，已填滿 透過 API 回傳。	否
輸出	OpenAI.FunctionAndCustomToolCallOutput 的字串或陣列	是你程式碼產生的函式呼叫輸出。 可以是字串或輸出內容的清單。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函數工具呼叫輸出類型。 一律為 function_call_output。 可能的值：function_call_output	Yes

OpenAI.ConversationItemFunctionToolCallResource

名稱	類型	Description	為必填項目	預設值
arguments	字串	要傳遞至函式的引數 JSON 字串。	Yes
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函數工具呼叫的唯一標識碼。	否
名稱	字串	要執行的函式名稱。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函式工具呼叫的類型。 一律為 function_call。 可能的值：function_call	Yes

OpenAI.ConversationItemImageGenToolCall

模型提出的圖像生成要求。

名稱	類型	Description	為必填項目	預設值
id	字串	影像生成呼叫的唯一 ID。	Yes
結果	字串（可空）		Yes
狀態	列舉	影像生成通話狀態。 可能的值：in_progress、、completed、 generatingfailed	Yes
型別	列舉	影像生成呼叫的類型。 一律為 image_generation_call。 可能的值：image_generation_call	Yes

OpenAI.ConversationItemList

一份對話項目清單。

名稱	類型	Description	為必填項目	預設值
資料	OpenAI.ConversationItem 的陣列	一份對話項目清單。	Yes
first_id	字串	清單中第一個項目的標識碼。	Yes
還有更多	布爾值	是否有更多項目可用。	Yes
last_id	字串	清單中最後一個項目的標識碼。	Yes
物件	列舉	傳回的物件類型必須是 list。 可能的值：list	Yes

OpenAI.ConversationItemLocalShellToolCall

在本機殼層上執行命令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.LocalShellExecAction	在伺服器上執行殼層命令。	Yes
call_id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
id	字串	本地 shell 呼叫的唯一 ID。	Yes
狀態	列舉	本地空殼通話狀態。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	本地 shell 呼叫的類型。 一律為 local_shell_call。 可能的值：local_shell_call	Yes

OpenAI.ConversationItemLocalShellToolCallOutput

本機 Shell 工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
輸出	字串	本機殼層工具呼叫輸出的 JSON 字串。	Yes
狀態	列舉	可能的值：in_progress、、 completedincomplete	否
型別	列舉	本地殼層工具呼叫輸出的類型。 一律為 local_shell_call_output。 可能的值：local_shell_call_output	Yes

OpenAI.ConversationItemMcpApprovalRequest

要求人工核准工具叫用。

名稱	類型	Description	為必填項目	預設值
arguments	字串	工具的自變數 JSON 字串。	Yes
id	字串	核准申請的唯一 ID。	Yes
名稱	字串	要執行的工具名稱。	Yes
伺服器標籤	字串	發出要求的 MCP 伺服器的標籤。	Yes
型別	列舉	項目的類型。 一律為 mcp_approval_request。 可能的值：mcp_approval_request	Yes

OpenAI.ConversationItemMcpApprovalResponseResource

對 MCP 核准申請的回應。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串	正在回應之核准要求的識別碼。	Yes
approve	布爾值	是否已核准要求。	Yes
id	字串	核准回應的唯一識別碼	Yes
reason	字串（可空）		否
型別	列舉	項目的類型。 一律為 mcp_approval_response。 可能的值：mcp_approval_response	Yes

OpenAI.ConversationItemMcpListTools

MCP 伺服器上可用的工具清單。

名稱	類型	Description	為必填項目	預設值
錯誤	字串（可空）		否
id	字串	名單的唯一ID。	Yes
伺服器標籤	字串	MCP 伺服器的標籤。	Yes
工具	OpenAI.MCPListToolsTool 的 array	伺服器上可用的工具。	Yes
型別	列舉	項目的類型。 一律為 mcp_list_tools。 可能的值：mcp_list_tools	Yes

OpenAI.ConversationItemMcpToolCall

MCP 伺服器上的工具叫用。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串（可空）		否
arguments	字串	傳遞到工具的參數所構成的 JSON 字串。	Yes
錯誤	字串（可空）		否
id	字串	工具呼叫的唯一 ID。	Yes
名稱	字串	執行的工具名稱。	Yes
輸出	字串（可空）		否
伺服器標籤	字串	執行此工具之 MCP 伺服器的標籤。	Yes
狀態	OpenAI.MCPToolCallStatus（開放AI.MCPToolCallStatus）		否
型別	列舉	項目的類型。 一律為 mcp_call。 可能的值：mcp_call	Yes

OpenAI.ConversationItemMessage

給模型的訊息或來自模型的訊息。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI.MessageContent 的陣列	訊息內容	Yes
id	字串	訊息的唯一識別碼。	Yes
角色	OpenAI.MessageRole		Yes
狀態	OpenAI.MessageStatus（開放人工智慧訊息狀態）		Yes
型別	列舉	訊息的類型。 一律設定為 message。 可能的值：message	Yes

OpenAI.ConversationItemReasoningItem

產生回應時，推理模型所使用之思想鏈結的描述。 如果你手動管理上下文，務必將這些項目包含在你的回應 API 的 中，以便後續對話回合使用。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI 的陣列 。ReasoningTextContent	推理文本內容。	否
encrypted_content	字串（可空）		否
id	字串	推理內容的唯一標識碼。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
摘要	OpenAI 的陣列 。摘要	推理摘要內容。	Yes
型別	列舉	物件的類型。 一律為 reasoning。 可能的值：reasoning	Yes

OpenAI.ConversationItemType

房產	價值觀
Type	字串
價值	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

網路搜尋工具呼叫的結果。 更多資訊請參閱 web 搜尋指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述此 Web 搜尋呼叫中採取的特定動作的物件。 包括模型如何使用 Web （搜尋、open_page、尋找） 的詳細資料。	Yes
id	字串	網路搜尋工具呼叫的唯一 ID。	Yes
狀態	列舉	Web 搜尋工具呼叫的狀態。 可能的值：in_progress、、searching、 completedfailed	Yes
型別	列舉	網路搜尋工具的呼叫類型。 一律為 web_search_call。 可能的值：web_search_call	Yes

OpenAI.ConversationParam

這個回應所屬的對話。 本次對話內容在回應請求前加上 input_items 。 此回應的輸入項目與輸出項目會在回應結束後自動加入此對話中。

類型：字串或 OpenAI.ConversationParam-2

這個回應所屬的對話。 本次對話內容在回應請求前加上 input_items 。 此回應的輸入項目與輸出項目會在回應結束後自動加入此對話中。

OpenAI.ConversationParam-2

這個回應所屬的對話。

名稱	類型	Description	為必填項目	預設值
id	字串	交談的唯一識別碼。	Yes

OpenAI.ConversationReference

這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。

名稱	類型	Description	為必填項目	預設值
id	字串	這個回應所關聯的對話唯一ID。	Yes

OpenAI.ConversationResource

名稱	類型	Description	為必填項目	預設值
建立於	整數	對話產生的時間，以秒數計，自 Unix 時代以來。	Yes
id	字串	交談的唯一識別碼。	Yes
中繼資料	OpenAI.Metadata	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	Yes
物件	列舉	物件類型，一律為 conversation。 可能的值：conversation	Yes

OpenAI.CreateChatCompletionRequestResponseFormat

物件，指定模型必須輸出的格式。 設定為 { "type": "json_schema", "json_schema": {...} } 啟用結構化輸出，確保模型與你提供的 JSON 架構相符。 想了解更多，請參閱 Structured Outputs 指南。 設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式，以確保模型產生的訊息為有效的 JSON。 對於支援它的模型，最好使用 。json_schema

OpenAI 的識別器。CreateChatCompletionRequestResponseFormat

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.CreateChatCompletionRequestResponseFormatType		Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON 物件回應格式。 產生 JSON 回應的較舊方法。 針對支援它的模型，建議使用 json_schema 。 請注意，模型不會在沒有系統或使用者訊息指示下產生 to do JSON。

名稱	類型	Description	為必填項目	預設值
型別	列舉	正在定義的回應格式類型。 一律為 json_object。 可能的值：json_object	Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

默認回應格式。 用來產生文字回應。

名稱	類型	Description	為必填項目	預設值
型別	列舉	正在定義的回應格式類型。 一律為 text。 可能的值：text	Yes

OpenAI.CreateChatCompletionRequestResponseFormatType

房產	價值觀
Type	字串
價值	text json_schema json_object

OpenAI.CreateConversationBody

名稱	類型	Description	為必填項目	預設值
items	OpenAI.InputItem 的陣列		否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否

OpenAI.CreateEvalCompletionsRunDataSource

CompletionsRunDataSource 物件，描述模型取樣組態。

名稱	類型	Description	為必填項目	預設值
輸入訊息	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	用於從模型取樣時。 決定輸入模型的訊息結構。 可以是對預先建構軌跡的參考（例如 item.input_trajectory），或是帶有變數參考命名空間的 item 範本。	否
型號	字串	用於產生完成的模型名稱 (例如 "o3-mini")。	否
採樣參數	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		否
來源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalStoredCompletionsSource	決定本次執行資料來源中命名空間的 item 填充內容。	Yes
型別	列舉	執行數據源的類型。 一律為 completions。 可能的值：completions	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

名稱	類型	Description	為必填項目	預設值
item_reference	字串		Yes
型別	列舉	可能的值：item_reference	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

名稱	類型	Description	為必填項目	預設值
樣板	OpenAI.EasyInputMessage 或 OpenAI.EvalItem 的陣列		Yes
型別	列舉	可能的值：template	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

名稱	類型	Description	為必填項目	預設值
max_completion_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
回應格式	OpenAI.ResponseFormatText 或 OpenAI.ResponseFormatJsonSchema 或 OpenAI.ResponseFormatJsonObject		否
seed	OpenAI.integer		否	42
溫度	OpenAI.numeric		否	1
工具	OpenAI.ChatCompletionTool 的陣列		否
top_p	OpenAI.numeric		否	1

OpenAI.CreateEvalCustomDataSourceConfig

CustomDataSourceConfig 物件，定義用於評估執行的數據源架構。 此架構是用來定義資料的形狀，其為：

• 用來定義測試準則和
• 建立執行時需要哪些數據

名稱	類型	Description	為必填項目	預設值
include_sample_schema (範例架構包含)	布爾值	評估值是否應該預期您會填入範例命名空間（例如，藉由從數據源產生回應）	否
項目架構	物件	數據源中每個數據列的 JSON 架構。	Yes
型別	列舉	資料來源的類型。 一律為 custom。 可能的值：custom	Yes

OpenAI.CreateEvalJsonlRunDataSource

JsonlRunDataSource 物件，指定符合 eval 的 JSONL 檔案

名稱	類型	Description	為必填項目	預設值
來源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	決定資料來源中填 item 入命名空間的資訊。	Yes
型別	列舉	資料來源的類型。 一律為 jsonl。 可能的值：jsonl	Yes

OpenAI.CreateEvalLogsDataSourceConfig

數據源組態，指定記錄查詢的元數據屬性。 這通常是像 usecase=chatbot 或 prompt-version=v2 等的元數據。

名稱	類型	Description	為必填項目	預設值
中繼資料	物件	記錄資料來源的中繼資料篩選。	否
型別	列舉	資料來源的類型。 一律為 logs。 可能的值：logs	Yes

OpenAI.CreateEvalResponsesRunDataSource

ResponsesRunDataSource 物件，描述模型取樣組態。

名稱	類型	Description	為必填項目	預設值
輸入訊息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate 或 OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	用於從模型取樣時。 決定輸入模型的訊息結構。 可以是對預先建構軌跡的參考（例如 item.input_trajectory），或是帶有變數參考命名空間的 item 範本。	否
型號	字串	用於產生完成的模型名稱 (例如 "o3-mini")。	否
採樣參數	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		否
來源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource 或 OpenAI.EvalResponsesSource	決定本次執行資料來源中命名空間的 item 填充內容。	Yes
型別	列舉	執行數據源的類型。 一律為 responses。 可能的值：responses	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

名稱	類型	Description	為必填項目	預設值
item_reference	字串		Yes
型別	列舉	可能的值：item_reference	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

名稱	類型	Description	為必填項目	預設值
樣板	物件陣列或 OpenAI.EvalItem		Yes
型別	列舉	可能的值：template	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

名稱	類型	Description	為必填項目	預設值
max_completion_tokens	OpenAI.integer		否
推理努力	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
seed	OpenAI.integer		否	42
溫度	OpenAI.numeric		否	1
收發簡訊	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		否
工具	OpenAI.Tool 的陣列		否
top_p	OpenAI.numeric		否	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

名稱	類型	Description	為必填項目	預設值
format	OpenAI.TextResponseFormatConfiguration	物件，指定模型必須輸出的格式。 { "type": "json_schema" }設定可啟用結構化輸出， 這可確保模型符合您提供的 JSON 架構。 前往此處深入了解 預設格式為 { "type": "text" }，且沒有其他選項。 *不建議用於GPT-4o及更新型號：** 設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式， 確保模型產生的訊息是有效的 JSON。 使用 json_schema 支援該功能的模型較為常用。	否

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

已廢棄，改用 LogsDataSourceConfig。

名稱	類型	Description	為必填項目	預設值
中繼資料	物件	儲存的完成資料來源的中繼資料篩選。	否
型別	列舉	資料來源的類型。 一律為 stored_completions。 可能的值：stored_completions	Yes

OpenAI.CreateFineTuningJobRequest

有效的模型：

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

名稱	類型	Description	為必填項目	預設值
超參數	OpenAI.CreateFineTuningJobRequestHyperparameters		否
批次大小	string 或 OpenAI.integer		否	自動
└─ 學習率乘數	字串或 OpenAI.numeric		否
└─ n_epochs	string 或 OpenAI.integer		否	自動
整合	array of OpenAI.CreateFineTuningJobRequestIntegrations	可以啟用於微調作業的整合項目清單。	否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
方法	OpenAI.FineTuneMethod	用於微調的方法。	否
型號	字串 （請參閱下面的有效模型）	要微調的模型名稱。 您可以選取其中一個 支援型號。	Yes
seed	OpenAI.integer （nullable）		否
suffix	字串（可空）	最多64個字元的字串，將會新增至微調的模型名稱。 例如，"custom-model-name" 的 suffix 會產生像 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel 這樣的模型名稱。 限制條件： 最小長度：1，最大長度：64	否
訓練檔案	字串	包含定型資料的已上傳檔案識別碼。 如需如何上傳檔案，請參閱上傳檔案。 您的數據集必須格式化為 JSONL 檔案。 此外，您必須以用途 fine-tune 上傳您的檔案。 檔案內容應依模型是否使用 聊天、 完成 格式，或微調方法使用 偏好格式 而有所不同。 更多細節請參閱 微調指南。	Yes
驗證檔案	字串（可空）	包含驗證數據的上傳檔案識別碼。 如果您提供此檔案，則會使用數據來產生驗證 在微調期間定期回報計量。 這些計量可在下項中檢視： 微調參數結果檔案。 定型和驗證檔案中不應該有相同的數據。 您的數據集必須格式化為 JSONL 檔案。 您必須以用途 fine-tune 上傳您的檔案。 更多細節請參閱 微調指南。	否

OpenAI.CreateFineTuningJobRequestHyperparameters

名稱	類型	Description	為必填項目	預設值
批次大小	string 或 OpenAI.integer		否
學習率倍增器	字串或 OpenAI.numeric		否
n_epochs	string 或 OpenAI.integer		否

OpenAI.CreateFineTuningJobRequestIntegrations

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：wandb	Yes
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Yes

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

名稱	類型	Description	為必填項目	預設值
實體	字串（可空）		否
名稱	字串（可空）		否
project	字串		Yes
tags	字串陣列		否

OpenAI.CreateResponse串流回應

類型：OpenAI.ResponseAudioDeltaEvent 或 OpenAI.ResponseAudioTranscriptDeltaEvent 或 OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent 或 OpenAI.ResponseCodeInterpreterCallInProgressEvent 或 OpenAI.ResponseCodeInterpreterCallInterpretingEvent 或 OpenAI.ResponseContentPartAddedEvent 或 OpenAI.ResponseCreatedEvent 或 OpenAI.ResponseErrorEvent 或OpenAI.ResponseFileSearchCallInProgressEvent 或 OpenAI.ResponseFileSearchCallSearchSearchingEvent 或 OpenAI.ResponseFunctionCallArgumentsDeltaEvent 或 OpenAI.ResponseInProgressEvent 或 OpenAI.ResponseInFalledEvent 或 OpenAI.ResponseIncompleteEvent 或 OpenAI.ResponseOutputItemAddedEvent 或 OpenAI.ResponseReasoningSummaryPartAddedEvent 或 OpenAI.ResponseReasoningSummaryTextDeltaEvent或OpenAI.回應理理TextDeltaEvent 或 OpenAI.ResponseRefusalDeltaEvent 或 OpenAI.ResponseTextDeltaEvent 或 OpenAI.ResponseWebSearchCallInProgressEvent 或 OpenAI.ResponseWebSearchCallSearchingEvent 或 OpenAI.ResponseImageGenCallInGenerationEvent、OpenAI.ResponseImageGenCallInProgressEvent 或 OpenAI.ResponseImageGenCallPartialImageEvent 或OpenAI.ResponseMCPCallArgumentsDeltaEvent 或 OpenAI.ResponseMCPCallFailedEvent 或 OpenAI.ResponseMCPCallInProgressEvent 或 OpenAI.ResponseMCPListToolsFailedEvent 或 OpenAI.ResponseMCPListToolsInProgressEvent 或 OpenAI.ResponseTextAnnotationAddedEvent 或 OpenAI.ResponseQueuedEvent 或 OpenAI.ResponseCustomToolCallInputDeltaEvent 或 OpenAI.ResponseAudioDoneEvent 或OpenAI.ResponseAudioTranscriptDoneEvent 或 OpenAI.ResponseCodeInterpreterCallCodeDoneEvent 或 OpenAI.ResponseCodeCallCompletedEvent 或 OpenAI.ResponseCompletedEvent 或 OpenAI.ResponseContentPartDoneEvent 或 OpenAI.ResponseFileSearchCallCompletedEvent 或 OpenAI.ResponseFunctionCallArgumentsDoneEvent 或 OpenAI.ResponseOutputItemDoneEvent 或OpenAI.ResponseReasoningSummaryPartDoneEvent 或 OpenAI.ResponseReasoningSummaryTextDoneEvent 或 OpenAI.ResponseReasoningTextDoneEvent 或 OpenAI.ResponseRefusalDoneEvent 或 OpenAI.ResponseTextDoneEvent 或 OpenAI.ResponseWebSearchCallCompletedEvent 或 OpenAI.ResponseImageGenCallCompletedEvent 或 OpenAI.ResponseMCPCallCompletedEvent或OpenAI.ResponseMCPListToolsCompletedEvent 或 OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

一種由使用者定義的文法。

名稱	類型	Description	為必填項目	預設值
定義	字串	文法定義。	Yes
syntax	OpenAI.GrammarSyntax1		Yes
型別	列舉	文法格式。 一律為 grammar。 可能的值：grammar	Yes

OpenAI.CustomTextFormatParam

不受限制的自由形式文字。

名稱	類型	Description	為必填項目	預設值
型別	列舉	不受限制的文字格式。 一律為 text。 可能的值：text	Yes

OpenAI.CustomToolParam

一個自訂工具，能依照指定格式處理輸入。 了解更多關於 custom tools

名稱	類型	Description	為必填項目	預設值
說明	字串	自訂工具的可選描述，用以提供更多背景說明。	否
format	OpenAI.CustomToolParamFormat	自訂工具的輸入格式。 預設是無限制文字。	否
\---- 類型	OpenAI.CustomToolParamFormatType		Yes
名稱	字串	自訂工具名稱，用於工具呼叫時的識別。	Yes
型別	列舉	自訂工具的類型。 一律為 custom。 可能的值：custom	Yes

OpenAI.CustomToolParamFormat

自訂工具的輸入格式。 預設是無限制文字。

OpenAI 的 Discriminator CustomToolParamFormat

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

房產	價值觀
Type	字串
價值	text grammar

OpenAI.DeletedConversationResource

名稱	類型	Description	為必填項目	預設值
已刪除	布爾值		Yes
id	字串		Yes
物件	列舉	可能的值：conversation.deleted	Yes

OpenAI.DetailEnum

房產	價值觀
Type	字串
價值	low high auto

OpenAI.雙擊動作

按兩下動作。

名稱	類型	Description	為必填項目	預設值
型別	列舉	指定事件類型。 對於按兩下動作，這個屬性一律會設定為 double_click。 可能的值：double_click	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.Drag

拖曳動作。

名稱	類型	Description	為必填項目	預設值
路徑	OpenAI.DragPoint 的陣列	座標陣列，表示拖曳動作的路徑。 座標會顯示為陣列 的物件，例如 <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>	Yes
型別	列舉	指定事件類型。 針對拖曳動作，此屬性為 總是設定為 drag。 可能的值：drag	Yes

OpenAI.DragPoint

x/y 座標組，例如 { x: 100, y: 200 }。

名稱	類型	Description	為必填項目	預設值
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.EasyInputMessage

具有角色的訊息輸入至模型，指出下列階層的指示。 由 developer 或 system 角色給出的指示優先於由角色 user 給出的指示。 具有 assistant 角色的訊息被認為是在先前交互作用中由模型產生的。

名稱	類型	Description	為必填項目	預設值
內容	string 或 OpenAI.InputMessageContentList	用於產生回應的模型文字、影像或音訊輸入。 也可以包含先前的助理回應。	Yes
角色	列舉	訊息輸入的作用。 一個user、assistant、system或其中之一 developer。 可能的值：user、、assistant、 systemdeveloper	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	訊息輸入的類型。 一律為 message。 可能的值：message	Yes

OpenAI.錯誤

名稱	類型	Description	為必填項目	預設值
附加資訊	物件		否
字碼	字串（可空）		Yes
debugInfo	物件		否
details	OpenAI.Error 的陣列		否
訊息	字串		Yes
param	字串（可空）		否
型別	字串		否

OpenAI.EvalApiError

物件，表示來自 Eval API 的錯誤回應。

名稱	類型	Description	為必填項目	預設值
字碼	字串	錯誤碼。	Yes
訊息	字串	錯誤訊息。	Yes

OpenAI.EvalGraderLabelModel

名稱	類型	Description	為必填項目	預設值
輸入	OpenAI.EvalItem 的陣列		Yes
labels	字串陣列	要指派給評估中每個項目的標籤。	Yes
型號	字串	要用於評估的模型。 必須支援結構化輸出。	Yes
名稱	字串	評分者的名稱。	Yes
傳遞的標籤	字串陣列	表示通過結果的標示。 必須是標籤的子集。	Yes
型別	列舉	物件類型，一律為 label_model。 可能的值：label_model	Yes

OpenAI.EvalGraderPython

名稱	類型	Description	為必填項目	預設值
image_tag	字串	要用於 Python 腳本的影像標記。	否
名稱	字串	評分者的名稱。	Yes
通過門檻	OpenAI.numeric		否
來源	字串	Python 腳本的原始程式碼。	Yes
型別	列舉	物件類型，一律為 python。 可能的值：python	Yes

OpenAI.EvalGraderScoreModel

名稱	類型	Description	為必填項目	預設值
輸入	OpenAI.EvalItem 的陣列	評分者評估的輸入訊息。 支援文字、輸出文字、輸入影像及輸入音訊內容區塊，並可能包含範本字串。	Yes
型號	字串	要用於評估的模型。	Yes
名稱	字串	評分者的名稱。	Yes
通過門檻	OpenAI.numeric		否
範圍	OpenAI.numeric 的陣列	分數的範圍。 預設為 [0, 1]。	否
採樣參數	OpenAI.EvalGraderScoreModelSamplingParams		否
└─ max_completions_tokens	OpenAI.integer （nullable）		否
推理工作量	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
~---- 種子	OpenAI.integer （nullable）		否
‧---- 溫度	OpenAI.numeric （可空）		否
top_p	OpenAI.numeric （可空）		否	1
型別	列舉	物件類型，一律為 score_model。 可能的值：score_model	Yes

OpenAI.EvalGraderScoreModelSamplingParams

名稱	類型	Description	為必填項目	預設值
max_completions_tokens	OpenAI.integer （nullable）		否
推理努力	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
seed	OpenAI.integer （nullable）		否
溫度	OpenAI.numeric （可空）		否
top_p	OpenAI.numeric （可空）		否	1

OpenAI.EvalGraderStringCheck

名稱	類型	Description	為必填項目	預設值
輸入	字串	輸入文字。 這可能包含範本字串。	Yes
名稱	字串	評分者的名稱。	Yes
作業	列舉	要執行的字串檢查作業。 eq、ne、like 或 ilike 的其中之一。。 可能的值：eq、、ne、 likeilike	Yes
參考	字串	參考文字。 這可能包含範本字串。	Yes
型別	列舉	物件類型，一律為 string_check。 可能的值：string_check	Yes

OpenAI.EvalGraderTextSimilarity

名稱	類型	Description	為必填項目	預設值
評估指標	列舉	要使用的評估計量。 其中一個cosine、fuzzy_match、bleu gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、、、 rouge_5 或 rouge_l。 可能的值：cosine， ， fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Yes
輸入	字串	正在評分的文字。	Yes
名稱	字串	評分者的名稱。	Yes
通過門檻	OpenAI.numeric		Yes
參考	字串	用來評分的文本。	Yes
型別	列舉	評分器的類型。 可能的值：text_similarity	Yes

OpenAI.EvalItem

具有角色的訊息輸入至模型，指出下列階層的指示。 由 developer 或 system 角色給出的指示優先於由角色 user 給出的指示。 具有 assistant 角色的訊息被認為是在先前交互作用中由模型產生的。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI.EvalItemContent	模型輸入 - 可以包含範本字串。 支援文字、輸出文字、輸入圖片及輸入音訊，可作為單一項目或多個項目陣列。	Yes
角色	列舉	訊息輸入的作用。 一個user、assistant、system或其中之一 developer。 可能的值：user、、assistant、 systemdeveloper	Yes
型別	列舉	訊息輸入的類型。 一律為 message。 可能的值：message	否

OpenAI.EvalItemContent

模型輸入 - 可以包含範本字串。 支援文字、輸出文字、輸入圖片及輸入音訊，可作為單一項目或多個項目陣列。

類型： OpenAI.EvalItemContentItem 或 OpenAI.EvalItemContentArray

模型輸入 - 可以包含範本字串。 支援文字、輸出文字、輸入圖片及輸入音訊，可作為單一項目或多個項目陣列。

OpenAI.EvalItemContentArray

一個輸入清單，每個輸入可以是輸入文字、輸出文字、輸入影像或輸入音訊物件。

陣列：OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

單一內容項目：輸入文字、輸出文字、輸入影像或輸入音訊。

類型： OpenAI.EvalItemContentText 或 OpenAI.EvalItemContentItemObject

單一內容項目：輸入文字、輸出文字、輸入影像或輸入音訊。

OpenAI.EvalItemContentItemObject

單一內容項目：輸入文字、輸出文字、輸入影像或輸入音訊。

OpenAI 的判別器。EvalItemContentItemObject

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.EvalItemContentItemObjectType		Yes

OpenAI.EvalItemContentItemObjectInputTextContent

模型的文字輸入。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸入。	Yes
型別	列舉	輸入項目的型別。 一律為 input_text。 可能的值：input_text	Yes

OpenAI.EvalItemContentItemObjectType

房產	價值觀
Type	字串
價值	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

模型的文字輸出。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸出。	Yes
型別	列舉	輸出文字的類型。 一律為 output_text。 可能的值：output_text	Yes

OpenAI.EvalItemContentText

模型的文字輸入。

類型：字串

OpenAI.EvalItemInputImage

用於 EvalItem 內容陣列中的影像輸入區塊。

名稱	類型	Description	為必填項目	預設值
detail	字串	要傳送至模型之影像的詳細數據層級。 high、low 或 auto 的其中之一。 預設為 auto。	否
image_url	字串	圖片輸入的網址。	Yes
型別	列舉	影像輸入的類型。 一律為 input_image。 可能的值：input_image	Yes

OpenAI.EvalJsonlFileContentSource

名稱	類型	Description	為必填項目	預設值
內容	array of OpenAI.EvalJsonlFileContentSourceContent	jsonl 檔案的內容。	Yes
型別	列舉	jsonl 來源的類型。 一律為 file_content。 可能的值：file_content	Yes

OpenAI.EvalJsonlFileContentSourceContent

名稱	類型	Description	為必填項目	預設值
項目	物件		Yes
樣本	物件		否

OpenAI.EvalJsonlFileIdSource

名稱	類型	Description	為必填項目	預設值
id	字串	檔案的識別碼。	Yes
型別	列舉	jsonl 來源的類型。 一律為 file_id。 可能的值：file_id	Yes

OpenAI.評估回應來源

描述執行數據源組態的 EvalResponsesSource 物件。

名稱	類型	Description	為必填項目	預設值
建立於之後	OpenAI.integer （nullable）		否
創建於之前	OpenAI.integer （nullable）		否
instructions_search	字串（可空）		否
中繼資料	物件（可空除）		否
型號	字串（可空）		否
推理努力	OpenAI.ReasoningEffort （可取消）	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
溫度	OpenAI.numeric （可空）		否
工具	字串陣列		否
top_p	OpenAI.numeric （可空）		否
型別	列舉	執行數據源的類型。 一律為 responses。 可能的值：responses	Yes
users	字串陣列		否

OpenAI.EvalRunOutputItemSample

名稱	類型	Description	為必填項目	預設值
錯誤	OpenAI.EvalApiError	物件，表示來自 Eval API 的錯誤回應。	Yes
finish_reason	字串		Yes
輸入	EvalRunOutputItemSampleInput 的陣列		Yes
max_completion_tokens	OpenAI.integer		Yes
型號	字串		Yes
輸出	EvalRunOutputItemSampleOutput 的陣列		Yes
seed	OpenAI.integer		Yes
溫度	OpenAI.numeric		Yes
top_p	OpenAI.numeric		Yes
使用方式	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleUsage

名稱	類型	Description	為必填項目	預設值
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerModelUsage

名稱	類型	Description	為必填項目	預設值
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
invocation_count	OpenAI.integer		Yes
model_name	字串		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerTestingCriteria 結果

名稱	類型	Description	為必填項目	預設值
失敗	OpenAI.integer		Yes
通過	OpenAI.integer		Yes
測試標準	字串		Yes

OpenAI.EvalRunResultCounts

名稱	類型	Description	為必填項目	預設值
錯誤	OpenAI.integer		Yes
失敗	OpenAI.integer		Yes
通過	OpenAI.integer		Yes
總計	OpenAI.integer		Yes

OpenAI.EvalStoredCompletionsSource

描述一組篩選條件的 StoredCompletionsRunDataSource 組態

名稱	類型	Description	為必填項目	預設值
建立於之後	OpenAI.integer （nullable）		否
創建於之前	OpenAI.integer （nullable）		否
limit	OpenAI.integer （nullable）		否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
型號	字串（可空）		否
型別	列舉	來源的類型。 一律為 stored_completions。 可能的值：stored_completions	Yes

OpenAI.FileCitationBody

檔案的引文。

名稱	類型	Description	為必填項目	預設值
檔案識別碼 (file_id)	字串	檔案的識別碼。	Yes
filename	字串	所引用檔案的檔名。	Yes
索引	OpenAI.integer		Yes
型別	列舉	檔案引文的類型。 一律為 file_citation。 可能的值：file_citation	Yes

OpenAI.FilePath

檔案的路徑。

名稱	類型	Description	為必填項目	預設值
檔案識別碼 (file_id)	字串	檔案的識別碼。	Yes
索引	OpenAI.integer		Yes
型別	列舉	檔案路徑的類型。 一律為 file_path。 可能的值：file_path	Yes

OpenAI.FileSearchTool

從上傳的檔案搜尋相關內容的工具。

名稱	類型	Description	為必填項目	預設值
filters	OpenAI.Filters （可空除）		否
最大結果數量	OpenAI.integer		否
排名選項	OpenAI.RankingOptions		否
└─ hybrid_search	OpenAI.HybridSearchOptions	控制互惠秩融合在啟用混合搜尋時，語意嵌入匹配與稀疏關鍵字匹配的權重。	否
----- 排名器	OpenAI.RankerVersionType	要用於檔案搜尋的排名器。	否
分數門檻	OpenAI.numeric	檔案搜尋的分數閾值，數位介於 0 到 1 之間。 接近 1 的數位只會嘗試只傳回最相關的結果，但可能會傳回較少的結果。	否
型別	列舉	檔案搜尋工具的類型。 一律為 file_search。 可能的值：file_search	Yes
向量儲存庫_IDs	字串陣列	要搜尋之向量存放區的識別碼。	Yes

OpenAI.FileSearchToolCallResults

名稱	類型	Description	為必填項目	預設值
attributes	OpenAI.VectorStoreFileAttributes （可空）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是字串 長度上限為64個字元。 值是字串，且具有最大的 長度為 512 個字元、布林值或數字。	否
檔案識別碼 (file_id)	字串		否
filename	字串		否
分數	數字		否
收發簡訊	字串		否

OpenAI.過濾器

類型： OpenAI.ComparisonFilter 或 OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

用於 DPO 微調作業的超參數。

名稱	類型	Description	為必填項目	預設值
批次大小	string 或 OpenAI.integer	每個批次中的範例數目。 批次大小越大，表示模型參數的更新頻率越低，而變異數越少。	否
Beta	字串或 OpenAI.numeric	DPO 方法的 beta 值。 較高的貝塔值會增加保單模型與參考模型間的罰款權重。	否
學習率倍增器	字串或 OpenAI.numeric	學習率的縮放比例。 較小的學習速率可能有助於避免過度學習。	否
n_epochs	string 或 OpenAI.integer	訓練模型的週期數目。 Epoch 是指透過訓練資料集的一個完整週期。	否

OpenAI.FineTuneDPOMethod

DPO 微調方法的設定。

名稱	類型	Description	為必填項目	預設值
超參數	OpenAI.FineTuneDPOHyperparameters	用於 DPO 微調作業的超參數。	否

OpenAI.FineTuneMethod

用於微調的方法。

名稱	類型	Description	為必填項目	預設值
資料保護專員	OpenAI.FineTuneDPOMethod	DPO 微調方法的設定。	否
reinforcement	OpenAI.FineTuneReinforcementMethod	強化微調方法的配置。	否
監督學習	OpenAI.FineTuneSupervisedMethod	受監督微調方法的設定。	否
型別	列舉	方法的類型。 是supervised、dpo或reinforcement。 可能的值：supervised、、 dporeinforcement	Yes

OpenAI.FineTuneReinforcementHyperparameters

用於增強式微調作業的超參數。

名稱	類型	Description	為必填項目	預設值
批次大小	string 或 OpenAI.integer	每個批次中的範例數目。 批次大小越大，表示模型參數的更新頻率越低，而變異數越少。	否
compute_multiplier	字串或 OpenAI.numeric	訓練期間探索搜尋空間所用計算量乘以計算量。	否
評估間隔	string 或 OpenAI.integer	評估運行間的訓練步驟數。	否
評估樣本	string 或 OpenAI.integer	每個訓練步驟需產生的評估樣本數量。	否
學習率倍增器	字串或 OpenAI.numeric	學習率的縮放比例。 較小的學習速率可能有助於避免過度學習。	否
n_epochs	string 或 OpenAI.integer	訓練模型的週期數目。 Epoch 是指透過訓練資料集的一個完整週期。	否
推理努力	列舉	推理工作層級。 可能的值：default、、low、 mediumhigh	否

OpenAI.FineTuneReinforcementMethod

強化微調方法的配置。

名稱	類型	Description	為必填項目	預設值
評分工具	OpenAI.GraderStringCheck 或 OpenAI.GraderTextSimilarity 、 OpenAI.GraderPython 或 OpenAI.GraderScoreModel 或 OpenAI.GraderMulti	用於微調工作的平級機。	Yes
超參數	OpenAI.FineTuneReinforcementHyperparameters	用於增強式微調作業的超參數。	否

OpenAI.FineTuneSupervisedHyperparameters

用於微調作業的超參數。

名稱	類型	Description	為必填項目	預設值
批次大小	string 或 OpenAI.integer	每個批次中的範例數目。 批次大小越大，表示模型參數的更新頻率越低，而變異數越少。	否
學習率倍增器	字串或 OpenAI.numeric	學習率的縮放比例。 較小的學習速率可能有助於避免過度學習。	否
n_epochs	string 或 OpenAI.integer	訓練模型的週期數目。 Epoch 是指透過訓練資料集的一個完整週期。	否

OpenAI.FineTuneSupervisedMethod

受監督微調方法的設定。

名稱	類型	Description	為必填項目	預設值
超參數	OpenAI.FineTuneSupervisedHyperparameters	用於微調作業的超參數。	否

OpenAI.FineTuningIntegration

名稱	類型	Description	為必填項目	預設值
型別	列舉	針對微調作業所啟用的整合類型 可能的值：wandb	Yes
wandb	OpenAI.FineTuningIntegrationWandb		Yes
└─ 實體	字串（可空）		否
\---- 名稱	字串（可空）		否
└─ project	字串		Yes
└─ 標籤	字串陣列		否

OpenAI.FineTuningIntegrationWandb

名稱	類型	Description	為必填項目	預設值
實體	字串（可空）		否
名稱	字串（可空）		否
project	字串		Yes
tags	字串陣列		否

OpenAI.FineTuningJob

fine_tuning.job物件代表透過 API 建立的微調作業。

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立微調作業時的 Unix 時間戳（以秒為單位）。	Yes
錯誤	OpenAI.FineTuningJobError （可空）		Yes
└─ 程式碼	字串		Yes
|---- 訊息	字串		Yes
└─ 參數	字串（可空）		Yes
預計完成	整數		否
fine_tuned_model	字串（可空）		Yes
完成時間	整數		Yes
超參數	OpenAI.FineTuningJobHyperparameters		Yes
批次大小	string 或 OpenAI.integer		否	自動
└─ 學習率乘數	字串或 OpenAI.numeric		否
└─ n_epochs	string 或 OpenAI.integer		否	自動
id	字串	物件標識碼，可在 API 端點中參考。	Yes
整合	OpenAI 的 array.FineTuningIntegration		否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
方法	OpenAI.FineTuneMethod	用於微調的方法。	否
型號	字串	正在微調的基礎模型。	Yes
物件	列舉	物件類型，一律為 “fine_tuning.job”。 可能的值：fine_tuning.job	Yes
organization_id	字串	擁有微調作業的組織。	Yes
結果檔案	字串陣列	微調任務的編譯結果檔案識別碼。 你可以用 Files API 取得結果。	Yes
seed	OpenAI.integer		Yes
狀態	列舉	微調作業的目前狀態，可以是 validating_files、、queuedrunning、succeeded、 failed或 cancelled。 可能的值：validating_files、、、queuedrunningsucceeded、failed、cancelled	Yes
訓練過的標記	OpenAI.integer （nullable）		Yes
訓練檔案	字串	用於訓練的檔案標識碼。 你可以用 Files API 取得訓練資料。	Yes
驗證檔案	字串（可空）		Yes

OpenAI.FineTuningJobCheckpoint

fine_tuning.job.checkpoint物件代表可用於微調作業的模型檢查點。

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立檢查點時的 Unix 時間戳記 (以秒為單位)。	Yes
微調模型檢查點	字串	所建立之微調檢查點模型的名稱。	Yes
微調作業識別碼	字串	從這個檢查點建立的微調作業名稱。	Yes
id	字串	可在 API 端點中參考的檢查點標識碼。	Yes
計量	OpenAI.FineTuningJobCheckpointMetrics		Yes
└─ 完整驗證損失	OpenAI.numeric		否
full_valid_mean_token_accuracy	OpenAI.numeric		否
└─ 步驟	OpenAI.numeric		否
└─ 訓練損失	OpenAI.numeric		否
train_mean_token_accuracy	OpenAI.numeric		否
valid_loss	OpenAI.numeric		否
└─ 有效平均標記準確率	OpenAI.numeric		否
物件	列舉	物件類型，一律為 “fine_tuning.job.checkpoint”。 可能的值：fine_tuning.job.checkpoint	Yes
步驟編號	OpenAI.integer		Yes

OpenAI.FineTuningJobCheckpointMetrics

名稱	類型	Description	為必填項目	預設值
full_valid_loss	OpenAI.numeric		否
full_valid_mean_token_accuracy	OpenAI.numeric		否
步驟	OpenAI.numeric		否
train_loss	OpenAI.numeric		否
train_mean_token_accuracy	OpenAI.numeric		否
valid_loss	OpenAI.numeric		否
valid_mean_token_accuracy	OpenAI.numeric		否

OpenAI.FineTuningJobError

名稱	類型	Description	為必填項目	預設值
字碼	字串		Yes
訊息	字串		Yes
param	字串（可空）		Yes

OpenAI.FineTuningJobEvent

微調作業事件物件

名稱	類型	Description	為必填項目	預設值
建立於	整數	建立微調作業時的 Unix 時間戳（以秒為單位）。	Yes
資料	OpenAI.FineTuningJobEventData		否
id	字串	物件識別碼。	Yes
水平儀	列舉	事件的記錄層級。 可能的值：info、、 warnerror	Yes
訊息	字串	事件的訊息。	Yes
物件	列舉	物件類型，一律為 “fine_tuning.job.event”。 可能的值：fine_tuning.job.event	Yes
型別	列舉	事件的類型。 可能的值： message、 metrics	否

OpenAI.FineTuningJobEventData

類型：物件

OpenAI.FineTuningJobHyperparameters

名稱	類型	Description	為必填項目	預設值
批次大小	string 或 OpenAI.integer		否
學習率倍增器	字串或 OpenAI.numeric		否
n_epochs	string 或 OpenAI.integer		否

OpenAI.FunctionAndCustomToolCallOutput

OpenAI 的判別器。FunctionAndCustomToolCallOutput

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

模型的檔案輸入。

名稱	類型	Description	為必填項目	預設值
file_data	字串	要傳送至模型的檔案內容。	否
檔案識別碼 (file_id)	字串（可空）		否
file_url	字串	要傳送給模型的檔案網址。	否
filename	字串	要傳送至模型的檔案名稱。	否
型別	列舉	輸入項目的型別。 一律為 input_file。 可能的值：input_file	Yes

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

輸入至模型的影像 了解影像輸入。

名稱	類型	Description	為必填項目	預設值
detail	OpenAI.ImageDetail		Yes
檔案識別碼 (file_id)	字串（可空）		否
image_url	字串		否
型別	列舉	輸入項目的型別。 一律為 input_image。 可能的值：input_image	Yes

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

模型的文字輸入。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸入。	Yes
型別	列舉	輸入項目的型別。 一律為 input_text。 可能的值：input_text	Yes

OpenAI.FunctionAndCustomToolCallOutputType

房產	價值觀
Type	字串
價值	input_text input_image input_file

OpenAI.FunctionCallItemStatus（開放AI）功能呼叫項目狀態（ItemStatus）

房產	價值觀
Type	字串
價值	in_progress completed incomplete

OpenAI.FunctionObject

名稱	類型	Description	為必填項目	預設值
說明	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	否
名稱	字串	要呼叫之函式的名稱。 必須是 a-z、A-Z、0-9，或包含底線或虛線，長度上限為 64。	Yes
參數	OpenAI.FunctionParameters（開放AI.FunctionParameters）	函式接受的參數，描述為 JSON 結構描述物件。 範例請參見 guide，以及 JSON Schema 參考 以了解格式相關文件。 省略 parameters 定義具有空白參數清單的函式。	否
嚴格	布林值（可空）		否

OpenAI.FunctionParameters（開放AI.FunctionParameters）

函式接受的參數，描述為 JSON 結構描述物件。 範例請參見 guide，以及 JSON Schema 參考 以了解格式相關文件。 省略 parameters 定義具有空白參數清單的函式。

類型：物件

OpenAI.FunctionShellAction

執行一個殼狀指令。

名稱	類型	Description	為必填項目	預設值
commands	字串陣列		Yes
max_output_length	OpenAI.integer （nullable）		Yes
timeout_ms	OpenAI.integer （nullable）		Yes

OpenAI.FunctionShellActionParam

描述如何執行 shell 工具呼叫的指令與限制。

名稱	類型	Description	為必填項目	預設值
commands	字串陣列	命令執行環境執行 shell 指令。	Yes
max_output_length	OpenAI.integer （nullable）		否
timeout_ms	OpenAI.integer （nullable）		否

OpenAI.FunctionShellCallItemStatus

Shell 工具呼叫的狀態值報告。

房產	價值觀
Type	字串
價值	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

是 shell 工具呼叫輸出的內容。

名稱	類型	Description	為必填項目	預設值
創建者	字串	創建該項目的演員識別碼。	否
結果	OpenAI.FunctionShellCallOutputOutresult	代表一個結束結果（帶有退出代碼）或一個超時結果，適用於 shell 呼叫的輸出區塊。	Yes
\---- 類型	OpenAI.FunctionShellCallOutputOutcomeType		Yes
stderr	字串	所擷取的標準誤差輸出。	Yes
stdout	字串	被捕捉到的標準輸出。	Yes

OpenAI.FunctionShellCallOutputContentParam

擷取 shell 工具呼叫輸出的一部分 stdout 和 stderr。

名稱	類型	Description	為必填項目	預設值
結果	OpenAI.FunctionShellCallOutputOutcomeParam	與此 shell 呼叫相關的退出或超時結果。	Yes
\---- 類型	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
stderr	字串	擷取了 shell 呼叫的 stderr 輸出。 限制條件： maxLength： 10485760	Yes
stdout	字串	擷取了 shell 呼叫的標準輸出。 限制條件： maxLength： 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

表示 shell 指令已完成並回傳一個退出代碼。

名稱	類型	Description	為必填項目	預設值
exit_code	OpenAI.integer		Yes
型別	列舉	結果類型。 一律為 exit。 可能的值：exit	Yes

OpenAI.FunctionShellCallOutputExitOutcomeParam

表示 shell 指令已完成並回傳一個退出代碼。

名稱	類型	Description	為必填項目	預設值
exit_code	OpenAI.integer		Yes
型別	列舉	結果類型。 一律為 exit。 可能的值：exit	Yes

OpenAI.FunctionShellCallOutputOutresult

代表一個結束結果（帶有退出代碼）或一個超時結果，適用於 shell 呼叫的輸出區塊。

OpenAI 的判別器。FunctionShellCallOutputOutcomes

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutoutoutoutcomes
exit	OpenAI.FunctionShellCallOutputExitOutcome

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

與此 shell 呼叫相關的退出或超時結果。

OpenAI 的判別器。FunctionShellCallOutputOutcomeParam

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutoutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

房產	價值觀
Type	字串
價值	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

房產	價值觀
Type	字串
價值	timeout exit

OpenAI.FunctionShellCallOutputTimeoutoutoutoutcomes

表示 shell 呼叫已超過設定時間限制。

名稱	類型	Description	為必填項目	預設值
型別	列舉	結果類型。 一律為 timeout。 可能的值：timeout	Yes

OpenAI.FunctionShellCallOutputTimeoutoutcomeParam

表示 shell 呼叫已超過設定時間限制。

名稱	類型	Description	為必填項目	預設值
型別	列舉	結果類型。 一律為 timeout。 可能的值：timeout	Yes

OpenAI.FunctionShellToolParam

一個讓模型能執行 shell 指令的工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	外殼工具的種類。 一律為 shell。 可能的值：shell	Yes

OpenAI.FunctionTool

在您自己的程式代碼中定義函式，模型可以選擇呼叫。

名稱	類型	Description	為必填項目	預設值
說明	字串（可空）		否
名稱	字串	要呼叫的函式名稱。	Yes
參數	物件（可空除）		Yes
嚴格	布林值（可空）		Yes
型別	列舉	函式工具的類型。 一律為 function。 可能的值：function	Yes

OpenAI.GraderLabelModel

LabelModelGrader 物件，使用模型將標籤指派給評估中的每個專案。

名稱	類型	Description	為必填項目	預設值
輸入	OpenAI.EvalItem 的陣列		Yes
labels	字串陣列	要指派給評估中每個項目的標籤。	Yes
型號	字串	要用於評估的模型。 必須支援結構化輸出。	Yes
名稱	字串	評分者的名稱。	Yes
傳遞的標籤	字串陣列	表示通過結果的標示。 必須是標籤的子集。	Yes
型別	列舉	物件類型，一律為 label_model。 可能的值：label_model	Yes

OpenAI.GraderMulti

MultiGrader 物件會結合多個評分員的輸出來產生單一分數。

名稱	類型	Description	為必填項目	預設值
計算輸出	字串	根據評分工具結果計算輸出的公式。	Yes
評分工具	OpenAI.GraderStringCheck 或 OpenAI.GraderTextSimilarity 、 OpenAI.GraderPython 或 OpenAI.GraderScoreModel 或 OpenAI.GraderLabelModel		Yes
名稱	字串	評分者的名稱。	Yes
型別	列舉	物件類型，一律為 multi。 可能的值：multi	Yes

OpenAI.GraderPython

在輸入上執行 Python 腳本的 PythonGrader 物件。

名稱	類型	Description	為必填項目	預設值
image_tag	字串	要用於 Python 腳本的影像標記。	否
名稱	字串	評分者的名稱。	Yes
來源	字串	Python 腳本的原始程式碼。	Yes
型別	列舉	物件類型，一律為 python。 可能的值：python	Yes

OpenAI.GraderScoreModel

ScoreModelGrader 物件，使用模型將分數指派給輸入。

名稱	類型	Description	為必填項目	預設值
輸入	OpenAI.EvalItem 的陣列	評分者評估的輸入訊息。 支援文字、輸出文字、輸入影像及輸入音訊內容區塊，並可能包含範本字串。	Yes
型號	字串	要用於評估的模型。	Yes
名稱	字串	評分者的名稱。	Yes
範圍	OpenAI.numeric 的陣列	分數的範圍。 預設為 [0, 1]。	否
採樣參數	OpenAI.EvalGraderScoreModelSamplingParams		否
└─ max_completions_tokens	OpenAI.integer （nullable）		否
推理工作量	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
~---- 種子	OpenAI.integer （nullable）		否
‧---- 溫度	OpenAI.numeric （可空）		否
top_p	OpenAI.numeric （可空）		否	1
型別	列舉	物件類型，一律為 score_model。 可能的值：score_model	Yes

OpenAI.GraderStringCheck

StringCheckGrader 物件，使用指定的作業執行輸入與參考之間的字串比較。

名稱	類型	Description	為必填項目	預設值
輸入	字串	輸入文字。 這可能包含範本字串。	Yes
名稱	字串	評分者的名稱。	Yes
作業	列舉	要執行的字串檢查作業。 eq、ne、like 或 ilike 的其中之一。。 可能的值：eq、、ne、 likeilike	Yes
參考	字串	參考文字。 這可能包含範本字串。	Yes
型別	列舉	物件類型，一律為 string_check。 可能的值：string_check	Yes

OpenAI.GraderTextSimilarity

TextSimilarityGrader 物件，其會根據相似度計量來評分文字。

名稱	類型	Description	為必填項目	預設值
評估指標	列舉	要使用的評估計量。 其中一個cosine、fuzzy_match、bleu gleu、meteor、rouge_1、rouge_2、rouge_3、rouge_4、、、 rouge_5 或 rouge_l。 可能的值：cosine， ， fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Yes
輸入	字串	正在評分的文字。	Yes
名稱	字串	評分者的名稱。	Yes
參考	字串	用來評分的文本。	Yes
型別	列舉	評分器的類型。 可能的值：text_similarity	Yes

OpenAI.GrammarSyntax1

房產	價值觀
Type	字串
價值	lark regex

OpenAI.HybridSearchOptions

名稱	類型	Description	為必填項目	預設值
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageDetail

房產	價值觀
Type	字串
價值	low high auto

OpenAI.ImageGenTool

一個利用 GPT 影像模型生成影像的工具。

有效的模型：

gpt-image-1
gpt-image-1-mini

名稱	類型	Description	為必填項目	預設值
背景	列舉	所產生影像的背景類型。 下列其中一項：transparent opaque 或 auto。 預設值：auto。 可能的值：transparent、、 opaqueauto	否
輸入精確度	OpenAI.InputFidelity （可取消）	控制模型將發揮多少努力來比對輸入影像的樣式和特徵，尤其是臉部特徵。 僅 gpt-image-1 支援此參數。 不支援 gpt-image-1-mini。 支援 high 與 low。 預設為 low。	否
輸入圖像遮罩	OpenAI.ImageGenToolInputImageMask		否
file_id	字串		否
image_url（圖片網址）	字串		否
型號	字串 （請參閱下面的有效模型）		否
moderation	列舉	生成影像的審核層級。 預設值：auto。 可能的值： auto、 low	否
輸出壓縮	OpenAI.integer		否	100
輸出格式	列舉	產生的影像輸出格式。 其中一個 png、webp或 jpeg。 預設值：png。 可能的值：png、、 webpjpeg	否
部分影像	OpenAI.integer		否
品質	列舉	產生的影像品質。 其中一個low、medium、high 或 auto。 預設值：auto。 可能的值：low、、medium、 highauto	否
size	列舉	產生的影像大小。 下列其中一項：1024x1024、1024x1536、 1536x1024 或 auto。 預設值：auto。 可能的值：1024x1024、、1024x1536、 1536x1024auto	否
型別	列舉	影像產生工具的類型。 一律為 image_generation。 可能的值：image_generation	Yes

OpenAI.ImageGenToolInputImageMask

名稱	類型	Description	為必填項目	預設值
檔案識別碼 (file_id)	字串		否
image_url	字串		否

OpenAI.IncludeEnum

指定要包含在模型回應中的其他輸出數據。 目前支援的值如下：

• web_search_call.action.sources：請提供網路搜尋工具呼叫的來源。
• code_interpreter_call.outputs：包含 Python 程式碼在程式碼解釋器工具中呼叫項目的執行輸出。
• computer_call_output.output.image_url：包含來自計算機呼叫輸出的圖像 URL。
• file_search_call.results：包含檔案搜尋工具呼叫的搜尋結果。
• message.input_image.image_url：包含輸入訊息中的影像 URL。
• message.output_text.logprobs：將 logprobs 包含在助手訊息中。
• reasoning.encrypted_content：在推理項目輸出中包含已加密版本的推理令牌。 這可讓在多回合交談中使用推理項目，例如，當以無狀態方式使用回應 API 時（例如當 store 參數設定為 false時，或者當組織已註冊無數據保留計劃時）。

房產	價值觀
說明	指定要包含在模型回應中的其他輸出數據。 目前支援的值如下：

• web_search_call.action.sources：請提供網路搜尋工具呼叫的來源。
• code_interpreter_call.outputs：包含 Python 程式碼在程式碼解釋器工具中呼叫項目的執行輸出。
• computer_call_output.output.image_url：包含來自計算機呼叫輸出的圖像 URL。
• file_search_call.results：包含檔案搜尋工具呼叫的搜尋結果。
• message.input_image.image_url：包含輸入訊息中的影像 URL。
• message.output_text.logprobs：將 logprobs 包含在助手訊息中。
• reasoning.encrypted_content：在推理項目輸出中包含已加密版本的推理令牌。 這可讓在多回合交談中使用推理項目，例如，當以無狀態方式使用回應 API 時（例如當 store 參數設定為 false時，或者當組織已註冊無數據保留計劃時）。 | | 類型 |string | | 值 | 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

音訊輸入至模型。

名稱	類型	Description	為必填項目	預設值
input_audio	OpenAI.InputAudioInputAudio		Yes
型別	列舉	輸入項目的型別。 一律為 input_audio。 可能的值：input_audio	Yes

OpenAI.InputAudioInputAudio

名稱	類型	Description	為必填項目	預設值
資料	字串		Yes
format	列舉	可能的值： mp3、 wav	Yes

OpenAI.InputContent

OpenAI 的判別器。InputContent

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

模型的檔案輸入。

名稱	類型	Description	為必填項目	預設值
file_data	字串	要傳送至模型的檔案內容。	否
檔案識別碼 (file_id)	字串（可空）		否
file_url	字串	要傳送給模型的檔案網址。	否
filename	字串	要傳送至模型的檔案名稱。	否
型別	列舉	輸入項目的型別。 一律為 input_file。 可能的值：input_file	Yes

OpenAI.InputContentInputImageContent

輸入至模型的影像 了解影像輸入。

名稱	類型	Description	為必填項目	預設值
detail	OpenAI.ImageDetail		Yes
檔案識別碼 (file_id)	字串（可空）		否
image_url	字串		否
型別	列舉	輸入項目的型別。 一律為 input_image。 可能的值：input_image	Yes

OpenAI.InputContentInputTextContent

模型的文字輸入。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸入。	Yes
型別	列舉	輸入項目的型別。 一律為 input_text。 可能的值：input_text	Yes

OpenAI.InputContentType

房產	價值觀
Type	字串
價值	input_text input_image input_file

OpenAI.InputFidelity

控制模型將發揮多少努力來比對輸入影像的樣式和特徵，尤其是臉部特徵。 僅 gpt-image-1 支援此參數。 不支援 gpt-image-1-mini。 支援 high 與 low。 預設為 low。

房產	價值觀
Type	字串
價值	high low

OpenAI.InputFileContent

模型的檔案輸入。

名稱	類型	Description	為必填項目	預設值
file_data	字串	要傳送至模型的檔案內容。	否
檔案識別碼 (file_id)	字串（可空）		否
file_url	字串	要傳送給模型的檔案網址。	否
filename	字串	要傳送至模型的檔案名稱。	否
型別	列舉	輸入項目的型別。 一律為 input_file。 可能的值：input_file	Yes

OpenAI.InputFileContentParam

模型的檔案輸入。

名稱	類型	Description	為必填項目	預設值
file_data	字串（可空）		否
檔案識別碼 (file_id)	字串（可空）		否
file_url	字串		否
filename	字串（可空）		否
型別	列舉	輸入項目的型別。 一律為 input_file。 可能的值：input_file	Yes

OpenAI.InputImageContent

輸入至模型的影像 了解影像輸入。

名稱	類型	Description	為必填項目	預設值
detail	OpenAI.ImageDetail		Yes
檔案識別碼 (file_id)	字串（可空）		否
image_url	字串		否
型別	列舉	輸入項目的型別。 一律為 input_image。 可能的值：input_image	Yes

OpenAI.InputImageContentParamAutoParam

輸入至模型的影像 了解影像輸入

名稱	類型	Description	為必填項目	預設值
detail	OpenAI.DetailEnum （可空除）		否
檔案識別碼 (file_id)	字串（可空）		否
image_url	字串		否
型別	列舉	輸入項目的型別。 一律為 input_image。 可能的值：input_image	Yes

OpenAI.InputItem

一個代表部分情境的項目，供模型產生回應。 可包含文字、圖片與音訊輸入，以及先前的助理回應與工具呼叫輸出。

OpenAI 的判別器。輸入項目

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
message	OpenAI.EasyInputMessage
item_reference	OpenAI.ItemReferenceParam
output_message	OpenAI.InputItemOutputMessage
file_search_call	OpenAI.InputItemFileSearchToolCall
computer_call	OpenAI.InputItemComputerToolCall
computer_call_output	OpenAI.InputItemComputerCallOutputItemParam
web_search_call	OpenAI.InputItemWebSearchToolCall
function_call	OpenAI.InputItemFunctionToolCall
function_call_output	OpenAI.InputItemFunctionCallOutputItemParam
reasoning	OpenAI.InputItemReasoningItem
compaction	OpenAI.InputItemCompactionSummaryItemParam
image_generation_call	OpenAI.InputItemImageGenToolCall
code_interpreter_call	OpenAI.InputItemCodeInterpreterToolCall
local_shell_call	OpenAI.InputItemLocalShellToolCall
local_shell_call_output	OpenAI.InputItemLocalShellToolCallOutput
shell_call	OpenAI.InputItemFunctionShellCallItemParam
shell_call_output	OpenAI.InputItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.InputItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.InputItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.InputItemMcpListTools
mcp_approval_request	OpenAI.InputItemMcpApprovalRequest
mcp_approval_response	OpenAI.InputItemMcpApprovalResponse（開放AI）。InputItemMcpApprovalResponse（回應）
mcp_call	OpenAI.InputItemMcpToolCall
custom_tool_call_output	OpenAI.InputItemCustomToolCallOutput
custom_tool_call	OpenAI.InputItemCustomToolCall

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

一個工具呼叫，代表使用差異補丁建立、刪除或更新檔案的請求。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
作業	OpenAI.ApplyPatchOperationParam	這是提供給apply_patch工具的create_file、delete_file或update_file操作之一。	Yes
\---- 類型	OpenAI.ApplyPatchOperationParamType		Yes
狀態	OpenAI.ApplyPatchCallStatusParam	apply_patch工具呼叫的狀態值報告。	Yes
型別	列舉	項目的類型。 一律為 apply_patch_call。 可能的值：apply_patch_call	Yes

OpenAI.InputItemApplyPatchToolCallOutputItemParam

由 apply 修補工具呼叫所輸出的串流輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
輸出	字串（可空）		否
狀態	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch工具呼叫輸出的結果值報告。	Yes
型別	列舉	項目的類型。 一律為 apply_patch_call_output。 可能的值：apply_patch_call_output	Yes

OpenAI.InputItemCodeInterpreterToolCall

執行程式代碼的工具呼叫。

名稱	類型	Description	為必填項目	預設值
字碼	字串（可空）		Yes
container_id	字串	用來執行程式代碼之容器的標識碼。	Yes
id	字串	程式代碼解釋器工具呼叫的唯一標識符。	Yes
輸出	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的陣列		Yes
狀態	列舉	程式代碼解釋器工具呼叫的狀態。 有效值為 in_progress、completed、incomplete、interpreting 和 failed。 可能的值：in_progress、completed、incomplete、interpreting、failed	Yes
型別	列舉	程式代碼解釋器工具呼叫的類型。 一律為 code_interpreter_call。 可能的值：code_interpreter_call	Yes

OpenAI.InputItemCompactionSummaryItemParam

API產生v1/responses/compact的壓縮項目。

名稱	類型	Description	為必填項目	預設值
encrypted_content	字串	壓縮摘要的加密內容。 限制條件： maxLength： 10485760	Yes
id	字串（可空）		否
型別	列舉	項目的類型。 一律為 compaction。 可能的值：compaction	Yes

OpenAI.InputItemComputerCallOutputItemParam

電腦工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
acknowledged_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列		否
call_id	字串	產生輸出之計算機工具呼叫的標識碼。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
輸出	OpenAI.Computer截圖圖片	計算機螢幕快照影像，與計算機使用工具搭配使用。	Yes
狀態	OpenAI.FunctionCallItemStatus （nullable）		否
型別	列舉	計算機工具呼叫輸出的類型。 一律為 computer_call_output。 可能的值：computer_call_output	Yes

OpenAI.InputItemComputerToolCall

對電腦使用工具發出的工具呼叫。 更多資訊請參閱 computer 使用指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.ComputerAction		Yes
call_id	字串	使用輸出回應工具呼叫時所使用的識別碼。	Yes
id	字串	計算機呼叫的唯一標識碼。	Yes
pending_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	電腦呼叫的擱置安全性檢查。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	計算機呼叫的類型。 一律為 computer_call。 可能的值：computer_call	Yes

OpenAI.InputItemCustomToolCall

呼叫模型建立的自訂工具。

名稱	類型	Description	為必填項目	預設值
call_id	字串	一個用於將此自訂工具呼叫映射到工具呼叫輸出的識別碼。	Yes
id	字串	OpenAI 平台自訂工具呼叫的唯一 ID。	否
輸入	字串	模型產生的自訂工具呼叫輸入。	Yes
名稱	字串	正在被呼叫的自訂工具名稱。	Yes
型別	列舉	自訂工具呼叫的類型。 一律為 custom_tool_call。 可能的值：custom_tool_call	Yes

OpenAI.InputItemCustomToolCallOutput

你程式碼中自訂工具呼叫的輸出，會回傳給模型。

名稱	類型	Description	為必填項目	預設值
call_id	字串	呼叫 ID，用來將這個自訂工具呼叫輸出對應到自訂工具呼叫。	Yes
id	字串	OpenAI 平台中自訂工具呼叫輸出的唯一 ID。	否
輸出	OpenAI.FunctionAndCustomToolCallOutput 的字串或陣列	你的程式碼產生的自訂工具呼叫輸出。 可以是字串或輸出內容的清單。	Yes
型別	列舉	自訂工具呼叫輸出的類型。 一律為 custom_tool_call_output。 可能的值：custom_tool_call_output	Yes

OpenAI.InputItemFileSearchToolCall

檔案搜尋工具呼叫的結果。 更多資訊請參閱 file 搜尋指南。

名稱	類型	Description	為必填項目	預設值
id	字串	檔案搜尋工具呼叫的唯一標識符。	Yes
queries	字串陣列	用來搜尋檔案的查詢。	Yes
results	OpenAI.FileSearchToolCallResults 的陣列		否
狀態	列舉	檔案搜尋工具呼叫的狀態。 下列其中一項：in_progress searching、 或 incomplete、 failed 可能的值：in_progress、searching、completed、incomplete、failed	Yes
型別	列舉	檔案搜尋工具呼叫的類型。 一律為 file_search_call。 可能的值：file_search_call	Yes

OpenAI.InputItemFunctionCallOutputItemParam

函式工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
輸出	OpenAI.InputTextContentParam 或 OpenAI.InputImageContentParamAutoParam 或 OpenAI.InputFileContentParam 的字串或陣列	函式工具呼叫的文字、圖片或檔案輸出。	Yes
狀態	OpenAI.FunctionCallItemStatus （nullable）		否
型別	列舉	函數工具呼叫輸出類型。 一律為 function_call_output。 可能的值：function_call_output	Yes

OpenAI.InputItemFunctionShellCallItemParam

一個代表執行一個或多個 shell 指令請求的工具。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.FunctionShellActionParam	描述如何執行 shell 工具呼叫的指令與限制。	Yes
└─ 指令	字串陣列	命令執行環境執行 shell 指令。	Yes
└─ max_output_length	OpenAI.integer （nullable）		否
└─ timeout_ms	OpenAI.integer （nullable）		否
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
狀態	OpenAI.FunctionShellCallItemStatus （可空）	Shell 工具呼叫的狀態值報告。	否
型別	列舉	項目的類型。 一律為 shell_call。 可能的值：shell_call	Yes

OpenAI.InputItemFunctionShellCallOutputItemParam

由 shell 工具呼叫所輸出的串流輸出項目。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
max_output_length	OpenAI.integer （nullable）		否
輸出	OpenAI.FunctionShellCallOutputContentParam 的陣列	擷取 stdout 和 stderr 輸出區塊，以及它們相關的結果。	Yes
型別	列舉	項目的類型。 一律為 shell_call_output。 可能的值：shell_call_output	Yes

OpenAI.InputItemFunctionToolCall

執行函式的工具呼叫。 更多資訊請參閱 function 呼叫指南。

名稱	類型	Description	為必填項目	預設值
arguments	字串	要傳遞至函式的引數 JSON 字串。	Yes
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函數工具呼叫的唯一標識碼。	否
名稱	字串	要執行的函式名稱。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函式工具呼叫的類型。 一律為 function_call。 可能的值：function_call	Yes

OpenAI.InputItemImageGenToolCall

模型提出的圖像生成要求。

名稱	類型	Description	為必填項目	預設值
id	字串	影像生成呼叫的唯一 ID。	Yes
結果	字串（可空）		Yes
狀態	列舉	影像生成通話狀態。 可能的值：in_progress、、completed、 generatingfailed	Yes
型別	列舉	影像生成呼叫的類型。 一律為 image_generation_call。 可能的值：image_generation_call	Yes

OpenAI.InputItemLocalShellToolCall

在本機殼層上執行命令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.LocalShellExecAction	在伺服器上執行殼層命令。	Yes
call_id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
id	字串	本地 shell 呼叫的唯一 ID。	Yes
狀態	列舉	本地空殼通話狀態。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	本地 shell 呼叫的類型。 一律為 local_shell_call。 可能的值：local_shell_call	Yes

OpenAI.InputItemLocalShellToolCallOutput

本機 Shell 工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
輸出	字串	本機殼層工具呼叫輸出的 JSON 字串。	Yes
狀態	列舉	可能的值：in_progress、、 completedincomplete	否
型別	列舉	本地殼層工具呼叫輸出的類型。 一律為 local_shell_call_output。 可能的值：local_shell_call_output	Yes

OpenAI.InputItemMcpApprovalRequest

要求人工核准工具叫用。

名稱	類型	Description	為必填項目	預設值
arguments	字串	工具的自變數 JSON 字串。	Yes
id	字串	核准申請的唯一 ID。	Yes
名稱	字串	要執行的工具名稱。	Yes
伺服器標籤	字串	發出要求的 MCP 伺服器的標籤。	Yes
型別	列舉	項目的類型。 一律為 mcp_approval_request。 可能的值：mcp_approval_request	Yes

OpenAI.InputItemMcpApprovalResponse（開放AI）。InputItemMcpApprovalResponse（回應）

對 MCP 核准申請的回應。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串	正在回應之核准要求的識別碼。	Yes
approve	布爾值	是否已核准要求。	Yes
id	字串（可空）		否
reason	字串（可空）		否
型別	列舉	項目的類型。 一律為 mcp_approval_response。 可能的值：mcp_approval_response	Yes

OpenAI.InputItemMcpListTools

MCP 伺服器上可用的工具清單。

名稱	類型	Description	為必填項目	預設值
錯誤	字串（可空）		否
id	字串	名單的唯一ID。	Yes
伺服器標籤	字串	MCP 伺服器的標籤。	Yes
工具	OpenAI.MCPListToolsTool 的 array	伺服器上可用的工具。	Yes
型別	列舉	項目的類型。 一律為 mcp_list_tools。 可能的值：mcp_list_tools	Yes

OpenAI.InputItemMcpToolCall

MCP 伺服器上的工具叫用。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串（可空）		否
arguments	字串	傳遞到工具的參數所構成的 JSON 字串。	Yes
錯誤	字串（可空）		否
id	字串	工具呼叫的唯一 ID。	Yes
名稱	字串	執行的工具名稱。	Yes
輸出	字串（可空）		否
伺服器標籤	字串	執行此工具之 MCP 伺服器的標籤。	Yes
狀態	OpenAI.MCPToolCallStatus（開放AI.MCPToolCallStatus）		否
型別	列舉	項目的類型。 一律為 mcp_call。 可能的值：mcp_call	Yes

OpenAI.InputItemOutputMessage

來自模型的輸出訊息。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI 的陣列 。OutputMessageContent	輸出訊息的內容。	Yes
id	字串	輸出訊息的唯一標識碼。	Yes
角色	列舉	輸出訊息的角色。 一律為 assistant。 可能的值：assistant	Yes
狀態	列舉	訊息輸入的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回輸入項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	輸出訊息的類型。 一律為 message。 可能的值：output_message	Yes

OpenAI.InputItemReasoningItem

產生回應時，推理模型所使用之思想鏈結的描述。 如果你手動管理上下文，務必將這些項目包含在你的回應 API 的 中，以便後續對話回合使用。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI 的陣列 。ReasoningTextContent	推理文本內容。	否
encrypted_content	字串（可空）		否
id	字串	推理內容的唯一標識碼。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
摘要	OpenAI 的陣列 。摘要	推理摘要內容。	Yes
型別	列舉	物件的類型。 一律為 reasoning。 可能的值：reasoning	Yes

OpenAI.InputItemType

房產	價值觀
Type	字串
價值	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

網路搜尋工具呼叫的結果。 更多資訊請參閱 web 搜尋指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述此 Web 搜尋呼叫中採取的特定動作的物件。 包括模型如何使用 Web （搜尋、open_page、尋找） 的詳細資料。	Yes
id	字串	網路搜尋工具呼叫的唯一 ID。	Yes
狀態	列舉	Web 搜尋工具呼叫的狀態。 可能的值：in_progress、、searching、 completedfailed	Yes
型別	列舉	網路搜尋工具的呼叫類型。 一律為 web_search_call。 可能的值：web_search_call	Yes

OpenAI.InputMessage

具有角色的訊息輸入至模型，指出下列階層的指示。 由 developer 或 system 角色給出的指示優先於由角色 user 給出的指示。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI.InputMessageContentList	一個或多個輸入項目的清單，包含不同內容 types.	Yes
角色	列舉	訊息輸入的作用。 user、system 或 developer 的其中之一。 可能的值：user、、 systemdeveloper	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	訊息輸入的類型。 一律設定為 message。 可能的值：message	Yes

OpenAI.InputMessageContentList

模型中一或多個輸入項目的清單，其中包含不同的內容類型。

陣列：OpenAI.InputContent

OpenAI.InputMessageResource

名稱	類型	Description	為必填項目	預設值
內容	OpenAI.InputMessageContentList	一個或多個輸入項目的清單，包含不同內容 types.	Yes
id	字串	訊息輸入的唯一標識碼。	Yes
角色	列舉	訊息輸入的作用。 user、system 或 developer 的其中之一。 可能的值：user、、 systemdeveloper	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	訊息輸入的類型。 一律設定為 message。 可能的值：message	Yes

OpenAI.InputParam

用來讓模型產生回應的文字、影像或檔案輸入。 瞭解詳情：

• 文字輸入與輸出
• 影像輸入
• 檔案輸入
• 對話狀態
• 函式呼叫

類型：OpenAI.InputItem 的字串或陣列

用來讓模型產生回應的文字、影像或檔案輸入。 瞭解詳情：

• 文字輸入與輸出
• 影像輸入
• 檔案輸入
• 對話狀態
• 函式呼叫

OpenAI.InputTextContent

模型的文字輸入。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸入。	Yes
型別	列舉	輸入項目的型別。 一律為 input_text。 可能的值：input_text	Yes

OpenAI.InputTextContentParam

模型的文字輸入。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸入。 限制條件： maxLength： 10485760	Yes
型別	列舉	輸入項目的型別。 一律為 input_text。 可能的值：input_text	Yes

OpenAI.項目

用來產生回應的內容項目。

OpenAI 的判別器。項目

此元件會使用 屬性 type 來區分不同的類型：

類型值	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

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ItemType		Yes

OpenAI.ItemApplyPatchToolCallItemParam

一個工具呼叫，代表使用差異補丁建立、刪除或更新檔案的請求。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
作業	OpenAI.ApplyPatchOperationParam	這是提供給apply_patch工具的create_file、delete_file或update_file操作之一。	Yes
\---- 類型	OpenAI.ApplyPatchOperationParamType		Yes
狀態	OpenAI.ApplyPatchCallStatusParam	apply_patch工具呼叫的狀態值報告。	Yes
型別	列舉	項目的類型。 一律為 apply_patch_call。 可能的值：apply_patch_call	Yes

OpenAI.ItemApplyPatchToolCallOutputItemParam

由 apply 修補工具呼叫所輸出的串流輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
輸出	字串（可空）		否
狀態	OpenAI.ApplyPatchCallOutputStatusParam	apply_patch工具呼叫輸出的結果值報告。	Yes
型別	列舉	項目的類型。 一律為 apply_patch_call_output。 可能的值：apply_patch_call_output	Yes

OpenAI.ItemCodeInterpreterToolCall

執行程式代碼的工具呼叫。

名稱	類型	Description	為必填項目	預設值
字碼	字串（可空）		Yes
container_id	字串	用來執行程式代碼之容器的標識碼。	Yes
id	字串	程式代碼解釋器工具呼叫的唯一標識符。	Yes
輸出	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的陣列		Yes
狀態	列舉	程式代碼解釋器工具呼叫的狀態。 有效值為 in_progress、completed、incomplete、interpreting 和 failed。 可能的值：in_progress、completed、incomplete、interpreting、failed	Yes
型別	列舉	程式代碼解釋器工具呼叫的類型。 一律為 code_interpreter_call。 可能的值：code_interpreter_call	Yes

OpenAI.ItemCompactionSummaryItemParam

API產生v1/responses/compact的壓縮項目。

名稱	類型	Description	為必填項目	預設值
encrypted_content	字串	壓縮摘要的加密內容。 限制條件： maxLength： 10485760	Yes
id	字串（可空）		否
型別	列舉	項目的類型。 一律為 compaction。 可能的值：compaction	Yes

OpenAI.ItemComputerCallOutputItemParam

電腦工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
acknowledged_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列		否
call_id	字串	產生輸出之計算機工具呼叫的標識碼。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
輸出	OpenAI.Computer截圖圖片	計算機螢幕快照影像，與計算機使用工具搭配使用。	Yes
狀態	OpenAI.FunctionCallItemStatus （nullable）		否
型別	列舉	計算機工具呼叫輸出的類型。 一律為 computer_call_output。 可能的值：computer_call_output	Yes

OpenAI.ItemComputerToolCall

對電腦使用工具發出的工具呼叫。 更多資訊請參閱 computer 使用指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.ComputerAction		Yes
call_id	字串	使用輸出回應工具呼叫時所使用的識別碼。	Yes
id	字串	計算機呼叫的唯一標識碼。	Yes
pending_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	電腦呼叫的擱置安全性檢查。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	計算機呼叫的類型。 一律為 computer_call。 可能的值：computer_call	Yes

OpenAI.ItemCustomToolCall

呼叫模型建立的自訂工具。

名稱	類型	Description	為必填項目	預設值
call_id	字串	一個用於將此自訂工具呼叫映射到工具呼叫輸出的識別碼。	Yes
id	字串	OpenAI 平台自訂工具呼叫的唯一 ID。	否
輸入	字串	模型產生的自訂工具呼叫輸入。	Yes
名稱	字串	正在被呼叫的自訂工具名稱。	Yes
型別	列舉	自訂工具呼叫的類型。 一律為 custom_tool_call。 可能的值：custom_tool_call	Yes

OpenAI.ItemCustomToolCallOutput

你程式碼中自訂工具呼叫的輸出，會回傳給模型。

名稱	類型	Description	為必填項目	預設值
call_id	字串	呼叫 ID，用來將這個自訂工具呼叫輸出對應到自訂工具呼叫。	Yes
id	字串	OpenAI 平台中自訂工具呼叫輸出的唯一 ID。	否
輸出	OpenAI.FunctionAndCustomToolCallOutput 的字串或陣列	你的程式碼產生的自訂工具呼叫輸出。 可以是字串或輸出內容的清單。	Yes
型別	列舉	自訂工具呼叫輸出的類型。 一律為 custom_tool_call_output。 可能的值：custom_tool_call_output	Yes

OpenAI.ItemFileSearchToolCall

檔案搜尋工具呼叫的結果。 更多資訊請參閱 file 搜尋指南。

名稱	類型	Description	為必填項目	預設值
id	字串	檔案搜尋工具呼叫的唯一標識符。	Yes
queries	字串陣列	用來搜尋檔案的查詢。	Yes
results	OpenAI.FileSearchToolCallResults 的陣列		否
狀態	列舉	檔案搜尋工具呼叫的狀態。 下列其中一項：in_progress searching、 或 incomplete、 failed 可能的值：in_progress、searching、completed、incomplete、failed	Yes
型別	列舉	檔案搜尋工具呼叫的類型。 一律為 file_search_call。 可能的值：file_search_call	Yes

OpenAI.ItemFunctionCallOutputItemParam

函式工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
輸出	OpenAI.InputTextContentParam 或 OpenAI.InputImageContentParamAutoParam 或 OpenAI.InputFileContentParam 的字串或陣列	函式工具呼叫的文字、圖片或檔案輸出。	Yes
狀態	OpenAI.FunctionCallItemStatus （nullable）		否
型別	列舉	函數工具呼叫輸出類型。 一律為 function_call_output。 可能的值：function_call_output	Yes

OpenAI.ItemFunctionShellCallItemParam

一個代表執行一個或多個 shell 指令請求的工具。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.FunctionShellActionParam	描述如何執行 shell 工具呼叫的指令與限制。	Yes
└─ 指令	字串陣列	命令執行環境執行 shell 指令。	Yes
└─ max_output_length	OpenAI.integer （nullable）		否
└─ timeout_ms	OpenAI.integer （nullable）		否
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
狀態	OpenAI.FunctionShellCallItemStatus （可空）	Shell 工具呼叫的狀態值報告。	否
型別	列舉	項目的類型。 一律為 shell_call。 可能的值：shell_call	Yes

OpenAI.ItemFunctionShellCallOutputItemParam

由 shell 工具呼叫所輸出的串流輸出項目。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。 限制條件： 最小長度：1，最大長度：64	Yes
id	字串（可空）		否
max_output_length	OpenAI.integer （nullable）		否
輸出	OpenAI.FunctionShellCallOutputContentParam 的陣列	擷取 stdout 和 stderr 輸出區塊，以及它們相關的結果。	Yes
型別	列舉	項目的類型。 一律為 shell_call_output。 可能的值：shell_call_output	Yes

OpenAI.ItemFunctionToolCall

執行函式的工具呼叫。 更多資訊請參閱 function 呼叫指南。

名稱	類型	Description	為必填項目	預設值
arguments	字串	要傳遞至函式的引數 JSON 字串。	Yes
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函數工具呼叫的唯一標識碼。	否
名稱	字串	要執行的函式名稱。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函式工具呼叫的類型。 一律為 function_call。 可能的值：function_call	Yes

OpenAI.ItemImageGenToolCall

模型提出的圖像生成要求。

名稱	類型	Description	為必填項目	預設值
id	字串	影像生成呼叫的唯一 ID。	Yes
結果	字串（可空）		Yes
狀態	列舉	影像生成通話狀態。 可能的值：in_progress、、completed、 generatingfailed	Yes
型別	列舉	影像生成呼叫的類型。 一律為 image_generation_call。 可能的值：image_generation_call	Yes

OpenAI.ItemLocalShellToolCall

在本機殼層上執行命令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.LocalShellExecAction	在伺服器上執行殼層命令。	Yes
call_id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
id	字串	本地 shell 呼叫的唯一 ID。	Yes
狀態	列舉	本地空殼通話狀態。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	本地 shell 呼叫的類型。 一律為 local_shell_call。 可能的值：local_shell_call	Yes

OpenAI.ItemLocalShellToolCallOutput

本機 Shell 工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
輸出	字串	本機殼層工具呼叫輸出的 JSON 字串。	Yes
狀態	列舉	可能的值：in_progress、、 completedincomplete	否
型別	列舉	本地殼層工具呼叫輸出的類型。 一律為 local_shell_call_output。 可能的值：local_shell_call_output	Yes

OpenAI.ItemMcpApprovalRequest

要求人工核准工具叫用。

名稱	類型	Description	為必填項目	預設值
arguments	字串	工具的自變數 JSON 字串。	Yes
id	字串	核准申請的唯一 ID。	Yes
名稱	字串	要執行的工具名稱。	Yes
伺服器標籤	字串	發出要求的 MCP 伺服器的標籤。	Yes
型別	列舉	項目的類型。 一律為 mcp_approval_request。 可能的值：mcp_approval_request	Yes

OpenAI.ItemMcpApprovalResponse

對 MCP 核准申請的回應。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串	正在回應之核准要求的識別碼。	Yes
approve	布爾值	是否已核准要求。	Yes
id	字串（可空）		否
reason	字串（可空）		否
型別	列舉	項目的類型。 一律為 mcp_approval_response。 可能的值：mcp_approval_response	Yes

OpenAI.ItemMcpListTools

MCP 伺服器上可用的工具清單。

名稱	類型	Description	為必填項目	預設值
錯誤	字串（可空）		否
id	字串	名單的唯一ID。	Yes
伺服器標籤	字串	MCP 伺服器的標籤。	Yes
工具	OpenAI.MCPListToolsTool 的 array	伺服器上可用的工具。	Yes
型別	列舉	項目的類型。 一律為 mcp_list_tools。 可能的值：mcp_list_tools	Yes

OpenAI.ItemMcpToolCall

MCP 伺服器上的工具叫用。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串（可空）		否
arguments	字串	傳遞到工具的參數所構成的 JSON 字串。	Yes
錯誤	字串（可空）		否
id	字串	工具呼叫的唯一 ID。	Yes
名稱	字串	執行的工具名稱。	Yes
輸出	字串（可空）		否
伺服器標籤	字串	執行此工具之 MCP 伺服器的標籤。	Yes
狀態	OpenAI.MCPToolCallStatus（開放AI.MCPToolCallStatus）		否
型別	列舉	項目的類型。 一律為 mcp_call。 可能的值：mcp_call	Yes

OpenAI.ItemOutputMessage

來自模型的輸出訊息。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI 的陣列 。OutputMessageContent	輸出訊息的內容。	Yes
id	字串	輸出訊息的唯一標識碼。	Yes
角色	列舉	輸出訊息的角色。 一律為 assistant。 可能的值：assistant	Yes
狀態	列舉	訊息輸入的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回輸入項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	輸出訊息的類型。 一律為 message。 可能的值：output_message	Yes

OpenAI.ItemReasoningItem

產生回應時，推理模型所使用之思想鏈結的描述。 如果你手動管理上下文，務必將這些項目包含在你的回應 API 的 中，以便後續對話回合使用。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI 的陣列 。ReasoningTextContent	推理文本內容。	否
encrypted_content	字串（可空）		否
id	字串	推理內容的唯一標識碼。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
摘要	OpenAI 的陣列 。摘要	推理摘要內容。	Yes
型別	列舉	物件的類型。 一律為 reasoning。 可能的值：reasoning	Yes

OpenAI.ItemReferenceParam

要參考之項目的內部識別碼。

名稱	類型	Description	為必填項目	預設值
id	字串	要參考之專案的標識碼。	Yes
型別	列舉	要參考的項目類型。 一律為 item_reference。 可能的值：item_reference	Yes

OpenAI.ItemResource

用來產生回應的內容項目。

OpenAI.ItemResource 的鑑別子

此元件會使用 屬性 type 來區分不同的類型：

類型值	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

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

一個工具呼叫，透過建立、刪除或更新檔案來套用檔案差異。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。	Yes
創建者	字串	創建這個工具呼叫的實體的 ID。	否
id	字串	套用補丁工具呼叫的唯一 ID。 透過 API 傳回此項目時填入。	Yes
作業	OpenAI.ApplyPatchFileOperation	其中一種create_file、delete_file或update_file操作透過apply_patch應用。	Yes
\---- 類型	OpenAI.ApplyPatchFileOperationType		Yes
狀態	OpenAI.ApplyPatchCallStatus（開放AI）。ApplyPatchCallStatus（查詢狀態）		Yes
型別	列舉	項目的類型。 一律為 apply_patch_call。 可能的值：apply_patch_call	Yes

OpenAI.ItemResourceApplyPatchToolCallOutput

由 apply patch tool 呼叫所輸出的輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。	Yes
創建者	字串	建立此工具的實體 ID 呼叫輸出。	否
id	字串	apply patch 工具呼叫輸出的唯一 ID。 透過 API 傳回此項目時填入。	Yes
輸出	字串（可空）		否
狀態	OpenAI.ApplyPatchCallOutputStatus		Yes
型別	列舉	項目的類型。 一律為 apply_patch_call_output。 可能的值：apply_patch_call_output	Yes

OpenAI.ItemResourceCodeInterpreterToolCall

執行程式代碼的工具呼叫。

名稱	類型	Description	為必填項目	預設值
字碼	字串（可空）		Yes
container_id	字串	用來執行程式代碼之容器的標識碼。	Yes
id	字串	程式代碼解釋器工具呼叫的唯一標識符。	Yes
輸出	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的陣列		Yes
狀態	列舉	程式代碼解釋器工具呼叫的狀態。 有效值為 in_progress、completed、incomplete、interpreting 和 failed。 可能的值：in_progress、completed、incomplete、interpreting、failed	Yes
型別	列舉	程式代碼解釋器工具呼叫的類型。 一律為 code_interpreter_call。 可能的值：code_interpreter_call	Yes

OpenAI.ItemResourceComputerToolCall

對電腦使用工具發出的工具呼叫。 更多資訊請參閱 computer 使用指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.ComputerAction		Yes
call_id	字串	使用輸出回應工具呼叫時所使用的識別碼。	Yes
id	字串	計算機呼叫的唯一標識碼。	Yes
pending_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	電腦呼叫的擱置安全性檢查。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	計算機呼叫的類型。 一律為 computer_call。 可能的值：computer_call	Yes

OpenAI.ItemResourceComputerToolCallOutputResource

名稱	類型	Description	為必填項目	預設值
acknowledged_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	API 報告的安全檢查已得到以下項目的認可： 開發人員。	否
call_id	字串	產生輸出之計算機工具呼叫的標識碼。	Yes
id	字串	計算機工具呼叫輸出的識別碼。	否
輸出	OpenAI.Computer截圖圖片	計算機螢幕快照影像，與計算機使用工具搭配使用。	Yes
狀態	列舉	訊息輸入的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回輸入項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	計算機工具呼叫輸出的類型。 一律為 computer_call_output。 可能的值：computer_call_output	Yes

OpenAI.ItemResourceFileSearchToolCall

檔案搜尋工具呼叫的結果。 更多資訊請參閱 file 搜尋指南。

名稱	類型	Description	為必填項目	預設值
id	字串	檔案搜尋工具呼叫的唯一標識符。	Yes
queries	字串陣列	用來搜尋檔案的查詢。	Yes
results	OpenAI.FileSearchToolCallResults 的陣列		否
狀態	列舉	檔案搜尋工具呼叫的狀態。 下列其中一項：in_progress searching、 或 incomplete、 failed 可能的值：in_progress、searching、completed、incomplete、failed	Yes
型別	列舉	檔案搜尋工具呼叫的類型。 一律為 file_search_call。 可能的值：file_search_call	Yes

OpenAI.ItemResourceFunctionShellCall

一個在受管理環境中執行一個或多個 shell 指令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.FunctionShellAction	執行一個殼狀指令。	Yes
└─ 指令	字串陣列		Yes
└─ max_output_length	OpenAI.integer （nullable）		Yes
└─ timeout_ms	OpenAI.integer （nullable）		Yes
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。	Yes
創建者	字串	創建這個工具呼叫的實體的 ID。	否
id	字串	shell 工具呼叫的唯一 ID。 透過 API 傳回此項目時填入。	Yes
狀態	OpenAI.LocalShellCallStatus（開放人工智慧）LocalShellCallStatus（狀態）		Yes
型別	列舉	項目的類型。 一律為 shell_call。 可能的值：shell_call	Yes

OpenAI.ItemResourceFunctionShellCallOutput

是 shell 工具呼叫所發出的輸出。

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。	Yes
創建者	字串	創建該項目的演員識別碼。	否
id	字串	shell呼叫輸出的唯一ID。 透過 API 傳回此項目時填入。	Yes
max_output_length	OpenAI.integer （nullable）		Yes
輸出	OpenAI.FunctionShellCallOutputContent 的陣列	一個包含 shell 呼叫輸出內容的陣列	Yes
型別	列舉	shell呼叫輸出的類型。 一律為 shell_call_output。 可能的值：shell_call_output	Yes

OpenAI.ItemResourceFunctionToolCallOutputResource

名稱	類型	Description	為必填項目	預設值
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函式工具呼叫輸出的唯一標識碼。 當這個項目時，已填滿 透過 API 回傳。	否
輸出	OpenAI.FunctionAndCustomToolCallOutput 的字串或陣列	是你程式碼產生的函式呼叫輸出。 可以是字串或輸出內容的清單。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函數工具呼叫輸出類型。 一律為 function_call_output。 可能的值：function_call_output	Yes

OpenAI.ItemResourceFunctionToolCallResource

名稱	類型	Description	為必填項目	預設值
arguments	字串	要傳遞至函式的引數 JSON 字串。	Yes
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函數工具呼叫的唯一標識碼。	否
名稱	字串	要執行的函式名稱。	Yes
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函式工具呼叫的類型。 一律為 function_call。 可能的值：function_call	Yes

OpenAI.ItemResourceImageGenToolCall

模型提出的圖像生成要求。

名稱	類型	Description	為必填項目	預設值
id	字串	影像生成呼叫的唯一 ID。	Yes
結果	字串（可空）		Yes
狀態	列舉	影像生成通話狀態。 可能的值：in_progress、、completed、 generatingfailed	Yes
型別	列舉	影像生成呼叫的類型。 一律為 image_generation_call。 可能的值：image_generation_call	Yes

OpenAI.ItemResourceLocalShellToolCall

在本機殼層上執行命令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.LocalShellExecAction	在伺服器上執行殼層命令。	Yes
call_id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
id	字串	本地 shell 呼叫的唯一 ID。	Yes
狀態	列舉	本地空殼通話狀態。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	本地 shell 呼叫的類型。 一律為 local_shell_call。 可能的值：local_shell_call	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

本機 Shell 工具呼叫的輸出。

名稱	類型	Description	為必填項目	預設值
id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
輸出	字串	本機殼層工具呼叫輸出的 JSON 字串。	Yes
狀態	列舉	可能的值：in_progress、、 completedincomplete	否
型別	列舉	本地殼層工具呼叫輸出的類型。 一律為 local_shell_call_output。 可能的值：local_shell_call_output	Yes

OpenAI.ItemResourceMcpApprovalRequest

要求人工核准工具叫用。

名稱	類型	Description	為必填項目	預設值
arguments	字串	工具的自變數 JSON 字串。	Yes
id	字串	核准申請的唯一 ID。	Yes
名稱	字串	要執行的工具名稱。	Yes
伺服器標籤	字串	發出要求的 MCP 伺服器的標籤。	Yes
型別	列舉	項目的類型。 一律為 mcp_approval_request。 可能的值：mcp_approval_request	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

對 MCP 核准申請的回應。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串	正在回應之核准要求的識別碼。	Yes
approve	布爾值	是否已核准要求。	Yes
id	字串	核准回應的唯一識別碼	Yes
reason	字串（可空）		否
型別	列舉	項目的類型。 一律為 mcp_approval_response。 可能的值：mcp_approval_response	Yes

OpenAI.ItemResourceMcpListTools

MCP 伺服器上可用的工具清單。

名稱	類型	Description	為必填項目	預設值
錯誤	字串（可空）		否
id	字串	名單的唯一ID。	Yes
伺服器標籤	字串	MCP 伺服器的標籤。	Yes
工具	OpenAI.MCPListToolsTool 的 array	伺服器上可用的工具。	Yes
型別	列舉	項目的類型。 一律為 mcp_list_tools。 可能的值：mcp_list_tools	Yes

OpenAI.ItemResourceMcpToolCall

MCP 伺服器上的工具叫用。

名稱	類型	Description	為必填項目	預設值
approval_request_id	字串（可空）		否
arguments	字串	傳遞到工具的參數所構成的 JSON 字串。	Yes
錯誤	字串（可空）		否
id	字串	工具呼叫的唯一 ID。	Yes
名稱	字串	執行的工具名稱。	Yes
輸出	字串（可空）		否
伺服器標籤	字串	執行此工具之 MCP 伺服器的標籤。	Yes
狀態	OpenAI.MCPToolCallStatus（開放AI.MCPToolCallStatus）		否
型別	列舉	項目的類型。 一律為 mcp_call。 可能的值：mcp_call	Yes

OpenAI.ItemResourceOutputMessage

來自模型的輸出訊息。

名稱	類型	Description	為必填項目	預設值
內容	OpenAI 的陣列 。OutputMessageContent	輸出訊息的內容。	Yes
id	字串	輸出訊息的唯一標識碼。	Yes
角色	列舉	輸出訊息的角色。 一律為 assistant。 可能的值：assistant	Yes
狀態	列舉	訊息輸入的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回輸入項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	輸出訊息的類型。 一律為 message。 可能的值：output_message	Yes

OpenAI.ItemResourceType

房產	價值觀
Type	字串
價值	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

網路搜尋工具呼叫的結果。 更多資訊請參閱 web 搜尋指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述此 Web 搜尋呼叫中採取的特定動作的物件。 包括模型如何使用 Web （搜尋、open_page、尋找） 的詳細資料。	Yes
id	字串	網路搜尋工具呼叫的唯一 ID。	Yes
狀態	列舉	Web 搜尋工具呼叫的狀態。 可能的值：in_progress、、searching、 completedfailed	Yes
型別	列舉	網路搜尋工具的呼叫類型。 一律為 web_search_call。 可能的值：web_search_call	Yes

OpenAI.ItemType

房產	價值觀
Type	字串
價值	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call custom_tool_call_output custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

網路搜尋工具呼叫的結果。 更多資訊請參閱 web 搜尋指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述此 Web 搜尋呼叫中採取的特定動作的物件。 包括模型如何使用 Web （搜尋、open_page、尋找） 的詳細資料。	Yes
id	字串	網路搜尋工具呼叫的唯一 ID。	Yes
狀態	列舉	Web 搜尋工具呼叫的狀態。 可能的值：in_progress、、searching、 completedfailed	Yes
型別	列舉	網路搜尋工具的呼叫類型。 一律為 web_search_call。 可能的值：web_search_call	Yes

OpenAI.KeyPressAction

模型想要執行的按鍵集合。

名稱	類型	Description	為必填項目	預設值
鑰匙	字串陣列	模型要求按下的按鍵組合。 這是字串陣列，每個字串都代表索引鍵。	Yes
型別	列舉	指定事件類型。 對於 keypress 動作，這個屬性一律會設定為 keypress。 可能的值：keypress	Yes

OpenAI.ListFineTuningJobCheckpointsResponse

名稱	類型	Description	為必填項目	預設值
資料	OpenAI.FineTuningJobCheckpoint 的 array		Yes
first_id	字串（可空）		否
還有更多	布爾值		Yes
last_id	字串（可空）		否
物件	列舉	可能的值：list	Yes

OpenAI.ListFineTuningJobEventsResponse

名稱	類型	Description	為必填項目	預設值
資料	array of OpenAI.FineTuningJobEvent		Yes
還有更多	布爾值		Yes
物件	列舉	可能的值：list	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

名稱	類型	Description	為必填項目	預設值
資料	OpenAI.FineTuningJob 的 array		Yes
還有更多	布爾值		Yes
物件	列舉	可能的值：list	Yes

OpenAI.LocalShellCallStatus（開放人工智慧）LocalShellCallStatus（狀態）

房產	價值觀
Type	字串
價值	in_progress completed incomplete

OpenAI.LocalShellExecAction

在伺服器上執行殼層命令。

名稱	類型	Description	為必填項目	預設值
指令	字串陣列	要執行的命令。	Yes
env	物件	要為命令設定的環境變數。	Yes
timeout_ms	OpenAI.integer （nullable）		否
型別	列舉	本地命令介面操作的類型。 一律為 exec。 可能的值：exec	Yes
使用者	字串（可空）		否
工作目錄	字串（可空）		否

OpenAI.LocalShellToolParam

允許模型在本機環境中執行殼層命令的工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	本地 shell 工具的類型。 一律為 local_shell。 可能的值：local_shell	Yes

OpenAI.LogProb

詞元的對數機率。

名稱	類型	Description	為必填項目	預設值
bytes	OpenAI.integer 的 array		Yes
logprob	OpenAI.numeric		Yes
Token	字串		Yes
top_logprobs	OpenAI.TopLogProb 的陣列		Yes

OpenAI.MCPListToolsTool

MCP 伺服器上可用的工具。

名稱	類型	Description	為必填項目	預設值
附註	OpenAI.MCPListToolsToolAnnotations （可空）		否
說明	字串（可空）		否
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
名稱	字串	工具的名稱。	Yes

OpenAI.MCPListToolsToolAnnotations

類型：物件

OpenAI.MCPListToolsToolInputSchema

類型：物件

OpenAI.MCPTool

透過遠端模型情境協定（MCP）伺服器，讓模型access使用更多工具。 了解更多關於MCP。

名稱	類型	Description	為必填項目	預設值
允許的工具	字串陣列或 OpenAI.MCPToolFilter		否
授權	字串	一種可與遠端 MCP 伺服器共用的 OAuth access 令牌，或是 並可自訂 MCP 伺服器 URL 或服務連接器。 您的應用程式 必須處理 OAuth 授權流程，並在此提供令牌。	否
connector_id	列舉	服務連接器的識別碼，例如 ChatGPT 中的連接器。 其中之一 server_url 或 connector_id 必須提供。 了解更多關於服務的資訊 連接器here。 目前支援 connector_id 的數值有： - Dropbox： connector_dropbox - Gmail： connector_gmail - Google 日曆： connector_googlecalendar - Google 雲端硬碟： connector_googledrive - Microsoft Teams：connector_microsoftteams - 展望行事曆： connector_outlookcalendar - Outlook 電子郵件： connector_outlookemail - SharePoint： connector_sharepoint 可能的值：connector_dropbox、、、connector_gmailconnector_googlecalendarconnector_googledrive、、、、、connector_microsoftteamsconnector_outlookcalendarconnector_outlookemailconnector_sharepoint	否
headers	物件（可空除）		否
project_connection_id	字串	project 中 MCP 伺服器的連線 ID。 連線會儲存連線至 MCP 伺服器所需的驗證和其他連線詳細資料。	否
需核准	object （請參閱下面的有效模型）		否
server_description	字串	MCP 伺服器的可選描述，用以提供更多背景說明。	否
伺服器標籤	字串	此 MCP 伺服器的標籤，用來在工具呼叫中識別它。	Yes
伺服器_URL	字串	MCP 伺服器的 URL。 其中一 server_url 例 connector_id 必為 提供。	否
型別	列舉	MCP 工具的類型。 一律為 mcp。 可能的值：mcp	Yes

OpenAI.MCPToolCallStatus（開放AI.MCPToolCallStatus）

房產	價值觀
Type	字串
價值	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

一個篩選物件用來指定允許使用哪些工具。

名稱	類型	Description	為必填項目	預設值
read_only	布爾值	表示工具是否會修改資料或為唯讀。 如果 MCP 伺服器標 註為 readOnlyHint， 它會符合這個過濾器。	否
tool_names	字串陣列	允許的工具名稱清單。	否

OpenAI.MCPToolRequireApproval

名稱	類型	Description	為必填項目	預設值
總是	OpenAI.MCPToolFilter	一個篩選物件用來指定允許使用哪些工具。	否
從不	OpenAI.MCPToolFilter	一個篩選物件用來指定允許使用哪些工具。	否

OpenAI.訊息內容

構成輸入或輸出項目的內容部分。

OpenAI 的判別器。訊息內容

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
text	OpenAI.TextContent
summary_text	OpenAI.摘要文字內容
computer_screenshot	OpenAI.Computer截圖內容
input_text	OpenAI.訊息內容輸入文字內容
output_text	OpenAI.訊息內容輸出文字內容
reasoning_text	OpenAI.訊息內容推理文字內容
refusal	OpenAI.訊息內容拒絕內容
input_image	OpenAI.訊息內容輸入影像內容
input_file	OpenAI.訊息內容輸入檔案內容

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.MessageContentType		Yes

OpenAI.訊息內容輸入檔案內容

模型的檔案輸入。

名稱	類型	Description	為必填項目	預設值
file_data	字串	要傳送至模型的檔案內容。	否
檔案識別碼 (file_id)	字串（可空）		否
file_url	字串	要傳送給模型的檔案網址。	否
filename	字串	要傳送至模型的檔案名稱。	否
型別	列舉	輸入項目的型別。 一律為 input_file。 可能的值：input_file	Yes

OpenAI.訊息內容輸入影像內容

輸入至模型的影像 了解影像輸入。

名稱	類型	Description	為必填項目	預設值
detail	OpenAI.ImageDetail		Yes
檔案識別碼 (file_id)	字串（可空）		否
image_url	字串		否
型別	列舉	輸入項目的型別。 一律為 input_image。 可能的值：input_image	Yes

OpenAI.訊息內容輸入文字內容

模型的文字輸入。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的文字輸入。	Yes
型別	列舉	輸入項目的型別。 一律為 input_text。 可能的值：input_text	Yes

OpenAI.訊息內容輸出文字內容

模型的文字輸出。

名稱	類型	Description	為必填項目	預設值
附註	OpenAI 的 array 。註解	文字輸出的註釋。	Yes
logprobs	OpenAI.LogProb 的陣列		否
收發簡訊	字串	模型的文字輸出。	Yes
型別	列舉	輸出文字的類型。 一律為 output_text。 可能的值：output_text	Yes

OpenAI.訊息內容推理文字內容

模型的推理文本。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的推理文本。	Yes
型別	列舉	推理文本的類型。 一律為 reasoning_text。 可能的值：reasoning_text	Yes

OpenAI.訊息內容拒絕內容

模型拒絕回應。

名稱	類型	Description	為必填項目	預設值
拒絕	字串	模型的拒絕說明。	Yes
型別	列舉	拒絕的類型。 一律為 refusal。 可能的值：refusal	Yes

OpenAI.MessageContentType

房產	價值觀
Type	字串
價值	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

房產	價值觀
Type	字串
價值	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus（開放人工智慧訊息狀態）

房產	價值觀
Type	字串
價值	in_progress completed incomplete

OpenAI.Metadata

可附加至物件的索引鍵/值組 (16 個為一組)。 這很適合用來以結構化格式儲存物件的其他資訊，以及透過 API 或儀錶板查詢物件。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。

類型：物件

OpenAI.ModelIdsCompaction

用於產生回應的型號識別碼，如 gpt-5 或 o3。 OpenAI 提供多種不同功能、效能特性及價格區間的模型。 請參閱 模型指南 ，瀏覽並比較可用模型。

類型： OpenAI.ModelIdsResponses 或字串

用於產生回應的型號識別碼，如 gpt-5 或 o3。 OpenAI 提供多種不同功能、效能特性及價格區間的模型。 請參閱 模型指南 ，瀏覽並比較可用模型。

OpenAI.ModelIdsResponses

房產	價值觀
Type	字串
價值	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

類型：字串或 OpenAI.ChatModel

OpenAI.Move

滑鼠移動動作。

名稱	類型	Description	為必填項目	預設值
型別	列舉	指定事件類型。 對於移動動作，此屬性為 總是設定為 move。 可能的值：move	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.OutputContent

OpenAI 的判別器。OutputContent

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent
reasoning_text	OpenAI.OutputContentReasoningTextContent

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

模型的文字輸出。

名稱	類型	Description	為必填項目	預設值
附註	OpenAI 的 array 。註解	文字輸出的註釋。	Yes
logprobs	OpenAI.LogProb 的陣列		否
收發簡訊	字串	模型的文字輸出。	Yes
型別	列舉	輸出文字的類型。 一律為 output_text。 可能的值：output_text	Yes

OpenAI.OutputContentReasoningTextContent

模型的推理文本。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的推理文本。	Yes
型別	列舉	推理文本的類型。 一律為 reasoning_text。 可能的值：reasoning_text	Yes

OpenAI.OutputContentRefusalContent

模型拒絕回應。

名稱	類型	Description	為必填項目	預設值
拒絕	字串	模型的拒絕說明。	Yes
型別	列舉	拒絕的類型。 一律為 refusal。 可能的值：refusal	Yes

OpenAI.OutputContentType

房產	價值觀
Type	字串
價值	output_text refusal reasoning_text

OpenAI.OutputItem

OpenAI 判別器。OutputItem

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
structured_outputs	結構化輸出輸出項目
workflow_action	工作流程行動輸出項目
oauth_consent_request	OAuthConsentRequestOutputItem
memory_search_call	記憶搜尋工具呼叫項目資源
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

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
response_id	字串	該項目所建立的回應。	否
型別	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

一個工具呼叫，透過建立、刪除或更新檔案來套用檔案差異。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。	Yes
創建者	字串	創建這個工具呼叫的實體的 ID。	否
id	字串	套用補丁工具呼叫的唯一 ID。 透過 API 傳回此項目時填入。	Yes
作業	OpenAI.ApplyPatchFileOperation	其中一種create_file、delete_file或update_file操作透過apply_patch應用。	Yes
\---- 類型	OpenAI.ApplyPatchFileOperationType		Yes
response_id	字串	該項目所建立的回應。	否
狀態	OpenAI.ApplyPatchCallStatus（開放AI）。ApplyPatchCallStatus（查詢狀態）		Yes
型別	列舉	項目的類型。 一律為 apply_patch_call。 可能的值：apply_patch_call	Yes

OpenAI.OutputItemApplyPatchToolCallOutput

由 apply patch tool 呼叫所輸出的輸出。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	模型產生的套用補丁工具呼叫的唯一 ID。	Yes
創建者	字串	建立此工具的實體 ID 呼叫輸出。	否
id	字串	apply patch 工具呼叫輸出的唯一 ID。 透過 API 傳回此項目時填入。	Yes
輸出	字串（可空）		否
response_id	字串	該項目所建立的回應。	否
狀態	OpenAI.ApplyPatchCallOutputStatus		Yes
型別	列舉	項目的類型。 一律為 apply_patch_call_output。 可能的值：apply_patch_call_output	Yes

OpenAI.OutputItemCodeInterpreterToolCall

執行程式代碼的工具呼叫。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
字碼	字串（可空）		Yes
container_id	字串	用來執行程式代碼之容器的標識碼。	Yes
id	字串	程式代碼解釋器工具呼叫的唯一標識符。	Yes
輸出	OpenAI.CodeInterpreterOutputLogs 或 OpenAI.CodeInterpreterOutputImage 的陣列		Yes
response_id	字串	該項目所建立的回應。	否
狀態	列舉	程式代碼解釋器工具呼叫的狀態。 有效值為 in_progress、completed、incomplete、interpreting 和 failed。 可能的值：in_progress、completed、incomplete、interpreting、failed	Yes
型別	列舉	程式代碼解釋器工具呼叫的類型。 一律為 code_interpreter_call。 可能的值：code_interpreter_call	Yes

OpenAI.OutputItemCompactionBody

API產生v1/responses/compact的壓縮項目。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
創建者	字串	創建該項目的演員識別碼。	否
encrypted_content	字串	由壓縮產生的加密內容。	Yes
id	字串	壓縮項目的唯一 ID。	Yes
response_id	字串	該項目所建立的回應。	否
型別	列舉	項目的類型。 一律為 compaction。 可能的值：compaction	Yes

OpenAI.OutputItemComputerToolCall

對電腦使用工具發出的工具呼叫。 更多資訊請參閱 computer 使用指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.ComputerAction		Yes
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	使用輸出回應工具呼叫時所使用的識別碼。	Yes
id	字串	計算機呼叫的唯一標識碼。	Yes
pending_safety_checks	OpenAI.ComputerCallCallSafetyCheckParam 的陣列	電腦呼叫的擱置安全性檢查。	Yes
response_id	字串	該項目所建立的回應。	否
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	計算機呼叫的類型。 一律為 computer_call。 可能的值：computer_call	Yes

OpenAI.OutputItemCustomToolCall

呼叫模型建立的自訂工具。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	一個用於將此自訂工具呼叫映射到工具呼叫輸出的識別碼。	Yes
id	字串	OpenAI 平台自訂工具呼叫的唯一 ID。	否
輸入	字串	模型產生的自訂工具呼叫輸入。	Yes
名稱	字串	正在被呼叫的自訂工具名稱。	Yes
response_id	字串	該項目所建立的回應。	否
型別	列舉	自訂工具呼叫的類型。 一律為 custom_tool_call。 可能的值：custom_tool_call	Yes

OpenAI.OutputItemFileSearchToolCall

檔案搜尋工具呼叫的結果。 更多資訊請參閱 file 搜尋指南。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
id	字串	檔案搜尋工具呼叫的唯一標識符。	Yes
queries	字串陣列	用來搜尋檔案的查詢。	Yes
response_id	字串	該項目所建立的回應。	否
results	OpenAI.FileSearchToolCallResults 的陣列		否
狀態	列舉	檔案搜尋工具呼叫的狀態。 下列其中一項：in_progress searching、 或 incomplete、 failed 可能的值：in_progress、searching、completed、incomplete、failed	Yes
型別	列舉	檔案搜尋工具呼叫的類型。 一律為 file_search_call。 可能的值：file_search_call	Yes

OpenAI.OutputItemFunctionShellCall

一個在受管理環境中執行一個或多個 shell 指令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.FunctionShellAction	執行一個殼狀指令。	Yes
└─ 指令	字串陣列		Yes
└─ max_output_length	OpenAI.integer （nullable）		Yes
└─ timeout_ms	OpenAI.integer （nullable）		Yes
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。	Yes
創建者	字串	創建這個工具呼叫的實體的 ID。	否
id	字串	shell 工具呼叫的唯一 ID。 透過 API 傳回此項目時填入。	Yes
response_id	字串	該項目所建立的回應。	否
狀態	OpenAI.LocalShellCallStatus（開放人工智慧）LocalShellCallStatus（狀態）		Yes
型別	列舉	項目的類型。 一律為 shell_call。 可能的值：shell_call	Yes

OpenAI.OutputItemFunctionShellCallOutput

是 shell 工具呼叫所發出的輸出。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	模型產生的殼層工具呼叫的唯一 ID。	Yes
創建者	字串	創建該項目的演員識別碼。	否
id	字串	shell呼叫輸出的唯一ID。 透過 API 傳回此項目時填入。	Yes
max_output_length	OpenAI.integer （nullable）		Yes
輸出	OpenAI.FunctionShellCallOutputContent 的陣列	一個包含 shell 呼叫輸出內容的陣列	Yes
response_id	字串	該項目所建立的回應。	否
型別	列舉	shell呼叫輸出的類型。 一律為 shell_call_output。 可能的值：shell_call_output	Yes

OpenAI.OutputItemFunctionToolCall

執行函式的工具呼叫。 更多資訊請參閱 function 呼叫指南。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
arguments	字串	要傳遞至函式的引數 JSON 字串。	Yes
call_id	字串	模型所產生的函式工具呼叫的唯一標識符。	Yes
id	字串	函數工具呼叫的唯一標識碼。	否
名稱	字串	要執行的函式名稱。	Yes
response_id	字串	該項目所建立的回應。	否
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
型別	列舉	函式工具呼叫的類型。 一律為 function_call。 可能的值：function_call	Yes

OpenAI.OutputItemImageGenToolCall

模型提出的圖像生成要求。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
id	字串	影像生成呼叫的唯一 ID。	Yes
response_id	字串	該項目所建立的回應。	否
結果	字串（可空）		Yes
狀態	列舉	影像生成通話狀態。 可能的值：in_progress、、completed、 generatingfailed	Yes
型別	列舉	影像生成呼叫的類型。 一律為 image_generation_call。 可能的值：image_generation_call	Yes

OpenAI.OutputItemLocalShellToolCall

在本機殼層上執行命令的工具呼叫。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.LocalShellExecAction	在伺服器上執行殼層命令。	Yes
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
call_id	字串	模型所產生的本機殼層工具呼叫的唯一識別碼。	Yes
id	字串	本地 shell 呼叫的唯一 ID。	Yes
response_id	字串	該項目所建立的回應。	否
狀態	列舉	本地空殼通話狀態。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	本地 shell 呼叫的類型。 一律為 local_shell_call。 可能的值：local_shell_call	Yes

OpenAI.OutputItemMcpApprovalRequest

要求人工核准工具叫用。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
arguments	字串	工具的自變數 JSON 字串。	Yes
id	字串	核准申請的唯一 ID。	Yes
名稱	字串	要執行的工具名稱。	Yes
response_id	字串	該項目所建立的回應。	否
伺服器標籤	字串	發出要求的 MCP 伺服器的標籤。	Yes
型別	列舉	項目的類型。 一律為 mcp_approval_request。 可能的值：mcp_approval_request	Yes

OpenAI.OutputItemMcpListTools

MCP 伺服器上可用的工具清單。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
錯誤	字串（可空）		否
id	字串	名單的唯一ID。	Yes
response_id	字串	該項目所建立的回應。	否
伺服器標籤	字串	MCP 伺服器的標籤。	Yes
工具	OpenAI.MCPListToolsTool 的 array	伺服器上可用的工具。	Yes
型別	列舉	項目的類型。 一律為 mcp_list_tools。 可能的值：mcp_list_tools	Yes

OpenAI.OutputItemMcpToolCall

MCP 伺服器上的工具叫用。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
approval_request_id	字串（可空）		否
arguments	字串	傳遞到工具的參數所構成的 JSON 字串。	Yes
錯誤	字串（可空）		否
id	字串	工具呼叫的唯一 ID。	Yes
名稱	字串	執行的工具名稱。	Yes
輸出	字串（可空）		否
response_id	字串	該項目所建立的回應。	否
伺服器標籤	字串	執行此工具之 MCP 伺服器的標籤。	Yes
狀態	OpenAI.MCPToolCallStatus（開放AI.MCPToolCallStatus）		否
型別	列舉	項目的類型。 一律為 mcp_call。 可能的值：mcp_call	Yes

OpenAI.OutputItemOutputMessage

來自模型的輸出訊息。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
內容	OpenAI 的陣列 。OutputMessageContent	輸出訊息的內容。	Yes
id	字串	輸出訊息的唯一標識碼。	Yes
response_id	字串	該項目所建立的回應。	否
角色	列舉	輸出訊息的角色。 一律為 assistant。 可能的值：assistant	Yes
狀態	列舉	訊息輸入的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回輸入項目時填入。 可能的值：in_progress、、 completedincomplete	Yes
型別	列舉	輸出訊息的類型。 一律為 message。 可能的值：output_message	Yes

OpenAI.OutputItemReasoningItem

產生回應時，推理模型所使用之思想鏈結的描述。 如果你手動管理上下文，務必將這些項目包含在你的回應 API 的 中，以便後續對話回合使用。

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
內容	OpenAI 的陣列 。ReasoningTextContent	推理文本內容。	否
encrypted_content	字串（可空）		否
id	字串	推理內容的唯一標識碼。	Yes
response_id	字串	該項目所建立的回應。	否
狀態	列舉	項目的狀態。 其中一個 in_progress、completed或 incomplete。 透過 API 傳回項目時填入。 可能的值：in_progress、、 completedincomplete	否
摘要	OpenAI 的陣列 。摘要	推理摘要內容。	Yes
型別	列舉	物件的類型。 一律為 reasoning。 可能的值：reasoning	Yes

OpenAI.OutputItemType

房產	價值觀
Type	字串
價值	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

網路搜尋工具呼叫的結果。 更多資訊請參閱 web 搜尋指南。

名稱	類型	Description	為必填項目	預設值
動作	OpenAI.WebSearchActionSearch 或 OpenAI.WebSearchActionOpenPage 或 OpenAI.WebSearchActionFind	描述此 Web 搜尋呼叫中採取的特定動作的物件。 包括模型如何使用 Web （搜尋、open_page、尋找） 的詳細資料。	Yes
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
id	字串	網路搜尋工具呼叫的唯一 ID。	Yes
response_id	字串	該項目所建立的回應。	否
狀態	列舉	Web 搜尋工具呼叫的狀態。 可能的值：in_progress、、searching、 completedfailed	Yes
型別	列舉	網路搜尋工具的呼叫類型。 一律為 web_search_call。 可能的值：web_search_call	Yes

OpenAI.OutputMessageContent

OpenAI 的判別器。OutputMessageContent

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

模型的文字輸出。

名稱	類型	Description	為必填項目	預設值
附註	OpenAI 的 array 。註解	文字輸出的註釋。	Yes
logprobs	OpenAI.LogProb 的陣列		否
收發簡訊	字串	模型的文字輸出。	Yes
型別	列舉	輸出文字的類型。 一律為 output_text。 可能的值：output_text	Yes

OpenAI.OutputMessageContentRefusalContent

模型拒絕回應。

名稱	類型	Description	為必填項目	預設值
拒絕	字串	模型的拒絕說明。	Yes
型別	列舉	拒絕的類型。 一律為 refusal。 可能的值：refusal	Yes

OpenAI.OutputMessageContentType

房產	價值觀
Type	字串
價值	output_text refusal

OpenAI.Prompt

關於提示範本及其變數的參考。 了解更多。

名稱	類型	Description	為必填項目	預設值
id	字串	要使用的提示範本的唯一識別碼。	Yes
variables	OpenAI.ResponsePromptVariables （可空）	選用的值對應，用於替換您下項中的變數： 提示。 替代值可以是字串或其他 回應輸入類型，例如影像或檔案。	否
版本	字串（可空）		否

OpenAI.RankerVersionType

房產	價值觀
Type	字串
價值	auto default-2024-11-15

OpenAI.排名選項

名稱	類型	Description	為必填項目	預設值
hybrid_search	OpenAI.HybridSearchOptions		否
└─ embedding_weight	OpenAI.numeric	倒數排序融合中嵌入的權重。	Yes
└─ text_weight	OpenAI.numeric	文本權重在互惠排名融合中。	Yes
排名工具	OpenAI.RankerVersionType		否
分數門檻	OpenAI.numeric		否

OpenAI.Reasoning

僅限 GPT-5 與 O 系列車型 推理模型的配置選項。

名稱	類型	Description	為必填項目	預設值
投入量	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
generate_summary	列舉	可能的值：auto、、 concisedetailed	否
摘要	列舉	可能的值：auto、、 concisedetailed	否

OpenAI.ReasoningEffort

限制推理模型的推理工作。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少推理工作可能會導致回應更快，以及回應中用於推理的權杖較少。

• gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。
• 所有模型在預設推gpt-5.1理努力之前medium皆不支援none。
• 該 gpt-5-pro 模型預設（且僅支持） high 推理努力。
• xhigh 支援所有之後 gpt-5.1-codex-max的模型。

房產	價值觀
Type	字串
可為空	Yes
價值	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

模型的推理文本。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	模型的推理文本。	Yes
型別	列舉	推理文本的類型。 一律為 reasoning_text。 可能的值：reasoning_text	Yes

OpenAI.Response

名稱	類型	Description	為必填項目	預設值
agent_reference	AgentReference （可空除）		Yes
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
背景	布林值（可空）		否
completed_at	整數		否
交談	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
‧----識別碼	字串	這個回應所關聯的對話唯一ID。	Yes
建立於	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
└─ 程式碼	OpenAI.ResponseErrorCode	回應的錯誤碼。	Yes
|---- 訊息	字串	人類看得懂的錯誤描述。	Yes
id	字串	此回應的唯一標識碼。	Yes
incomplete_details	OpenAI.回應不完整細節 （可空除）		Yes
|---- 原因	列舉	可能的值： max_output_tokens、 content_filter	否
instructions	OpenAI.InputItem 的字串或陣列		Yes
max_output_tokens	OpenAI.integer （nullable）		否
最大工具呼叫次數	OpenAI.integer （nullable）		否
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
型號	字串	用於生成此回應的模型部署。	否
物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
output_text	字串（可空）		否
平行工具呼叫	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
previous_response_id	字串（可空）		否
提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
reasoning	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─努力	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
└─ 產生摘要	列舉	可能的值：auto、、 concisedetailed	否
‧---- 摘要	列舉	可能的值：auto、、 concisedetailed	否
safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
服務層級	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
溫度	OpenAI.numeric （可空）		否	1
收發簡訊	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
truncation	列舉	可能的值： auto、 disabled	否
使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否

OpenAI.ResponseAudioDeltaEvent

當有部分音訊回應時發出。

名稱	類型	Description	為必填項目	預設值
delta	字串	Base64 編碼回應音訊位元組的區塊。	Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.audio.delta。 可能的值：response.audio.delta	Yes

OpenAI.ResponseAudioDoneEvent

當音訊回應完成時發出。

名稱	類型	Description	為必填項目	預設值
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.audio.done。 可能的值：response.audio.done	Yes

OpenAI.回應音訊逐字稿DeltaEvent

當有部分音訊文字記錄時發出。

名稱	類型	Description	為必填項目	預設值
delta	字串	音訊回應的部分文字記錄。	Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.audio.transcript.delta。 可能的值：response.audio.transcript.delta	Yes

OpenAI.ResponseAudioTranscriptDoneEvent

完整音訊文字記錄完成時發出。

名稱	類型	Description	為必填項目	預設值
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.audio.transcript.done。 可能的值：response.audio.transcript.done	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

當程式代碼解釋器串流部分代碼段時發出。

名稱	類型	Description	為必填項目	預設值
delta	字串	程式代碼解釋器正在串流的部分代碼段。	Yes
item_id	字串	程式代碼解釋器工具呼叫專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.code_interpreter_call_code.delta。 可能的值：response.code_interpreter_call_code.delta	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

當程式碼片段由程式代碼解釋器完成時發出信號。

名稱	類型	Description	為必填項目	預設值
字碼	字串	程式代碼解釋器輸出的最終代碼段。	Yes
item_id	字串	程式代碼解釋器工具呼叫專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.code_interpreter_call_code.done。 可能的值：response.code_interpreter_call_code.done	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

當程式代碼解釋器呼叫完成時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	程式代碼解釋器工具呼叫專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.code_interpreter_call.completed。 可能的值：response.code_interpreter_call.completed	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

當程式代碼解釋器呼叫正在進行時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	程式代碼解釋器工具呼叫專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.code_interpreter_call.in_progress。 可能的值：response.code_interpreter_call.in_progress	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

當程式代碼解釋器正在主動解譯代碼段時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	程式代碼解釋器工具呼叫專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.code_interpreter_call.interpreting。 可能的值：response.code_interpreter_call.interpreting	Yes

OpenAI.ResponseCompletedEvent

模型回應完成時發出。

名稱	類型	Description	為必填項目	預設值
response	OpenAI.回應		Yes
└─ agent_reference	AgentReference （可空除）	這個回應所用的代理人	Yes
‧---- 背景	布林值（可空）		否
└─ completed_at	整數（可為零）		否
└─ 對話	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
└─ created_at	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
-------- 錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
‧----識別碼	字串	此回應的唯一標識碼。	Yes
└─ 未完成的細節	OpenAI.回應不完整細節 （可空除）		Yes
└─ 指示	OpenAI.InputItem（可空） 的字串或陣列		Yes
輸出字元數最大值 (max_output_tokens)	OpenAI.integer （nullable）		否
max_tool_calls	OpenAI.integer （nullable）		否
~---- 元數據	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
└─ 模型	字串	用於生成此回應的模型部署。	否
└─ 物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
└─ 輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
└─ 輸出文字	字串（可空）		否
└─ 平行工具調用	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
└─ 上一個回應ID (previous_response_id)	字串（可空）		否
└─ 提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
└─ prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
└─ prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
|---- 推理	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─ safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
└─ service_tier	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
└─ 狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
‧---- 溫度	OpenAI.numeric （可空）		否	1
└─ 正文	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
└─ 工具選擇	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
|---- 工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
└─ top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
└─ 截斷	列舉	可能的值： auto、 disabled	否
|---- 使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
└─ 使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.completed。 可能的值：response.completed	Yes

OpenAI.ResponseContentPartAddedEvent

新增內容元件時發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
item_id	字串	已新增內容組件的輸出項目識別碼。	Yes
output_index	OpenAI.integer		Yes
組件	OpenAI.OutputContent		Yes
\---- 類型	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.content_part.added。 可能的值：response.content_part.added	Yes

OpenAI.ResponseContentPartDoneEvent

當內容部份已完成時發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
item_id	字串	已新增內容組件的輸出項目識別碼。	Yes
output_index	OpenAI.integer		Yes
組件	OpenAI.OutputContent		Yes
\---- 類型	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.content_part.done。 可能的值：response.content_part.done	Yes

OpenAI.ResponseCreatedEvent

建立回應時發出的事件。

名稱	類型	Description	為必填項目	預設值
response	OpenAI.回應		Yes
└─ agent_reference	AgentReference （可空除）	這個回應所用的代理人	Yes
‧---- 背景	布林值（可空）		否
└─ completed_at	整數（可為零）		否
└─ 對話	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
└─ created_at	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
-------- 錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
‧----識別碼	字串	此回應的唯一標識碼。	Yes
└─ 未完成的細節	OpenAI.回應不完整細節 （可空除）		Yes
└─ 指示	OpenAI.InputItem（可空） 的字串或陣列		Yes
輸出字元數最大值 (max_output_tokens)	OpenAI.integer （nullable）		否
max_tool_calls	OpenAI.integer （nullable）		否
~---- 元數據	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
└─ 模型	字串	用於生成此回應的模型部署。	否
└─ 物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
└─ 輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
└─ 輸出文字	字串（可空）		否
└─ 平行工具調用	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
└─ 上一個回應ID (previous_response_id)	字串（可空）		否
└─ 提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
└─ prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
└─ prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
|---- 推理	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─ safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
└─ service_tier	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
└─ 狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
‧---- 溫度	OpenAI.numeric （可空）		否	1
└─ 正文	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
└─ 工具選擇	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
|---- 工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
└─ top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
└─ 截斷	列舉	可能的值： auto、 disabled	否
|---- 使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
└─ 使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.created。 可能的值：response.created	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

代表對自訂工具呼叫輸入的 delta（部分更新）的事件。

名稱	類型	Description	為必填項目	預設值
delta	字串	自訂工具呼叫的增量輸入資料（delta）。	Yes
item_id	字串	與此事件相關的 API 項目唯一識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件類型識別碼。 可能的值：response.custom_tool_call_input.delta	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

表示該輸入對自訂工具呼叫已完成的事件。

名稱	類型	Description	為必填項目	預設值
輸入	字串	自訂工具呼叫的完整輸入資料。	Yes
item_id	字串	與此事件相關的 API 項目唯一識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件類型識別碼。 可能的值：response.custom_tool_call_input.done	Yes

OpenAI.ResponseError

當模型無法生成回應時，會返回一個錯誤對象。

名稱	類型	Description	為必填項目	預設值
字碼	OpenAI.ResponseErrorCode	回應的錯誤碼。	Yes
訊息	字串	人類看得懂的錯誤描述。	Yes

OpenAI.ResponseErrorCode

回應的錯誤碼。

房產	價值觀
Type	字串
價值	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

發生錯誤時發出。

名稱	類型	Description	為必填項目	預設值
字碼	字串（可空）		Yes
訊息	字串	錯誤訊息。	Yes
param	字串（可空）		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 error。 可能的值：error	Yes

OpenAI.ResponseFailedEvent

回應失敗時所發出的事件。

名稱	類型	Description	為必填項目	預設值
response	OpenAI.回應		Yes
└─ agent_reference	AgentReference （可空除）	這個回應所用的代理人	Yes
‧---- 背景	布林值（可空）		否
└─ completed_at	整數（可為零）		否
└─ 對話	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
└─ created_at	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
-------- 錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
‧----識別碼	字串	此回應的唯一標識碼。	Yes
└─ 未完成的細節	OpenAI.回應不完整細節 （可空除）		Yes
└─ 指示	OpenAI.InputItem（可空） 的字串或陣列		Yes
輸出字元數最大值 (max_output_tokens)	OpenAI.integer （nullable）		否
max_tool_calls	OpenAI.integer （nullable）		否
~---- 元數據	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
└─ 模型	字串	用於生成此回應的模型部署。	否
└─ 物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
└─ 輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
└─ 輸出文字	字串（可空）		否
└─ 平行工具調用	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
└─ 上一個回應ID (previous_response_id)	字串（可空）		否
└─ 提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
└─ prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
└─ prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
|---- 推理	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─ safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
└─ service_tier	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
└─ 狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
‧---- 溫度	OpenAI.numeric （可空）		否	1
└─ 正文	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
└─ 工具選擇	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
|---- 工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
└─ top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
└─ 截斷	列舉	可能的值： auto、 disabled	否
|---- 使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
└─ 使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.failed。 可能的值：response.failed	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

完成檔案搜尋呼叫時發出 （找到的結果）。

名稱	類型	Description	為必填項目	預設值
item_id	字串	發起檔案搜尋呼叫的輸出項目的標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.file_search_call.completed。 可能的值：response.file_search_call.completed	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

起始檔案搜尋呼叫時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	發起檔案搜尋呼叫的輸出項目的標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.file_search_call.in_progress。 可能的值：response.file_search_call.in_progress	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

檔案搜尋目前正在搜尋時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	發起檔案搜尋呼叫的輸出項目的標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.file_search_call.searching。 可能的值：response.file_search_call.searching	Yes

OpenAI.ResponseFormatJsonObject

JSON 物件回應格式。 產生 JSON 回應的較舊方法。 針對支援它的模型，建議使用 json_schema 。 請注意，模型不會在沒有系統或使用者訊息指示下產生 to do JSON。

名稱	類型	Description	為必填項目	預設值
型別	列舉	正在定義的回應格式類型。 一律為 json_object。 可能的值：json_object	Yes

OpenAI.ResponseFormatJsonSchema

JSON 結構的回應格式。 用來產生結構化 JSON 回應。 了解更多關於結構化輸出。

名稱	類型	Description	為必填項目	預設值
JSON 架構	OpenAI.ResponseFormatJsonSchemaJsonJsonSchema		Yes
└─ 描述	字串		否
\---- 名稱	字串		Yes
└─ 綱要	OpenAI.ResponseFormatJsonSchemaSchema	回應格式的結構描述，描述為 JSON 結構描述物件。 瞭解如何 在這裡建置 JSON 架構。	否
└─ 嚴格	布林值（可空）		否
型別	列舉	正在定義的回應格式類型。 一律為 json_schema。 可能的值：json_schema	Yes

OpenAI.ResponseFormatJsonSchemaJsonJsonSchema

名稱	類型	Description	為必填項目	預設值
說明	字串		否
名稱	字串		Yes
結構描述	OpenAI.ResponseFormatJsonSchemaSchema	回應格式的結構描述，描述為 JSON 結構描述物件。 瞭解如何 在這裡建置 JSON 架構。	否
嚴格	布林值（可空）		否

OpenAI.ResponseFormatJsonSchemaSchema (OpenAI.回應格式Json架構模式)

回應格式的結構描述，描述為 JSON 結構描述物件。 瞭解如何 在這裡建置 JSON 架構。

類型：物件

OpenAI.ResponseFormatText

默認回應格式。 用來產生文字回應。

名稱	類型	Description	為必填項目	預設值
型別	列舉	正在定義的回應格式類型。 一律為 text。 可能的值：text	Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

當有部分函式呼叫引數差異時發出。

名稱	類型	Description	為必填項目	預設值
delta	字串	新增的函式呼叫引數差異。	Yes
item_id	字串	函式呼叫引數差異新增至的輸出項目識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.function_call_arguments.delta。 可能的值：response.function_call_arguments.delta	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

在完成函式呼叫引數時發出。

名稱	類型	Description	為必填項目	預設值
arguments	字串	函數調用引數。	Yes
item_id	字串	項目的標識碼。	Yes
名稱	字串	呼叫之函數的名稱。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	可能的值：response.function_call_arguments.done	Yes

OpenAI.ResponseImageGenCallCompletedEvent

當映像產生工具呼叫完成且最終映像可供使用時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	正在處理之影像產生專案的唯一標識符。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.image_generation_call.completed'。 可能的值：response.image_generation_call.completed	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

當映像產生工具呼叫主動產生映射時發出 （中繼狀態）。

名稱	類型	Description	為必填項目	預設值
item_id	字串	正在處理之影像產生專案的唯一標識符。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.image_generation_call.generating'。 可能的值：response.image_generation_call.generating	Yes

OpenAI.ResponseImageGenCallInProgressEvent

映像產生工具呼叫進行時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	正在處理之影像產生專案的唯一標識符。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.image_generation_call.in_progress'。 可能的值：response.image_generation_call.in_progress	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

在影像產生串流期間提供部分影像時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	正在處理之影像產生專案的唯一標識符。	Yes
output_index	OpenAI.integer		Yes
partial_image_b64	字串	Base64 編碼的部分影像數據，適合轉譯為影像。	Yes
partial_image_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.image_generation_call.partial_image'。 可能的值：response.image_generation_call.partial_image	Yes

OpenAI.ResponseInProgressEvent

回應正在進行時發出。

名稱	類型	Description	為必填項目	預設值
response	OpenAI.回應		Yes
└─ agent_reference	AgentReference （可空除）	這個回應所用的代理人	Yes
‧---- 背景	布林值（可空）		否
└─ completed_at	整數（可為零）		否
└─ 對話	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
└─ created_at	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
-------- 錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
‧----識別碼	字串	此回應的唯一標識碼。	Yes
└─ 未完成的細節	OpenAI.回應不完整細節 （可空除）		Yes
└─ 指示	OpenAI.InputItem（可空） 的字串或陣列		Yes
輸出字元數最大值 (max_output_tokens)	OpenAI.integer （nullable）		否
max_tool_calls	OpenAI.integer （nullable）		否
~---- 元數據	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
└─ 模型	字串	用於生成此回應的模型部署。	否
└─ 物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
└─ 輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
└─ 輸出文字	字串（可空）		否
└─ 平行工具調用	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
└─ 上一個回應ID (previous_response_id)	字串（可空）		否
└─ 提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
└─ prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
└─ prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
|---- 推理	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─ safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
└─ service_tier	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
└─ 狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
‧---- 溫度	OpenAI.numeric （可空）		否	1
└─ 正文	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
└─ 工具選擇	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
|---- 工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
└─ top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
└─ 截斷	列舉	可能的值： auto、 disabled	否
|---- 使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
└─ 使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.in_progress。 可能的值：response.in_progress	Yes

OpenAI.回應不完整細節

名稱	類型	Description	為必填項目	預設值
reason	列舉	可能的值： max_output_tokens、 content_filter	否

OpenAI.ResponseIncompleteEvent

當回應以不完整狀態結束時所發出的事件。

名稱	類型	Description	為必填項目	預設值
response	OpenAI.回應		Yes
└─ agent_reference	AgentReference （可空除）	這個回應所用的代理人	Yes
‧---- 背景	布林值（可空）		否
└─ completed_at	整數（可為零）		否
└─ 對話	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
└─ created_at	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
-------- 錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
‧----識別碼	字串	此回應的唯一標識碼。	Yes
└─ 未完成的細節	OpenAI.回應不完整細節 （可空除）		Yes
└─ 指示	OpenAI.InputItem（可空） 的字串或陣列		Yes
輸出字元數最大值 (max_output_tokens)	OpenAI.integer （nullable）		否
max_tool_calls	OpenAI.integer （nullable）		否
~---- 元數據	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
└─ 模型	字串	用於生成此回應的模型部署。	否
└─ 物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
└─ 輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
└─ 輸出文字	字串（可空）		否
└─ 平行工具調用	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
└─ 上一個回應ID (previous_response_id)	字串（可空）		否
└─ 提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
└─ prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
└─ prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
|---- 推理	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─ safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
└─ service_tier	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
└─ 狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
‧---- 溫度	OpenAI.numeric （可空）		否	1
└─ 正文	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
└─ 工具選擇	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
|---- 工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
└─ top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
└─ 截斷	列舉	可能的值： auto、 disabled	否
|---- 使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
└─ 使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.incomplete。 可能的值：response.incomplete	Yes

OpenAI.回應LogProb

對數概率是模型在序列中指定位置產生特定標記的對數機率。 較低負（較高）的 logprob 值表示模型對該標記選擇的信心更高。

名稱	類型	Description	為必填項目	預設值
logprob	OpenAI.numeric		Yes
Token	字串	可能的文字標記。	Yes
top_logprobs	OpenAI 陣列 。回應LogProbTopLogprobs	前20個最可能的代幣的對數機率。	否

OpenAI.回應LogProb頂Logprobs

名稱	類型	Description	為必填項目	預設值
logprob	OpenAI.numeric		否
Token	字串		否

OpenAI.ResponseMCPCallArgumentsDeltaEvent

當 MCP 工具呼叫的引數有差異 (部分更新) 時發出。

名稱	類型	Description	為必填項目	預設值
delta	字串	一個包含 MCP 工具呼叫參數部分更新的 JSON 字串。	Yes
item_id	字串	處理 MCP 工具呼叫專案的唯一識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 永遠是「response.mcp_call_arguments.delta」。 可能的值：response.mcp_call_arguments.delta	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

當 MCP 工具呼叫的自變數完成時發出。

名稱	類型	Description	為必填項目	預設值
arguments	字串	一個包含 MCP 工具呼叫最終參數的 JSON 字串。	Yes
item_id	字串	處理 MCP 工具呼叫專案的唯一識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 總是「response.mcp_call_arguments完成」。 可能的值：response.mcp_call_arguments.done	Yes

OpenAI.ResponseMCPCallCompletedEvent

MCP 工具呼叫成功完成時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	完成的 MCP 工具呼叫項目的 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.mcp_call.completed'。 可能的值：response.mcp_call.completed	Yes

OpenAI.ResponseMCPCallFailedEvent

MCP 工具呼叫失敗時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	失敗的 MCP 工具呼叫項目的 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.mcp_call.failed'。 可能的值：response.mcp_call.failed	Yes

OpenAI.ResponseMCPCallInProgressEvent

MCP 工具呼叫進行時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	處理 MCP 工具呼叫專案的唯一識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.mcp_call.in_progress'。 可能的值：response.mcp_call.in_progress	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

成功擷取可用 MCP 工具清單時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	產生此輸出的 MCP 工具呼叫項目的 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.mcp_list_tools.completed'。 可能的值：response.mcp_list_tools.completed	Yes

OpenAI.ResponseMCPListToolsFailedEvent

嘗試列出可用的 MCP 工具失敗時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	失敗的 MCP 工具呼叫項目的 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.mcp_list_tools.failed'。 可能的值：response.mcp_list_tools.failed	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

當系統正在擷取可用 MCP 工具清單時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	正在處理的 MCP 工具呼叫項目的 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.mcp_list_tools.in_progress'。 可能的值：response.mcp_list_tools.in_progress	Yes

OpenAI.ResponseOutputItemAddedEvent

新增輸出項目時發出。

名稱	類型	Description	為必填項目	預設值
項目	OpenAI.OutputItem		Yes
└─ agent_reference	代理參考	就是製造該物品的代理人。	否
└─ response_id	字串	該項目所建立的回應。	否
\---- 類型	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.output_item.added。 可能的值：response.output_item.added	Yes

OpenAI.ResponseOutputItemDoneEvent

當輸出項目標示為完成時發出。

名稱	類型	Description	為必填項目	預設值
項目	OpenAI.OutputItem		Yes
└─ agent_reference	代理參考	就是製造該物品的代理人。	否
└─ response_id	字串	該項目所建立的回應。	否
\---- 類型	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.output_item.done。 可能的值：response.output_item.done	Yes

OpenAI.ResponseTextAnnotationAddedEvent

當新增註解以輸出文字內容時會發出。

名稱	類型	Description	為必填項目	預設值
註釋	OpenAI.註解	一個適用於輸出文字範圍的註解。	Yes
\---- 類型	OpenAI.AnnotationType		Yes
annotation_index	OpenAI.integer		Yes
content_index	OpenAI.integer		Yes
item_id	字串	標註所加入項目的唯一識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 永遠是「response.output_text.annotation.added」。 可能的值：response.output_text.annotation.added	Yes

OpenAI.ResponsePromptVariables

選用的值對應，用於替換您提示中的變數。 替代值可以是字串或其他回應輸入類型，例如影像或檔案。

類型：物件

OpenAI.ResponseQueuedEvent

當回應排入佇列並等候處理時發出。

名稱	類型	Description	為必填項目	預設值
response	OpenAI.回應		Yes
└─ agent_reference	AgentReference （可空除）	這個回應所用的代理人	Yes
‧---- 背景	布林值（可空）		否
└─ completed_at	整數（可為零）		否
└─ 對話	OpenAI.ConversationReference （可空）	這句話所屬的對話。 這個回應的輸入項目和輸出項目會自動加入這個對話。	否
└─ created_at	整數	建立此回應時的 Unix 時間戳（以秒為單位）。	Yes
-------- 錯誤	OpenAI.ResponseError （可空）	當模型無法生成回應時，會返回一個錯誤對象。	Yes
‧----識別碼	字串	此回應的唯一標識碼。	Yes
└─ 未完成的細節	OpenAI.回應不完整細節 （可空除）		Yes
└─ 指示	OpenAI.InputItem（可空） 的字串或陣列		Yes
輸出字元數最大值 (max_output_tokens)	OpenAI.integer （nullable）		否
max_tool_calls	OpenAI.integer （nullable）		否
~---- 元數據	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
└─ 模型	字串	用於生成此回應的模型部署。	否
└─ 物件	列舉	此資源的物件類型 - 一律設定為 response。 可能的值：response	Yes
└─ 輸出	OpenAI.OutputItem 的陣列	模型所產生的內容項目陣列。 - 陣列中 output 項目的長度和順序相依 針對模型的回應。 - 而不是存取 output 陣列中的第一個項目，而且 假設這是一則由 assistant 所生成的內容訊息。 模型，您可能會考慮使用 output_text 屬性，其中 在 SDK 中支持。	Yes
└─ 輸出文字	字串（可空）		否
└─ 平行工具調用	布爾值	是否允許模型平行執行工具呼叫。	Yes	對
└─ 上一個回應ID (previous_response_id)	字串（可空）		否
└─ 提示	OpenAI.Prompt	關於提示範本及其變數的參考。 了解更多。	否
└─ prompt_cache_key	字串	OpenAI 用來緩存類似請求的回應，以優化快取命中率。 取代了欄位 user。 了解更多。	否
└─ prompt_cache_retention	列舉	可能的值： in-memory、 24h	否
|---- 推理	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─ safety_identifier	字串	一個穩定的識別碼，用來協助偵測可能違反 OpenAI 使用政策的應用程式使用者。 ID 應該是一串字串，能唯一識別每個使用者。 我們建議你先查閱他們的用戶名稱或電子郵件地址，以避免傳送任何識別資訊給我們。 了解更多。	否
└─ service_tier	OpenAI.ServiceTier	指定用來處理要求的處理類型。 - 若設定為「自動」，則請求會在 Project 設定中設定的服務層級進行處理。 除非另有設定，Project 將使用「default」。 - 若設定為「預設」，則以所選型號的標準價格與效能處理請求。 - 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。 - 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。	否
└─ 狀態	列舉	回應產生的狀態。 下列其中一項：completed、failed、 in_progress、cancelled、queued 或 incomplete。 可能的值：completed、、、failedin_progresscancelled、queued、incomplete	否
‧---- 溫度	OpenAI.numeric （可空）		否	1
└─ 正文	OpenAI.回應文字參數	來自模型的文字回應組態選項。 可以是平淡的 文字或結構化 JSON 資料。 瞭解詳情： - 文字輸入與輸出 - 結構化輸出	否
└─ 工具選擇	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceParam		否
|---- 工具	OpenAI.ToolsArray	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具： - 內建工具：OpenAI 所提供的工具，可擴充 模型的功能，例如 web search 或file search。 了解更多 內建工具。 - MCP 工具：透過自訂 MCP 伺服器與第三方系統整合 或是預先定義的連接器，如 Google Drive 和 SharePoint。 了解更多 MCP 工具。 - 函式呼叫 （自訂工具）：您定義的函式， 讓模型能夠呼叫你自己的程式碼，並帶有強型別參數 以及輸出。 了解更多 function calling。 你也可以使用 自訂工具來呼叫自己的程式碼。	否
└─ top_logprobs	OpenAI.integer （nullable）		否
top_p	OpenAI.numeric （可空）		否	1
└─ 截斷	列舉	可能的值： auto、 disabled	否
|---- 使用方式	OpenAI.ResponseUsage	表示令牌使用詳細數據，包括輸入令牌、輸出令牌、 輸出令牌的細目，以及所使用的令牌總數。	否
└─ 使用者	字串（已棄用）	此欄位被替換為 safety_identifier 和 prompt_cache_key。 請用 prompt_cache_key 來維護快取優化。 為你的終端使用者提供穩定的識別碼。 用來提升快取命中率，透過更精確的分桶分類類似請求，並幫助 OpenAI 偵測及防止濫用行為。 了解更多。	否
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 'response.queued'。 可能的值：response.queued	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

新增新的推理摘要組件時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	這個摘要組件所關聯項目的識別碼。	Yes
output_index	OpenAI.integer		Yes
組件	OpenAI.回應理由摘要部分新增事件部分		Yes
└─ 正文	字串		Yes
\---- 類型	列舉	可能的值：summary_text	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.reasoning_summary_part.added。 可能的值：response.reasoning_summary_part.added	Yes

OpenAI.回應理由摘要部分新增事件部分

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串		Yes
型別	列舉	可能的值：summary_text	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

當推理摘要部分完成時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	這個摘要組件所關聯項目的識別碼。	Yes
output_index	OpenAI.integer		Yes
組件	OpenAI.回應理由摘要部分完成事件部分		Yes
└─ 正文	字串		Yes
\---- 類型	列舉	可能的值：summary_text	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.reasoning_summary_part.done。 可能的值：response.reasoning_summary_part.done	Yes

OpenAI.回應理由摘要部分完成事件部分

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串		Yes
型別	列舉	可能的值：summary_text	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

當差異新增至推理摘要文字時發出。

名稱	類型	Description	為必填項目	預設值
delta	字串	新增至摘要的文字差異。	Yes
item_id	字串	這個摘要文字差異所關聯項目的識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.reasoning_summary_text.delta。 可能的值：response.reasoning_summary_text.delta	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

當推理摘要文字完成時發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	這個摘要文字所關聯之專案的標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
收發簡訊	字串	已完成的推理摘要全文。	Yes
型別	列舉	事件的類型。 一律為 response.reasoning_summary_text.done。 可能的值：response.reasoning_summary_text.done	Yes

OpenAI.ResponseReasoningTextDeltaEvent

當推理文本中加入 delta 時會產生。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
delta	字串	新增到推理內容中的文字差異。	Yes
item_id	字串	此推理文字 delta 所關聯的項目 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.reasoning_text.delta。 可能的值：response.reasoning_text.delta	Yes

OpenAI.回應推理文字完成事件

當推理文本完成時會發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
item_id	字串	這段推理文本所關聯的物品 ID。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
收發簡訊	字串	完成推理內容的全文。	Yes
型別	列舉	事件的類型。 一律為 response.reasoning_text.done。 可能的值：response.reasoning_text.done	Yes

OpenAI.ResponseRefusalDeltaEvent

當有部分拒絕文字時發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
delta	字串	新增的拒絕文字。	Yes
item_id	字串	要新增拒絕文字的輸出項目識別碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.refusal.delta。 可能的值：response.refusal.delta	Yes

OpenAI.ResponseRefusalDoneEvent

拒絕文字完成時發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
item_id	字串	已完成拒絕文字的輸出項目識別碼。	Yes
output_index	OpenAI.integer		Yes
拒絕	字串	最終的拒絕文字。	Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.refusal.done。 可能的值：response.refusal.done	Yes

OpenAI.ResponseStreamOptions

串流回應的選項。 只有當您設定 stream: true 時，才需要設定此選項。

名稱	類型	Description	為必填項目	預設值
include_obfuscation	布爾值	當 true 時，將會啟用串流模糊化。 串流混淆加法 隨機字元到 obfuscation 一個欄位，串流 delta 事件到 將有效載荷大小標準化，以防範某些側通道攻擊。 這些混淆欄位預設包含，但會增加少量 將開銷轉移到資料流。 你可以設定 include_obfuscation 為 false 是為了優化頻寬，前提是你信任網路連結 你的應用程式和 OpenAI API 一起。	否

OpenAI.ResponseTextDeltaEvent

當有額外的文字差異時發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
delta	字串	已新增的文字差異。	Yes
item_id	字串	已新增文字差異的輸出項目識別碼。	Yes
logprobs	OpenAI 的陣列 。回應LogProb	delta 中標記的對數機率。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.output_text.delta。 可能的值：response.output_text.delta	Yes

OpenAI.ResponseTextDoneEvent

完成文字內容時發出。

名稱	類型	Description	為必填項目	預設值
content_index	OpenAI.integer		Yes
item_id	字串	已完成文字內容的輸出項目識別碼。	Yes
logprobs	OpenAI 的陣列 。回應LogProb	delta 中標記的對數機率。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
收發簡訊	字串	已完成的文字內容。	Yes
型別	列舉	事件的類型。 一律為 response.output_text.done。 可能的值：response.output_text.done	Yes

OpenAI.回應文字參數

來自模型的文字回應組態選項。 可以是純文字或結構化 JSON 數據。 瞭解詳情：

• 文字輸入與輸出
• 結構化輸出

名稱	類型	Description	為必填項目	預設值
format	OpenAI.TextResponseFormatConfiguration	物件，指定模型必須輸出的格式。 { "type": "json_schema" }設定可啟用結構化輸出， 這可確保模型符合您提供的 JSON 架構。 前往此處深入了解 預設格式為 { "type": "text" }，且沒有其他選項。 *不建議用於GPT-4o及更新型號：** 設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式， 確保模型產生的訊息是有效的 JSON。 使用 json_schema 支援該功能的模型較為常用。	否
詳細程度	OpenAI.冗長	限制模型回應的冗長程度。 數值越低，結果為 回答越簡潔，而數值越高，回答越冗長。 目前支援的值為 low、medium 和 high。	否

OpenAI.ResponseUsage

代表令牌使用詳細數據，包括輸入令牌、輸出令牌、輸出令牌明細，以及所使用的令牌總數。

名稱	類型	Description	為必填項目	預設值
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
cached_tokens	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.回應使用輸出代幣詳情		Yes
└─ 推理詞元	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageInputTokensDetails

名稱	類型	Description	為必填項目	預設值
cached_tokens	OpenAI.integer		Yes

OpenAI.回應使用輸出代幣詳情

名稱	類型	Description	為必填項目	預設值
reasoning_tokens	OpenAI.integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

當網路搜尋通話完成時會發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	與 Web 搜尋呼叫相關聯的輸出專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.web_search_call.completed。 可能的值：response.web_search_call.completed	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

當網路搜尋呼叫啟動時會發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	與 Web 搜尋呼叫相關聯的輸出專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.web_search_call.in_progress。 可能的值：response.web_search_call.in_progress	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

當網路搜尋呼叫正在執行時會發出。

名稱	類型	Description	為必填項目	預設值
item_id	字串	與 Web 搜尋呼叫相關聯的輸出專案的唯一標識碼。	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
型別	列舉	事件的類型。 一律為 response.web_search_call.searching。 可能的值：response.web_search_call.searching	Yes

OpenAI.截圖

螢幕擷取畫面動作。

名稱	類型	Description	為必填項目	預設值
型別	列舉	指定事件類型。 針對螢幕快照動作，此屬性為 總是設定為 screenshot。 可能的值：screenshot	Yes

OpenAI.Scroll

捲動動作。

名稱	類型	Description	為必填項目	預設值
scroll_x	OpenAI.integer		Yes
scroll_y	OpenAI.integer		Yes
型別	列舉	指定事件類型。 對於捲動動作，此屬性為 總是設定為 scroll。 可能的值：scroll	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.SearchContextSize

房產	價值觀
Type	字串
價值	low medium high

OpenAI.ServiceTier

指定用來處理要求的處理類型。

• 如果設定為「自動」，那麼請求會在 Project 設定中設定的服務層級被處理。 除非另有設定，Project 將使用「default」。
• 如果設定為「預設」，則會使用所選型號的標準定價和效能來處理要求。
• 若設定為「flex」或「priority」，則請求將以相應的服務層級處理。
• 未設定時，預設行為為「自動」。 設定參數後 service_tier ，回應體將包含 service_tier 基於實際用於服務請求的處理模式的值。 此回應值可能與參數中設定的值不同。

房產	價值觀
Type	字串
可為空	Yes
價值	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

執行工具呼叫時，強制模型呼叫apply_patch工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	這個工具可以呼叫。 一律為 apply_patch。 可能的值：apply_patch	Yes

OpenAI.SpecificFunctionShellParam

當需要工具呼叫時，強制模型呼叫 shell 工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	這個工具可以呼叫。 一律為 shell。 可能的值：shell	Yes

OpenAI。摘要

模型的摘要文字。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	這是目前模型推理輸出的總結。	Yes
型別	列舉	物件的類型。 一律為 summary_text。 可能的值：summary_text	Yes

OpenAI.摘要文字內容

模型的摘要文字。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	這是目前模型推理輸出的總結。	Yes
型別	列舉	物件的類型。 一律為 summary_text。 可能的值：summary_text	Yes

OpenAI.TextContent

文字內容。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串		Yes
型別	列舉	可能的值：text	Yes

OpenAI.TextResponseFormatConfiguration

物件，指定模型必須輸出的格式。 { "type": "json_schema" }設定會啟用結構化輸出，以確保模型符合您提供的 JSON 架構。 前往此處深入了解

預設格式為 { "type": "text" }，且沒有其他選項。 不建議用於 gpt-4o 及較新型號：* 設定啟用 { "type": "json_object" } 舊版 JSON 模式，確保模型產生的訊息是有效的 JSON。 對於支援它的模型，最好使用 。json_schema

OpenAI 的判別器。TextResponseFormatConfiguration

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON 物件回應格式。 產生 JSON 回應的較舊方法。 針對支援它的模型，建議使用 json_schema 。 請注意，模型不會在沒有系統或使用者訊息指示下產生 to do JSON。

名稱	類型	Description	為必填項目	預設值
型別	列舉	正在定義的回應格式類型。 一律為 json_object。 可能的值：json_object	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

默認回應格式。 用來產生文字回應。

名稱	類型	Description	為必填項目	預設值
型別	列舉	正在定義的回應格式類型。 一律為 text。 可能的值：text	Yes

OpenAI.TextResponseFormatConfigurationType

房產	價值觀
Type	字串
價值	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON 結構的回應格式。 用來產生結構化 JSON 回應。 了解更多關於結構化輸出。

名稱	類型	Description	為必填項目	預設值
說明	字串	模型使用之回應格式的描述 決定如何以特定格式回應。	否
名稱	字串	回應格式的名稱。 必須是 a-z、A-Z、0-9 或包含 底線和虛線，最大長度為 64。	Yes
結構描述	OpenAI.ResponseFormatJsonSchemaSchema	回應格式的結構描述，描述為 JSON 結構描述物件。 瞭解如何 在這裡建置 JSON 架構。	Yes
嚴格	布林值（可空）		否
型別	列舉	正在定義的回應格式類型。 一律為 json_schema。 可能的值：json_schema	Yes

OpenAI.Tool

可用來產生回應的工具。

OpenAI.Tool 的識別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	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	A2APreview工具
memory_search_preview	記憶體搜尋預覽工具
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

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ToolType		Yes

OpenAI.工具選擇允許

限制模型可用的工具於預先定義的集合。

名稱	類型	Description	為必填項目	預設值
mode	列舉	限制模型可用的工具於預先定義的集合。 auto 允許模型從允許的工具中選擇並產生 訊息。 required 需要模型呼叫一個或多個允許的工具。 可能的值： auto、 required	Yes
工具	物件陣列	一份模型應被允許呼叫的工具定義清單。 對於回應 API，工具定義清單可能如下： json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>	Yes
型別	列舉	允許的工具配置類型。 一律為 allowed_tools。 可能的值：allowed_tools	Yes

OpenAI.ToolChoiceCodeInterpreter

指出模型應該使用內建工具來產生回應。 了解更多內建工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：code_interpreter	Yes

OpenAI.ToolChoiceComputerUsePreview

指出模型應該使用內建工具來產生回應。 了解更多內建工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：computer_use_preview	Yes

OpenAI.ToolChoiceCustom

用這個選項強制模型呼叫特定的自訂工具。

名稱	類型	Description	為必填項目	預設值
名稱	字串	要呼叫的自訂工具名稱。	Yes
型別	列舉	對於自訂工具呼叫，類型總是 custom。 可能的值：custom	Yes

OpenAI.ToolChoiceFileSearch

指出模型應該使用內建工具來產生回應。 了解更多內建工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：file_search	Yes

OpenAI.ToolChoiceFunction

使用此選項可強制模型呼叫特定函式。

名稱	類型	Description	為必填項目	預設值
名稱	字串	要呼叫的函式名稱。	Yes
型別	列舉	針對函式呼叫，類型一律為function。 可能的值：function	Yes

OpenAI.ToolChoiceImageGeneration

指出模型應該使用內建工具來產生回應。 了解更多內建工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：image_generation	Yes

OpenAI.ToolChoiceMCP

使用此選項可強制模型在遠端 MCP 伺服器上呼叫特定工具。

名稱	類型	Description	為必填項目	預設值
名稱	字串（可空）		否
伺服器標籤	字串	要使用的 MCP 伺服器的標籤。	Yes
型別	列舉	針對 MCP 工具，類型一律為 mcp。 可能的值：mcp	Yes

OpenAI.ToolChoiceOptions

控制模型所呼叫的工具 (若有)。 none 表示模型不會呼叫任何工具，而是會產生訊息。 auto 表示模型可以選擇產生訊息或是呼叫一或多個工具。 required 表示模型必須呼叫一或多個工具。

房產	價值觀
Type	字串
價值	none auto required

OpenAI.ToolChoiceParam

模型應該如何選取產生回應時要使用的工具（或工具）。 tools請參閱 參數，以瞭解如何指定模型可以呼叫的工具。

OpenAI 的判別器。ToolChoiceParam

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
allowed_tools	OpenAI.工具選擇允許
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

名稱	類型	Description	為必填項目	預設值
型別	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

房產	價值觀
Type	字串
價值	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

指出模型應該使用內建工具來產生回應。 了解更多內建工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：web_search_preview	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

指出模型應該使用內建工具來產生回應。 了解更多內建工具。

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：web_search_preview_2025_03_11	Yes

OpenAI.工具類型

房產	價值觀
Type	字串
價值	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

模型可能會在產生回應時呼叫的工具陣列。 您可以藉由設定 tool_choice 參數來指定要使用的工具。 我們支援以下類別的工具：

• 內建工具：OpenAI 提供的擴充模型功能的工具，如 web search或 file search。 了解更多關於內建工具。
• MCP 工具：透過自訂 MCP 伺服器或預設連接器（如 Google Drive 和 SharePoint）與第三方系統整合。 了解更多關於 MCP Tools。
• 函式呼叫（自訂工具）：由你定義的函式，使模型能呼叫帶有強型別參數與輸出的程式碼。 了解更多關於 function calling。 你也可以使用自訂工具來呼叫自己的程式碼。

陣列：OpenAI.Tool

OpenAI.TopLogProb

詞元的最高對數機率。

名稱	類型	Description	為必填項目	預設值
bytes	OpenAI.integer 的 array		Yes
logprob	OpenAI.numeric		Yes
Token	字串		Yes

OpenAI.Type

要輸入文字的動作。

名稱	類型	Description	為必填項目	預設值
收發簡訊	字串	要輸入的文字。	Yes
型別	列舉	指定事件類型。 針對類型動作，此屬性為 總是設定為 type。 可能的值：type	Yes

OpenAI.更新對話體

名稱	類型	Description	為必填項目	預設值
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	Yes

OpenAI.UrlCitationBody

用來產生模型回應之 Web 資源的引文。

名稱	類型	Description	為必填項目	預設值
end_index	OpenAI.integer		Yes
start_index	OpenAI.integer		Yes
title	字串	Web 資源的標題。	Yes
型別	列舉	URL 引文的類型。 一律為 url_citation。 可能的值：url_citation	Yes
URL	字串	Web 資源的 URL。	Yes

OpenAI.VectorStoreFileAttributes

可附加至物件的索引鍵/值組 (16 個為一組)。 這很適合用來以結構化格式儲存物件的其他資訊，以及透過 API 或儀錶板查詢物件。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元、布爾值或數位的字串。

類型：物件

OpenAI.冗長

限制模型回應的冗長程度。 數值越低，回答越簡潔，數值越高，回答越冗長。 目前支援的值為 low、medium 和 high。

房產	價值觀
Type	字串
可為空	Yes
價值	low medium high

OpenAI。等等

等候動作。

名稱	類型	Description	為必填項目	預設值
型別	列舉	指定事件類型。 針對等候動作，此屬性為 總是設定為 wait。 可能的值：wait	Yes

OpenAI.WebSearchActionFind

動作類型 「find」：在載入的頁面內搜尋模式。

名稱	類型	Description	為必填項目	預設值
模式	字串	在頁面內搜尋的模式或文字。	Yes
型別	列舉	動作類型。 可能的值：find_in_page	Yes
URL	字串	搜尋該模式的頁面的 URL。	Yes

OpenAI.WebSearchActionOpenPage

動作類型 「open_page」 - 從搜尋結果開啟特定的 URL。

名稱	類型	Description	為必填項目	預設值
型別	列舉	動作類型。 可能的值：open_page	Yes
URL	字串	模型所開啟的 URL。	Yes

OpenAI.WebSearchActionSearch

動作類型 「search」 - 執行 Web 搜尋查詢。

名稱	類型	Description	為必填項目	預設值
queries	字串陣列	搜尋查詢。	否
查詢	字串（已棄用）	[已棄用]搜尋關鍵字。	Yes
來源	OpenAI 的陣列 。WebSearchActionSearchSearchSources	搜尋中使用的來源。	否
型別	列舉	動作類型。 可能的值：search	Yes

OpenAI.WebSearchAction搜尋來源

名稱	類型	Description	為必填項目	預設值
型別	列舉	可能的值：url	Yes
URL	字串		Yes

OpenAI.WebSearchApproximateLocation

使用者的大致位置。

名稱	類型	Description	為必填項目	預設值
城市	字串（可空）		否
country	字串（可空）		否
區域	字串（可空）		否
timezone	字串（可空）		否
型別	列舉	位置近似的類型。 一律為 approximate。 可能的值：approximate	否

OpenAI.WebSearchPreviewTool

此工具會在網路上搜尋相關結果，以供回應使用。 了解更多關於 web 搜尋工具。

名稱	類型	Description	為必填項目	預設值
搜尋上下文大小	OpenAI.SearchContextSize		否
型別	列舉	Web 搜尋工具的類型。 web_search_preview 或 web_search_preview_2025_03_11 的其中之一。 可能的值：web_search_preview	Yes
使用者位置	OpenAI.ApproximateLocation （可取消）		否
└─ 城市	字串（可空）		否
└─ 鄉村	字串（可空）		否
└─ 地區	字串（可空）		否
└─ 時區	字串（可空）		否
\---- 類型	列舉	位置近似的類型。 一律為 approximate。 可能的值：approximate	Yes

OpenAI.WebSearchTool

在網路上搜尋與該題目的相關來源。 了解更多關於 web 搜尋工具。

名稱	類型	Description	為必填項目	預設值
custom_search_configuration	WebSearchConfiguration	bing 自訂搜尋的網頁搜尋設定	否
└─ instance_name	字串	提供給組態的自定義組態實例名稱。	Yes
└─ project_connection_id	字串	Project 連接 ID 用於接地，使用 bing 自訂搜尋	Yes
filters	OpenAI.WebSearchToolFilters（ 可空除）		否
└─ allowed_domains	字串陣列（可為空）		否
搜尋上下文大小	列舉	用於搜尋的內容窗口空間量高階指引。 low、medium 或 high 的其中之一。 medium 是預設值。 可能的值：low、、 mediumhigh	否
型別	列舉	Web 搜尋工具的類型。 web_search 或 web_search_2025_08_26 的其中之一。 可能的值：web_search	Yes
使用者位置	OpenAI.WebSearchApproximateLocation （可空除）	使用者的大致位置。	否
└─ 城市	字串（可空）		否
└─ 鄉村	字串（可空）		否
└─ 地區	字串（可空）		否
└─ 時區	字串（可空）		否
\---- 類型	列舉	位置近似的類型。 一律為 approximate。 可能的值：approximate	否

OpenAI.WebSearchToolFilters

名稱	類型	Description	為必填項目	預設值
allowed_domains	字串陣列		否

OpenAI.integer

類型：整數

格式：int64

OpenAI.numeric

類型：數字

賽制：雙倍

OpenApiAnonymousAuthDetails

OpenApi 匿名驗證的安全性詳細數據

名稱	類型	Description	為必填項目	預設值
型別	列舉	物件類型，一律為 'anonymous'。 可能的值：anonymous	Yes

OpenApiAuthDetails

OpenApiFunctionDefinition 的驗證詳細數據

OpenApiAuthDetails 的識別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

名稱	類型	Description	為必填項目	預設值
型別	OpenApiAuthType	OpenApi 終端節點的身份驗證類型。 可使用的型別如下： - 匿名（無需認證） - Project 連線（需project_connection_id端點，依 AI Foundry 設定） - Managed_Identity（需要受眾以進行基於身份的授權）	Yes

OpenApiAuthType

OpenApi 終端節點的身份驗證類型。 可使用的型別如下：

• 匿名（無需身份驗證）
• Project 連線（需project_connection_id端點，依照 AI Foundry 設定）
• Managed_Identity （需要受眾進行基於身份的身份驗證）

房產	價值觀
說明	OpenApi 終端節點的身份驗證類型。 可使用的型別如下： - 匿名（無需認證） - Project 連線（需project_connection_id端點，依 AI Foundry 設定） - Managed_Identity（需要受眾以進行基於身份的授權）
Type	字串
價值	anonymous project_connection managed_identity

OpenApiFunctionDefinition

openapi 函式的輸入定義資訊。

名稱	類型	Description	為必填項目	預設值
auth	OpenApiAuthDetails	OpenApiFunctionDefinition 的驗證詳細數據	Yes
\---- 類型	OpenApiAuthType	驗證類型必須是匿名/project_connection/managed_identity	Yes
default_params	字串陣列	將使用使用者提供預設值的 OpenAPI 規格參數清單	否
說明	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	否
functions	物件陣列	OpenApi 工具使用的函數定義清單	否
名稱	字串	要呼叫之函式的名稱。	Yes
規格	物件	openapi 函式圖形，描述為 JSON 架構物件。	Yes

OpenApiManagedAuthDetails

OpenApi managed_identity驗證的安全性詳細數據

名稱	類型	Description	為必填項目	預設值
security_scheme	OpenApiManagedSecurityScheme	OpenApi managed_identity 驗證的安全性配置	Yes
└─ 觀眾	字串	managed_identity驗證類型的驗證範圍	Yes
型別	列舉	物件類型，一律為 『managed_identity』。 可能的值：managed_identity	Yes

OpenApiManagedSecurityScheme

OpenApi managed_identity 驗證的安全性配置

名稱	類型	Description	為必填項目	預設值
audience	字串	managed_identity驗證類型的驗證範圍	Yes

OpenApiProjectConnectionAuthDetails

OpenApi project 連線驗證的安全細節

名稱	類型	Description	為必填項目	預設值
security_scheme	OpenApiProjectConnectionSecurityScheme	OpenApi managed_identity 驗證的安全性配置	Yes
└─ project_connection_id	字串	Project 連線識別碼用於 Project Connection 認證類型	Yes
型別	列舉	物件類型，一律為 'project_connection'。 可能的值：project_connection	Yes

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity 驗證的安全性配置

名稱	類型	Description	為必填項目	預設值
project_connection_id	字串	Project 連線識別碼用於 Project Connection 認證類型	Yes

OpenApiTool

OpenAPI 工具的輸入定義資訊，用來設定代理程式。

名稱	類型	Description	為必填項目	預設值
OpenAPI	OpenApiFunctionDefinition	openapi 函式的輸入定義資訊。	Yes
└─ 真	OpenApiAuthDetails	開啟 API 驗證詳細數據	Yes
└─ default_params	字串陣列	將使用使用者提供預設值的 OpenAPI 規格參數清單	否
└─ 描述	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	否
└─ 函數	物件陣列（唯讀）	OpenApi 工具使用的函數定義清單	否
└─ 描述	字串	函式用途的說明，由模型使用來選擇呼叫函式的時機和方式。	否
\---- 名稱	字串	要呼叫之函式的名稱。	Yes
└─ 參數	物件	函式接受的參數，描述為 JSON 結構描述物件。	Yes
\---- 名稱	字串	要呼叫之函式的名稱。	Yes
└─ 規格	物件	openapi 函式圖形，描述為 JSON 架構物件。	Yes
型別	列舉	物件類型，一律為 'openapi'。 可能的值：openapi	Yes

頁面順序

房產	價值觀
Type	字串
價值	asc desc

分頁連線

Connection 項的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	連接陣列	此頁面上的 Connection 專案	Yes

PagedDatasetVersion

DatasetVersion 項的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	DatasetVersion 陣列	此頁上的 DatasetVersion 項	Yes

分頁部署

Deployment 項的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	部署陣列	此頁面上的 [部署] 專案	Yes

PagedEvaluationRule

EvaluationRule 項目的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	評估規則陣列	本頁的評估規則項目	Yes

頁碼評價分類法

評估分類項目的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	評估陣列 分類法	本頁的評估分類項目	Yes

PagedEvaluatorVersion

EvaluatorVersion 項目的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	EvaluatorVersion 陣列	本頁的 EvaluatorVersion 項目	Yes

頁碼索引

索引項的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	索引陣列	此頁上的索引項	Yes

頁洞洞察

Insight 項目的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	洞察陣列	本頁的 Insight 項目	Yes

PagedRedTeam

RedTeam 項的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	RedTeam 陣列	此頁面上的 RedTeam 專案	Yes

PagedSchedule

排程項目的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	排程陣列	此頁面上的排程專案	Yes

PagedScheduleRun

ScheduleRun 專案的分頁集合

名稱	類型	Description	為必填項目	預設值
nextLink	字串	專案下一頁的連結	否
value	ScheduleRun 陣列	此頁面上的 ScheduleRun 專案	Yes

待上載請求

表示對待上載的請求。

名稱	類型	Description	為必填項目	預設值
connectionName （連接名稱）	字串	Azure Storage Account connection name to create temporary SAS token	否
待處理上傳ID	字串	如果未提供 PendingUploadId，則將使用隨機 GUID。	否
pendingUploadType	列舉	BlobReference 是唯一支持的類型。 可能的值：BlobReference	Yes

待上載回應

表示待處理上傳請求的回應

名稱	類型	Description	為必填項目	預設值
blobReference	BlobReference	Blob 引用詳細資訊。	Yes
└─ blobUri	字串	用戶端上傳數據的 Blob URI 路徑。 範例：https://blob.windows.core.net/Container/Path	Yes
└─ 資格	SasCredential	用憑證資訊來access storage帳號。	Yes
└─ storageAccountArmId	字串	要用的 storage 帳號的 ARM ID。	Yes
待處理上傳ID	字串	此上傳請求的ID。	Yes
pendingUploadType	列舉	BlobReference 是唯一支持的類型 可能的值：BlobReference	Yes
版本	字串	如果使用者在最初創建上傳時未指定版本，則要創建的資產版本	否

PromptAgentDefinition

提示代理人定義

名稱	類型	Description	為必填項目	預設值
instructions	字串（可空）	插入模型內容中的系統（或開發人員）訊息。	否
類型	列舉	可能的值：prompt	Yes
型號	字串	要用於此代理程式的模型部署。	Yes
rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
└─ rai_policy_name	字串	要套用的 RAI 原則名稱。	Yes
reasoning	OpenAI.Reasoning （可取消）	僅限 GPT-5 與 O 系列車型 設定選項 推理模型。	否
└─努力	OpenAI.ReasoningEffort	限制推理的努力 推理模型。 目前支援的值為 none、 minimal、 lowmediumhighxhigh和 。 減少 推理工作可能會導致更快的回應和更少的令牌使用 回應中的推理。 - gpt-5.1 預設為 none，但不執行推理。 支持的 gpt-5.1 推理值為 none、 low、 medium、 high和 。 GPT-5.1 中支援所有推理值的工具呼叫。 - 所有預設推理前gpt-5.1的模型皆不支援medium。none - 模型 gpt-5-pro 預設（且僅支援） high 推理努力。 - xhigh 支援所有之後 gpt-5.1-codex-max的模型。	否
└─ 產生摘要	列舉	可能的值：auto、、 concisedetailed	否
‧---- 摘要	列舉	可能的值：auto、、 concisedetailed	否
structured_inputs	物件	一組結構化輸入，可參與提示範本取代或工具引數繫結。	否
溫度	數字	要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。 一般會建議改變這個值或 top_p，但不建議同時改變。	否	1
收發簡訊	PromptAgentDefinitionTextOptions	來自模型的文字回應組態選項。 可以是純文字或結構化 JSON 數據。	否
└─ 格式	OpenAI.TextResponseFormatConfiguration	物件，指定模型必須輸出的格式。 { "type": "json_schema" }設定可啟用結構化輸出， 這可確保模型符合您提供的 JSON 架構。 前往此處深入了解 預設格式為 { "type": "text" }，且沒有其他選項。 *不建議用於GPT-4o及更新型號：** 設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式， 確保模型產生的訊息是有效的 JSON。 使用 json_schema 支援該功能的模型較為常用。	否
tool_choice	string 或 OpenAI.ToolChoiceParam	模型應該如何選取產生回應時要使用的工具（或工具）。 tools請參閱 參數，以瞭解如何指定模型可以呼叫的工具。	否
工具	OpenAI.Tool 的陣列	模型可能會在產生回應時呼叫的工具陣列。 您 可以藉由設定 tool_choice 參數來指定要使用的工具。	否
top_p	數字	使用溫度進行取樣的替代方案，稱為核取樣， 其中模型會考慮具有 top_p 機率的詞元的結果 質量。 因此 0.1 表示僅包含前 10% 機率質量的詞元 會被考量。 一般會建議改變這個值或 temperature，但不建議同時改變。	否	1

PromptAgentDefinitionTextOptions

來自模型的文字回應組態選項。 可以是純文字或結構化 JSON 數據。

名稱	類型	Description	為必填項目	預設值
format	OpenAI.TextResponseFormatConfiguration	物件，指定模型必須輸出的格式。 { "type": "json_schema" }設定可啟用結構化輸出， 這可確保模型符合您提供的 JSON 架構。 前往此處深入了解 預設格式為 { "type": "text" }，且沒有其他選項。 *不建議用於GPT-4o及更新型號：** 設定為 { "type": "json_object" } 可啟用較舊的 JSON 模式， 確保模型產生的訊息是有效的 JSON。 使用 json_schema 支援該功能的模型較為常用。	否

PromptBasedEvaluatorDefinition

基於提示的評估器

名稱	類型	Description	為必填項目	預設值
data_schema	物件	評估者輸入資料的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
init_parameters	物件	評估者輸入參數的 JSON 結構描述 （草案 2020-12）。 這包括類型、屬性、必要等參數。	否
計量	物件	此評估器產生的輸出指標清單	否
prompt_text	字串	用於評估的提示文字	Yes
型別	列舉	可能的值：prompt	Yes

協議版本記錄

單一通訊協定及其版本的記錄對映。

名稱	類型	Description	為必填項目	預設值
通訊協定	代理協定		Yes
版本	字串	通訊協定的版本字串，例如 'v0.1.1'。	Yes

RaiConfig

負責任 AI （RAI） 內容篩選和安全功能的設定。

名稱	類型	Description	為必填項目	預設值
rai_policy_name	字串	要套用的 RAI 原則名稱。	Yes

RecurrenceSchedule

週期性排程模型。

復發判別器 Schedule

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
Hourly	每小時重複排程
Daily	每日重複排程
Weekly	每週重複排程
Monthly	每月重複排程

名稱	類型	Description	為必填項目	預設值
型別	RecurrenceType	週期類型。	Yes

RecurrenceTrigger

基於週期的觸發器。

名稱	類型	Description	為必填項目	預設值
endTime	字串	ISO 8601 格式週期排程的結束時間。	否
間隔	整數	週期性排程的間隔。	Yes
排程	RecurrenceSchedule	週期性排程模型。	Yes
\---- 類型	RecurrenceType	重複出現的頻率類型。	Yes
startTime	字串	ISO 8601 格式週期排程的開始時間。	否
timeZone	字串	週期排程的時區。	否	UTC
型別	列舉	觸發程式的類型。 可能的值：Recurrence	Yes

RecurrenceType

週期類型。

房產	價值觀
說明	週期類型。
Type	字串
價值	Hourly Daily Weekly Monthly

紅隊

紅隊詳情。

名稱	類型	Description	為必填項目	預設值
應用場景	字串	應用場景為紅隊作，生成場景特定的攻擊。	否
攻擊策略	攻擊策略陣列	攻擊策略清單或攻擊策略的嵌套清單。	否
顯示名稱	字串	紅隊運行的名稱。	否
id	字串（唯讀）	紅隊運行的標識碼。	Yes
數字轉	整數	類比輪次數。	否
properties	物件	紅隊的屬性。 不同於標籤，屬性是僅限新增的。 新增之後，就無法移除屬性。	否
風險類別	風險類別陣列	要為其產生攻擊目標的風險類別清單。	否
模擬	布爾值	僅模擬或模擬 + 評估。 默認為 false，如果為 true，則掃描輸出對話而不是評估結果。	否	否
狀態	字串（唯讀）	紅隊的狀態。 它由服務設置，並且是唯讀的。	否
tags	物件	紅隊的標籤。 與屬性不同，標籤是完全可變的。	否
目標	TargetConfig	目標配置的抽象類。	Yes
\---- 類型	字串	模型配置的類型。	Yes

RedTeamEvalRunDataSource

名稱	類型	Description	為必填項目	預設值
item_generation_params	ItemGenerationParams	代表用於控制物品產生操作的參數集合。	Yes
\---- 類型	ItemGenerationParamsType	使用物品生成參數的類型。	Yes
目標	目標	具有鑑別器支援的目標基底類別。	Yes
\---- 類型	字串	目標的類型。	Yes
型別	列舉	資料來源的類型。 一律為 azure_ai_red_team。 可能的值：azure_ai_red_team	Yes

RedTeamItemGenerationParams

名稱	類型	Description	為必填項目	預設值
attack_strategies	攻擊策略陣列	將使用攻擊策略的集合。	Yes
num_turns	整數	遊戲允許的回合數。	Yes	20
型別	列舉	物品產生參數的類型。 可能的值：red_team	Yes

RedTeamSeedPromptsItemGenerationParams

代表紅隊種子提示產生物品的參數。

名稱	類型	Description	為必填項目	預設值
attack_strategies	攻擊策略陣列	將使用攻擊策略的集合。	Yes
num_turns	整數	遊戲允許的回合數。	Yes	20
來源	OpenAI.EvalJsonlFileContentSource		Yes
\---- 內容	array of OpenAI.EvalJsonlFileContentSourceContent	jsonl 檔案的內容。	Yes
\---- 類型	列舉	jsonl 來源的類型。 一律為 file_content。 可能的值：file_content	Yes
型別	列舉	物品生成參數的類型總是 red_team_seed_prompts。 可能的值：red_team_seed_prompts	Yes

RedTeamTaxonomyItemGenerationParams

代表紅隊分類物品產生的參數。

名稱	類型	Description	為必填項目	預設值
attack_strategies	攻擊策略陣列	將使用攻擊策略的集合。	Yes
num_turns	整數	遊戲允許的回合數。	Yes	20
來源	OpenAI.EvalJsonlFileContentSource		Yes
\---- 內容	array of OpenAI.EvalJsonlFileContentSourceContent	jsonl 檔案的內容。	Yes
\---- 類型	列舉	jsonl 來源的類型。 一律為 file_content。 可能的值：file_content	Yes
型別	列舉	物品生成參數的類型總是 red_team_taxonomy。 可能的值：red_team_taxonomy	Yes

回應檢索項目生成參數

代表回應檢索題目產生的參數。

名稱	類型	Description	為必填項目	預設值
data_mapping	物件	從來源欄位映射到response_id欄位，這是擷取聊天歷史所必需的。	Yes
max_num_turns	整數	評估聊天歷史的最大回合數。	Yes
來源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	JSONL 內容讀取的來源。	Yes
型別	列舉	物品生成參數的類型總是 response_retrieval。 可能的值：response_retrieval	Yes

風險類別

攻擊目標的風險類別。

房產	價值觀
說明	攻擊目標的風險類別。
Type	字串
價值	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SAS信用

共享Access簽名（SAS）憑證定義

名稱	類型	Description	為必填項目	預設值
SAS	字串（唯讀）	SAS 權杖	否
型別	列舉	認證類型 可能的值：SAS	Yes

SampleType

分析中使用的樣本類型。

房產	價值觀
說明	分析中使用的樣本類型。
Type	字串
價值	EvaluationResultSample

SasCredential 證書

SAS 憑證定義

名稱	類型	Description	為必填項目	預設值
sasUri	字串（唯讀）	SAS uri	Yes
型別	列舉	憑證類型 可能的值：SAS	Yes

排程

排程模型。

名稱	類型	Description	為必填項目	預設值
說明	字串	排程的描述。	否
顯示名稱	字串	排程的名稱。	否
enabled	布爾值	排程的已啟用狀態。	Yes
id	字串（唯讀）	排程的識別碼。	Yes
properties	物件	Schedule 的屬性。 不同於標籤，屬性是僅限新增的。 新增之後，就無法移除屬性。	否
provisioning狀態	ScheduleProvisioningStatus （唯讀）	排程佈建狀態。	否
系統數據	物件（唯讀）	資源的系統中繼資料。	Yes
tags	物件	Schedule 的標籤。 與屬性不同，標籤是完全可變的。	否
工作	ScheduleTask	排程任務模型。	Yes
└─ 配置	物件	工作的設定。	否
\---- 類型	排程任務類型	任務的類型。	Yes
觸發	Trigger	排程觸發程式的基礎模型。	Yes
\---- 類型	TriggerType	觸發程式的類型。	Yes

排程配置狀態

排程佈建狀態。

房產	價值觀
說明	排程佈建狀態。
Type	字串
價值	Creating Updating Deleting Succeeded Failed

排程

排程執行模型。

名稱	類型	Description	為必填項目	預設值
錯誤	字串（唯讀）	排程執行的錯誤資訊。	否
id	字串（唯讀）	排程執行的識別碼。	Yes
properties	物件（唯讀）	排程執行的屬性。	Yes
scheduleID	字串	排程的識別碼。	Yes
勝	布林值（唯讀）	觸發排程執行的成功狀態。	Yes
triggerTime	字串	排程執行的觸發時間。	否

ScheduleTask

排程任務模型。

排程任務的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
Evaluation	評估排程任務
Insight	洞察排程任務

名稱	類型	Description	為必填項目	預設值
組態	物件	工作的設定。	否
型別	排程任務類型	任務的類型。	Yes

排程任務類型

任務的類型。

房產	價值觀
說明	任務的類型。
Type	字串
價值	Evaluation Insight

SharepointGroundingToolParameters（SharepointGroundingToolParameters）

SharePoint 接地工具參數。

名稱	類型	Description	為必填項目	預設值
project_connections	ToolProjectConnection 的陣列	這個工具上的 project 連結。 最多只能有 1 個連線 資源附帶於工具上。	否

SharepointPreviewTool

用來設定代理程式的 Sharepoint 工具輸入定義資訊。

名稱	類型	Description	為必填項目	預設值
sharepoint_grounding_preview	SharepointGroundingToolParameters（SharepointGroundingToolParameters）	SharePoint 接地工具參數。	Yes
└─ project_connections	ToolProjectConnection 的陣列	這個工具上的 project 連結。 最多只能有 1 個連線 資源附帶於工具上。 限制： maxItems：1	否
型別	列舉	物件類型，永遠是「sharepoint_grounding_preview」。 可能的值：sharepoint_grounding_preview	Yes

Sku

Sku 資訊

名稱	類型	Description	為必填項目	預設值
容量	整數	Sku 容量	Yes
family	字串	Sku 家族	Yes
名稱	字串	Sku 名稱	Yes
size	字串	Sku 大小	Yes
分層	字串	Sku 層	Yes

結構化輸入定義

可參與提示範本替換和工具引數繫結的結構化輸入。

名稱	類型	Description	為必填項目	預設值
default_value		如果未提供執行時期值，則輸入的預設值。	否
說明	字串	人類可讀的輸入描述。	否
required	布爾值	呼叫代理程式時是否需要輸入內容。	否	否
結構描述	物件	結構化輸入的 JSON 結構描述 （選用）。	否

StructuredOutputDefinition

一個由代理人能產生的結構化輸出。

名稱	類型	Description	為必填項目	預設值
說明	字串	要發出的輸出描述。 模型用來判斷何時發出輸出。	Yes
名稱	字串	結構化輸出的名稱。	Yes
結構描述	物件	結構化輸出的 JSON 結構描述。	Yes
嚴格	布林值（可空）	是否強制執行嚴格驗證。 預設 true。	Yes

結構化輸出輸出項目

名稱	類型	Description	為必填項目	預設值
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
輸出		回應過程中捕捉的結構化輸出。	Yes
response_id	字串	該項目所建立的回應。	否
型別	列舉	可能的值：structured_outputs	Yes

SyntheticDataGenerationPreviewEvalRunDataSource

代表一個基於產生的合成資料進行評估的資料來源，用於測試。

名稱	類型	Description	為必填項目	預設值
輸入訊息	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		否
|---- 範本	物件陣列或 OpenAI.EvalItem		Yes
\---- 類型	列舉	可能的值：template	Yes
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Yes
└─ model_deployment_name	字串	用於產生合成資料的模型部署名稱。	Yes
└─ output_dataset_id	字串（唯讀）	儲存合成資料的輸出資料集識別碼。 產生的資料是一個包含欄位 id、query 和 test_description 的 jsonl 檔案。	否
└─ output_dataset_name	字串	輸出資料集名稱，儲存合成資料。 若未提供，服務會自動產生資料集名稱。	否
└─ 提示	字串	用於產生合成資料的提示。 這是在目標類型為「azure_ai_agent」且在代理中設定指令時的選項。	否
└─ samples_count	整數	產生最多資料樣本數。	Yes
└─ 資料來源	array of OpenAI.EvalJsonlFileIdSource	可選的種子資料內容來源檔案用於資料產生。	Yes
\---- 類型	列舉	物品產生參數的類型。 可能的值：synthetic_data_gen_preview	Yes
目標	目標	具有鑑別器支援的目標基底類別。	Yes
\---- 類型	字串	目標的類型。	Yes
型別	列舉	資料來源類型總是 azure_ai_synthetic_data_gen_preview。 可能的值：azure_ai_synthetic_data_gen_preview	Yes

SyntheticDataGenerationPreviewItemGenerationParams

名稱	類型	Description	為必填項目	預設值
model_deployment_name	字串	用於產生合成資料的模型部署名稱。	Yes
output_dataset_id	字串（唯讀）	儲存合成資料的輸出資料集識別碼。 產生的資料是一個包含欄位 id、query 和 test_description 的 jsonl 檔案。	否
output_dataset_name	字串	輸出資料集名稱，儲存合成資料。 若未提供，服務會自動產生資料集名稱。	否
提示	字串	用於產生合成資料的提示。 這是在目標類型為「azure_ai_agent」且在代理中設定指令時的選項。	否
samples_count	整數	產生最多資料樣本數。	Yes
來源	array of OpenAI.EvalJsonlFileIdSource	可選的種子資料內容來源檔案用於資料產生。	Yes
型別	列舉	物品產生參數的類型。 可能的值：synthetic_data_gen_preview	Yes

標的

具有鑑別器支援的目標基底類別。

目標識別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

名稱	類型	Description	為必填項目	預設值
型別	字串	目標的類型。	Yes

目標完成評估跑數據源

代表基於目標的完井評估配置資料來源。

名稱	類型	Description	為必填項目	預設值
輸入訊息	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		否
項目參考	字串		Yes
\---- 類型	列舉	可能的值：item_reference	Yes
來源	OpenAI.EvalJsonlFileContentSource 或 OpenAI.EvalJsonlFileIdSource	內嵌或檔案資料的原始設定。	Yes
目標	目標	具有鑑別器支援的目標基底類別。	Yes
\---- 類型	字串	目標的類型。	Yes
型別	列舉	資料來源類型總是 azure_ai_target_completions。 可能的值：azure_ai_target_completions	Yes

TargetConfig

目標配置的抽象類。

TargetConfig 的判別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

名稱	類型	Description	為必填項目	預設值
型別	字串	模型配置的類型。	Yes

目標更新

具有鑑別器支援的目標基底類別。

TargetUpdate 的識別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

名稱	類型	Description	為必填項目	預設值
型別	字串	目標的類型。	Yes

分類分類

分類類別定義。

名稱	類型	Description	為必填項目	預設值
說明	字串	分類類別的描述。	否
id	字串	分類類別的唯一識別碼。	Yes
名稱	字串	分類類別的名稱。	Yes
properties	物件	分類類別的其他屬性。	否
風險類別	風險類別	攻擊目標的風險類別。	Yes
子類別	分類子類別陣列	分類學子類別列表。	Yes

分類子類別

分類學子類別定義。

名稱	類型	Description	為必填項目	預設值
說明	字串	分類學子類別的描述。	否
enabled	布爾值	此子類別下的分類項目列表。	Yes
id	字串	分類子類別的唯一識別碼。	Yes
名稱	字串	分類子類別的名稱。	Yes
properties	物件	分類子類別的其他屬性。	否

工具說明

客服專員可以使用的工具說明。

名稱	類型	Description	為必填項目	預設值
說明	字串	工具用途的簡要說明。	否
名稱	字串	工具的名稱。	否

工具專案連接

一個 project 連線資源。

名稱	類型	Description	為必填項目	預設值
project_connection_id	字串	一個 ToolProjectConnectionList 中的 project 連線，附加於此工具。	Yes

TracesPreviewEvalRunDataSource

代表用於分析執行的資料來源，這些執行可透過儲存在 Application Insights 中的代理追蹤進行。

名稱	類型	Description	為必填項目	預設值
agent_id	字串	用來篩選痕跡以供評估的代理人 ID。	否
agent_name	字串	代理人名稱用於篩選痕跡以供評估。	否
end_time	整數	Unix 時間戳記（以秒計）標記追蹤查詢視窗結束。 預設時間回到當前。	否
ingestion_delay_seconds	整數	查詢追蹤時申請擷取的延遲。	否	300
lookback_hours	整數	從 Application Insights 取得追蹤時會套用回看視窗（以小時計）。 對於排程評估，這是從重現間隔推斷出來的。	否	168
max_traces	整數	取樣限制適用於用於評估的痕跡。	否	1000
trace_ids	字串陣列	應評估的代理人追蹤識別碼集合。	否
型別	列舉	資料來源類型總是 azure_ai_traces_preview。 可能的值：azure_ai_traces_preview	Yes

治療效果類型

治療效果類型。

房產	價值觀
說明	治療效果類型。
Type	字串
價值	TooFewSamples Inconclusive Changed Improved Degraded

觸發程序

排程觸發程式的基礎模型。

觸發器的鑑別器

此元件會使用 屬性 type 來區分不同的類型：

類型值	Schema
Cron	CronTrigger 的
Recurrence	RecurrenceTrigger 觸發器
OneTime	一次觸發

名稱	類型	Description	為必填項目	預設值
型別	TriggerType	觸發程式的類型。	Yes

觸發類型

觸發程式的類型。

房產	價值觀
說明	觸發程式的類型。
Type	字串
價值	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

名稱	類型	Description	為必填項目	預設值
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
manifest_id	字串	用來匯入代理版本的清單 ID。	Yes
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
parameter_values	物件	清單的輸入將導致一個完全具現化的特工。	Yes

更新代理請求

名稱	類型	Description	為必填項目	預設值
定義	代理定義		Yes
└─ 善良	特工種類		Yes
└─ rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
說明	字串	人類可讀的代理程式描述。 限制： max長度：512	否
中繼資料	物件	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否

更新評估參數體

名稱	類型	Description	為必填項目	預設值
中繼資料	OpenAI.Metadata （可空化）	可附加至物件的索引鍵/值組 (16 個為一組)。 這可以是 適用於以結構化方式儲存物件的其他資訊 透過 API 或儀錶板來格式化和查詢物件。 索引鍵是長度上限為64個字元的字串。 值為字串 長度上限為 512 個字元。	否
名稱	字串		否
properties	物件	一組可附加於物件上的不可變 16 對鍵值，用於儲存額外資訊。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元的字串。	否

使用者設定記憶項目

專門包含從對話中提取的用戶個人資料信息的記憶項目，例如偏好、興趣和個人詳細信息。

名稱	類型	Description	為必填項目	預設值
內容	字串	記憶體的內容。	Yes
類型	列舉	記憶項目的種類。 可能的值：user_profile	Yes
memory_id	字串	記憶體項目的唯一 ID。	Yes
範圍	字串	以邏輯方式分組及隔離記憶體的命名空間，例如使用者 ID。	Yes
updated_at	整數	記憶體項目的最後更新時間。	Yes

WebSearchConfiguration

bing 自訂搜尋的網頁搜尋設定

名稱	類型	Description	為必填項目	預設值
instance_name	字串	提供給組態的自定義組態實例名稱。	Yes
project_connection_id	字串	Project 連接 ID 用於接地，使用 bing 自訂搜尋	Yes

每週重複排程

每週週期排程。

名稱	類型	Description	為必填項目	預設值
daysOfWeek	週日數陣列	週期性排程的星期幾。	Yes
型別	列舉	每週週期類型。 可能的值：Weekly	Yes

工作流程行動輸出項目

名稱	類型	Description	為必填項目	預設值
action_id	字串	動作的唯一識別碼。	Yes
agent_reference	代理參考		否
\---- 名稱	字串	代理程式的名稱。 限制： 最大長度：256	Yes
\---- 類型	列舉	可能的值：agent_reference	Yes
└─版本	字串	代理程式的版本識別碼。	否
類型	字串	例如CSDL動作類型（例如「SetVariable」、「InvokeAzureAgent」）。	Yes
parent_action_id	字串	如果是巢狀動作，則識別父動作。	否
previous_action_id	字串	若該動作緊接著另一個動作，則該動作的識別碼。	否
response_id	字串	該項目所建立的回應。	否
狀態	列舉	動作狀態（例如，「in_progress」、「完成」、「失敗」、「取消」）。 可能的值：completed、、failed、 in_progresscancelled	Yes
型別	列舉	可能的值：workflow_action	Yes

工作流程代理定義

工作流程代理程式定義。

名稱	類型	Description	為必填項目	預設值
類型	列舉	可能的值：workflow	Yes
rai_config	RaiConfig	負責任 AI （RAI） 內容篩選和安全功能的設定。	否
└─ rai_policy_name	字串	要套用的 RAI 原則名稱。	Yes
工作流程	字串	工作流程的 CSDL YAML 定義。	否

整數

類型：整數

格式：int64