次の方法で共有


AgentsCreateOptionalParams interface

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

Extends

プロパティ

description

エージェントの人間が判読できる説明。

foundryFeatures

プレビュー操作を使用したり、永続化されたプレビュー リソースを変更したりする場合は、機能フラグのオプトインが必要です。

metadata

オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。

継承されたプロパティ

abortSignal

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

onResponse

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

requestOptions

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

tracingOptions

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

プロパティの詳細

description

エージェントの人間が判読できる説明。

description?: string

プロパティ値

string

foundryFeatures

プレビュー操作を使用したり、永続化されたプレビュー リソースを変更したりする場合は、機能フラグのオプトインが必要です。

foundryFeatures?: AgentDefinitionOptInKeys

プロパティ値

metadata

オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、構造化された形式でオブジェクトに関する追加情報を格納したり、API またはダッシュボードを使用してオブジェクトのクエリを実行したりする場合に役立ちます。

キーは、最大長が 64 文字の文字列です。 値は、最大長が 512 文字の文字列です。

metadata?: Record<string, string>

プロパティ値

Record<string, string>

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

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

OperationOptions.abortSignal から継承された

onResponse

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

onResponse?: RawResponseCallback

プロパティ値

OperationOptions.onResponse から継承された

requestOptions

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

requestOptions?: OperationRequestOptions

プロパティ値

OperationOptions.requestOptions から継承された

tracingOptions

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

tracingOptions?: OperationTracingOptions

プロパティ値

OperationOptions.tracingOptions から継承された