FormRecognizerClient.yml

### YamlMime:TSType
name: FormRecognizerClient
uid: '@azure/cognitiveservices-formrecognizer.FormRecognizerClient'
package: '@azure/cognitiveservices-formrecognizer'
summary: ''
fullName: FormRecognizerClient
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: >-
      FormRecognizerClient(ServiceClientCredentials, string,
      ServiceClientOptions)
    uid: '@azure/cognitiveservices-formrecognizer.FormRecognizerClient.constructor'
    package: '@azure/cognitiveservices-formrecognizer'
    summary: Initializes a new instance of the FormRecognizerClient class.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new FormRecognizerClient(credentials: ServiceClientCredentials,
        endpoint: string, options?: ServiceClientOptions)
      parameters:
        - id: credentials
          type: <xref uid="@azure/ms-rest-js.ServiceClientCredentials" />
          description: >-
            Subscription credentials which uniquely identify client
            subscription.
        - id: endpoint
          type: string
          description: >-
            Supported Cognitive Services endpoints (protocol and hostname, for
            example:

            https://westus2.api.cognitive.microsoft.com).
        - id: options
          type: <xref uid="@azure/ms-rest-js.ServiceClientOptions" />
          description: The parameter options
inheritedProperties:
  - name: credentials
    uid: '@azure/cognitiveservices-formrecognizer.FormRecognizerClient.credentials'
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    fullName: credentials
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'credentials: ServiceClientCredentials'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.ServiceClientCredentials" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [FormRecognizerClientContext.credentials](xref:@azure/cognitiveservices-formrecognizer.FormRecognizerClientContext.credentials)
  - name: endpoint
    uid: '@azure/cognitiveservices-formrecognizer.FormRecognizerClient.endpoint'
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    fullName: endpoint
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'endpoint: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [FormRecognizerClientContext.endpoint](xref:@azure/cognitiveservices-formrecognizer.FormRecognizerClientContext.endpoint)
inheritedMethods:
  - name: >-
      sendOperationRequest(OperationArguments, OperationSpec,
      ServiceCallback<any>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.sendOperationRequest
    package: '@azure/cognitiveservices-formrecognizer'
    summary: Send an HTTP request that is populated using the provided OperationSpec.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function sendOperationRequest(operationArguments: OperationArguments,
        operationSpec: OperationSpec, callback?: ServiceCallback<any>):
        Promise<RestResponse>
      parameters:
        - id: operationArguments
          type: <xref uid="@azure/ms-rest-js.OperationArguments" />
          description: >-
            The arguments that the HTTP request's templated values will be
            populated from.
        - id: operationSpec
          type: <xref uid="@azure/ms-rest-js.OperationSpec" />
          description: The OperationSpec to use to populate the httpRequest.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;any&gt;
          description: The callback to call when the response is received.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/ms-rest-js.RestResponse" />&gt;
    inheritanceDescription: >-
      <b>Inherited From</b>
      [FormRecognizerClientContext.sendOperationRequest](xref:@azure/cognitiveservices-formrecognizer.FormRecognizerClientContext.sendOperationRequest)
  - name: sendRequest(RequestPrepareOptions | WebResourceLike)
    uid: '@azure/cognitiveservices-formrecognizer.FormRecognizerClient.sendRequest'
    package: '@azure/cognitiveservices-formrecognizer'
    summary: Send the provided httpRequest.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function sendRequest(options: RequestPrepareOptions | WebResourceLike):
        Promise<HttpOperationResponse>
      parameters:
        - id: options
          type: >-
            <xref uid="@azure/ms-rest-js.RequestPrepareOptions" /> | <xref
            uid="@azure/ms-rest-js.WebResourceLike" />
          description: ''
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/ms-rest-js.HttpOperationResponse" />&gt;
    inheritanceDescription: >-
      <b>Inherited From</b>
      [FormRecognizerClientContext.sendRequest](xref:@azure/cognitiveservices-formrecognizer.FormRecognizerClientContext.sendRequest)
methods:
  - name: >-
      analyzeWithCustomModel(string, HttpRequestBody,
      FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.analyzeWithCustomModel
    package: '@azure/cognitiveservices-formrecognizer'
    summary: >-
      Extract key-value pairs from a given document. The input document must be
      of one of the

      supported content types - 'application/pdf', 'image/jpeg' or 'image/png'.
      A success response is

      returned in JSON.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function analyzeWithCustomModel(id: string, formStream: HttpRequestBody,
        options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams):
        Promise<AnalyzeWithCustomModelResponse>
      parameters:
        - id: id
          type: string
          description: Model Identifier to analyze the document with.
        - id: formStream
          type: <xref uid="@azure/ms-rest-js.HttpRequestBody" />
          description: A pdf document or image (jpg,png) file to analyze.
        - id: options
          type: >-
            <xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.FormRecognizerClientAnalyzeWithCustomModelOptionalParams"
            />
          description: The optional parameters
      return:
        description: Promise<Models.AnalyzeWithCustomModelResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.AnalyzeWithCustomModelResponse"
          />&gt;
  - name: >-
      analyzeWithCustomModel(string, HttpRequestBody,
      FormRecognizerClientAnalyzeWithCustomModelOptionalParams,
      ServiceCallback<AnalyzeResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.analyzeWithCustomModel_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function analyzeWithCustomModel(id: string, formStream: HttpRequestBody,
        options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams,
        callback: ServiceCallback<AnalyzeResult>)
      parameters:
        - id: id
          type: string
          description: Model Identifier to analyze the document with.
        - id: formStream
          type: <xref uid="@azure/ms-rest-js.HttpRequestBody" />
          description: A pdf document or image (jpg,png) file to analyze.
        - id: options
          type: >-
            <xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.FormRecognizerClientAnalyzeWithCustomModelOptionalParams"
            />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.AnalyzeResult"
            />&gt;
          description: The callback
  - name: >-
      analyzeWithCustomModel(string, HttpRequestBody,
      ServiceCallback<AnalyzeResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.analyzeWithCustomModel_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function analyzeWithCustomModel(id: string, formStream: HttpRequestBody,
        callback: ServiceCallback<AnalyzeResult>)
      parameters:
        - id: id
          type: string
          description: Model Identifier to analyze the document with.
        - id: formStream
          type: <xref uid="@azure/ms-rest-js.HttpRequestBody" />
          description: A pdf document or image (jpg,png) file to analyze.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.AnalyzeResult"
            />&gt;
          description: The callback
  - name: batchReadReceipt(string, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.batchReadReceipt
    package: '@azure/cognitiveservices-formrecognizer'
    summary: >-
      Batch Read Receipt operation. The response contains a field called
      'Operation-Location', which

      contains the URL that you must use for your 'Get Read Receipt Result'
      operation.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function batchReadReceipt(url: string, options?: RequestOptionsBase):
        Promise<BatchReadReceiptResponse>
      parameters:
        - id: url
          type: string
          description: Publicly reachable URL of an image.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.BatchReadReceiptResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.BatchReadReceiptResponse"
          />&gt;
  - name: batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.batchReadReceipt_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function batchReadReceipt(url: string, options: RequestOptionsBase,
        callback: ServiceCallback<void>)
      parameters:
        - id: url
          type: string
          description: Publicly reachable URL of an image.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: batchReadReceipt(string, ServiceCallback<void>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.batchReadReceipt_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function batchReadReceipt(url: string, callback: ServiceCallback<void>)'
      parameters:
        - id: url
          type: string
          description: Publicly reachable URL of an image.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.batchReadReceiptInStream
    package: '@azure/cognitiveservices-formrecognizer'
    summary: >-
      Read Receipt operation. When you use the 'Batch Read Receipt' interface,
      the response contains a

      field called 'Operation-Location'. The 'Operation-Location' field contains
      the URL that you must

      use for your 'Get Read Receipt Result' operation.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function batchReadReceiptInStream(image: HttpRequestBody, options?:
        RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>
      parameters:
        - id: image
          type: <xref uid="@azure/ms-rest-js.HttpRequestBody" />
          description: An image stream.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.BatchReadReceiptInStreamResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.BatchReadReceiptInStreamResponse"
          />&gt;
  - name: >-
      batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase,
      ServiceCallback<void>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.batchReadReceiptInStream_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function batchReadReceiptInStream(image: HttpRequestBody, options:
        RequestOptionsBase, callback: ServiceCallback<void>)
      parameters:
        - id: image
          type: <xref uid="@azure/ms-rest-js.HttpRequestBody" />
          description: An image stream.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.batchReadReceiptInStream_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function batchReadReceiptInStream(image: HttpRequestBody, callback:
        ServiceCallback<void>)
      parameters:
        - id: image
          type: <xref uid="@azure/ms-rest-js.HttpRequestBody" />
          description: An image stream.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: deleteCustomModel(string, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.deleteCustomModel
    package: '@azure/cognitiveservices-formrecognizer'
    summary: Delete model artifacts.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteCustomModel(id: string, options?: RequestOptionsBase):
        Promise<RestResponse>
      parameters:
        - id: id
          type: string
          description: The identifier of the model to delete.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<msRest.RestResponse>
        type: Promise&lt;<xref uid="@azure/ms-rest-js.RestResponse" />&gt;
  - name: deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.deleteCustomModel_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteCustomModel(id: string, options: RequestOptionsBase,
        callback: ServiceCallback<void>)
      parameters:
        - id: id
          type: string
          description: The identifier of the model to delete.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: deleteCustomModel(string, ServiceCallback<void>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.deleteCustomModel_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function deleteCustomModel(id: string, callback: ServiceCallback<void>)'
      parameters:
        - id: id
          type: string
          description: The identifier of the model to delete.
        - id: callback
          type: <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;void&gt;
          description: The callback
  - name: getCustomModel(string, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getCustomModel
    package: '@azure/cognitiveservices-formrecognizer'
    summary: Get information about a model.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getCustomModel(id: string, options?: RequestOptionsBase):
        Promise<GetCustomModelResponse>
      parameters:
        - id: id
          type: string
          description: Model identifier.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.GetCustomModelResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.GetCustomModelResponse"
          />&gt;
  - name: getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getCustomModel_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getCustomModel(id: string, options: RequestOptionsBase,
        callback: ServiceCallback<ModelResult>)
      parameters:
        - id: id
          type: string
          description: Model identifier.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.ModelResult"
            />&gt;
          description: The callback
  - name: getCustomModel(string, ServiceCallback<ModelResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getCustomModel_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getCustomModel(id: string, callback:
        ServiceCallback<ModelResult>)
      parameters:
        - id: id
          type: string
          description: Model identifier.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.ModelResult"
            />&gt;
          description: The callback
  - name: getCustomModels(RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getCustomModels
    package: '@azure/cognitiveservices-formrecognizer'
    summary: Get information about all trained custom models
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getCustomModels(options?: RequestOptionsBase):
        Promise<GetCustomModelsResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.GetCustomModelsResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.GetCustomModelsResponse"
          />&gt;
  - name: getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getCustomModels_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getCustomModels(options: RequestOptionsBase, callback:
        ServiceCallback<ModelsResult>)
      parameters:
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.ModelsResult"
            />&gt;
          description: The callback
  - name: getCustomModels(ServiceCallback<ModelsResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getCustomModels_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getCustomModels(callback: ServiceCallback<ModelsResult>)'
      parameters:
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.ModelsResult"
            />&gt;
          description: The callback
  - name: getExtractedKeys(string, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getExtractedKeys
    package: '@azure/cognitiveservices-formrecognizer'
    summary: |-
      Retrieve the keys that were
      extracted during the training of the specified model.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getExtractedKeys(id: string, options?: RequestOptionsBase):
        Promise<GetExtractedKeysResponse>
      parameters:
        - id: id
          type: string
          description: Model identifier.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.GetExtractedKeysResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.GetExtractedKeysResponse"
          />&gt;
  - name: getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getExtractedKeys_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getExtractedKeys(id: string, options: RequestOptionsBase,
        callback: ServiceCallback<KeysResult>)
      parameters:
        - id: id
          type: string
          description: Model identifier.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.KeysResult"
            />&gt;
          description: The callback
  - name: getExtractedKeys(string, ServiceCallback<KeysResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getExtractedKeys_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getExtractedKeys(id: string, callback:
        ServiceCallback<KeysResult>)
      parameters:
        - id: id
          type: string
          description: Model identifier.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.KeysResult"
            />&gt;
          description: The callback
  - name: getReadReceiptResult(string, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getReadReceiptResult
    package: '@azure/cognitiveservices-formrecognizer'
    summary: >-
      This interface is used for getting the analysis results of a 'Batch Read
      Receipt' operation. The

      URL to this interface should be retrieved from the 'Operation-Location'
      field returned from the

      'Batch Read Receipt' operation.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getReadReceiptResult(operationId: string, options?:
        RequestOptionsBase): Promise<GetReadReceiptResultResponse>
      parameters:
        - id: operationId
          type: string
          description: >-
            Id of read operation returned in the response of a 'Batch Read
            Receipt'

            operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.GetReadReceiptResultResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.GetReadReceiptResultResponse"
          />&gt;
  - name: >-
      getReadReceiptResult(string, RequestOptionsBase,
      ServiceCallback<ReadReceiptResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getReadReceiptResult_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getReadReceiptResult(operationId: string, options:
        RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)
      parameters:
        - id: operationId
          type: string
          description: >-
            Id of read operation returned in the response of a 'Batch Read
            Receipt'

            operation.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.ReadReceiptResult"
            />&gt;
          description: The callback
  - name: getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.getReadReceiptResult_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getReadReceiptResult(operationId: string, callback:
        ServiceCallback<ReadReceiptResult>)
      parameters:
        - id: operationId
          type: string
          description: >-
            Id of read operation returned in the response of a 'Batch Read
            Receipt'

            operation.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.ReadReceiptResult"
            />&gt;
          description: The callback
  - name: trainCustomModel(TrainRequest, RequestOptionsBase)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.trainCustomModel
    package: '@azure/cognitiveservices-formrecognizer'
    summary: >-
      Create and train a custom model. The train request must include a source
      parameter that is

      either an externally accessible Azure Storage blob container Uri
      (preferably a Shared Access

      Signature Uri) or valid path to a data folder in a locally mounted drive.
      When local paths are

      specified, they must follow the Linux/Unix path format and be an absolute
      path rooted to the

      input mount configuration

      setting value e.g., if '{Mounts:Input}' configuration setting value is
      '/input' then a valid

      source path would be '/input/contosodataset'. All data to be trained is
      expected to be directly

      under the source folder. Subfolders are not supported. Models are trained
      using documents that

      are of the following content type - 'application/pdf', 'image/jpeg' and
      'image/png'."

      Other type of content is ignored.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function trainCustomModel(trainRequest: TrainRequest, options?:
        RequestOptionsBase): Promise<TrainCustomModelResponse>
      parameters:
        - id: trainRequest
          type: >-
            <xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.TrainRequest"
            />
          description: Request object for training.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
      return:
        description: Promise<Models.TrainCustomModelResponse>
        type: >-
          Promise&lt;<xref
          uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.TrainCustomModelResponse"
          />&gt;
  - name: >-
      trainCustomModel(TrainRequest, RequestOptionsBase,
      ServiceCallback<TrainResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.trainCustomModel_2
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function trainCustomModel(trainRequest: TrainRequest, options:
        RequestOptionsBase, callback: ServiceCallback<TrainResult>)
      parameters:
        - id: trainRequest
          type: >-
            <xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.TrainRequest"
            />
          description: Request object for training.
        - id: options
          type: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />
          description: The optional parameters
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.TrainResult"
            />&gt;
          description: The callback
  - name: trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
    uid: >-
      @azure/cognitiveservices-formrecognizer.FormRecognizerClient.trainCustomModel_1
    package: '@azure/cognitiveservices-formrecognizer'
    summary: ''
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function trainCustomModel(trainRequest: TrainRequest, callback:
        ServiceCallback<TrainResult>)
      parameters:
        - id: trainRequest
          type: >-
            <xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.TrainRequest"
            />
          description: Request object for training.
        - id: callback
          type: >-
            <xref uid="@azure/ms-rest-js.ServiceCallback" />&lt;<xref
            uid="@azure/cognitiveservices-formrecognizer.FormRecognizerModels.TrainResult"
            />&gt;
          description: The callback
extends: >-
  <xref
  uid="@azure/cognitiveservices-formrecognizer.FormRecognizerClientContext" />