@azure-rest/ai-document-intelligence package
Interfaces
AddressValueOutput |
Valeur du champ d’adresse. |
AnalyzeDocument202Headers | |
AnalyzeDocument202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
AnalyzeDocumentBodyParam | |
AnalyzeDocumentDefaultResponse | |
AnalyzeDocumentFromStream | |
AnalyzeDocumentFromStream202Headers | |
AnalyzeDocumentFromStream202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
AnalyzeDocumentFromStreamBodyParam | |
AnalyzeDocumentFromStreamDefaultResponse | |
AnalyzeDocumentFromStreamLogicalResponse |
Réponse finale pour l’opération analyzeDocumentFromStream de longue durée |
AnalyzeDocumentFromStreamMediaTypesParam | |
AnalyzeDocumentFromStreamQueryParam | |
AnalyzeDocumentFromStreamQueryParamProperties | |
AnalyzeDocumentLogicalResponse |
Réponse finale pour l’opération analyzeDocument de longue durée |
AnalyzeDocumentMediaTypesParam | |
AnalyzeDocumentQueryParam | |
AnalyzeDocumentQueryParamProperties | |
AnalyzeDocumentRequest |
Paramètres d’analyse de document. |
AnalyzeResultOperationOutput |
État et résultat de l’opération d’analyse. |
AnalyzeResultOutput |
Résultat de l’analyse du document. |
AuthorizeCopyRequest |
Corps de la demande pour autoriser la copie du modèle de document. |
AuthorizeModelCopy | |
AuthorizeModelCopy200Response |
La demande a réussi. |
AuthorizeModelCopyBodyParam | |
AuthorizeModelCopyDefaultResponse | |
AzureBlobContentSource |
Stockage Blob Azure contenu. |
AzureBlobContentSourceOutput |
Stockage Blob Azure contenu. |
AzureBlobFileListContentSource |
Liste de fichiers dans Stockage Blob Azure. |
AzureBlobFileListContentSourceOutput |
Liste de fichiers dans Stockage Blob Azure. |
BoundingRegionOutput |
Polygone englobant sur une page spécifique de l’entrée. |
BuildClassifier | |
BuildClassifier202Headers | |
BuildClassifier202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
BuildClassifierBodyParam | |
BuildClassifierDefaultResponse | |
BuildClassifierLogicalResponse |
Réponse finale pour l’opération buildClassifier de longue durée |
BuildDocumentClassifierRequest |
Corps de la demande pour créer un nouveau classifieur de documents personnalisé. |
BuildDocumentModelRequest |
Corps de la demande pour générer un nouveau modèle de document personnalisé. |
BuildModel | |
BuildModel202Headers | |
BuildModel202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
BuildModelBodyParam | |
BuildModelDefaultResponse | |
BuildModelLogicalResponse |
Réponse finale pour l’opération buildModel de longue durée |
ClassifierDocumentTypeDetails |
Informations sur le type de document classifieur. |
ClassifierDocumentTypeDetailsOutput |
Informations sur le type de document classifieur. |
ClassifyDocument202Headers | |
ClassifyDocument202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
ClassifyDocumentBodyParam | |
ClassifyDocumentDefaultResponse | |
ClassifyDocumentFromStream | |
ClassifyDocumentFromStream202Headers | |
ClassifyDocumentFromStream202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
ClassifyDocumentFromStreamBodyParam | |
ClassifyDocumentFromStreamDefaultResponse | |
ClassifyDocumentFromStreamLogicalResponse |
Réponse finale pour l’opération classdocumentFromStream de longue durée |
ClassifyDocumentFromStreamMediaTypesParam | |
ClassifyDocumentFromStreamQueryParam | |
ClassifyDocumentFromStreamQueryParamProperties | |
ClassifyDocumentLogicalResponse |
Réponse finale pour l’opération classDocument de longue durée |
ClassifyDocumentMediaTypesParam | |
ClassifyDocumentQueryParam | |
ClassifyDocumentQueryParamProperties | |
ClassifyDocumentRequest |
Paramètres de classification de document. |
ClientRequestIdHeaderOutput |
Fournit l’en-tête « x-ms-client-request-id » pour activer la corrélation des requêtes dans les requêtes et les réponses. |
ComponentDocumentModelDetails |
Composant d’un modèle de document composé. |
ComposeDocumentModelRequest |
Corps de la demande pour créer un modèle de document composé à partir de modèles de document de composant. |
ComposeModel | |
ComposeModel202Headers | |
ComposeModel202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
ComposeModelBodyParam | |
ComposeModelDefaultResponse | |
ComposeModelLogicalResponse |
Réponse finale pour l’opération composeModel de longue durée |
CopyAuthorization |
Autorisation de copier un modèle de document vers la ressource cible et modelId spécifiées. |
CopyAuthorizationOutput |
Autorisation de copier un modèle de document vers la ressource cible et modelId spécifiées. |
CopyModelTo | |
CopyModelTo202Headers | |
CopyModelTo202Response |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. |
CopyModelToBodyParam | |
CopyModelToDefaultResponse | |
CopyModelToLogicalResponse |
Réponse finale pour l’opération copyModelTo de longue durée |
CurrencyValueOutput |
Valeur du champ monétaire. |
CustomDocumentModelsDetailsOutput |
Détails sur les modèles de documents personnalisés. |
DeleteClassifier204Headers | |
DeleteClassifier204Response |
Il n’y a pas de contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles. |
DeleteClassifierDefaultResponse | |
DeleteClassifierHeaderParam | |
DeleteClassifierHeaders | |
DeleteModel204Headers | |
DeleteModel204Response |
Il n’y a pas de contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles. |
DeleteModelDefaultResponse | |
DeleteModelHeaderParam | |
DeleteModelHeaders | |
DocumentBarcodeOutput |
Objet de code-barres. |
DocumentCaptionOutput |
Objet légende décrivant une table ou une figure. |
DocumentClassifierBuildOperationDetailsOutput |
Obtient l’objet de réponse Operation. |
DocumentClassifierDetailsOutput |
Informations de classifieur de document. |
DocumentFieldOutput |
Objet représentant le contenu et l’emplacement d’une valeur de champ. |
DocumentFieldSchemaOutput |
Description du schéma sémantique de champ à l’aide d’une syntaxe de style schéma JSON. |
DocumentFigureOutput |
Objet représentant une figure dans le document. |
DocumentFootnoteOutput |
Objet de note de bas de page décrivant une table ou une figure. |
DocumentFormulaOutput |
Objet de formule. |
DocumentKeyValueElementOutput |
Objet représentant la clé de champ ou la valeur d’une paire clé-valeur. |
DocumentKeyValuePairOutput |
Objet représentant un champ de formulaire avec une étiquette de champ distincte (clé) et une valeur de champ (peut être vide). |
DocumentLanguageOutput |
Objet représentant la langue détectée pour une étendue de texte donnée. |
DocumentLineOutput |
Objet de ligne de contenu constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection. |
DocumentListItemOutput |
Objet représentant un élément de liste dans le document. |
DocumentListOutput |
Objet représentant une liste dans le document. |
DocumentModelBuildOperationDetailsOutput |
Obtient l’objet de réponse Operation. |
DocumentModelComposeOperationDetailsOutput |
Obtient l’objet de réponse Operation. |
DocumentModelCopyToOperationDetailsOutput |
Obtient l’objet de réponse Operation. |
DocumentModelDetailsOutput |
Informations sur le modèle de document. |
DocumentOutput |
Objet décrivant l’emplacement et le contenu sémantique d’un document. |
DocumentPageOutput |
Éléments de contenu et de disposition extraits d’une page de l’entrée. |
DocumentParagraphOutput |
Objet de paragraphe composé de lignes contiguës avec généralement un alignement et un espacement communs. |
DocumentSectionOutput |
Objet représentant une section dans le document. |
DocumentSelectionMarkOutput |
Objet de marque de sélection représentant case activée zones, cases d’option et autres éléments indiquant une sélection. |
DocumentSpanOutput |
Région contiguë de la propriété de contenu concaténé, spécifiée sous forme de décalage et de longueur. |
DocumentStyleOutput |
Objet représentant les styles de texte observés. |
DocumentTableCellOutput |
Objet représentant l’emplacement et le contenu d’une cellule de table. |
DocumentTableOutput |
Objet table constitué de cellules de tableau organisées dans une disposition rectangulaire. |
DocumentTypeDetailsOutput |
Informations sur le type de document. |
DocumentWordOutput |
Objet word constitué d’une séquence contiguë de caractères. Pour les langues non délimitées par l’espace, telles que le chinois, le japonais et le coréen, chaque caractère est représenté comme son propre mot. |
ErrorModelOutput |
Objet d’erreur. |
ErrorResponseOutput |
Objet de réponse d’erreur. |
GetAnalyzeResult | |
GetAnalyzeResult200Response |
La demande a réussi. |
GetAnalyzeResultDefaultResponse | |
GetClassifier | |
GetClassifier200Headers | |
GetClassifier200Response |
La demande a réussi. |
GetClassifierDefaultResponse | |
GetClassifierHeaderParam | |
GetClassifierHeaders | |
GetClassifyResult | |
GetClassifyResult200Response |
La demande a réussi. |
GetClassifyResultDefaultResponse | |
GetDocumentClassifierBuildOperation200Headers | |
GetDocumentClassifierBuildOperation200Response |
La demande a réussi. |
GetDocumentClassifierBuildOperationDefaultResponse | |
GetDocumentClassifierBuildOperationHeaderParam | |
GetDocumentClassifierBuildOperationHeaders | |
GetDocumentModelBuildOperation | |
GetDocumentModelBuildOperation200Headers | |
GetDocumentModelBuildOperation200Response |
La demande a réussi. |
GetDocumentModelBuildOperationDefaultResponse | |
GetDocumentModelBuildOperationHeaderParam | |
GetDocumentModelBuildOperationHeaders | |
GetDocumentModelComposeOperation200Headers | |
GetDocumentModelComposeOperation200Response |
La demande a réussi. |
GetDocumentModelComposeOperationDefaultResponse | |
GetDocumentModelComposeOperationHeaderParam | |
GetDocumentModelComposeOperationHeaders | |
GetDocumentModelCopyToOperation200Headers | |
GetDocumentModelCopyToOperation200Response |
La demande a réussi. |
GetDocumentModelCopyToOperationDefaultResponse | |
GetDocumentModelCopyToOperationHeaderParam | |
GetDocumentModelCopyToOperationHeaders | |
GetModel | |
GetModel200Headers | |
GetModel200Response |
La demande a réussi. |
GetModelDefaultResponse | |
GetModelHeaderParam | |
GetModelHeaders | |
GetOperation200Headers | |
GetOperation200Response |
La demande a réussi. |
GetOperationDefaultResponse | |
GetOperationHeaderParam | |
GetOperationHeaders | |
GetResourceInfo | |
GetResourceInfo200Response |
La demande a réussi. |
GetResourceInfoDefaultResponse | |
InnerErrorOutput |
Objet contenant des informations plus spécifiques sur l’erreur. |
ListClassifiers | |
ListClassifiers200Headers | |
ListClassifiers200Response |
La demande a réussi. |
ListClassifiersDefaultResponse | |
ListClassifiersHeaderParam | |
ListClassifiersHeaders | |
ListModels | |
ListModels200Headers | |
ListModels200Response |
La demande a réussi. |
ListModelsDefaultResponse | |
ListModelsHeaderParam | |
ListModelsHeaders | |
ListOperations | |
ListOperations200Headers | |
ListOperations200Response |
La demande a réussi. |
ListOperationsDefaultResponse | |
ListOperationsHeaderParam | |
ListOperationsHeaders | |
OperationDetailsOutputParent |
Informations sur l’opération. |
PagingOptions |
Options pour l’assistance de pagination |
QuotaDetailsOutput |
Date/heure de réinitialisation du quota utilisé, limite et prochaine réinitialisation. |
ResourceDetailsOutput |
Informations générales sur la ressource actuelle. |
Routes | |
WarningOutput |
Objet d’erreur. |
Alias de type
Functions
Informations relatives à la fonction
default(string, TokenCredential | KeyCredential, ClientOptions)
Initialiser un nouveau instance deDocumentIntelligenceClient
function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentIntelligenceClient
Paramètres
- endpoint
-
string
Point de terminaison du service Document Intelligence.
- credentials
identifier de manière unique les informations d’identification du client
- options
- ClientOptions
paramètre pour tous les paramètres facultatifs
Retours
getLongRunningPoller<TResult>(Client, BuildModelDefaultResponse | BuildModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Fonction d’assistance qui génère un objet Poller pour aider à interroger une opération de longue durée.
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModelDefaultResponse | BuildModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Paramètres
- client
- Client
Client à utiliser pour envoyer la demande d’obtention de pages supplémentaires.
- initialResponse
Réponse initiale.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Options permettant de définir un état de reprise d’activité ou un intervalle d’interrogation personnalisé.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
- Objet polleur pour interroger les mises à jour de l’état de l’opération et obtenir la réponse finale.
getLongRunningPoller<TResult>(Client, ComposeModelDefaultResponse | ComposeModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModelDefaultResponse | ComposeModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Paramètres
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, CopyModelToDefaultResponse | CopyModelTo202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelToDefaultResponse | CopyModelTo202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Paramètres
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, BuildClassifierDefaultResponse | BuildClassifier202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifierDefaultResponse | BuildClassifier202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Paramètres
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Paramètres
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Paramètres
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Paramètres
Retours
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Paramètres
Retours
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response
Paramètres
Retours
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Paramètres
Retours
response
isUnexpected(AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse): response
Paramètres
Retours
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Paramètres
- response
Retours
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Paramètres
- response
Retours
response
isUnexpected(BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response)
function isUnexpected(response: BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response): response
Paramètres
Retours
response
isUnexpected(ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response)
function isUnexpected(response: ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response): response
Paramètres
Retours
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Paramètres
Retours
response
isUnexpected(CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response)
function isUnexpected(response: CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response): response
Paramètres
Retours
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Paramètres
- response
Retours
response
isUnexpected(BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response)
function isUnexpected(response: BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response): response
Paramètres
Retours
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Paramètres
Retours
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Paramètres
Retours
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Paramètres
Retours
response
isUnexpected(ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse): response
Paramètres
Retours
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Paramètres
Retours
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper pour paginer les résultats d’une réponse initiale qui suit la spécification de l’extension Autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Paramètres
- client
- Client
Client à utiliser pour envoyer les demandes de page suivantes
- initialResponse
-
TResponse
Réponse initiale contenant les éléments nextLink et active
- options
-
PagingOptions<TResponse>
Retours
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator pour itérer les éléments
Azure SDK for JavaScript