MessagesCreateMessageOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| attachments | メッセージに添付されているファイルと、追加先にする必要があるツールの一覧。 |
| metadata | オブジェクトにアタッチできる最大 16 個のキーと値のペアのセット。構造化された形式でそのオブジェクトに関する追加情報を格納するために使用されます。 キーの長さは最大 64 文字で、値の長さは最大 512 文字です。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
attachments
メッセージに添付されているファイルと、追加先にする必要があるツールの一覧。
attachments?: null | MessageAttachment[]プロパティ値
null | MessageAttachment[]
metadata
オブジェクトにアタッチできる最大 16 個のキーと値のペアのセット。構造化された形式でそのオブジェクトに関する追加情報を格納するために使用されます。 キーの長さは最大 64 文字で、値の長さは最大 512 文字です。
metadata?: null | Record<string, string>プロパティ値
null | Record<string, string>
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
OperationOptions.abortSignal から継承された
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
OperationOptions.onResponse から継承された
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
OperationOptions.requestOptions から継承された
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
OperationOptions.tracingOptions から継承された