@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>)
자동 등록 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>