RunsCreateRunOptionalParams interface
選擇性參數。
- Extends
屬性
| additional |
要附加至執行指令結尾的其他指示。 這有助於修改個別執行的行為，而無須覆寫其他指令。 |
| additional |
在建立執行之前，將其他訊息新增至執行緒。 |
| include | 要包含在回應中的其他欄位清單。
目前唯一支援的值是 |
| instructions | 覆寫的系統指示，代理程式應該用來執行線程。 |
| max |
執行過程中可能使用的完成令牌數目上限。 執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。 如果執行超過指定的完成權杖數目，執行將會以狀態 |
| max |
在執行過程中可能使用的提示令牌數目上限。 執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。 如果執行超過指定的提示權杖數目，執行將會以狀態 |
| metadata | 一組最多可以附加至物件的16個索引鍵/值組，用於以結構化格式儲存該物件的其他資訊。 索引鍵的長度可能最多為64個字元，且值長度最多為512個字元。 |
| model | 代理程式應該用來執行線程的覆寫模型名稱。 |
| parallel |
如果 |
| response |
指定模型必須輸出的格式。 |
| stream | 若為 |
| temperature | 要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。 |
| tool |
控制模型是否呼叫和呼叫哪一個工具。 |
| tool |
代理應用於運行線程的被覆蓋的已啟用工具資源。 |
| tools | 代理程式應該用來執行線程的已啟用工具清單。 |
| topP | 核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。 因此，0.1 表示只考慮組成前 10% 機率質量的權杖。 一般會建議改變這個值或溫度，但不建議同時改變。 |
| truncation |
當內容視窗向前移動時，用來卸載訊息的策略。 |
繼承的屬性
| abort |
可用來中止要求的訊號。 |
| on |
每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。 |
| polling |
設定輪詢行為的選項。 |
| request |
建立和傳送此作業之 HTTP 要求時所使用的選項。 |
| tracing |
啟用追蹤時所使用的選項。 |
屬性詳細資料
additionalInstructions
要附加至執行指令結尾的其他指示。 這有助於修改個別執行的行為，而無須覆寫其他指令。
additionalInstructions?: null | string屬性值
null | string
additionalMessages
在建立執行之前，將其他訊息新增至執行緒。
additionalMessages?: null | ThreadMessageOptions[]屬性值
null | ThreadMessageOptions[]
include
要包含在回應中的其他欄位清單。
目前唯一支援的值是 step_details.tool_calls[*].file_search.results[*].content 擷取檔案搜尋結果內容。
include?: "step_details.tool_calls[*].file_search.results[*].content"[]屬性值
"step_details.tool_calls[].file_search.results[].content"[]
instructions
覆寫的系統指示，代理程式應該用來執行線程。
instructions?: null | string屬性值
null | string
maxCompletionTokens
執行過程中可能使用的完成令牌數目上限。 執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。 如果執行超過指定的完成權杖數目，執行將會以狀態 incomplete 結束。 如需詳細資訊，請參閱 incomplete_details。
maxCompletionTokens?: null | number屬性值
null | number
maxPromptTokens
在執行過程中可能使用的提示令牌數目上限。 執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。 如果執行超過指定的提示權杖數目，執行將會以狀態 incomplete 結束。 如需詳細資訊，請參閱 incomplete_details。
maxPromptTokens?: null | number屬性值
null | number
metadata
一組最多可以附加至物件的16個索引鍵/值組，用於以結構化格式儲存該物件的其他資訊。 索引鍵的長度可能最多為64個字元，且值長度最多為512個字元。
metadata?: null | Record<string, string>屬性值
null | Record<string, string>
model
代理程式應該用來執行線程的覆寫模型名稱。
model?: null | string屬性值
null | string
parallelToolCalls
如果 true 函式會在工具使用期間平行執行。
parallelToolCalls?: boolean屬性值
boolean
responseFormat
指定模型必須輸出的格式。
responseFormat?: null | AgentsResponseFormatOption屬性值
null | AgentsResponseFormatOption
stream
若為 true，則會傳回在以伺服器傳送的事件形式執行期間發生，並在執行進入終端狀態且顯示 data: [DONE] 訊息時終止的事件資料流。
stream?: boolean屬性值
boolean
temperature
要使用的取樣溫度，介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機，而 0.2 之類的較低值會使它更集中且具決定性。
temperature?: null | number屬性值
null | number
toolChoice
toolResources
tools
topP
核取樣是溫度取樣的替代方法，在此方法中，模型會考慮包含 top_p 機率質量的權杖結果。 因此，0.1 表示只考慮組成前 10% 機率質量的權杖。
一般會建議改變這個值或溫度，但不建議同時改變。
topP?: null | number屬性值
null | number
truncationStrategy
繼承的屬性詳細資料
abortSignal
onResponse
每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。
onResponse?: RawResponseCallback屬性值
繼承自 OperationOptions.onResponse
pollingOptions
設定輪詢行為的選項。
pollingOptions?: PollingOptions屬性值
requestOptions
建立和傳送此作業之 HTTP 要求時所使用的選項。
requestOptions?: OperationRequestOptions屬性值
繼承自 OperationOptions.requestOptions
tracingOptions
啟用追蹤時所使用的選項。
tracingOptions?: OperationTracingOptions屬性值
繼承自 OperationOptions.tracingOptions