Compartilhar via


@azure-rest/ai-document-intelligence package

Interfaces

AddressValueOutput

Valor do campo de endereço.

AnalyzeBatchDocuments
AnalyzeBatchDocuments202Headers
AnalyzeBatchDocuments202Response

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

AnalyzeBatchDocumentsBodyParam
AnalyzeBatchDocumentsDefaultResponse
AnalyzeBatchDocumentsLogicalResponse

A resposta final da operação analyzeBatchDocuments de execução prolongada

AnalyzeBatchDocumentsMediaTypesParam
AnalyzeBatchDocumentsQueryParam
AnalyzeBatchDocumentsQueryParamProperties
AnalyzeBatchDocumentsRequest

Parâmetros de análise de documentos em lote.

AnalyzeBatchOperationDetailOutput

Detalhes da operação de um documento em uma análise em lote.

AnalyzeBatchResultOperationOutput

Status e resultado da operação de análise de lote.

AnalyzeBatchResultOutput

Resultado da análise do documento em lote.

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 da operação analyzeDocumentFromStream de execução prolongada

AnalyzeDocumentFromStreamMediaTypesParam
AnalyzeDocumentFromStreamQueryParam
AnalyzeDocumentFromStreamQueryParamProperties
AnalyzeDocumentLogicalResponse

A resposta final da 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.

AuthorizeClassifierCopy
AuthorizeClassifierCopy200Response

A solicitação foi bem-sucedida.

AuthorizeClassifierCopyBodyParam
AuthorizeClassifierCopyDefaultResponse
AuthorizeClassifierCopyRequest

Solicitar corpo para autorizar a cópia do classificador de documento.

AuthorizeCopyRequest

Solicitar corpo para autorizar a cópia do modelo de documento.

AuthorizeModelCopy
AuthorizeModelCopy200Response

A solicitação foi bem-sucedida.

AuthorizeModelCopyBodyParam
AuthorizeModelCopyDefaultResponse
AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.

AzureBlobContentSourceOutput

Conteúdo do Armazenamento de Blobs do Azure.

AzureBlobFileListContentSource

Lista de arquivos no Armazenamento de Blobs do Azure.

AzureBlobFileListContentSourceOutput

Lista de arquivos no 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 da operação buildClassifier de execução prolongada

BuildDocumentClassifierRequest

Solicitar corpo para criar um novo classificador de documento personalizado.

BuildDocumentModelRequest

Solicitar corpo 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 da operação buildModel de execução prolongada

ClassifierCopyAuthorization

Autorização para copiar um classificador de documento para o recurso de destino especificado e classifierId.

ClassifierCopyAuthorizationOutput

Autorização para copiar um classificador de documento para o recurso de destino especificado e classifierId.

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 da operação classifyDocumentFromStream de execução prolongada

ClassifyDocumentFromStreamMediaTypesParam
ClassifyDocumentFromStreamQueryParam
ClassifyDocumentFromStreamQueryParamProperties
ClassifyDocumentLogicalResponse

A resposta final da operação classifyDocument de execução prolongada

ClassifyDocumentMediaTypesParam
ClassifyDocumentQueryParam
ClassifyDocumentQueryParamProperties
ClassifyDocumentRequest

Parâmetros de classificação de documento.

ComposeDocumentModelRequest

Solicitar corpo 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 da 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.

CopyClassifierTo
CopyClassifierTo202Headers
CopyClassifierTo202Response

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

CopyClassifierToBodyParam
CopyClassifierToDefaultResponse
CopyClassifierToLogicalResponse

A resposta final da operação copyClassifierTo de execução prolongada

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 da operação copyModelTo de execução prolongada

CurrencyValueOutput

Valor do campo moeda.

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 de legenda que descreve uma tabela ou figura.

DocumentClassifierBuildOperationDetailsOutput

Obter objeto de resposta da Operação.

DocumentClassifierCopyToOperationDetailsOutput

Obter objeto de resposta da Operação.

DocumentClassifierDetailsOutput

Informações do classificador de documento.

DocumentFieldOutput

Um objeto que representa o conteúdo e o local de um valor de campo.

DocumentFieldSchema

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.

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.

DocumentIntelligenceClientOptions

Os parâmetros opcionais para o cliente

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.

DocumentModelBuildOperationDetailsOutput

Obter objeto de resposta da Operação.

DocumentModelComposeOperationDetailsOutput

Obter objeto de resposta da Operação.

DocumentModelCopyToOperationDetailsOutput

Obter objeto de resposta da 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 layout e conteúdo 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 caixas de seleção, botões de opção e outros elementos que indicam uma seleção.

DocumentSpanOutput

Região contígua da propriedade de conteúdo concatenado, 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.

DocumentTypeDetails

Informações de tipo de documento.

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 sem 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.

GetAnalyzeBatchResult
GetAnalyzeBatchResult200Response

A solicitação foi bem-sucedida.

GetAnalyzeBatchResultDefaultResponse
GetAnalyzeResult
GetAnalyzeResult200Response

A solicitação foi bem-sucedida.

GetAnalyzeResultDefaultResponse
GetAnalyzeResultFigure
GetAnalyzeResultFigure200Headers
GetAnalyzeResultFigure200Response

A solicitação foi bem-sucedida.

GetAnalyzeResultFigureDefaultResponse
GetAnalyzeResultPdf
GetAnalyzeResultPdf200Headers
GetAnalyzeResultPdf200Response

A solicitação foi bem-sucedida.

GetAnalyzeResultPdfDefaultResponse
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
GetDocumentClassifierCopyToOperation200Headers
GetDocumentClassifierCopyToOperation200Response

A solicitação foi bem-sucedida.

GetDocumentClassifierCopyToOperationDefaultResponse
GetDocumentClassifierCopyToOperationHeaderParam
GetDocumentClassifierCopyToOperationHeaders
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

ResourceDetailsOutput

Informações gerais sobre o recurso atual.

Routes
SimplePollerLike

Um sondador simples que pode ser usado para sondar uma operação de longa execução.

WarningOutput

O objeto de erro.

Aliases de tipo

AnalyzeBatchDocumentsParameters
AnalyzeDocumentFromStreamParameters
AnalyzeDocumentParameters
AnalyzeOutputOption

Alias para AnalyzeOutputOption

AuthorizeClassifierCopyParameters
AuthorizeModelCopyParameters
BuildClassifierParameters
BuildModelParameters
ClassifyDocumentFromStreamParameters
ClassifyDocumentParameters
ComposeModelParameters
ContentFormat

Alias para ContentFormat

ContentFormatOutput

Alias para ContentFormatOutput

ContentSourceKind

Alias para ContentSourceKind

ContentSourceKindOutput

Alias para ContentSourceKindOutput

CopyClassifierToParameters
CopyModelToParameters
DeleteClassifierParameters
DeleteModelParameters
DocumentAnalysisFeature

Alias para DocumentAnalysisFeature

DocumentAnalysisFeatureOutput

Alias para DocumentAnalysisFeatureOutput

DocumentBarcodeKindOutput

Alias para DocumentBarcodeKindOutput

DocumentBuildMode

Alias para DocumentBuildMode

DocumentBuildModeOutput

Alias para DocumentBuildModeOutput

DocumentFieldType

Alias para DocumentFieldType

DocumentFieldTypeOutput

Alias para DocumentFieldTypeOutput

DocumentFormulaKindOutput

Alias para DocumentFormulaKindOutput

DocumentIntelligenceClient
DocumentSelectionMarkStateOutput

Alias para DocumentSelectionMarkStateOutput

DocumentSignatureTypeOutput

Alias para DocumentSignatureTypeOutput

DocumentTableCellKindOutput

Alias para DocumentTableCellKindOutput

FontStyleOutput

Alias para FontStyleOutput

FontWeightOutput

Alias para FontWeightOutput

GetAnalyzeBatchResultParameters
GetAnalyzeResultFigureParameters
GetAnalyzeResultParameters
GetAnalyzeResultPdfParameters
GetArrayType

Tipo auxiliar para extrair o tipo de uma matriz

GetClassifierParameters
GetClassifyResultParameters
GetDocumentClassifierBuildOperationParameters
GetDocumentClassifierCopyToOperationParameters
GetDocumentModelBuildOperationParameters
GetDocumentModelComposeOperationParameters
GetDocumentModelCopyToOperationParameters
GetModelParameters
GetOperationParameters
GetPage

O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver.

GetResourceInfoParameters
LengthUnitOutput

Alias para LengthUnitOutput

ListClassifiersParameters
ListModelsParameters
ListOperationsParameters
OperationDetailsOutput

Informações da operação.

OperationKindOutput

Alias para OperationKindOutput

OperationStatusOutput

Alias para OperationStatusOutput

PagedDocumentClassifierDetailsOutput

Coleção de páginas de itens DocumentClassifierDetails

PagedDocumentModelDetailsOutput

Coleção de páginas de itens DocumentModelDetails

PagedOperationDetailsOutput

Coleção de páginas de itens OperationDetails

PaginateReturn

Tipo auxiliar para inferir o tipo dos elementos de página do tipo de resposta Esse tipo é gerado com base nas informações de swagger para x-ms-pageable especificamente na propriedade itemName que indica a propriedade da resposta em que os itens de página são encontrados. O valor padrão é value. Esse tipo nos permitirá fornecer Iterador fortemente tipado com base na resposta que obtemos como segundo parâmetro

ParagraphRoleOutput

Alias para ParagraphRoleOutput

SplitMode

Alias para SplitMode

SplitModeOutput

Alias para SplitModeOutput

StringIndexType

Alias para StringIndexType

StringIndexTypeOutput

Alias para StringIndexTypeOutput

Funções

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

Inicializar uma nova instância de DocumentIntelligenceClient

getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de execução longa.

getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
isUnexpected(GetModel200Response | GetModelDefaultResponse)
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Auxiliar para paginar resultados de uma resposta inicial que segue a especificação da extensão de x-ms-pageable Autorest

Detalhes da função

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

Inicializar uma nova instância de DocumentIntelligenceClient

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient

Parâmetros

endpointParam

string

O ponto de extremidade do serviço do Document Intelligence.

credentials

TokenCredential | KeyCredential

identificar exclusivamente a credencial do cliente

options
DocumentIntelligenceClientOptions

o parâmetro para todos os parâmetros opcionais

Retornos

getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de execução longa.

function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, 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.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opções para definir um estado de retomada ou um intervalo de sondagem personalizado.

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Um objeto poller para sondar atualizações de estado de operação e, eventualmente, obter a resposta final.

getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client
options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Retornos

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)

function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)

function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)

function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetOperation200Response | GetOperationDefaultResponse)

function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)

function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)

function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)

function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)

function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)

function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)

function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)

function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)

function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(GetModel200Response | GetModelDefaultResponse)

function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)

function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)

function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)

function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)

function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)

function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(ListModels200Response | ListModelsDefaultResponse)

function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)

function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)

function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)

function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)

function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)

function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)

function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response

Parâmetros

Retornos

response

isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)

function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)

function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)

function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response

Parâ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 de x-ms-pageable Autorest

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 para iterar os elementos