[Form Recognizer] Regenerate with the latest swagger (Azure#22801)

* swagger

* regenerate

* Info -> Details

* Apply suggestions from code review

* Update sdk/formrecognizer/ai-form-recognizer/src/documentModelAdministrationClient.ts

* test fixes

* new reciordign

* conflicts

* fix test

* changelog

Author: HarshaNalluru

sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md

@@ -11,6 +11,7 @@
 - Removed `PrebuiltModels` and all of its fields as well as related helper types. The strongly-typed functionality previously provided by `PrebuiltModels` is now provided by sample code that you can copy into your own project. See the [`prebuilt` samples directory](https://github.com/azure/azure-sdk-for-js/tree/main/sdk/formrecognizer/ai-form-recognizer/samples-dev/prebuilt/) for models compatible with the current Form Recognizer API.
 - Separated URL-based and file-based analysis inputs into two separate methods: `beginAnalyzeDocument` (for file stream inputs) and `beginAnalyzeDocumentFromUrl` (for URL-based inputs). Previously, both were accepted as inputs to a single `beginAnalyzeDocument` method, and a string value would be interpreted as if it were a URL, but this was confusing. The two inputs now have distinct signatures and documentation.
 - Removed the `beginExtractLayout`, `beginExtractGeneralDocument`, and `beginReadDocument` methods. Strongly-typed `DocumentModel` instances for the corresponding `prebuilt-layout`, `prebuilt-document`, and `prebuilt-read` models are located in the [`prebuilt` samples directory](https://github.com/azure/azure-sdk-for-js/tree/main/sdk/formrecognizer/ai-form-recognizer/samples-dev/prebuilt/).
+- Changed the suffix `-Info` for the methods and interfaces such as `DocumentModelAdministrationClient#getResourceInfo` and `DocumentModelInfo` to `-Details`.
 
 ### Bugs Fixed
 

sdk/formrecognizer/ai-form-recognizer/bin/defaultFields.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { DocumentModelInfo } from "../src";
+import { DocumentModelDetails } from "../src";
 import { Field } from "./utils";
 
 /**
@@ -73,7 +73,7 @@ const documentFeatures = [...layoutFeatures, "keyValuePairs"];
  * @param model - the model to get the features of
  * @returns the list of features supported by the model
  */
-export function getFeatures(model: DocumentModelInfo): string[] {
+export function getFeatures(model: DocumentModelDetails): string[] {
   return (
     (model as any).features ??
     {

sdk/formrecognizer/ai-form-recognizer/bin/writeModelCode.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { EOL } from "os";
-import { DocTypeInfo, DocumentModelInfo } from "../src";
+import { DocumentTypeDetails, DocumentModelDetails } from "../src";
 import { DocumentFieldSchema } from "../src/generated";
 import { DocumentField } from "../src/models";
 import { defaultResultFields, getFeatures } from "./defaultFields";
@@ -24,7 +24,7 @@ const sampleHeader = `// Copyright (c) Microsoft Corporation.
 /**
  * Generate a header with the model information.
  */
-function templateHeader(model: DocumentModelInfo): string {
+function templateHeader(model: DocumentModelDetails): string {
   return `${sampleHeader}
 
 // Model:       ${model.modelId}
@@ -41,7 +41,7 @@ function templateHeader(model: DocumentModelInfo): string {
  * @param model - the ModelInfo to generate code for
  * @returns a string of TypeScript source code
  */
-export async function writeModelCode(model: DocumentModelInfo): Promise<string> {
+export async function writeModelCode(model: DocumentModelDetails): Promise<string> {
   let contents = templateHeader(model);
 
   contents += 'import * as fr from "@azure/ai-form-recognizer";' + EOL + EOL;
@@ -141,7 +141,7 @@ export async function writeModelCode(model: DocumentModelInfo): Promise<string>
 
 // Get the doc type variants of a model.
 function extractModelVariants(
-  model: DocumentModelInfo,
+  model: DocumentModelDetails,
   _rootSlug: string[]
 ): Record<string, DocType> {
   const result: ReturnType<typeof extractModelVariants> = {};
@@ -408,7 +408,7 @@ function* flatMap<T1, T2>(it: Iterable<T1>, f: (v: T1) => T2 | Iterable<T2>): It
 /**
  * Helper interface for representing a DocType during generation, allowing for renaming and contextual, taxonomic naming.
  */
-interface DocType extends DocTypeInfo {
+interface DocType extends DocumentTypeDetails {
   originalDocType: string;
   name: string;
   slug: string[];

sdk/formrecognizer/ai-form-recognizer/recordings/node/api_key_analysis_node_healthinsurancecard__us/recording_png_file_stream.json

@@ -104,7 +104,7 @@ export interface CopyAuthorization {
 }
 
 // @public
-export function createModelFromSchema(schema: Omit<DocumentModelInfo, "createdDateTime">): DocumentModel<AnalyzeResult<unknown>>;
+export function createModelFromSchema(schema: Omit<DocumentModelDetails, "createdDateTime">): DocumentModel<AnalyzeResult<unknown>>;
 
 // @public
 export interface CreateModelOptions extends OperationOptions, CommonModelCreationOptions, PollerOptions<DocumentModelOperationState> {
@@ -117,7 +117,7 @@ export interface CurrencyValue {
 }
 
 // @public
-export interface CustomDocumentModelsInfo {
+export interface CustomDocumentModelsDetails {
     count: number;
     limit: number;
 }
@@ -126,18 +126,6 @@ export interface CustomDocumentModelsInfo {
 export interface DeleteModelOptions extends OperationOptions {
 }
 
-// @public
-export interface DocTypeInfo {
-    buildMode?: DocumentBuildMode;
-    description?: string;
-    fieldConfidence?: {
-        [propertyName: string]: number;
-    };
-    fieldSchema: {
-        [propertyName: string]: DocumentFieldSchema;
-    };
-}
-
 // @public
 export interface DocumentAddressField extends DocumentFieldCommon {
     kind: "address";
@@ -284,9 +272,9 @@ export class DocumentModelAdministrationClient {
     beginCopyModelTo(sourceModelId: string, authorization: CopyAuthorization, options?: BeginCopyModelOptions): Promise<DocumentModelPoller>;
     deleteModel(modelId: string, options?: DeleteModelOptions): Promise<void>;
     getCopyAuthorization(destinationModelId: string, options?: GetCopyAuthorizationOptions): Promise<CopyAuthorization>;
-    getModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelInfo>;
-    getOperation(operationId: string, options?: GetOperationOptions): Promise<OperationInfo>;
-    getResourceInfo(options?: GetResourceInfoOptions): Promise<ResourceInfo>;
+    getModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelDetails>;
+    getOperation(operationId: string, options?: GetOperationOptions): Promise<OperationDetails>;
+    getResourceDetails(options?: GetResourceDetailsOptions): Promise<ResourceDetails>;
     listModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentModelSummary>;
     listOperations(options?: ListOperationsOptions): PagedAsyncIterableIterator<OperationSummary>;
 }
@@ -305,14 +293,14 @@ export const DocumentModelBuildMode: {
 };
 
 // @public
-export interface DocumentModelInfo extends DocumentModelSummary {
+export interface DocumentModelDetails extends DocumentModelSummary {
     docTypes?: {
-        [propertyName: string]: DocTypeInfo;
+        [propertyName: string]: DocumentTypeDetails;
     };
 }
 
 // @public
-export interface DocumentModelOperationState extends PollOperationState<DocumentModelInfo> {
+export interface DocumentModelOperationState extends PollOperationState<DocumentModelDetails> {
     apiVersion?: string;
     createdOn: Date;
     lastUpdatedOn: Date;
@@ -323,7 +311,7 @@ export interface DocumentModelOperationState extends PollOperationState<Document
 }
 
 // @public
-export type DocumentModelPoller = PollerLike<DocumentModelOperationState, DocumentModelInfo>;
+export type DocumentModelPoller = PollerLike<DocumentModelOperationState, DocumentModelDetails>;
 
 // @public
 export interface DocumentModelSummary {
@@ -450,6 +438,18 @@ export interface DocumentTimeField extends DocumentFieldCommon {
     value?: string;
 }
 
+// @public
+export interface DocumentTypeDetails {
+    buildMode?: DocumentBuildMode;
+    description?: string;
+    fieldConfidence?: {
+        [propertyName: string]: number;
+    };
+    fieldSchema: {
+        [propertyName: string]: DocumentFieldSchema;
+    };
+}
+
 // @public
 export interface DocumentValueField<T> extends DocumentFieldCommon {
     value?: T;
@@ -500,10 +500,10 @@ export interface GetOperationOptions extends OperationOptions {
 }
 
 // @public
-export type GetOperationResponse = OperationInfo;
+export type GetOperationResponse = OperationDetails;
 
 // @public
-export interface GetResourceInfoOptions extends OperationOptions {
+export interface GetResourceDetailsOptions extends OperationOptions {
 }
 
 // @public
@@ -530,7 +530,7 @@ export interface ListOperationsOptions extends OperationOptions {
 }
 
 // @public
-export interface OperationInfo extends OperationSummary {
+export interface OperationDetails extends OperationSummary {
     error?: ErrorModel;
     result?: Record<string, unknown>;
 }
@@ -573,8 +573,8 @@ export interface PollerOptions<TState extends PollOperationState<unknown>> exten
 }
 
 // @public
-export interface ResourceInfo {
-    customDocumentModels: CustomDocumentModelsInfo;
+export interface ResourceDetails {
+    customDocumentModels: CustomDocumentModelsDetails;
 }
 
 // @public

sdk/formrecognizer/ai-form-recognizer/recordings/node/api_key_analysis_node_tax__us__w2/recording_png_file_stream.json

@@ -19,7 +19,7 @@ async function main() {
 
   const client = new DocumentModelAdministrationClient(endpoint, credential);
 
-  const info = await client.getResourceInfo();
+  const info = await client.getResourceDetails();
 
   console.log(
     `Custom document models: ${info.customDocumentModels.count} of ${info.customDocumentModels.limit}`

sdk/formrecognizer/ai-form-recognizer/recordings/node/api_key_analysis_node_vaccinationcard/recording_jpg_file_stream.json

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { DocumentFieldSchema, DocumentModelInfo } from "./generated";
+import { DocumentFieldSchema, DocumentModelDetails } from "./generated";
 import { AnalyzedDocument, AnalyzeResult } from "./lro/analysis";
 import { DocumentField } from "./models/fields";
 import { FormRecognizerApiVersion } from "./options";
@@ -87,7 +87,7 @@ function extractField(
  * @returns - a DocumentModel that encodes the schema
  */
 export function createModelFromSchema(
-  schema: Omit<DocumentModelInfo, "createdDateTime">
+  schema: Omit<DocumentModelDetails, "createdDateTime">
 ): DocumentModel<AnalyzeResult<unknown>> {
   return {
     modelId: schema.modelId,

sdk/formrecognizer/ai-form-recognizer/review/ai-form-recognizer.api.md

@@ -9,12 +9,12 @@ import { SDK_VERSION } from "./constants";
 import {
   CopyAuthorization,
   GeneratedClient,
-  ResourceInfo,
+  ResourceDetails,
   GetOperationResponse,
-  DocumentModelInfo,
+  DocumentModelDetails,
   DocumentModelSummary,
   OperationSummary,
-  OperationInfo,
+  OperationDetails,
 } from "./generated";
 import { accept1 } from "./generated/models/parameters";
 import {
@@ -29,7 +29,7 @@ import {
   DeleteModelOptions,
   DocumentModelAdministrationClientOptions,
   GetCopyAuthorizationOptions,
-  GetResourceInfoOptions,
+  GetResourceDetailsOptions,
   GetModelOptions,
   GetOperationOptions,
   ListModelsOptions,
@@ -173,16 +173,16 @@ export class DocumentModelAdministrationClient {
    *   description: "This is an example model!"
    * });
    *
-   * // Model building, like all other model creation operations, returns a poller that eventually produces a ModelInfo
+   * // Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
    * // object
-   * const modelInfo = await poller.pollUntilDone();
+   * const modelDetails = await poller.pollUntilDone();
    *
    * const {
    *   modelId, // identical to the modelId given when creating the model
    *   description, // identical to the description given when creating the model
    *   createdDateTime, // the Date (timestamp) that the model was created
    *   docTypes // information about the document types in the model and their field schemas
-   * } = modelInfo;
+   * } = modelDetails;
    * ```
    *
    * @param modelId - the unique ID of the model to create
@@ -242,15 +242,15 @@ export class DocumentModelAdministrationClient {
    * });
    *
    * // Model composition, like all other model creation operations, returns a poller that eventually produces a
-   * // ModelInfo object
-   * const modelInfo = await poller.pollUntilDone();
+   * // ModelDetails object
+   * const modelDetails = await poller.pollUntilDone();
    *
    * const {
    *   modelId, // identical to the modelId given when creating the model
    *   description, // identical to the description given when creating the model
    *   createdDateTime, // the Date (timestamp) that the model was created
    *   docTypes // information about the document types of the composed submodels
-   * } = modelInfo;
+   * } = modelDetails;
    * ```
    *
    * @param modelId - the unique ID of the model to create
@@ -342,16 +342,16 @@ export class DocumentModelAdministrationClient {
    * // Finally, use the _source_ client to copy the model and await the copy operation
    * const poller = await sourceClient.beginCopyModelTo("<source model ID>");
    *
-   * // Model copying, like all other model creation operations, returns a poller that eventually produces a ModelInfo
+   * // Model copying, like all other model creation operations, returns a poller that eventually produces a ModelDetails
    * // object
-   * const modelInfo = await poller.pollUntilDone();
+   * const modelDetails = await poller.pollUntilDone();
    *
    * const {
    *   modelId, // identical to the modelId given when creating the copy authorization
    *   description, // identical to the description given when creating the copy authorization
    *   createdDateTime, // the Date (timestamp) that the model was created
    *   docTypes // information about the document types of the model (identical to the original, source model)
-   * } = modelInfo;
+   * } = modelDetails;
    * ```
    *
    * @param sourceModelId - the unique ID of the source model that will be copied
@@ -382,7 +382,7 @@ export class DocumentModelAdministrationClient {
    * This is the meat of the above model creation operations.
    *
    * @param definition - operation definition (start operation method, request options)
-   * @returns a model poller (produces a ModelInfo)
+   * @returns a model poller (produces a ModelDetails)
    */
   private async createDocumentModelPoller(
     definition: TrainingOperationDefinition
@@ -413,7 +413,7 @@ export class DocumentModelAdministrationClient {
                     httpMethod: "GET",
                     responses: {
                       200: {
-                        bodyMapper: Mappers.OperationInfo,
+                        bodyMapper: Mappers.OperationDetails,
                       },
                       default: {
                         bodyMapper: Mappers.ErrorResponse,
@@ -436,7 +436,7 @@ export class DocumentModelAdministrationClient {
               }
             );
 
-    const poller = await lro<DocumentModelInfo, DocumentModelOperationState>(
+    const poller = await lro<DocumentModelDetails, DocumentModelOperationState>(
       {
         init: async () => toTrainingPollOperationState(await toInit()),
         poll: async ({ operationId }) =>
@@ -474,28 +474,28 @@ export class DocumentModelAdministrationClient {
    * ```javascript
    * const {
    *   // Information about the custom models in the current resource
-   *   customDocumentModelInfo: {
+   *   customDocumentModelDetails: {
    *     // The number of custom models in the current resource
    *     count,
    *     // The maximum number of models that the current resource can support
    *     limit
    *   }
-   * } = await client.getInfo();
+   * } = await client.getResourceDetails();
    * ```
    *
    * @param options - optional settings for the request
    * @returns basic information about this client's resource
    */
-  public getResourceInfo(options: GetResourceInfoOptions = {}): Promise<ResourceInfo> {
+  public getResourceDetails(options: GetResourceDetailsOptions = {}): Promise<ResourceDetails> {
     return this._tracing.withSpan(
-      "DocumentModelAdministrationClient.getResourceInfo",
+      "DocumentModelAdministrationClient.getResourceDetails",
       options,
-      (finalOptions) => this._restClient.getResourceInfo(finalOptions)
+      (finalOptions) => this._restClient.getResourceDetails(finalOptions)
     );
   }
 
   /**
-   * Retrieves information about a model ({@link ModelInfo}) by ID.
+   * Retrieves information about a model ({@link ModelDetails}) by ID.
    *
    * This method can retrieve information about custom as well as prebuilt models.
    *
@@ -536,7 +536,7 @@ export class DocumentModelAdministrationClient {
    * @param options - optional settings for the request
    * @returns information about the model with the given ID
    */
-  public getModel(modelId: string, options: GetModelOptions = {}): Promise<DocumentModelInfo> {
+  public getModel(modelId: string, options: GetModelOptions = {}): Promise<DocumentModelDetails> {
     return this._tracing.withSpan(
       "DocumentModelAdministrationClient.getModel",
       options,
@@ -606,7 +606,7 @@ export class DocumentModelAdministrationClient {
   }
 
   /**
-   * Retrieves information about an operation (`OperationInfo`) by its ID.
+   * Retrieves information about an operation (`OperationDetails`) by its ID.
    *
    * Operations represent non-analysis tasks, such as building, composing, or copying a model.
    *
@@ -633,7 +633,7 @@ export class DocumentModelAdministrationClient {
   public getOperation(
     operationId: string,
     options: GetOperationOptions = {}
-  ): Promise<OperationInfo> {
+  ): Promise<OperationDetails> {
     return this._tracing.withSpan(
       "DocumentModelAdministrationClient.getOperation",
       options,