UNPKG

@azure-rest/ai-document-intelligence

Version:
1,735 lines (1,471 loc) 72.4 kB
## API Report File for "@azure-rest/ai-document-intelligence" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts import type { Client } from '@azure-rest/core-client'; import type { ClientOptions } from '@azure-rest/core-client'; import type { HttpResponse } from '@azure-rest/core-client'; import type { KeyCredential } from '@azure/core-auth'; import type { OperationState } from '@azure/core-lro'; import type { PathUncheckedResponse } from '@azure-rest/core-client'; import type { PollerLike } from '@azure/core-lro'; import type { RawHttpHeaders } from '@azure/core-rest-pipeline'; import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline'; import type { RequestParameters } from '@azure-rest/core-client'; import type { StreamableMethod } from '@azure-rest/core-client'; import type { TokenCredential } from '@azure/core-auth'; // @public export interface AddressValueOutput { city?: string; cityDistrict?: string; countryRegion?: string; house?: string; houseNumber?: string; level?: string; poBox?: string; postalCode?: string; road?: string; state?: string; stateDistrict?: string; streetAddress?: string; suburb?: string; unit?: string; } // @public (undocumented) export interface AnalyzeBatchDocuments { post(options: AnalyzeBatchDocumentsParameters): StreamableMethod<AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse>; } // @public (undocumented) export interface AnalyzeBatchDocuments202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface AnalyzeBatchDocuments202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & AnalyzeBatchDocuments202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface AnalyzeBatchDocumentsBodyParam { body: AnalyzeBatchDocumentsRequest; } // @public (undocumented) export interface AnalyzeBatchDocumentsDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface AnalyzeBatchDocumentsFeaturesQueryParam { explode: false; style: "form"; value: DocumentAnalysisFeature[]; } // @public export interface AnalyzeBatchDocumentsLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export interface AnalyzeBatchDocumentsMediaTypesParam { contentType: "application/json"; } // @public export interface AnalyzeBatchDocumentsOutputQueryParam { explode: false; style: "form"; value: AnalyzeOutputOption[]; } // @public (undocumented) export type AnalyzeBatchDocumentsParameters = AnalyzeBatchDocumentsQueryParam & AnalyzeBatchDocumentsMediaTypesParam & AnalyzeBatchDocumentsBodyParam & RequestParameters; // @public export interface AnalyzeBatchDocumentsQueryFieldsQueryParam { explode: false; style: "form"; value: string[]; } // @public (undocumented) export interface AnalyzeBatchDocumentsQueryParam { // (undocumented) queryParameters?: AnalyzeBatchDocumentsQueryParamProperties; } // @public (undocumented) export interface AnalyzeBatchDocumentsQueryParamProperties { features?: DocumentAnalysisFeature[] | AnalyzeBatchDocumentsFeaturesQueryParam; locale?: string; output?: AnalyzeOutputOption[] | AnalyzeBatchDocumentsOutputQueryParam; outputContentFormat?: DocumentContentFormat; pages?: string; queryFields?: string[] | AnalyzeBatchDocumentsQueryFieldsQueryParam; stringIndexType?: StringIndexType; } // @public export interface AnalyzeBatchDocumentsRequest { azureBlobFileListSource?: AzureBlobFileListContentSource; azureBlobSource?: AzureBlobContentSource; overwriteExisting?: boolean; resultContainerUrl: string; resultPrefix?: string; } // @public export interface AnalyzeBatchOperationDetailOutput { error?: DocumentIntelligenceErrorOutput; resultUrl?: string; sourceUrl: string; status: DocumentIntelligenceOperationStatusOutput; } // @public export interface AnalyzeBatchOperationOutput { createdDateTime: string; error?: DocumentIntelligenceErrorOutput; lastUpdatedDateTime: string; percentCompleted?: number; result?: AnalyzeBatchResultOutput; resultId?: string; status: DocumentIntelligenceOperationStatusOutput; } // @public export interface AnalyzeBatchResultOutput { details?: Array<AnalyzeBatchOperationDetailOutput>; failedCount: number; skippedCount: number; succeededCount: number; } // @public export interface AnalyzedDocumentOutput { boundingRegions?: Array<BoundingRegionOutput>; confidence: number; docType: string; fields?: Record<string, DocumentFieldOutput>; spans: Array<DocumentSpanOutput>; } // @public (undocumented) export interface AnalyzeDocument202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface AnalyzeDocument202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & AnalyzeDocument202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface AnalyzeDocumentBodyParam { body: AnalyzeDocumentRequest; } // @public (undocumented) export interface AnalyzeDocumentDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface AnalyzeDocumentFeaturesQueryParam { explode: false; style: "form"; value: DocumentAnalysisFeature[]; } // @public (undocumented) export interface AnalyzeDocumentFromStream { post(options: AnalyzeDocumentFromStreamParameters): StreamableMethod<AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse>; post(options: AnalyzeDocumentParameters): StreamableMethod<AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse>; } // @public (undocumented) export interface AnalyzeDocumentFromStream202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface AnalyzeDocumentFromStream202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & AnalyzeDocumentFromStream202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface AnalyzeDocumentFromStreamBodyParam { body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream; } // @public (undocumented) export interface AnalyzeDocumentFromStreamDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface AnalyzeDocumentFromStreamFeaturesQueryParam { explode: false; style: "form"; value: DocumentAnalysisFeature[]; } // @public export interface AnalyzeDocumentFromStreamLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export interface AnalyzeDocumentFromStreamMediaTypesParam { contentType: "application/octet-stream" | "application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/bmp" | "image/heif" | "text/html" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.presentationml.presentation"; } // @public export interface AnalyzeDocumentFromStreamOutputQueryParam { explode: false; style: "form"; value: AnalyzeOutputOption[]; } // @public (undocumented) export type AnalyzeDocumentFromStreamParameters = AnalyzeDocumentFromStreamQueryParam & AnalyzeDocumentFromStreamMediaTypesParam & AnalyzeDocumentFromStreamBodyParam & RequestParameters; // @public export interface AnalyzeDocumentFromStreamQueryFieldsQueryParam { explode: false; style: "form"; value: string[]; } // @public (undocumented) export interface AnalyzeDocumentFromStreamQueryParam { // (undocumented) queryParameters?: AnalyzeDocumentFromStreamQueryParamProperties; } // @public (undocumented) export interface AnalyzeDocumentFromStreamQueryParamProperties { features?: DocumentAnalysisFeature[] | AnalyzeDocumentFromStreamFeaturesQueryParam; locale?: string; output?: AnalyzeOutputOption[] | AnalyzeDocumentFromStreamOutputQueryParam; outputContentFormat?: DocumentContentFormat; pages?: string; queryFields?: string[] | AnalyzeDocumentFromStreamQueryFieldsQueryParam; stringIndexType?: StringIndexType; } // @public export interface AnalyzeDocumentLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export interface AnalyzeDocumentMediaTypesParam { contentType: "application/json"; } // @public export interface AnalyzeDocumentOutputQueryParam { explode: false; style: "form"; value: AnalyzeOutputOption[]; } // @public (undocumented) export type AnalyzeDocumentParameters = AnalyzeDocumentQueryParam & AnalyzeDocumentMediaTypesParam & AnalyzeDocumentBodyParam & RequestParameters; // @public export interface AnalyzeDocumentQueryFieldsQueryParam { explode: false; style: "form"; value: string[]; } // @public (undocumented) export interface AnalyzeDocumentQueryParam { // (undocumented) queryParameters?: AnalyzeDocumentQueryParamProperties; } // @public (undocumented) export interface AnalyzeDocumentQueryParamProperties { features?: DocumentAnalysisFeature[] | AnalyzeDocumentFeaturesQueryParam; locale?: string; output?: AnalyzeOutputOption[] | AnalyzeDocumentOutputQueryParam; outputContentFormat?: DocumentContentFormat; pages?: string; queryFields?: string[] | AnalyzeDocumentQueryFieldsQueryParam; stringIndexType?: StringIndexType; } // @public export interface AnalyzeDocumentRequest { base64Source?: string; urlSource?: string; } // @public export interface AnalyzeOperationOutput { analyzeResult?: AnalyzeResultOutput; createdDateTime: string; error?: DocumentIntelligenceErrorOutput; lastUpdatedDateTime: string; status: DocumentIntelligenceOperationStatusOutput; } // @public export type AnalyzeOutputOption = string; // @public export interface AnalyzeResultOutput { apiVersion: string; content: string; contentFormat?: DocumentContentFormatOutput; documents?: Array<AnalyzedDocumentOutput>; figures?: Array<DocumentFigureOutput>; keyValuePairs?: Array<DocumentKeyValuePairOutput>; languages?: Array<DocumentLanguageOutput>; modelId: string; pages: Array<DocumentPageOutput>; paragraphs?: Array<DocumentParagraphOutput>; sections?: Array<DocumentSectionOutput>; stringIndexType: StringIndexTypeOutput; styles?: Array<DocumentStyleOutput>; tables?: Array<DocumentTableOutput>; warnings?: Array<DocumentIntelligenceWarningOutput>; } // @public (undocumented) export interface AuthorizeClassifierCopy { post(options: AuthorizeClassifierCopyParameters): StreamableMethod<AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse>; } // @public export interface AuthorizeClassifierCopy200Response extends HttpResponse { // (undocumented) body: ClassifierCopyAuthorizationOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface AuthorizeClassifierCopyBodyParam { body: AuthorizeClassifierCopyRequest; } // @public (undocumented) export interface AuthorizeClassifierCopyDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type AuthorizeClassifierCopyParameters = AuthorizeClassifierCopyBodyParam & RequestParameters; // @public export interface AuthorizeClassifierCopyRequest { classifierId: string; description?: string; tags?: Record<string, string>; } // @public export interface AuthorizeCopyRequest { description?: string; modelId: string; tags?: Record<string, string>; } // @public (undocumented) export interface AuthorizeModelCopy { post(options: AuthorizeModelCopyParameters): StreamableMethod<AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse>; } // @public export interface AuthorizeModelCopy200Response extends HttpResponse { // (undocumented) body: ModelCopyAuthorizationOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface AuthorizeModelCopyBodyParam { body: AuthorizeCopyRequest; } // @public (undocumented) export interface AuthorizeModelCopyDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type AuthorizeModelCopyParameters = AuthorizeModelCopyBodyParam & RequestParameters; // @public export interface AzureBlobContentSource { containerUrl: string; prefix?: string; } // @public export interface AzureBlobContentSourceOutput { containerUrl: string; prefix?: string; } // @public export interface AzureBlobFileListContentSource { containerUrl: string; fileList: string; } // @public export interface AzureBlobFileListContentSourceOutput { containerUrl: string; fileList: string; } // @public export interface BoundingRegionOutput { pageNumber: number; polygon: number[]; } // @public (undocumented) export interface BuildClassifier { post(options: BuildClassifierParameters): StreamableMethod<BuildClassifier202Response | BuildClassifierDefaultResponse>; } // @public (undocumented) export interface BuildClassifier202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface BuildClassifier202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & BuildClassifier202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface BuildClassifierBodyParam { body: BuildDocumentClassifierRequest; } // @public (undocumented) export interface BuildClassifierDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface BuildClassifierLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export type BuildClassifierParameters = BuildClassifierBodyParam & RequestParameters; // @public export interface BuildDocumentClassifierRequest { allowOverwrite?: boolean; baseClassifierId?: string; classifierId: string; description?: string; docTypes: Record<string, ClassifierDocumentTypeDetails>; } // @public export interface BuildDocumentModelRequest { allowOverwrite?: boolean; azureBlobFileListSource?: AzureBlobFileListContentSource; azureBlobSource?: AzureBlobContentSource; buildMode: DocumentBuildMode; description?: string; maxTrainingHours?: number; modelId: string; tags?: Record<string, string>; } // @public (undocumented) export interface BuildModel { post(options: BuildModelParameters): StreamableMethod<BuildModel202Response | BuildModelDefaultResponse>; } // @public (undocumented) export interface BuildModel202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface BuildModel202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & BuildModel202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface BuildModelBodyParam { body: BuildDocumentModelRequest; } // @public (undocumented) export interface BuildModelDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface BuildModelLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export type BuildModelParameters = BuildModelBodyParam & RequestParameters; // @public export interface ClassifierCopyAuthorization { accessToken: string; expirationDateTime: Date | string; targetClassifierId: string; targetClassifierLocation: string; targetResourceId: string; targetResourceRegion: string; } // @public export interface ClassifierCopyAuthorizationOutput { accessToken: string; expirationDateTime: string; targetClassifierId: string; targetClassifierLocation: string; targetResourceId: string; targetResourceRegion: string; } // @public export interface ClassifierDocumentTypeDetails { azureBlobFileListSource?: AzureBlobFileListContentSource; azureBlobSource?: AzureBlobContentSource; sourceKind?: ContentSourceKind; } // @public export interface ClassifierDocumentTypeDetailsOutput { azureBlobFileListSource?: AzureBlobFileListContentSourceOutput; azureBlobSource?: AzureBlobContentSourceOutput; sourceKind?: ContentSourceKindOutput; } // @public (undocumented) export interface ClassifyDocument202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface ClassifyDocument202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & ClassifyDocument202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface ClassifyDocumentBodyParam { body: ClassifyDocumentRequest; } // @public (undocumented) export interface ClassifyDocumentDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface ClassifyDocumentFromStream { post(options: ClassifyDocumentFromStreamParameters): StreamableMethod<ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse>; post(options: ClassifyDocumentParameters): StreamableMethod<ClassifyDocument202Response | ClassifyDocumentDefaultResponse>; } // @public (undocumented) export interface ClassifyDocumentFromStream202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface ClassifyDocumentFromStream202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & ClassifyDocumentFromStream202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface ClassifyDocumentFromStreamBodyParam { body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream; } // @public (undocumented) export interface ClassifyDocumentFromStreamDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface ClassifyDocumentFromStreamLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export interface ClassifyDocumentFromStreamMediaTypesParam { contentType: "application/octet-stream" | "application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/bmp" | "image/heif" | "text/html" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.presentationml.presentation"; } // @public (undocumented) export type ClassifyDocumentFromStreamParameters = ClassifyDocumentFromStreamQueryParam & ClassifyDocumentFromStreamMediaTypesParam & ClassifyDocumentFromStreamBodyParam & RequestParameters; // @public (undocumented) export interface ClassifyDocumentFromStreamQueryParam { // (undocumented) queryParameters?: ClassifyDocumentFromStreamQueryParamProperties; } // @public (undocumented) export interface ClassifyDocumentFromStreamQueryParamProperties { pages?: string; split?: SplitMode; stringIndexType?: StringIndexType; } // @public export interface ClassifyDocumentLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export interface ClassifyDocumentMediaTypesParam { contentType: "application/json"; } // @public (undocumented) export type ClassifyDocumentParameters = ClassifyDocumentQueryParam & ClassifyDocumentMediaTypesParam & ClassifyDocumentBodyParam & RequestParameters; // @public (undocumented) export interface ClassifyDocumentQueryParam { // (undocumented) queryParameters?: ClassifyDocumentQueryParamProperties; } // @public (undocumented) export interface ClassifyDocumentQueryParamProperties { pages?: string; split?: SplitMode; stringIndexType?: StringIndexType; } // @public export interface ClassifyDocumentRequest { base64Source?: string; urlSource?: string; } // @public export interface ComposeDocumentModelRequest { classifierId: string; description?: string; docTypes: Record<string, DocumentTypeDetails>; modelId: string; split?: SplitMode; tags?: Record<string, string>; } // @public (undocumented) export interface ComposeModel { post(options: ComposeModelParameters): StreamableMethod<ComposeModel202Response | ComposeModelDefaultResponse>; } // @public (undocumented) export interface ComposeModel202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface ComposeModel202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & ComposeModel202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface ComposeModelBodyParam { body: ComposeDocumentModelRequest; } // @public (undocumented) export interface ComposeModelDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface ComposeModelLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export type ComposeModelParameters = ComposeModelBodyParam & RequestParameters; // @public export type ContentSourceKind = string; // @public export type ContentSourceKindOutput = string; // @public (undocumented) export interface CopyClassifierTo { post(options: CopyClassifierToParameters): StreamableMethod<CopyClassifierTo202Response | CopyClassifierToDefaultResponse>; } // @public (undocumented) export interface CopyClassifierTo202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface CopyClassifierTo202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & CopyClassifierTo202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface CopyClassifierToBodyParam { body: ClassifierCopyAuthorization; } // @public (undocumented) export interface CopyClassifierToDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface CopyClassifierToLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export type CopyClassifierToParameters = CopyClassifierToBodyParam & RequestParameters; // @public (undocumented) export interface CopyModelTo { post(options: CopyModelToParameters): StreamableMethod<CopyModelTo202Response | CopyModelToDefaultResponse>; } // @public (undocumented) export interface CopyModelTo202Headers { // (undocumented) "operation-location": string; "retry-after"?: number; } // @public export interface CopyModelTo202Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & CopyModelTo202Headers; // (undocumented) status: "202"; } // @public (undocumented) export interface CopyModelToBodyParam { body: ModelCopyAuthorization; } // @public (undocumented) export interface CopyModelToDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public export interface CopyModelToLogicalResponse extends HttpResponse { // (undocumented) status: "200"; } // @public (undocumented) export type CopyModelToParameters = CopyModelToBodyParam & RequestParameters; // @public function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, { apiVersion, ...options }?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient; export default createClient; // @public export interface CurrencyValueOutput { amount: number; currencyCode?: string; currencySymbol?: string; } // @public export interface CustomDocumentModelsDetailsOutput { count: number; limit: number; } // @public export interface DeleteAnalyzeBatchResult204Response extends HttpResponse { // (undocumented) status: "204"; } // @public (undocumented) export interface DeleteAnalyzeBatchResultDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type DeleteAnalyzeBatchResultParameters = RequestParameters; // @public export interface DeleteAnalyzeResult204Response extends HttpResponse { // (undocumented) status: "204"; } // @public (undocumented) export interface DeleteAnalyzeResultDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type DeleteAnalyzeResultParameters = RequestParameters; // @public (undocumented) export interface DeleteClassifier204Headers { "x-ms-client-request-id"?: string; } // @public export interface DeleteClassifier204Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & DeleteClassifier204Headers; // (undocumented) status: "204"; } // @public (undocumented) export interface DeleteClassifierDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface DeleteClassifierHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & DeleteClassifierHeaders; } // @public (undocumented) export interface DeleteClassifierHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type DeleteClassifierParameters = DeleteClassifierHeaderParam & RequestParameters; // @public (undocumented) export interface DeleteModel204Headers { "x-ms-client-request-id"?: string; } // @public export interface DeleteModel204Response extends HttpResponse { // (undocumented) headers: RawHttpHeaders & DeleteModel204Headers; // (undocumented) status: "204"; } // @public (undocumented) export interface DeleteModelDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface DeleteModelHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & DeleteModelHeaders; } // @public (undocumented) export interface DeleteModelHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type DeleteModelParameters = DeleteModelHeaderParam & RequestParameters; // @public export type DocumentAnalysisFeature = string; // @public export type DocumentAnalysisFeatureOutput = string; // @public export type DocumentBarcodeKindOutput = string; // @public export interface DocumentBarcodeOutput { confidence: number; kind: DocumentBarcodeKindOutput; polygon?: number[]; span: DocumentSpanOutput; value: string; } // @public export type DocumentBuildMode = string; // @public export type DocumentBuildModeOutput = string; // @public export interface DocumentCaptionOutput { boundingRegions?: Array<BoundingRegionOutput>; content: string; elements?: string[]; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentClassifierBuildOperationDetailsOutput extends DocumentIntelligenceOperationDetailsOutputParent { kind: "documentClassifierBuild"; result?: DocumentClassifierDetailsOutput; } // @public export interface DocumentClassifierCopyToOperationDetailsOutput extends DocumentIntelligenceOperationDetailsOutputParent { kind: "documentClassifierCopyTo"; result?: DocumentClassifierDetailsOutput; } // @public export interface DocumentClassifierDetailsOutput { apiVersion: string; baseClassifierId?: string; classifierId: string; createdDateTime: string; description?: string; docTypes: Record<string, ClassifierDocumentTypeDetailsOutput>; expirationDateTime?: string; readonly modifiedDateTime?: string; warnings?: Array<DocumentIntelligenceWarningOutput>; } // @public export type DocumentContentFormat = string; // @public export type DocumentContentFormatOutput = string; // @public export interface DocumentFieldOutput { boundingRegions?: Array<BoundingRegionOutput>; confidence?: number; content?: string; spans?: Array<DocumentSpanOutput>; type: DocumentFieldTypeOutput; valueAddress?: AddressValueOutput; valueArray?: Array<DocumentFieldOutput>; valueBoolean?: boolean; valueCountryRegion?: string; valueCurrency?: CurrencyValueOutput; valueDate?: string; valueInteger?: number; valueNumber?: number; valueObject?: Record<string, DocumentFieldOutput>; valuePhoneNumber?: string; valueSelectionGroup?: string[]; valueSelectionMark?: DocumentSelectionMarkStateOutput; valueSignature?: DocumentSignatureTypeOutput; valueString?: string; valueTime?: string; } // @public export interface DocumentFieldSchema { description?: string; example?: string; items?: DocumentFieldSchema; properties?: Record<string, DocumentFieldSchema>; type: DocumentFieldType; } // @public export interface DocumentFieldSchemaOutput { description?: string; example?: string; items?: DocumentFieldSchemaOutput; properties?: Record<string, DocumentFieldSchemaOutput>; type: DocumentFieldTypeOutput; } // @public export type DocumentFieldType = string; // @public export type DocumentFieldTypeOutput = string; // @public export interface DocumentFigureOutput { boundingRegions?: Array<BoundingRegionOutput>; caption?: DocumentCaptionOutput; elements?: string[]; footnotes?: Array<DocumentFootnoteOutput>; id?: string; spans: Array<DocumentSpanOutput>; } // @public export type DocumentFontStyleOutput = string; // @public export type DocumentFontWeightOutput = string; // @public export interface DocumentFootnoteOutput { boundingRegions?: Array<BoundingRegionOutput>; content: string; elements?: string[]; spans: Array<DocumentSpanOutput>; } // @public export type DocumentFormulaKindOutput = string; // @public export interface DocumentFormulaOutput { confidence: number; kind: DocumentFormulaKindOutput; polygon?: number[]; span: DocumentSpanOutput; value: string; } // @public (undocumented) export type DocumentIntelligenceClient = Client & { path: Routes; }; // @public export interface DocumentIntelligenceClientOptions extends ClientOptions { apiVersion?: string; } // @public export interface DocumentIntelligenceErrorOutput { code: string; details?: Array<DocumentIntelligenceErrorOutput>; innererror?: DocumentIntelligenceInnerErrorOutput; message: string; target?: string; } // @public export interface DocumentIntelligenceErrorResponseOutput { error: DocumentIntelligenceErrorOutput; } // @public export interface DocumentIntelligenceInnerErrorOutput { code?: string; innererror?: DocumentIntelligenceInnerErrorOutput; message?: string; } // @public export type DocumentIntelligenceOperationDetailsOutput = DocumentIntelligenceOperationDetailsOutputParent | DocumentModelBuildOperationDetailsOutput | DocumentModelComposeOperationDetailsOutput | DocumentModelCopyToOperationDetailsOutput | DocumentClassifierCopyToOperationDetailsOutput | DocumentClassifierBuildOperationDetailsOutput; // @public export interface DocumentIntelligenceOperationDetailsOutputParent { apiVersion?: string; createdDateTime: string; error?: DocumentIntelligenceErrorOutput; // (undocumented) kind: OperationKindOutput; lastUpdatedDateTime: string; operationId: string; percentCompleted?: number; resourceLocation: string; status: DocumentIntelligenceOperationStatusOutput; tags?: Record<string, string>; } // @public export type DocumentIntelligenceOperationStatusOutput = string; // @public export interface DocumentIntelligenceResourceDetailsOutput { customDocumentModels: CustomDocumentModelsDetailsOutput; } // @public export interface DocumentIntelligenceWarningOutput { code: string; message: string; target?: string; } // @public export interface DocumentKeyValueElementOutput { boundingRegions?: Array<BoundingRegionOutput>; content: string; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentKeyValuePairOutput { confidence: number; key: DocumentKeyValueElementOutput; value?: DocumentKeyValueElementOutput; } // @public export interface DocumentLanguageOutput { confidence: number; locale: string; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentLineOutput { content: string; polygon?: number[]; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentModelBuildOperationDetailsOutput extends DocumentIntelligenceOperationDetailsOutputParent { kind: "documentModelBuild"; result?: DocumentModelDetailsOutput; } // @public export interface DocumentModelComposeOperationDetailsOutput extends DocumentIntelligenceOperationDetailsOutputParent { kind: "documentModelCompose"; result?: DocumentModelDetailsOutput; } // @public export interface DocumentModelCopyToOperationDetailsOutput extends DocumentIntelligenceOperationDetailsOutputParent { kind: "documentModelCopyTo"; result?: DocumentModelDetailsOutput; } // @public export interface DocumentModelDetailsOutput { readonly apiVersion?: string; readonly azureBlobFileListSource?: AzureBlobFileListContentSourceOutput; readonly azureBlobSource?: AzureBlobContentSourceOutput; readonly buildMode?: DocumentBuildModeOutput; classifierId?: string; readonly createdDateTime: string; description?: string; readonly docTypes?: Record<string, DocumentTypeDetailsOutput>; readonly expirationDateTime?: string; modelId: string; readonly modifiedDateTime?: string; split?: SplitModeOutput; tags?: Record<string, string>; readonly trainingHours?: number; readonly warnings?: Array<DocumentIntelligenceWarningOutput>; } // @public export interface DocumentPageOutput { angle?: number; barcodes?: Array<DocumentBarcodeOutput>; formulas?: Array<DocumentFormulaOutput>; height?: number; lines?: Array<DocumentLineOutput>; pageNumber: number; selectionMarks?: Array<DocumentSelectionMarkOutput>; spans: Array<DocumentSpanOutput>; unit?: LengthUnitOutput; width?: number; words?: Array<DocumentWordOutput>; } // @public export interface DocumentParagraphOutput { boundingRegions?: Array<BoundingRegionOutput>; content: string; role?: ParagraphRoleOutput; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentSectionOutput { elements?: string[]; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentSelectionMarkOutput { confidence: number; polygon?: number[]; span: DocumentSpanOutput; state: DocumentSelectionMarkStateOutput; } // @public export type DocumentSelectionMarkStateOutput = string; // @public export type DocumentSignatureTypeOutput = string; // @public export interface DocumentSpanOutput { length: number; offset: number; } // @public export interface DocumentStyleOutput { backgroundColor?: string; color?: string; confidence: number; fontStyle?: DocumentFontStyleOutput; fontWeight?: DocumentFontWeightOutput; isHandwritten?: boolean; similarFontFamily?: string; spans: Array<DocumentSpanOutput>; } // @public export type DocumentTableCellKindOutput = string; // @public export interface DocumentTableCellOutput { boundingRegions?: Array<BoundingRegionOutput>; columnIndex: number; columnSpan?: number; content: string; elements?: string[]; kind?: DocumentTableCellKindOutput; rowIndex: number; rowSpan?: number; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentTableOutput { boundingRegions?: Array<BoundingRegionOutput>; caption?: DocumentCaptionOutput; cells: Array<DocumentTableCellOutput>; columnCount: number; footnotes?: Array<DocumentFootnoteOutput>; rowCount: number; spans: Array<DocumentSpanOutput>; } // @public export interface DocumentTypeDetails { buildMode?: DocumentBuildMode; confidenceThreshold?: number; description?: string; features?: DocumentAnalysisFeature[]; fieldConfidence?: Record<string, number>; fieldSchema?: Record<string, DocumentFieldSchema>; maxDocumentsToAnalyze?: number; modelId?: string; queryFields?: string[]; } // @public export interface DocumentTypeDetailsOutput { buildMode?: DocumentBuildModeOutput; confidenceThreshold?: number; description?: string; features?: DocumentAnalysisFeatureOutput[]; fieldConfidence?: Record<string, number>; fieldSchema?: Record<string, DocumentFieldSchemaOutput>; maxDocumentsToAnalyze?: number; modelId?: string; queryFields?: string[]; } // @public export interface DocumentWordOutput { confidence: number; content: string; polygon?: number[]; span: DocumentSpanOutput; } // @public (undocumented) export interface GetAnalyzeBatchResult { delete(options?: DeleteAnalyzeBatchResultParameters): StreamableMethod<DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse>; get(options?: GetAnalyzeBatchResultParameters): StreamableMethod<GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse>; } // @public export interface GetAnalyzeBatchResult200Response extends HttpResponse { // (undocumented) body: AnalyzeBatchOperationOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface GetAnalyzeBatchResultDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type GetAnalyzeBatchResultParameters = RequestParameters; // @public (undocumented) export interface GetAnalyzeResult { delete(options?: DeleteAnalyzeResultParameters): StreamableMethod<DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse>; get(options?: GetAnalyzeResultParameters): StreamableMethod<GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse>; } // @public export interface GetAnalyzeResult200Response extends HttpResponse { // (undocumented) body: AnalyzeOperationOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface GetAnalyzeResultDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface GetAnalyzeResultFigure { get(options?: GetAnalyzeResultFigureParameters): StreamableMethod<GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse>; } // @public (undocumented) export interface GetAnalyzeResultFigure200Headers { "content-type": "image/png"; } // @public export interface GetAnalyzeResultFigure200Response extends HttpResponse { body: Uint8Array; // (undocumented) headers: RawHttpHeaders & GetAnalyzeResultFigure200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetAnalyzeResultFigureDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type GetAnalyzeResultFigureParameters = RequestParameters; // @public (undocumented) export type GetAnalyzeResultParameters = RequestParameters; // @public (undocumented) export interface GetAnalyzeResultPdf { get(options?: GetAnalyzeResultPdfParameters): StreamableMethod<GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse>; } // @public (undocumented) export interface GetAnalyzeResultPdf200Headers { "content-type": "application/pdf"; } // @public export interface GetAnalyzeResultPdf200Response extends HttpResponse { body: Uint8Array; // (undocumented) headers: RawHttpHeaders & GetAnalyzeResultPdf200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetAnalyzeResultPdfDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type GetAnalyzeResultPdfParameters = RequestParameters; // @public export type GetArrayType<T> = T extends Array<infer TData> ? TData : never; // @public (undocumented) export interface GetClassifier { delete(options?: DeleteClassifierParameters): StreamableMethod<DeleteClassifier204Response | DeleteClassifierDefaultResponse>; get(options?: GetClassifierParameters): StreamableMethod<GetClassifier200Response | GetClassifierDefaultResponse>; } // @public (undocumented) export interface GetClassifier200Headers { "x-ms-client-request-id"?: string; } // @public export interface GetClassifier200Response extends HttpResponse { // (undocumented) body: DocumentClassifierDetailsOutput; // (undocumented) headers: RawHttpHeaders & GetClassifier200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetClassifierDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface GetClassifierHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & GetClassifierHeaders; } // @public (undocumented) export interface GetClassifierHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type GetClassifierParameters = GetClassifierHeaderParam & RequestParameters; // @public (undocumented) export interface GetClassifyResult { get(options?: GetClassifyResultParameters): StreamableMethod<GetClassifyResult200Response | GetClassifyResultDefaultResponse>; } // @public export interface GetClassifyResult200Response extends HttpResponse { // (undocumented) body: AnalyzeOperationOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface GetClassifyResultDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export type GetClassifyResultParameters = RequestParameters; // @public (undocumented) export interface GetDocumentClassifierBuildOperation200Headers { "x-ms-client-request-id"?: string; } // @public export interface GetDocumentClassifierBuildOperation200Response extends HttpResponse { // (undocumented) body: DocumentClassifierBuildOperationDetailsOutput; // (undocumented) headers: RawHttpHeaders & GetDocumentClassifierBuildOperation200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetDocumentClassifierBuildOperationDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface GetDocumentClassifierBuildOperationHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & GetDocumentClassifierBuildOperationHeaders; } // @public (undocumented) export interface GetDocumentClassifierBuildOperationHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type GetDocumentClassifierBuildOperationParameters = GetDocumentClassifierBuildOperationHeaderParam & RequestParameters; // @public (undocumented) export interface GetDocumentClassifierCopyToOperation200Headers { "x-ms-client-request-id"?: string; } // @public export interface GetDocumentClassifierCopyToOperation200Response extends HttpResponse { // (undocumented) body: DocumentClassifierCopyToOperationDetailsOutput; // (undocumented) headers: RawHttpHeaders & GetDocumentClassifierCopyToOperation200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetDocumentClassifierCopyToOperationDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface GetDocumentClassifierCopyToOperationHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & GetDocumentClassifierCopyToOperationHeaders; } // @public (undocumented) export interface GetDocumentClassifierCopyToOperationHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type GetDocumentClassifierCopyToOperationParameters = GetDocumentClassifierCopyToOperationHeaderParam & RequestParameters; // @public (undocumented) export interface GetDocumentModelBuildOperation { get(options?: GetDocumentModelBuildOperationParameters): StreamableMethod<GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse>; get(options?: GetDocumentModelComposeOperationParameters): StreamableMethod<GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse>; get(options?: GetDocumentModelCopyToOperationParameters): StreamableMethod<GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse>; get(options?: GetDocumentClassifierCopyToOperationParameters): StreamableMethod<GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse>; get(options?: GetDocumentClassifierBuildOperationParameters): StreamableMethod<GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse>; get(options?: GetOperationParameters): StreamableMethod<GetOperation200Response | GetOperationDefaultResponse>; } // @public (undocumented) export interface GetDocumentModelBuildOperation200Headers { "x-ms-client-request-id"?: string; } // @public export interface GetDocumentModelBuildOperation200Response extends HttpResponse { // (undocumented) body: DocumentModelBuildOperationDetailsOutput; // (undocumented) headers: RawHttpHeaders & GetDocumentModelBuildOperation200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetDocumentModelBuildOperationDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface GetDocumentModelBuildOperationHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & GetDocumentModelBuildOperationHeaders; } // @public (undocumented) export interface GetDocumentModelBuildOperationHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type GetDocumentModelBuildOperationParameters = GetDocumentModelBuildOperationHeaderParam & RequestParameters; // @public (undocumented) export interface GetDocumentModelComposeOperation200Headers { "x-ms-client-request-id"?: string; } // @public export interface GetDocumentModelComposeOperation200Response extends HttpResponse { // (undocumented) body: DocumentModelComposeOperationDetailsOutput; // (undocumented) headers: RawHttpHeaders & GetDocumentModelComposeOperation200Headers; // (undocumented) status: "200"; } // @public (undocumented) export interface GetDocumentModelComposeOperationDefaultResponse extends HttpResponse { // (undocumented) body: DocumentIntelligenceErrorResponseOutput; // (undocumented) status: string; } // @public (undocumented) export interface GetDocumentModelComposeOperationHeaderParam { // (undocumented) headers?: RawHttpHeadersInput & GetDocumentModelComposeOperationHeaders; } // @public (undocumented) export interface GetDocumentModelComposeOperationHeaders { "x-ms-client-request-id"?: string; } // @public (undocumented) export type GetDocumentModelComposeOperationParameters = GetDocumentModelComposeOperationHeaderParam & RequestParameters; // @public (undocumented) export interface GetDocumentModelCopyToOperation200Headers { "x-ms-client-request-i