ListDocumentStatusesOptionalParams interface

Pakiet:
@azure/ai-translation-document

Parametry opcjonalne.

Rozszerzenie
OperationOptions

Właściwości

createdAfter

data/godzina rozpoczęcia pobierania elementów po
createdBefore

data/godzina zakończenia pobierania elementów przed
documentIds

Identyfikatory do użycia w filtrowaniu
maxPageSize

maxPageSize to maksymalna liczba elementów zwracanych na stronie. Jeśli kolejne przedmioty są zamawiane przez górę (lub góra nie jest określona i jest więcej przedmiotów do zwrotu),
orderBy

zapytanie sortujące kolekcję (np. 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc opis')
skip

Skip wskazuje liczbę rekordów do pominięcia z listy rekordów przechowywanych przez serwer w zależności od określonej metody sortowania. Domyślnie sortujemy według malejącego czasu rozpoczęcia.

Klienci MOGĄ używać parametrów zapytania top i skip, aby określić liczbę wyników do zwrócenia oraz przesunięcie do kolekcji. Gdy klient poda zarówno top, jak i skip, serwer POWINIEN najpierw zastosować skip, a potem top na kolekcji.

Uwaga: Jeśli serwer nie może uszanować górnej i/lub pominąć, serwer MUSI zwrócić błąd do klienta informującego o tym, zamiast po prostu ignorować opcje zapytania.
statuses

Stany do użycia w filtrowaniu
top

top oznacza łączną liczbę rekordów, które użytkownik chce zwrócić na wszystkich stronach.

Klienci MOGĄ używać parametrów zapytania top i skip, aby określić liczbę wyników do zwrócenia oraz przesunięcie do kolekcji. Gdy klient poda zarówno top, jak i skip, serwer POWINIEN najpierw zastosować skip, a potem top na kolekcji.

Uwaga: Jeśli serwer nie może uszanować górnej i/lub pominąć, serwer MUSI zwrócić błąd do klienta informującego o tym, zamiast po prostu ignorować opcje zapytania.

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

createdAfter

data/godzina rozpoczęcia pobierania elementów po

createdAfter?: Date

Wartość właściwości

Date

createdBefore

data/godzina zakończenia pobierania elementów przed

createdBefore?: Date

Wartość właściwości

Date

documentIds

Identyfikatory do użycia w filtrowaniu

documentIds?: string[]

Wartość właściwości

string[]

maxPageSize

maxPageSize to maksymalna liczba elementów zwracanych na stronie. Jeśli kolejne przedmioty są zamawiane przez górę (lub góra nie jest określona i jest więcej przedmiotów do zwrotu),

maxPageSize?: number

Wartość właściwości

number

orderBy

zapytanie sortujące kolekcję (np. 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc opis')

orderBy?: string[]

Wartość właściwości

string[]

skip

Skip wskazuje liczbę rekordów do pominięcia z listy rekordów przechowywanych przez serwer w zależności od określonej metody sortowania. Domyślnie sortujemy według malejącego czasu rozpoczęcia.

Klienci MOGĄ używać parametrów zapytania top i skip, aby określić liczbę wyników do zwrócenia oraz przesunięcie do kolekcji. Gdy klient poda zarówno top, jak i skip, serwer POWINIEN najpierw zastosować skip, a potem top na kolekcji.

Uwaga: Jeśli serwer nie może uszanować górnej i/lub pominąć, serwer MUSI zwrócić błąd do klienta informującego o tym, zamiast po prostu ignorować opcje zapytania.

skip?: number

Wartość właściwości

number

statuses

Stany do użycia w filtrowaniu

statuses?: string[]

Wartość właściwości

string[]

top

top oznacza łączną liczbę rekordów, które użytkownik chce zwrócić na wszystkich stronach.

Klienci MOGĄ używać parametrów zapytania top i skip, aby określić liczbę wyników do zwrócenia oraz przesunięcie do kolekcji. Gdy klient poda zarówno top, jak i skip, serwer POWINIEN najpierw zastosować skip, a potem top na kolekcji.

Uwaga: Jeśli serwer nie może uszanować górnej i/lub pominąć, serwer MUSI zwrócić błąd do klienta informującego o tym, zamiast po prostu ignorować opcje zapytania.

top?: number

Wartość właściwości

number

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

AbortSignalLike

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

RawResponseCallback

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

OperationRequestOptions

dziedziczone z OperationOptions.requestOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone z OperationOptions.tracingOptions