@azure-rest/ai-document-intelligence package
Interfaces
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 paginada de itens DocumentClassifierDetails |
| PagedDocumentModelDetailsOutput |
Coleção paginada de itens DocumentModelDetails |
| PagedOperationDetailsOutput |
Coleção paginada de itens OperationDetails |
| PaginateReturn |
Tipo auxiliar para inferir o Tipo dos elementos paginados do tipo de resposta Esse tipo é gerado com base nas informações do swagger para x-ms-pageable, especificamente na propriedade itemName, que indica a propriedade da resposta onde os itens de página são encontrados. O valor padrão é |
| ParagraphRoleOutput |
Alias para ParagraphRoleOutput |
| SplitMode |
Alias para SplitMode |
| SplitModeOutput |
Alias para SplitModeOutput |
| StringIndexType |
Alias para StringIndexType |
| StringIndexTypeOutput |
Alias para StringIndexTypeOutput |
Funções
Detalhes de Função
default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)
Inicializar uma nova instância do DocumentIntelligenceClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient
Parâmetros
- endpointParam
-
string
O ponto de extremidade do serviço de Inteligência de Documentos.
- credentials
identificar exclusivamente a credencial do cliente
o parâmetro para todos os parâmetros opcionais
Devoluções
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 longa duração.
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parâmetros
- client
- Client
Cliente a utilizar para enviar o pedido para obter páginas adicionais.
- initialResponse
-
AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse
A resposta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opções para definir um estado de retomada ou intervalo de sondagem personalizado.
Devoluções
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Um poller se opõe a pesquisar atualizações de estado da 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
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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
- initialResponse
-
CopyClassifierTo202Response | CopyClassifierToDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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
- initialResponse
-
AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluções
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>>
Devoluções
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Parâmetros
- response
Devoluções
response
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response
Parâmetros
Devoluções
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
O auxiliar para paginar resulta 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 utilizar para enviar os pedidos da página seguinte
- initialResponse
-
TResponse
Resposta inicial contendo o nextLink e a página atual de elementos
- options
-
PagingOptions<TResponse>
Devoluções
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar os elementos