@azure-rest/ai-document-intelligence package
インターフェイス
型エイリアス
関数
関数の詳細
default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)
DocumentIntelligenceClient
の新しいインスタンスを初期化する
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient
パラメーター
- endpointParam
-
string
ドキュメント インテリジェンス サービス エンドポイント。
- credentials
クライアント資格情報を一意に識別する
すべての省略可能なパラメーターのパラメーター
戻り値
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, GetLongRunningPollerOptions)
実行時間の長い操作のポーリングに役立つ Poller オブジェクトを構築するヘルパー関数。
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
追加のページを取得する要求の送信に使用するクライアント。
- initialResponse
-
AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse
最初の応答。
- options
- GetLongRunningPollerOptions
再開状態またはカスタム ポーリング間隔を設定するオプション。
戻り値
PollerLike<OperationState<TResult>, TResult>
- 操作状態の更新をポーリングし、最終的に最終的な応答を取得するポーリング オブジェクト。
getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- initialResponse
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- initialResponse
-
CopyClassifierTo202Response | CopyClassifierToDefaultResponse
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- Client
- options
- GetLongRunningPollerOptions
戻り値
PollerLike<OperationState<TResult>, TResult>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetResourceDetails200Response | GetResourceDetailsDefaultResponse)
function isUnexpected(response: GetResourceDetails200Response | GetResourceDetailsDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse)
function isUnexpected(response: DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse)
function isUnexpected(response: ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
パラメーター
- response
戻り値
response
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response
パラメーター
戻り値
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response
パラメーター
戻り値
response
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response
パラメーター
戻り値
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Autorest x-ms-pageable
拡張機能の仕様に従った最初の応答からの結果を改ページするヘルパー
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
パラメーター
- client
- Client
次のページ要求の送信に使用するクライアント
- initialResponse
-
TResponse
nextLink と要素の現在のページを含む初期応答
- options
-
PagingOptions<TResponse>
戻り値
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator を使用して要素を反復処理する
parseResultIdFromResponse({ headers: { operation-location: string } })
initialResponse ヘッダーから operation-id を返します。
function parseResultIdFromResponse(initialResponse: { headers: { operation-location: string } }): string
パラメーター
- initialResponse
-
{ headers: { operation-location: string } }
戻り値
string
streamToUint8Array(ReadableStream)
NodeJS.ReadableStream を Uint8Array に変換します。
function streamToUint8Array(stream: ReadableStream): Promise<Uint8Array>
パラメーター
- stream
-
ReadableStream
戻り値
Promise<Uint8Array>