@azure-rest/ai-document-intelligence package
Rozhraní
Aliasy typu
Funkce
Podrobnosti funkce
default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)
Inicializace nové instance DocumentIntelligenceClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient
Parametry
- endpointParam
-
string
Koncový bod služby Document Intelligence
- credentials
jedinečně identifikovat přihlašovací údaje klienta
parametr pro všechny volitelné parametry
Návraty
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, GetLongRunningPollerOptions)
Pomocná funkce, která vytvoří objekt Poller, který pomáhá dotazovat dlouho běžící operaci.
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
Klient, který se má použít k odeslání požadavku, aby získal další stránky.
- initialResponse
-
AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse
Počáteční odpověď.
- options
- GetLongRunningPollerOptions
Možnosti nastavení stavu obnovení nebo vlastního intervalu dotazování
Návraty
PollerLike<OperationState<TResult>, TResult>
- Objekt poller, který se má dotazovat na aktualizace stavu operace, a nakonec získat konečnou odpověď.
getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- initialResponse
-
CopyClassifierTo202Response | CopyClassifierToDefaultResponse
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- Client
- options
- GetLongRunningPollerOptions
Návraty
PollerLike<OperationState<TResult>, TResult>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetResourceDetails200Response | GetResourceDetailsDefaultResponse)
function isUnexpected(response: GetResourceDetails200Response | GetResourceDetailsDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Parametry
Návraty
response
isUnexpected(DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse)
function isUnexpected(response: DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response
Parametry
Návraty
response
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response
Parametry
Návraty
response
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response
Parametry
Návraty
response
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response
Parametry
Návraty
response
isUnexpected(DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse): response
Parametry
Návraty
response
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response
Parametry
Návraty
response
isUnexpected(ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse)
function isUnexpected(response: ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Parametry
- response
Návraty
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Parametry
- response
Návraty
response
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response
Parametry
Návraty
response
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response
Parametry
Návraty
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Parametry
Návraty
response
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response
Parametry
Návraty
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Parametry
- response
Návraty
response
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response
Parametry
Návraty
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Parametry
Návraty
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Parametry
Návraty
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response
Parametry
Návraty
response
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response
Parametry
Návraty
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Parametry
Návraty
response
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response
Parametry
Návraty
response
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response
Parametry
Návraty
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parametry
- client
- Client
Klient, který se má použít k odesílání žádostí na další stránku
- initialResponse
-
TResponse
Počáteční odpověď obsahující nextLink a aktuální stránku prvků
- options
-
PagingOptions<TResponse>
Návraty
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator pro iteraci prvků
parseResultIdFromResponse({ headers: { operation-location: string } })
Vrátí ID operace z hlavičky initialResponse.
function parseResultIdFromResponse(initialResponse: { headers: { operation-location: string } }): string
Parametry
- initialResponse
-
{ headers: { operation-location: string } }
Návraty
string
streamToUint8Array(ReadableStream)
Převede NodeJS.ReadableStream na Uint8Array.
function streamToUint8Array(stream: ReadableStream): Promise<Uint8Array>
Parametry
- stream
-
ReadableStream
Návraty
Promise<Uint8Array>