ComputerVisionModels.ComputerVisionClientReadOptionalParams.yml

### YamlMime:TSType
name: ComputerVisionClientReadOptionalParams
uid: >-
  @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams
package: '@azure/cognitiveservices-computervision'
summary: Optional Parameters.
fullName: ComputerVisionClientReadOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: language
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.language
    package: '@azure/cognitiveservices-computervision'
    summary: >-
      The BCP-47 language code of the text in the document. Read supports auto
      language

      identification and multi-language documents, so only provide a language
      code if you would like

      to force the document to be processed in that specific language. See

      https://aka.ms/ocr-languages for list of supported languages. Possible
      values include: 'af',

      'ast', 'bi', 'br', 'ca', 'ceb', 'ch', 'co', 'crh', 'cs', 'csb', 'da',
      'de', 'en', 'es', 'et',

      'eu', 'fi', 'fil', 'fj', 'fr', 'fur', 'fy', 'ga', 'gd', 'gil', 'gl', 'gv',
      'hni', 'hsb', 'ht',

      'hu', 'ia', 'id', 'it', 'iu', 'ja', 'jv', 'kaa', 'kac', 'kea', 'kha',
      'kl', 'ko', 'ku', 'kw',

      'lb', 'ms', 'mww', 'nap', 'nl', 'no', 'oc', 'pl', 'pt', 'quc', 'rm',
      'sco', 'sl', 'sq', 'sv',

      'sw', 'tet', 'tr', 'tt', 'uz', 'vo', 'wae', 'yua', 'za', 'zh-Hans',
      'zh-Hant', 'zu'
    fullName: language
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'language?: OcrDetectionLanguage'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/cognitiveservices-computervision.ComputerVisionModels.OcrDetectionLanguage"
          />
  - name: modelVersion
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.modelVersion
    package: '@azure/cognitiveservices-computervision'
    summary: >-
      Optional parameter to specify the version of the OCR model used for text
      extraction. Accepted

      values are: "latest", "latest-preview", "2021-04-12". Defaults to
      "latest". Default value:

      'latest'.
    fullName: modelVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'modelVersion?: string'
      return:
        description: ''
        type: string
  - name: pages
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.pages
    package: '@azure/cognitiveservices-computervision'
    summary: >-
      Custom page numbers for multi-page documents(PDF/TIFF), input the number
      of the pages you want

      to get OCR result. For a range of pages, use a hyphen. Separate each page
      or range with a

      comma.
    fullName: pages
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'pages?: string[]'
      return:
        description: ''
        type: string[]
  - name: readingOrder
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.readingOrder
    package: '@azure/cognitiveservices-computervision'
    summary: >-
      Optional parameter to specify which reading order algorithm should be
      applied when ordering

      the extract text elements. Can be either 'basic' or 'natural'. Will
      default to 'basic' if not

      specified. Default value: 'basic'.
    fullName: readingOrder
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'readingOrder?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: abortSignal
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.abortSignal
    package: '@azure/cognitiveservices-computervision'
    summary: The signal which can be used to abort requests.
    fullName: abortSignal
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.AbortSignalLike" />
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.abortSignal
  - name: customHeaders
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.customHeaders
    package: '@azure/cognitiveservices-computervision'
    summary: |-
      User defined custom request headers that
      will be applied before the request is sent.
    fullName: customHeaders
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customHeaders?: {[key: string]: string}'
      return:
        description: ''
        type: '{[key: string]: string}'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.customHeaders
  - name: onDownloadProgress
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.onDownloadProgress
    package: '@azure/cognitiveservices-computervision'
    summary: Callback which fires upon download progress.
    fullName: onDownloadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onDownloadProgress
  - name: onUploadProgress
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.onUploadProgress
    package: '@azure/cognitiveservices-computervision'
    summary: Callback which fires upon upload progress.
    fullName: onUploadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onUploadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onUploadProgress
  - name: timeout
    uid: >-
      @azure/cognitiveservices-computervision.ComputerVisionModels.ComputerVisionClientReadOptionalParams.timeout
    package: '@azure/cognitiveservices-computervision'
    summary: >-
      The number of milliseconds a request can take before automatically being
      terminated.
    fullName: timeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'timeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.timeout
extends: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />