AgentsListOptimizationCandidatesOptionalParams interface

選擇性參數。

Extends

屬性

after

Candidate-ID 游標標示上一頁的最後一項。

before

Candidate-ID 游標,從下一頁標示第一個項目。

expand

以逗號分隔的擴展鍵列表。 傳遞 mutations 以填充突變 value 欄位;省略以接收僅 type包含 的突變項目。 未來預覽可能會新增更多擴展鍵。

limit

限制可歸還的物品數量。 限制範圍在1到100之間,預設為20。

order

依候選 started_at 時間戳排序。

繼承的屬性

abortSignal

可用來中止要求的訊號。

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

tracingOptions

啟用追蹤時所使用的選項。

屬性詳細資料

after

Candidate-ID 游標標示上一頁的最後一項。

after?: string

屬性值

string

before

Candidate-ID 游標,從下一頁標示第一個項目。

before?: string

屬性值

string

expand

以逗號分隔的擴展鍵列表。 傳遞 mutations 以填充突變 value 欄位;省略以接收僅 type包含 的突變項目。 未來預覽可能會新增更多擴展鍵。

expand?: "mutations"[]

屬性值

"mutations"[]

limit

限制可歸還的物品數量。 限制範圍在1到100之間,預設為20。

limit?: number

屬性值

number

order

依候選 started_at 時間戳排序。

order?: PageOrder

屬性值

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自 OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

繼承自 OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

繼承自 OperationOptions.requestOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

繼承自 OperationOptions.tracingOptions