ListDocumentStatusesOptionalParams interface

Pacchetto:

@azure/ai-translation-document

Parametri facoltativi.

Extends

OperationOptions

Proprietà

createdAfter	data/ora di inizio per ottenere gli elementi dopo
createdBefore	data/ora di fine per ottenere gli elementi prima
documentIds	ID da usare nel filtro
maxPageSize	maxPageSize è il massimo degli elementi restituiti in una pagina. Se altri articoli vengono richiesti tramite top (o top non specificato e ci sono altri articoli da restituire),
orderBy	la query di ordinamento per la collezione (es: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')
skip	Skip indica il numero di record da saltare dalla lista dei record detenuti dal server in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente. I client POSSONO utilizzare parametri di query top e skip per specificare un numero di risultati da restituire e un offset nella collezione. Quando sia il top che lo skip sono dati da un client, il server DOVREBBE prima applicare lo skip e poi il top sulla collezione. Nota: Se il server non può rispettare il top e/o saltare, DEVE restituire un errore al client per informarlo invece di ignorare semplicemente le opzioni di interrogazione.
statuses	Stati da usare nel filtro
top	La parte superiore indica il numero totale di record che l'utente desidera restituire su tutte le pagine. I client POSSONO utilizzare parametri di query top e skip per specificare un numero di risultati da restituire e un offset nella collezione. Quando sia il top che lo skip sono dati da un client, il server DOVREBBE prima applicare lo skip e poi il top sulla collezione. Nota: Se il server non può rispettare il top e/o saltare, DEVE restituire un errore al client per informarlo invece di ignorare semplicemente le opzioni di interrogazione.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
onResponse	Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
requestOptions	Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
tracingOptions	Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

createdAfter

data/ora di inizio per ottenere gli elementi dopo

createdAfter?: Date

Valore della proprietà

Date

createdBefore

data/ora di fine per ottenere gli elementi prima

createdBefore?: Date

Valore della proprietà

Date

documentIds

ID da usare nel filtro

documentIds?: string[]

Valore della proprietà

string[]

maxPageSize

maxPageSize è il massimo degli elementi restituiti in una pagina. Se altri articoli vengono richiesti tramite top (o top non specificato e ci sono altri articoli da restituire),

maxPageSize?: number

Valore della proprietà

number

orderBy

la query di ordinamento per la collezione (es: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')

orderBy?: string[]

Valore della proprietà

string[]

skip

Skip indica il numero di record da saltare dalla lista dei record detenuti dal server in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente.

I client POSSONO utilizzare parametri di query top e skip per specificare un numero di risultati da restituire e un offset nella collezione. Quando sia il top che lo skip sono dati da un client, il server DOVREBBE prima applicare lo skip e poi il top sulla collezione.

Nota: Se il server non può rispettare il top e/o saltare, DEVE restituire un errore al client per informarlo invece di ignorare semplicemente le opzioni di interrogazione.

skip?: number

Valore della proprietà

number

statuses

Stati da usare nel filtro

statuses?: string[]

Valore della proprietà

string[]

top

La parte superiore indica il numero totale di record che l'utente desidera restituire su tutte le pagine.

I client POSSONO utilizzare parametri di query top e skip per specificare un numero di risultati da restituire e un offset nella collezione. Quando sia il top che lo skip sono dati da un client, il server DOVREBBE prima applicare lo skip e poi il top sulla collezione.

Nota: Se il server non può rispettare il top e/o saltare, DEVE restituire un errore al client per informarlo invece di ignorare semplicemente le opzioni di interrogazione.

top?: number

Valore della proprietà

number

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato da OperationOptions.abortSignal

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

RawResponseCallback

Ereditato da OperationOptions.onResponse

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

OperationRequestOptions

Ereditato da OperationOptions.requestOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato da OperationOptions.tracingOptions