ListMessageFilesOptions interface

  • リファレンス
パッケージ:
@azure/openai-assistants

メッセージ ファイルの一覧表示に使用される詳細。

Extends
OperationOptions

プロパティ

after

ページ分割で使用するカーソル。 after は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。
before

ページ分割で使用するカーソル。 は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。
limit

返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。
order

オブジェクトのcreated_atタイムスタンプによる並べ替え順序。 昇順の場合は asc、降順の場合は desc。

継承されたプロパティ

abortSignal

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

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

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

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

プロパティの詳細

after

ページ分割で使用するカーソル。 after は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。

after?: string

プロパティ値

string

before

ページ分割で使用するカーソル。 は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。

before?: string

プロパティ値

string

limit

返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。

limit?: number

プロパティ値

number

order

オブジェクトのcreated_atタイムスタンプによる並べ替え順序。 昇順の場合は asc、降順の場合は desc。

order?: string

プロパティ値

string

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

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