共用方式為


CreateThreadAndRunOptionalParams interface

選擇性參數。

Extends

屬性

instructions

覆寫的系統指示代理程式應該用來執行線程。

maxCompletionTokens

執行過程中可能使用的完成令牌數目上限。 執行會盡可能在多個執行回合中僅使用指定數目的完成權杖。 如果執行超過指定的完成權杖數目,執行將會以狀態 incomplete 結束。 如需詳細資訊,請參閱 incomplete_details

maxPromptTokens

在執行過程中可能使用的提示令牌數目上限。 執行會盡可能在多個執行回合中僅使用指定數目的提示權杖。 如果執行超過指定的提示權杖數目,執行將會以狀態 incomplete 結束。 如需詳細資訊,請參閱 incomplete_details

metadata

一組最多可以附加至物件的16個索引鍵/值組,用於以結構化格式儲存該物件的其他資訊。 索引鍵的長度可能最多為64個字元,且值長度最多為512個字元。

model

代理程式應該用來執行線程的覆寫模型。

parallelToolCalls

如果 true 函式會在工具使用期間平行執行。

responseFormat

指定模型必須輸出的格式。

stream

若為 true,則會傳回在以伺服器傳送的事件形式執行期間發生,並在執行進入終端狀態且顯示 data: [DONE] 訊息時終止的事件資料流。

temperature

要使用的取樣溫度,介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機,而 0.2 之類的較低值會使它更集中且具決定性。

thread

用來建立新線程的詳細數據。 如果未提供任何線程,則會建立空的線程。

toolChoice

控制模型是否呼叫和呼叫哪一個工具。

toolResources

覆寫代理程式可用於此執行的工具。 這在每次執行的情況下修改行為很有用

tools

代理程式應該用來執行線程的已啟用工具清單。

topP

核取樣是溫度取樣的替代方法,在此方法中,模型會考慮包含 top_p 機率質量的權杖結果。 因此,0.1 表示只考慮組成前 10% 機率質量的權杖。

一般會建議改變這個值或溫度,但不建議同時改變。

truncationStrategy

當內容視窗向前移動時,用來卸載訊息的策略。

繼承的屬性

abortSignal

可用來中止要求的訊號。

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

tracingOptions

啟用追蹤時所使用的選項。

屬性詳細資料

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

屬性值

stream

若為 true,則會傳回在以伺服器傳送的事件形式執行期間發生,並在執行進入終端狀態且顯示 data: [DONE] 訊息時終止的事件資料流。

stream?: boolean

屬性值

boolean

temperature

要使用的取樣溫度,介於 0 到 2 之間。 0.8 之類的較高值會讓輸出更隨機,而 0.2 之類的較低值會使它更集中且具決定性。

temperature?: null | number

屬性值

null | number

thread

用來建立新線程的詳細數據。 如果未提供任何線程,則會建立空的線程。

thread?: AgentThreadCreationOptions

屬性值

toolChoice

控制模型是否呼叫和呼叫哪一個工具。

toolChoice?: null | AgentsToolChoiceOption

屬性值

toolResources

覆寫代理程式可用於此執行的工具。 這在每次執行的情況下修改行為很有用

toolResources?: null | ToolResources

屬性值

null | ToolResources

tools

代理程式應該用來執行線程的已啟用工具清單。

tools?: null | ToolDefinitionUnion[]

屬性值

topP

核取樣是溫度取樣的替代方法,在此方法中,模型會考慮包含 top_p 機率質量的權杖結果。 因此,0.1 表示只考慮組成前 10% 機率質量的權杖。

一般會建議改變這個值或溫度,但不建議同時改變。

topP?: null | number

屬性值

null | number

truncationStrategy

當內容視窗向前移動時,用來卸載訊息的策略。

truncationStrategy?: null | TruncationObject

屬性值

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自 OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

繼承自 OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

繼承自 OperationOptions.requestOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

繼承自 OperationOptions.tracingOptions