BetaAgentsListSessionFilesOptionalParams interface

Parametry opcjonalne.

Rozszerzenie

Właściwości

after

Kursor do wykorzystania w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.

before

Kursor do wykorzystania w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.

foundryFeatures

Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

limit

Limit liczby zwracanych obiektów. Limit może wahać się od 1 do 100, a domyślny to 20.

order

Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej idesc kolejności malejącej.

path

Ścieżka katalogu do listy, względem katalogu sesji macierzystej. Domyślnie jest ustawiony do katalogu głównego, jeśli nie jest dostępny.

userIsolationKey

Nieprzejrzysty klucz izolacji dla użytkownika używany do ograniczania danych o skali końcowej (odpowiedzi, rozmowy, sesje) do konkretnego użytkownika końcowego.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

after

Kursor do wykorzystania w stronicowaniu. after jest identyfikatorem obiektu definiującym miejsce na liście. Na przykład, jeśli wykonasz żądanie listy i otrzymasz 100 obiektów kończących się na obj_foo, kolejne wywołanie może zawierać after=obj_foo, aby pobrać następną stronę listy.

after?: string

Wartość właściwości

string

before

Kursor do wykorzystania w stronicowaniu. before jest identyfikatorem obiektu definiującym miejsce na liście. Jeśli na przykład wykonasz żądanie listy i otrzymasz 100 obiektów, kończąc się obj_foo, kolejne wywołanie może zawierać wartość before=obj_foo w celu pobrania poprzedniej strony listy.

before?: string

Wartość właściwości

string

foundryFeatures

Flaga funkcji wymagana podczas korzystania z operacji w wersji zapoznawczej lub modyfikowania trwałych zasobów w wersji zapoznawczej.

foundryFeatures?: "HostedAgents=V1Preview"

Wartość właściwości

"HostedAgents=V1Preview"

limit

Limit liczby zwracanych obiektów. Limit może wahać się od 1 do 100, a domyślny to 20.

limit?: number

Wartość właściwości

number

order

Sortuj kolejność według znacznika created_at czasu obiektów. asc w przypadku kolejności rosnącej idesc kolejności malejącej.

order?: PageOrder

Wartość właściwości

path

Ścieżka katalogu do listy, względem katalogu sesji macierzystej. Domyślnie jest ustawiony do katalogu głównego, jeśli nie jest dostępny.

path?: string

Wartość właściwości

string

userIsolationKey

Nieprzejrzysty klucz izolacji dla użytkownika używany do ograniczania danych o skali końcowej (odpowiedzi, rozmowy, sesje) do konkretnego użytkownika końcowego.

userIsolationKey?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

dziedziczone z OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

dziedziczone z OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

dziedziczone z OperationOptions.requestOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

dziedziczone z OperationOptions.tracingOptions