@azure-rest/ai-document-intelligence 1.0.0-beta.1 → 1.0.0-beta.2

package/review/ai-document-intelligence.api.md

@@ -16,6 +16,7 @@ import { Paged } from '@azure/core-paging';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { PathUncheckedResponse } from '@azure-rest/core-client';
 import { RawHttpHeaders } from '@azure/core-rest-pipeline';
+import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
 import { RequestParameters } from '@azure-rest/core-client';
 import { SimplePollerLike } from '@azure/core-lro';
 import { StreamableMethod } from '@azure-rest/core-client';
@@ -43,6 +44,7 @@ export interface AddressValueOutput {
 export interface AnalyzeDocument202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -76,6 +78,7 @@ export interface AnalyzeDocumentFromStream {
 export interface AnalyzeDocumentFromStream202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -268,6 +271,7 @@ export interface BuildClassifier {
 export interface BuildClassifier202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -302,6 +306,7 @@ export type BuildClassifierParameters = BuildClassifierBodyParam & RequestParame
 
 // @public
 export interface BuildDocumentClassifierRequest {
+    baseClassifierId?: string;
     classifierId: string;
     description?: string;
     docTypes: Record<string, ClassifierDocumentTypeDetails>;
@@ -326,6 +331,7 @@ export interface BuildModel {
 export interface BuildModel202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -376,6 +382,7 @@ export interface ClassifierDocumentTypeDetailsOutput {
 export interface ClassifyDocument202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -409,6 +416,7 @@ export interface ClassifyDocumentFromStream {
 export interface ClassifyDocumentFromStream202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -490,6 +498,10 @@ export interface ClassifyDocumentRequest {
     urlSource?: string;
 }
 
+// @public
+export interface ClientRequestIdHeaderOutput {
+}
+
 // @public
 export interface ComponentDocumentModelDetails {
     modelId: string;
@@ -512,6 +524,7 @@ export interface ComposeModel {
 export interface ComposeModel202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -573,6 +586,7 @@ export interface CopyModelTo {
 export interface CopyModelTo202Headers {
     // (undocumented)
     "operation-location": string;
+    "retry-after"?: number;
 }
 
 // @public
@@ -622,8 +636,15 @@ export interface CustomDocumentModelsDetailsOutput {
     limit: number;
 }
 
+// @public (undocumented)
+export interface DeleteClassifier204Headers {
+    "x-ms-client-request-id"?: string;
+}
+
 // @public
 export interface DeleteClassifier204Response extends HttpResponse {
+    // (undocumented)
+    headers: RawHttpHeaders & DeleteClassifier204Headers;
     // (undocumented)
     status: "204";
 }
@@ -637,10 +658,28 @@ export interface DeleteClassifierDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type DeleteClassifierParameters = RequestParameters;
+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";
 }
@@ -654,7 +693,18 @@ export interface DeleteModelDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type DeleteModelParameters = RequestParameters;
+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 interface DocumentBarcodeOutput {
@@ -682,11 +732,13 @@ export interface DocumentClassifierBuildOperationDetailsOutput extends Operation
 // @public
 export interface DocumentClassifierDetailsOutput {
     apiVersion: string;
+    baseClassifierId?: string;
     classifierId: string;
     createdDateTime: string;
     description?: string;
     docTypes: Record<string, ClassifierDocumentTypeDetailsOutput>;
     expirationDateTime?: string;
+    warnings?: Array<WarningOutput>;
 }
 
 // @public
@@ -706,6 +758,7 @@ export interface DocumentFieldOutput {
     valueNumber?: number;
     valueObject?: Record<string, DocumentFieldOutput>;
     valuePhoneNumber?: string;
+    valueSelectionGroup?: string[];
     valueSelectionMark?: string;
     valueSignature?: string;
     valueString?: string;
@@ -825,6 +878,7 @@ export interface DocumentModelDetailsOutput {
     expirationDateTime?: string;
     modelId: string;
     tags?: Record<string, string>;
+    warnings?: Array<WarningOutput>;
 }
 
 // @public
@@ -978,11 +1032,18 @@ export interface GetClassifier {
     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";
 }
 
@@ -995,7 +1056,18 @@ export interface GetClassifierDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type GetClassifierParameters = RequestParameters;
+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 {
@@ -1021,11 +1093,18 @@ export interface GetClassifyResultDefaultResponse extends HttpResponse {
 // @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";
 }
 
@@ -1038,7 +1117,18 @@ export interface GetDocumentClassifierBuildOperationDefaultResponse extends Http
 }
 
 // @public (undocumented)
-export type GetDocumentClassifierBuildOperationParameters = RequestParameters;
+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 GetDocumentModelBuildOperation {
@@ -1049,11 +1139,18 @@ export interface GetDocumentModelBuildOperation {
     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";
 }
 
@@ -1066,13 +1163,31 @@ export interface GetDocumentModelBuildOperationDefaultResponse extends HttpRespo
 }
 
 // @public (undocumented)
-export type GetDocumentModelBuildOperationParameters = RequestParameters;
+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";
 }
 
@@ -1085,13 +1200,31 @@ export interface GetDocumentModelComposeOperationDefaultResponse extends HttpRes
 }
 
 // @public (undocumented)
-export type GetDocumentModelComposeOperationParameters = RequestParameters;
+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-id"?: string;
+}
 
 // @public
 export interface GetDocumentModelCopyToOperation200Response extends HttpResponse {
     // (undocumented)
     body: DocumentModelCopyToOperationDetailsOutput;
     // (undocumented)
+    headers: RawHttpHeaders & GetDocumentModelCopyToOperation200Headers;
+    // (undocumented)
     status: "200";
 }
 
@@ -1104,7 +1237,18 @@ export interface GetDocumentModelCopyToOperationDefaultResponse extends HttpResp
 }
 
 // @public (undocumented)
-export type GetDocumentModelCopyToOperationParameters = RequestParameters;
+export interface GetDocumentModelCopyToOperationHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetDocumentModelCopyToOperationHeaders;
+}
+
+// @public (undocumented)
+export interface GetDocumentModelCopyToOperationHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type GetDocumentModelCopyToOperationParameters = GetDocumentModelCopyToOperationHeaderParam & RequestParameters;
 
 // @public
 export function getLongRunningPoller<TResult extends BuildModelLogicalResponse | BuildModelDefaultResponse>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
@@ -1130,11 +1274,18 @@ export interface GetModel {
     get(options?: GetModelParameters): StreamableMethod<GetModel200Response | GetModelDefaultResponse>;
 }
 
+// @public (undocumented)
+export interface GetModel200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
 // @public
 export interface GetModel200Response extends HttpResponse {
     // (undocumented)
     body: DocumentModelDetailsOutput;
     // (undocumented)
+    headers: RawHttpHeaders & GetModel200Headers;
+    // (undocumented)
     status: "200";
 }
 
@@ -1147,13 +1298,31 @@ export interface GetModelDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type GetModelParameters = RequestParameters;
+export interface GetModelHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetModelHeaders;
+}
+
+// @public (undocumented)
+export interface GetModelHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type GetModelParameters = GetModelHeaderParam & RequestParameters;
+
+// @public (undocumented)
+export interface GetOperation200Headers {
+    "x-ms-client-request-id"?: string;
+}
 
 // @public
 export interface GetOperation200Response extends HttpResponse {
     // (undocumented)
     body: OperationDetailsOutput;
     // (undocumented)
+    headers: RawHttpHeaders & GetOperation200Headers;
+    // (undocumented)
     status: "200";
 }
 
@@ -1166,7 +1335,18 @@ export interface GetOperationDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type GetOperationParameters = RequestParameters;
+export interface GetOperationHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetOperationHeaders;
+}
+
+// @public (undocumented)
+export interface GetOperationHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type GetOperationParameters = GetOperationHeaderParam & RequestParameters;
 
 // @public
 export type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
@@ -1209,7 +1389,7 @@ export interface InnerErrorOutput {
 export function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response is ListOperationsDefaultResponse;
 
 // @public (undocumented)
-export function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response is GetDocumentModelBuildOperationDefaultResponse;
+export function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response is GetDocumentModelBuildOperationDefaultResponse;
 
 // @public (undocumented)
 export function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response is GetResourceInfoDefaultResponse;
@@ -1218,7 +1398,7 @@ export function isUnexpected(response: GetResourceInfo200Response | GetResourceI
 export function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response is GetAnalyzeResultDefaultResponse;
 
 // @public (undocumented)
-export function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse): response is AnalyzeDocumentFromStreamDefaultResponse;
+export function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse): response is AnalyzeDocumentFromStreamDefaultResponse;
 
 // @public (undocumented)
 export function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response is GetModelDefaultResponse;
@@ -1254,7 +1434,7 @@ export function isUnexpected(response: GetClassifier200Response | GetClassifierD
 export function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response is DeleteClassifierDefaultResponse;
 
 // @public (undocumented)
-export function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse): response is ClassifyDocumentFromStreamDefaultResponse;
+export function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentLogicalResponse | ClassifyDocumentFromStreamDefaultResponse): response is ClassifyDocumentFromStreamDefaultResponse;
 
 // @public (undocumented)
 export function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response is GetClassifyResultDefaultResponse;
@@ -1264,11 +1444,18 @@ export interface ListClassifiers {
     get(options?: ListClassifiersParameters): StreamableMethod<ListClassifiers200Response | ListClassifiersDefaultResponse>;
 }
 
+// @public (undocumented)
+export interface ListClassifiers200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
 // @public
 export interface ListClassifiers200Response extends HttpResponse {
     // (undocumented)
     body: PagedDocumentClassifierDetailsOutput;
     // (undocumented)
+    headers: RawHttpHeaders & ListClassifiers200Headers;
+    // (undocumented)
     status: "200";
 }
 
@@ -1281,18 +1468,36 @@ export interface ListClassifiersDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type ListClassifiersParameters = RequestParameters;
+export interface ListClassifiersHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & ListClassifiersHeaders;
+}
+
+// @public (undocumented)
+export interface ListClassifiersHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type ListClassifiersParameters = ListClassifiersHeaderParam & RequestParameters;
 
 // @public (undocumented)
 export interface ListModels {
     get(options?: ListModelsParameters): StreamableMethod<ListModels200Response | ListModelsDefaultResponse>;
 }
 
+// @public (undocumented)
+export interface ListModels200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
 // @public
 export interface ListModels200Response extends HttpResponse {
     // (undocumented)
     body: PagedDocumentModelDetailsOutput;
     // (undocumented)
+    headers: RawHttpHeaders & ListModels200Headers;
+    // (undocumented)
     status: "200";
 }
 
@@ -1305,18 +1510,36 @@ export interface ListModelsDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type ListModelsParameters = RequestParameters;
+export interface ListModelsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & ListModelsHeaders;
+}
+
+// @public (undocumented)
+export interface ListModelsHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type ListModelsParameters = ListModelsHeaderParam & RequestParameters;
 
 // @public (undocumented)
 export interface ListOperations {
     get(options?: ListOperationsParameters): StreamableMethod<ListOperations200Response | ListOperationsDefaultResponse>;
 }
 
+// @public (undocumented)
+export interface ListOperations200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
 // @public
 export interface ListOperations200Response extends HttpResponse {
     // (undocumented)
     body: PagedOperationDetailsOutput;
     // (undocumented)
+    headers: RawHttpHeaders & ListOperations200Headers;
+    // (undocumented)
     status: "200";
 }
 
@@ -1329,10 +1552,21 @@ export interface ListOperationsDefaultResponse extends HttpResponse {
 }
 
 // @public (undocumented)
-export type ListOperationsParameters = RequestParameters;
+export interface ListOperationsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & ListOperationsHeaders;
+}
+
+// @public (undocumented)
+export interface ListOperationsHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type ListOperationsParameters = ListOperationsHeaderParam & RequestParameters;
 
 // @public
-export type OperationDetailsOutput = DocumentModelBuildOperationDetailsOutput | DocumentModelComposeOperationDetailsOutput | DocumentModelCopyToOperationDetailsOutput | DocumentClassifierBuildOperationDetailsOutput;
+export type OperationDetailsOutput = OperationDetailsOutputParent | DocumentModelBuildOperationDetailsOutput | DocumentModelComposeOperationDetailsOutput | DocumentModelCopyToOperationDetailsOutput | DocumentClassifierBuildOperationDetailsOutput;
 
 // @public
 export interface OperationDetailsOutputParent {
@@ -1406,6 +1640,13 @@ export interface Routes {
     (path: "/documentClassifiers/{classifierId}/analyzeResults/{resultId}", classifierId: string, resultId: string): GetClassifyResult;
 }
 
+// @public
+export interface WarningOutput {
+    code: string;
+    message: string;
+    target?: string;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```