ListDocumentStatusesOptionalParams interface

Paquet:

@azure/ai-translation-document

Paramètres facultatifs.

Extends

OperationOptions

Propriétés

createdAfter	date de début pour obtenir les éléments après
createdBefore	date de fin pour obtenir les éléments avant
documentIds	ID à utiliser dans le filtrage
maxPageSize	maxPageSize correspond au maximum d’éléments retournés sur une page. Si plus d’articles sont demandés via le top (ou si top n’est pas spécifié et qu’il y a d’autres articles à retourner),
orderBy	la requête de tri pour la collection (ex : 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')
skip	Skip indique le nombre d’enregistrements à ignorer dans la liste des enregistrements détenus par le serveur selon la méthode de tri spécifiée. Par défaut, nous trions en décroissant l’heure de début. Les clients PEUVENT utiliser les paramètres de requête top et skip pour spécifier un nombre de résultats à retourner et un décalage dans la collection. Lorsque le top et le skip sont donnés par un client, le serveur DEVRAIT d’abord appliquer le skip puis le top sur la collection. Note : Si le serveur ne peut pas respecter le top et/ou passer, il DOIT renvoyer une erreur au client pour l’informer au lieu d’ignorer simplement les options de requête.
statuses	États à utiliser dans le filtrage
top	Le haut indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés sur toutes les pages. Les clients PEUVENT utiliser les paramètres de requête top et skip pour spécifier un nombre de résultats à retourner et un décalage dans la collection. Lorsque le top et le skip sont donnés par un client, le serveur DEVRAIT d’abord appliquer le skip puis le top sur la collection. Note : Si le serveur ne peut pas respecter le top et/ou passer, il DOIT renvoyer une erreur au client pour l’informer au lieu d’ignorer simplement les options de requête.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
tracingOptions	Options utilisées lorsque le suivi est activé.

Détails de la propriété

createdAfter

date de début pour obtenir les éléments après

createdAfter?: Date

Valeur de propriété

Date

createdBefore

date de fin pour obtenir les éléments avant

createdBefore?: Date

Valeur de propriété

Date

documentIds

ID à utiliser dans le filtrage

documentIds?: string[]

Valeur de propriété

string[]

maxPageSize

maxPageSize correspond au maximum d’éléments retournés sur une page. Si plus d’articles sont demandés via le top (ou si top n’est pas spécifié et qu’il y a d’autres articles à retourner),

maxPageSize?: number

Valeur de propriété

number

orderBy

la requête de tri pour la collection (ex : 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')

orderBy?: string[]

Valeur de propriété

string[]

skip

Skip indique le nombre d’enregistrements à ignorer dans la liste des enregistrements détenus par le serveur selon la méthode de tri spécifiée. Par défaut, nous trions en décroissant l’heure de début.

Les clients PEUVENT utiliser les paramètres de requête top et skip pour spécifier un nombre de résultats à retourner et un décalage dans la collection. Lorsque le top et le skip sont donnés par un client, le serveur DEVRAIT d’abord appliquer le skip puis le top sur la collection.

Note : Si le serveur ne peut pas respecter le top et/ou passer, il DOIT renvoyer une erreur au client pour l’informer au lieu d’ignorer simplement les options de requête.

skip?: number

Valeur de propriété

number

statuses

États à utiliser dans le filtrage

statuses?: string[]

Valeur de propriété

string[]

top

Le haut indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés sur toutes les pages.

Les clients PEUVENT utiliser les paramètres de requête top et skip pour spécifier un nombre de résultats à retourner et un décalage dans la collection. Lorsque le top et le skip sont donnés par un client, le serveur DEVRAIT d’abord appliquer le skip puis le top sur la collection.

Note : Si le serveur ne peut pas respecter le top et/ou passer, il DOIT renvoyer une erreur au client pour l’informer au lieu d’ignorer simplement les options de requête.

top?: number

Valeur de propriété

number

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

héritée de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

héritée de OperationOptions.requestOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

héritée de OperationOptions.tracingOptions