RunsCreateRunOptionalParams interface

パッケージ:

@azure/ai-agents

省略可能なパラメーター。

Extends

OperationOptions,PollingOptionsParams

プロパティ

additionalInstructions	実行の手順の最後に追加する追加の手順。 これは、他の手順をオーバーライドすることなく、実行ごとに動作を変更する場合に役立ちます。
additionalMessages	実行を作成する前に、スレッドにメッセージを追加します。
include	応答に含める追加フィールドの一覧。 現在サポートされている唯一の値は、ファイル検索結果の内容をフェッチするために step_details.tool_calls[*].file_search.results[*].content です。
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 のような小さい値にすると、出力はより集中的および決定論的になります。
toolChoice	モデルによって呼び出されるツールかどうかを制御します。
toolResources	エージェントがスレッドの実行に使用する必要がある、オーバーライドされた有効なツールリソース。
tools	エージェントがスレッドの実行に使用する有効なツールのオーバーライドされた一覧。
topP	温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
truncationStrategy	コンテキスト ウィンドウが進むにつれてメッセージを削除するために使用する戦略。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
pollingOptions	ポーリング動作を構成するためのオプション。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

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

モデルによって呼び出されるツールかどうかを制御します。

toolChoice?: null | AgentsToolChoiceOption

プロパティ値

null | AgentsToolChoiceOption

toolResources

エージェントがスレッドの実行に使用する必要がある、オーバーライドされた有効なツールリソース。

toolResources?: null | ToolResources

プロパティ値

null | ToolResources

tools

エージェントがスレッドの実行に使用する有効なツールのオーバーライドされた一覧。

tools?: null | ToolDefinitionUnion[]

プロパティ値

null | ToolDefinitionUnion[]

topP

温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。

topP?: null | number

プロパティ値

null | number

truncationStrategy

コンテキスト ウィンドウが進むにつれてメッセージを削除するために使用する戦略。

truncationStrategy?: null | TruncationObject

プロパティ値

null | TruncationObject

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

OperationOptions.abortSignal から継承された

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

OperationOptions.onResponse から継承された

pollingOptions

ポーリング動作を構成するためのオプション。

pollingOptions?: PollingOptions

プロパティ値

PollingOptions

PollingOptionsParams.pollingOptions から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

OperationOptions.requestOptions から継承された

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptions から継承された