@azure-rest/ai-document-intelligence package
Interfaces
| AddressValueOutput |
Valor do campo de endereço. |
| AnalyzeDocument202Headers | |
| AnalyzeDocument202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| AnalyzeDocumentBodyParam | |
| AnalyzeDocumentDefaultResponse | |
| AnalyzeDocumentFromStream | |
| AnalyzeDocumentFromStream202Headers | |
| AnalyzeDocumentFromStream202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| AnalyzeDocumentFromStreamBodyParam | |
| AnalyzeDocumentFromStreamDefaultResponse | |
| AnalyzeDocumentFromStreamLogicalResponse |
A resposta final para a operação analyzeDocumentFromStream de execução prolongada |
| AnalyzeDocumentFromStreamMediaTypesParam | |
| AnalyzeDocumentFromStreamQueryParam | |
| AnalyzeDocumentFromStreamQueryParamProperties | |
| AnalyzeDocumentLogicalResponse |
A resposta final para a operação analyzeDocument de execução prolongada |
| AnalyzeDocumentMediaTypesParam | |
| AnalyzeDocumentQueryParam | |
| AnalyzeDocumentQueryParamProperties | |
| AnalyzeDocumentRequest |
Parâmetros de análise de documento. |
| AnalyzeResultOperationOutput |
Status e resultado da operação de análise. |
| AnalyzeResultOutput |
Resultado da análise do documento. |
| AuthorizeCopyRequest |
Corpo da solicitação para autorizar a cópia do modelo de documento. |
| AuthorizeModelCopy | |
| AuthorizeModelCopy200Response |
A solicitação foi bem-sucedida. |
| AuthorizeModelCopyBodyParam | |
| AuthorizeModelCopyDefaultResponse | |
| AzureBlobContentSource |
Armazenamento de Blobs do Azure conteúdo. |
| AzureBlobContentSourceOutput |
Armazenamento de Blobs do Azure conteúdo. |
| AzureBlobFileListContentSource |
Lista de arquivos em Armazenamento de Blobs do Azure. |
| AzureBlobFileListContentSourceOutput |
Lista de arquivos em Armazenamento de Blobs do Azure. |
| BoundingRegionOutput |
Delimitando o polígono em uma página específica da entrada. |
| BuildClassifier | |
| BuildClassifier202Headers | |
| BuildClassifier202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| BuildClassifierBodyParam | |
| BuildClassifierDefaultResponse | |
| BuildClassifierLogicalResponse |
A resposta final para a operação buildClassifier de execução prolongada |
| BuildDocumentClassifierRequest |
Corpo da solicitação para criar um novo classificador de documento personalizado. |
| BuildDocumentModelRequest |
Corpo da solicitação para criar um novo modelo de documento personalizado. |
| BuildModel | |
| BuildModel202Headers | |
| BuildModel202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| BuildModelBodyParam | |
| BuildModelDefaultResponse | |
| BuildModelLogicalResponse |
A resposta final para a operação buildModel de execução prolongada |
| ClassifierDocumentTypeDetails |
Informações de tipo de documento do classificador. |
| ClassifierDocumentTypeDetailsOutput |
Informações de tipo de documento do classificador. |
| ClassifyDocument202Headers | |
| ClassifyDocument202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| ClassifyDocumentBodyParam | |
| ClassifyDocumentDefaultResponse | |
| ClassifyDocumentFromStream | |
| ClassifyDocumentFromStream202Headers | |
| ClassifyDocumentFromStream202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| ClassifyDocumentFromStreamBodyParam | |
| ClassifyDocumentFromStreamDefaultResponse | |
| ClassifyDocumentFromStreamLogicalResponse |
A resposta final para a operação classifyDocumentFromStream de execução prolongada |
| ClassifyDocumentFromStreamMediaTypesParam | |
| ClassifyDocumentFromStreamQueryParam | |
| ClassifyDocumentFromStreamQueryParamProperties | |
| ClassifyDocumentLogicalResponse |
A resposta final para a operação classifyDocument de execução prolongada |
| ClassifyDocumentMediaTypesParam | |
| ClassifyDocumentQueryParam | |
| ClassifyDocumentQueryParamProperties | |
| ClassifyDocumentRequest |
Parâmetros de classificação de documentos. |
| ClientRequestIdHeaderOutput |
Fornece o cabeçalho 'x-ms-client-request-id' para habilitar a correlação de solicitação em solicitações e respostas. |
| ComponentDocumentModelDetails |
Um componente de um modelo de documento composto. |
| ComposeDocumentModelRequest |
Corpo da solicitação para criar um modelo de documento composto a partir de modelos de documento de componente. |
| ComposeModel | |
| ComposeModel202Headers | |
| ComposeModel202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| ComposeModelBodyParam | |
| ComposeModelDefaultResponse | |
| ComposeModelLogicalResponse |
A resposta final para a operação composeModel de execução prolongada |
| CopyAuthorization |
Autorização para copiar um modelo de documento para o recurso de destino e modelId especificados. |
| CopyAuthorizationOutput |
Autorização para copiar um modelo de documento para o recurso de destino e modelId especificados. |
| CopyModelTo | |
| CopyModelTo202Headers | |
| CopyModelTo202Response |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. |
| CopyModelToBodyParam | |
| CopyModelToDefaultResponse | |
| CopyModelToLogicalResponse |
A resposta final para a operação copyModelTo de execução prolongada |
| CurrencyValueOutput |
Conversor de Moedas valor do campo. |
| CustomDocumentModelsDetailsOutput |
Detalhes sobre modelos de documentos personalizados. |
| DeleteClassifier204Headers | |
| DeleteClassifier204Response |
Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis. |
| DeleteClassifierDefaultResponse | |
| DeleteClassifierHeaderParam | |
| DeleteClassifierHeaders | |
| DeleteModel204Headers | |
| DeleteModel204Response |
Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis. |
| DeleteModelDefaultResponse | |
| DeleteModelHeaderParam | |
| DeleteModelHeaders | |
| DocumentBarcodeOutput |
Um objeto de código de barras. |
| DocumentCaptionOutput |
Um objeto legenda que descreve uma tabela ou figura. |
| DocumentClassifierBuildOperationDetailsOutput |
Obter objeto de resposta operação. |
| DocumentClassifierDetailsOutput |
Informações do classificador do documento. |
| DocumentFieldOutput |
Um objeto que representa o conteúdo e o local de um valor de campo. |
| DocumentFieldSchemaOutput |
Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON. |
| DocumentFigureOutput |
Um objeto que representa uma figura no documento. |
| DocumentFootnoteOutput |
Um objeto de nota de rodapé que descreve uma tabela ou figura. |
| DocumentFormulaOutput |
Um objeto de fórmula. |
| DocumentKeyValueElementOutput |
Um objeto que representa a chave de campo ou o valor em um par chave-valor. |
| DocumentKeyValuePairOutput |
Um objeto que representa um campo de formulário com rótulo de campo distinto (chave) e valor de campo (pode estar vazio). |
| DocumentLanguageOutput |
Um objeto que representa o idioma detectado para um determinado intervalo de texto. |
| DocumentLineOutput |
Um objeto de linha de conteúdo que consiste em uma sequência adjacente de elementos de conteúdo, como palavras e marcas de seleção. |
| DocumentListItemOutput |
Um objeto que representa um item de lista no documento. |
| DocumentListOutput |
Um objeto que representa uma lista no documento. |
| DocumentModelBuildOperationDetailsOutput |
Obter objeto de resposta operação. |
| DocumentModelComposeOperationDetailsOutput |
Obter objeto de resposta operação. |
| DocumentModelCopyToOperationDetailsOutput |
Obter objeto de resposta operação. |
| DocumentModelDetailsOutput |
Informações do modelo de documento. |
| DocumentOutput |
Um objeto que descreve o local e o conteúdo semântico de um documento. |
| DocumentPageOutput |
Elementos de conteúdo e layout extraídos de uma página da entrada. |
| DocumentParagraphOutput |
Um objeto de parágrafo que consiste em linhas contíguas geralmente com alinhamento e espaçamento comuns. |
| DocumentSectionOutput |
Um objeto que representa uma seção no documento. |
| DocumentSelectionMarkOutput |
Um objeto de marca de seleção que representa marcar caixas, botões de opção e outros elementos que indicam uma seleção. |
| DocumentSpanOutput |
Região contígua da propriedade de conteúdo concatenada, especificada como um deslocamento e comprimento. |
| DocumentStyleOutput |
Um objeto que representa os estilos de texto observados. |
| DocumentTableCellOutput |
Um objeto que representa o local e o conteúdo de uma célula de tabela. |
| DocumentTableOutput |
Um objeto de tabela que consiste em células de tabela organizadas em um layout retangular. |
| DocumentTypeDetailsOutput |
Informações de tipo de documento. |
| DocumentWordOutput |
Um objeto de palavra que consiste em uma sequência contígua de caracteres. Para idiomas delimitados por espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra. |
| ErrorModelOutput |
O objeto de erro. |
| ErrorResponseOutput |
Objeto de resposta de erro. |
| GetAnalyzeResult | |
| GetAnalyzeResult200Response |
A solicitação foi bem-sucedida. |
| GetAnalyzeResultDefaultResponse | |
| GetClassifier | |
| GetClassifier200Headers | |
| GetClassifier200Response |
A solicitação foi bem-sucedida. |
| GetClassifierDefaultResponse | |
| GetClassifierHeaderParam | |
| GetClassifierHeaders | |
| GetClassifyResult | |
| GetClassifyResult200Response |
A solicitação foi bem-sucedida. |
| GetClassifyResultDefaultResponse | |
| GetDocumentClassifierBuildOperation200Headers | |
| GetDocumentClassifierBuildOperation200Response |
A solicitação foi bem-sucedida. |
| GetDocumentClassifierBuildOperationDefaultResponse | |
| GetDocumentClassifierBuildOperationHeaderParam | |
| GetDocumentClassifierBuildOperationHeaders | |
| GetDocumentModelBuildOperation | |
| GetDocumentModelBuildOperation200Headers | |
| GetDocumentModelBuildOperation200Response |
A solicitação foi bem-sucedida. |
| GetDocumentModelBuildOperationDefaultResponse | |
| GetDocumentModelBuildOperationHeaderParam | |
| GetDocumentModelBuildOperationHeaders | |
| GetDocumentModelComposeOperation200Headers | |
| GetDocumentModelComposeOperation200Response |
A solicitação foi bem-sucedida. |
| GetDocumentModelComposeOperationDefaultResponse | |
| GetDocumentModelComposeOperationHeaderParam | |
| GetDocumentModelComposeOperationHeaders | |
| GetDocumentModelCopyToOperation200Headers | |
| GetDocumentModelCopyToOperation200Response |
A solicitação foi bem-sucedida. |
| GetDocumentModelCopyToOperationDefaultResponse | |
| GetDocumentModelCopyToOperationHeaderParam | |
| GetDocumentModelCopyToOperationHeaders | |
| GetModel | |
| GetModel200Headers | |
| GetModel200Response |
A solicitação foi bem-sucedida. |
| GetModelDefaultResponse | |
| GetModelHeaderParam | |
| GetModelHeaders | |
| GetOperation200Headers | |
| GetOperation200Response |
A solicitação foi bem-sucedida. |
| GetOperationDefaultResponse | |
| GetOperationHeaderParam | |
| GetOperationHeaders | |
| GetResourceInfo | |
| GetResourceInfo200Response |
A solicitação foi bem-sucedida. |
| GetResourceInfoDefaultResponse | |
| InnerErrorOutput |
Um objeto que contém informações mais específicas sobre o erro. |
| ListClassifiers | |
| ListClassifiers200Headers | |
| ListClassifiers200Response |
A solicitação foi bem-sucedida. |
| ListClassifiersDefaultResponse | |
| ListClassifiersHeaderParam | |
| ListClassifiersHeaders | |
| ListModels | |
| ListModels200Headers | |
| ListModels200Response |
A solicitação foi bem-sucedida. |
| ListModelsDefaultResponse | |
| ListModelsHeaderParam | |
| ListModelsHeaders | |
| ListOperations | |
| ListOperations200Headers | |
| ListOperations200Response |
A solicitação foi bem-sucedida. |
| ListOperationsDefaultResponse | |
| ListOperationsHeaderParam | |
| ListOperationsHeaders | |
| OperationDetailsOutputParent |
Informações da operação. |
| PagingOptions |
Opções para o auxiliar de paginação |
| QuotaDetailsOutput |
Cota usada, limite e próxima data/hora de redefinição. |
| ResourceDetailsOutput |
Informações gerais sobre o recurso atual. |
| Routes | |
| WarningOutput |
O objeto de erro. |
Aliases de tipo
Funções
Detalhes da função
default(string, TokenCredential | KeyCredential, ClientOptions)
Inicializar uma nova instância do DocumentIntelligenceClient
function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentIntelligenceClientParâmetros
- endpoint
-
string
O ponto de extremidade do serviço do Document Intelligence.
- credentials
identificar exclusivamente a credencial do cliente
- options
- ClientOptions
o parâmetro para todos os parâmetros opcionais
Retornos
getLongRunningPoller<TResult>(Client, BuildModelDefaultResponse | BuildModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de execução prolongada.
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModelDefaultResponse | BuildModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parâmetros
- client
- Client
Cliente a ser usado para enviar a solicitação para obter páginas adicionais.
- initialResponse
A resposta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opções para definir um estado de retomada ou intervalo de sondagem personalizado.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
- Um objeto poller para sondar atualizações de estado da operação e, eventualmente, obter a resposta final.
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>>Parâmetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retornos
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>>Parâmetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retornos
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>>Parâmetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retornos
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>>Parâmetros
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retornos
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>>Parâmetros
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse): responseParâmetros
Retornos
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): responseParâmetros
- response
Retornos
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): responseParâmetros
- response
Retornos
response
isUnexpected(BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response)
function isUnexpected(response: BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response): responseParâmetros
Retornos
response
isUnexpected(ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response)
function isUnexpected(response: ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response): responseParâmetros
Retornos
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response)
function isUnexpected(response: CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response): responseParâmetros
Retornos
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): responseParâmetros
- response
Retornos
response
isUnexpected(BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response)
function isUnexpected(response: BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response): responseParâmetros
Retornos
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse): responseParâmetros
Retornos
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): responseParâmetros
Retornos
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Auxiliar para paginar resultados de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>Parâmetros
- client
- Client
Cliente a ser usado para enviar as solicitações da próxima página
- initialResponse
-
TResponse
Resposta inicial que contém o nextLink e a página atual dos elementos
- options
-
PagingOptions<TResponse>
Retornos
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar os elementos
Azure SDK for JavaScript