CreateThreadAndRunOptionalParams interface

パッケージ:

@azure/ai-agents

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

Extends

OperationOptions

プロパティ

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％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
truncationStrategy	コンテキスト ウィンドウが進むにつれてメッセージを削除するために使用する戦略。

継承されたプロパティ

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

プロパティの詳細

instructions

オーバーライドされたシステム命令は、エージェントがスレッドの実行に使用する必要があります。

instructions?: string | null

プロパティ値

string | null

maxCompletionTokens

実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。

maxCompletionTokens?: number | null

プロパティ値

number | null

maxPromptTokens

実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。

maxPromptTokens?: number | null

プロパティ値

number | null

metadata

オブジェクトにアタッチできる最大 16 個のキーと値のペアのセット。構造化された形式でそのオブジェクトに関する追加情報を格納するために使用されます。 キーの長さは最大 64 文字で、値の長さは最大 512 文字です。

metadata?: Record<string, string> | null

プロパティ値

Record<string, string> | null

model

エージェントがスレッドの実行に使用するオーバーライドされたモデル。

model?: string | null

プロパティ値

string | null

parallelToolCalls

true 関数は、ツールの使用中に並列で実行されます。

parallelToolCalls?: boolean

プロパティ値

boolean

responseFormat

モデルから出力する必要がある形式を指定します。

responseFormat?: AgentsResponseFormatOption | null

プロパティ値

AgentsResponseFormatOption | null

stream

true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。

stream?: boolean

プロパティ値

boolean

temperature

使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。

temperature?: number | null

プロパティ値

number | null

thread

新しいスレッドの作成に使用される詳細。 スレッドが指定されていない場合は、空のスレッドが作成されます。

thread?: AgentThreadCreationOptions

プロパティ値

AgentThreadCreationOptions

toolChoice

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

toolChoice?: AgentsToolChoiceOption | null

プロパティ値

AgentsToolChoiceOption | null

toolResources

エージェントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に便利です

toolResources?: ToolResources | null

プロパティ値

ToolResources | null

tools

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

tools?: ToolDefinitionUnion[] | null

プロパティ値

ToolDefinitionUnion[] | null

topP

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

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

topP?: number | null

プロパティ値

number | null

truncationStrategy

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

truncationStrategy?: TruncationObject | null

プロパティ値

TruncationObject | null

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

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

OperationOptions.abortSignal から継承された

onResponse

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

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

OperationOptions.onResponse から継承された

requestOptions

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

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

OperationOptions.requestOptions から継承された

tracingOptions

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

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptions から継承された