@azure-rest/ai-document-intelligence package
Antarmuka
Alias Jenis
| AnalyzeBatchDocumentsParameters | |
| AnalyzeDocumentFromStreamParameters | |
| AnalyzeDocumentParameters | |
| AnalyzeOutputOption |
Alias untuk AnalyzeOutputOption |
| AuthorizeClassifierCopyParameters | |
| AuthorizeModelCopyParameters | |
| BuildClassifierParameters | |
| BuildModelParameters | |
| ClassifyDocumentFromStreamParameters | |
| ClassifyDocumentParameters | |
| ComposeModelParameters | |
| ContentFormat |
Alias untuk ContentFormat |
| ContentFormatOutput |
Alias untuk ContentFormatOutput |
| ContentSourceKind |
Alias untuk ContentSourceKind |
| ContentSourceKindOutput |
Alias untuk ContentSourceKindOutput |
| CopyClassifierToParameters | |
| CopyModelToParameters | |
| DeleteClassifierParameters | |
| DeleteModelParameters | |
| DocumentAnalysisFeature |
Alias untuk DocumentAnalysisFeature |
| DocumentAnalysisFeatureOutput |
Alias untuk DocumentAnalysisFeatureOutput |
| DocumentBarcodeKindOutput |
Alias untuk DocumentBarcodeKindOutput |
| DocumentBuildMode |
Alias untuk DocumentBuildMode |
| DocumentBuildModeOutput |
Alias untuk DocumentBuildModeOutput |
| DocumentFieldType |
Alias untuk DocumentFieldType |
| DocumentFieldTypeOutput |
Alias untuk DocumentFieldTypeOutput |
| DocumentFormulaKindOutput |
Alias untuk DocumentFormulaKindOutput |
| DocumentIntelligenceClient | |
| DocumentSelectionMarkStateOutput |
Alias untuk DocumentSelectionMarkStateOutput |
| DocumentSignatureTypeOutput |
Alias untuk DocumentSignatureTypeOutput |
| DocumentTableCellKindOutput |
Alias untuk DocumentTableCellKindOutput |
| FontStyleOutput |
Alias untuk FontStyleOutput |
| FontWeightOutput |
Alias untuk FontWeightOutput |
| GetAnalyzeBatchResultParameters | |
| GetAnalyzeResultFigureParameters | |
| GetAnalyzeResultParameters | |
| GetAnalyzeResultPdfParameters | |
| GetArrayType |
Jenis pembantu untuk mengekstrak jenis array |
| GetClassifierParameters | |
| GetClassifyResultParameters | |
| GetDocumentClassifierBuildOperationParameters | |
| GetDocumentClassifierCopyToOperationParameters | |
| GetDocumentModelBuildOperationParameters | |
| GetDocumentModelComposeOperationParameters | |
| GetDocumentModelCopyToOperationParameters | |
| GetModelParameters | |
| GetOperationParameters | |
| GetPage |
Jenis fungsi kustom yang menentukan cara mendapatkan halaman dan tautan ke yang berikutnya jika ada. |
| GetResourceInfoParameters | |
| LengthUnitOutput |
Alias untuk LengthUnitOutput |
| ListClassifiersParameters | |
| ListModelsParameters | |
| ListOperationsParameters | |
| OperationDetailsOutput |
Info operasi. |
| OperationKindOutput |
Alias untuk OperationKindOutput |
| OperationStatusOutput |
Alias untuk OperationStatusOutput |
| PagedDocumentClassifierDetailsOutput |
Kumpulan halaman item DocumentClassifierDetails |
| PagedDocumentModelDetailsOutput |
Kumpulan halaman item DocumentModelDetails |
| PagedOperationDetailsOutput |
Kumpulan halaman item OperationDetails |
| PaginateReturn |
Jenis pembantu untuk menyimpulkan Jenis elemen halaman dari jenis respons Jenis ini dihasilkan berdasarkan informasi swagger untuk x-ms-pageable khususnya pada properti itemName yang menunjukkan properti respons tempat item halaman ditemukan. Nilai defaultnya adalah |
| ParagraphRoleOutput |
Alias untuk ParagraphRoleOutput |
| SplitMode |
Alias untuk SplitMode |
| SplitModeOutput |
Alias untuk SplitModeOutput |
| StringIndexType |
Alias untuk StringIndexType |
| StringIndexTypeOutput |
Alias untuk StringIndexTypeOutput |
Fungsi
Detail Fungsi
default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)
Menginisialisasi instans baru DocumentIntelligenceClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient
Parameter
- endpointParam
-
string
Titik akhir layanan Kecerdasan Dokumen.
- credentials
mengidentifikasi kredensial klien secara unik
parameter untuk semua parameter opsional
Mengembalikan
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Fungsi pembantu yang membangun objek Poller untuk membantu polling operasi yang berjalan lama.
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameter
- client
- Client
Klien yang digunakan untuk mengirim permintaan untuk mendapatkan halaman tambahan.
- initialResponse
-
AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse
Respons awal.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opsi untuk mengatur status resume atau interval polling kustom.
Mengembalikan
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Objek poller untuk polling pembaruan status operasi dan akhirnya mendapatkan respons akhir.
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>>
Parameter
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
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>>
Parameter
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
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>>
Parameter
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
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>>
Parameter
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
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>>
Parameter
- client
- Client
- initialResponse
-
CopyClassifierTo202Response | CopyClassifierToDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
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>>
Parameter
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
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>>
Parameter
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Mengembalikan
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Parameter
- response
Mengembalikan
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Parameter
- response
Mengembalikan
response
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Parameter
- response
Mengembalikan
response
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response
Parameter
Mengembalikan
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Pembantu untuk mem-paginate hasil dari respons awal yang mengikuti spesifikasi ekstensi Autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parameter
- client
- Client
Klien yang digunakan untuk mengirim permintaan halaman berikutnya
- initialResponse
-
TResponse
Respons awal yang berisi nextLink dan halaman elemen saat ini
- options
-
PagingOptions<TResponse>
Mengembalikan
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator untuk melakukan iterasi elemen