RubyDoc.info: Class: Azure::CognitiveServices::ComputerVision::V2_0::ComputerVisionClient – Documentation for azure_cognitiveservices_computervision (0.20.2)

#analyze_image(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `ImageAnalysis`

This operation extracts a rich set of visual features based on the image content. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult

detects if the image is pornographic in nature (depicts nudity or a sex

act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
visual_features (Array<VisualFeatureTypes>) (defaults to: nil) —

A string indicating what
details (Array<Details>) (defaults to: nil) —

A string indicating which domain-specific
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(ImageAnalysis) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 156

def analyze_image(url, visual_features:nil, details:nil, language:nil, custom_headers:nil)
  response = analyze_image_async(url, visual_features:visual_features, details:details, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#analyze_image_async(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation extracts a rich set of visual features based on the image content. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult

detects if the image is pornographic in nature (depicts nudity or a sex

act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
visual_features (Array<VisualFeatureTypes>) (defaults to: nil) —

A string indicating what
details (Array<Details>) (defaults to: nil) —

A string indicating which domain-specific
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 247

def analyze_image_async(url, visual_features:nil, details:nil, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'analyze'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'visualFeatures' => visual_features.nil? ? nil : visual_features.join(','),'details' => details.nil? ? nil : details.join(','),'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageAnalysis.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#analyze_image_by_domain(model, url, language: nil, custom_headers: nil) ⇒ `DomainModelResults`

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

model (String) —

The domain-specific content to recognize.
url (String) —

Publicly reachable URL of an image.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(DomainModelResults) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 696

def analyze_image_by_domain(model, url, language:nil, custom_headers:nil)
  response = analyze_image_by_domain_async(model, url, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#analyze_image_by_domain_async(model, url, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

model (String) —

The domain-specific content to recognize.
url (String) —

Publicly reachable URL of an image.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 753

def analyze_image_by_domain_async(model, url, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'model is nil' if model.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'models/{model}/analyze'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'model' => model},
      query_params: {'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::DomainModelResults.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#analyze_image_by_domain_in_stream(model, image, language: nil, custom_headers: nil) ⇒ `DomainModelResults`

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

model (String) —

The domain-specific content to recognize.
image —

An image stream.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(DomainModelResults) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2571

def analyze_image_by_domain_in_stream(model, image, language:nil, custom_headers:nil)
  response = analyze_image_by_domain_in_stream_async(model, image, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#analyze_image_by_domain_in_stream_async(model, image, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

model (String) —

The domain-specific content to recognize.
image —

An image stream.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2628

def analyze_image_by_domain_in_stream_async(model, image, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'model is nil' if model.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'models/{model}/analyze'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'model' => model},
      query_params: {'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::DomainModelResults.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#analyze_image_by_domain_in_stream_with_http_info(model, image, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

model (String) —

The domain-specific content to recognize.
image —

An image stream.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2600
2601
2602

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2600

def analyze_image_by_domain_in_stream_with_http_info(model, image, language:nil, custom_headers:nil)
  analyze_image_by_domain_in_stream_async(model, image, language:language, custom_headers:custom_headers).value!
end

#analyze_image_by_domain_with_http_info(model, url, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

model (String) —

The domain-specific content to recognize.
url (String) —

Publicly reachable URL of an image.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



725
726
727

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 725

def analyze_image_by_domain_with_http_info(model, url, language:nil, custom_headers:nil)
  analyze_image_by_domain_async(model, url, language:language, custom_headers:custom_headers).value!
end

#analyze_image_in_stream(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `ImageAnalysis`

This operation extracts a rich set of visual features based on the image content. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult

detects if the image is pornographic in nature (depicts nudity or a sex

act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

image —

An image stream.
visual_features (Array<VisualFeatureTypes>) (defaults to: nil) —

A string indicating what
details (Array<Details>) (defaults to: nil) —

A string indicating which domain-specific
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(ImageAnalysis) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1839

def analyze_image_in_stream(image, visual_features:nil, details:nil, language:nil, custom_headers:nil)
  response = analyze_image_in_stream_async(image, visual_features:visual_features, details:details, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#analyze_image_in_stream_async(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation extracts a rich set of visual features based on the image content. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult

detects if the image is pornographic in nature (depicts nudity or a sex

act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

image —

An image stream.
visual_features (Array<VisualFeatureTypes>) (defaults to: nil) —

A string indicating what
details (Array<Details>) (defaults to: nil) —

A string indicating which domain-specific
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1930

def analyze_image_in_stream_async(image, visual_features:nil, details:nil, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'analyze'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'visualFeatures' => visual_features.nil? ? nil : visual_features.join(','),'details' => details.nil? ? nil : details.join(','),'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageAnalysis.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#analyze_image_in_stream_with_http_info(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation extracts a rich set of visual features based on the image content. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult

detects if the image is pornographic in nature (depicts nudity or a sex

act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

image —

An image stream.
visual_features (Array<VisualFeatureTypes>) (defaults to: nil) —

A string indicating what
details (Array<Details>) (defaults to: nil) —

A string indicating which domain-specific
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1885
1886
1887

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1885

def analyze_image_in_stream_with_http_info(image, visual_features:nil, details:nil, language:nil, custom_headers:nil)
  analyze_image_in_stream_async(image, visual_features:visual_features, details:details, language:language, custom_headers:custom_headers).value!
end

#analyze_image_with_http_info(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation extracts a rich set of visual features based on the image content. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult

detects if the image is pornographic in nature (depicts nudity or a sex

act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English. details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
visual_features (Array<VisualFeatureTypes>) (defaults to: nil) —

A string indicating what
details (Array<Details>) (defaults to: nil) —

A string indicating which domain-specific
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



202
203
204

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 202

def analyze_image_with_http_info(url, visual_features:nil, details:nil, language:nil, custom_headers:nil)
  analyze_image_async(url, visual_features:visual_features, details:details, language:language, custom_headers:custom_headers).value!
end

#batch_read_file(url, custom_headers: nil) ⇒ `Object`

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘GetReadOperationResult’ operation to access OCR results.

will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1610

def batch_read_file(url, custom_headers:nil)
  response = batch_read_file_async(url, custom_headers:custom_headers).value!
  nil
end

#batch_read_file_async(url, custom_headers: nil) ⇒ `Concurrent::Promise`

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘GetReadOperationResult’ operation to access OCR results.

to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1647

def batch_read_file_async(url, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'read/core/asyncBatchAnalyze'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#batch_read_file_in_stream(image, custom_headers: nil) ⇒ `Object`

Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘Get Read Result operation’ to access OCR results.

will be added to the HTTP request.

Parameters:

image —

An image stream.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 3114

def batch_read_file_in_stream(image, custom_headers:nil)
  response = batch_read_file_in_stream_async(image, custom_headers:custom_headers).value!
  nil
end

#batch_read_file_in_stream_async(image, custom_headers: nil) ⇒ `Concurrent::Promise`

Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘Get Read Result operation’ to access OCR results.

to the HTTP request.

Parameters:

image —

An image stream.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 3151

def batch_read_file_in_stream_async(image, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'read/core/asyncBatchAnalyze'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#batch_read_file_in_stream_with_http_info(image, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘Get Read Result operation’ to access OCR results.

will be added to the HTTP request.

Parameters:

image —

An image stream.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



3133
3134
3135

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 3133

def batch_read_file_in_stream_with_http_info(image, custom_headers:nil)
  batch_read_file_in_stream_async(image, custom_headers:custom_headers).value!
end

#batch_read_file_with_http_info(url, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘GetReadOperationResult’ operation to access OCR results.

will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1629
1630
1631

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1629

def batch_read_file_with_http_info(url, custom_headers:nil)
  batch_read_file_async(url, custom_headers:custom_headers).value!
end

#describe_image(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `ImageDescription`

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

be returned. The default is 1. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
max_candidates (Integer) (defaults to: 1) —

Maximum number of candidate descriptions to
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(ImageDescription) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 336

def describe_image(url, max_candidates:1, language:nil, custom_headers:nil)
  response = describe_image_async(url, max_candidates:max_candidates, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#describe_image_async(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

be returned. The default is 1. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
max_candidates (Integer) (defaults to: 1) —

Maximum number of candidate descriptions to
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 395

def describe_image_async(url, max_candidates:1, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'describe'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxCandidates' => max_candidates,'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageDescription.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#describe_image_in_stream(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `ImageDescription`

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

be returned. The default is 1. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

image —

An image stream.
max_candidates (Integer) (defaults to: 1) —

Maximum number of candidate descriptions to
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(ImageDescription) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2143

def describe_image_in_stream(image, max_candidates:1, language:nil, custom_headers:nil)
  response = describe_image_in_stream_async(image, max_candidates:max_candidates, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#describe_image_in_stream_async(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

be returned. The default is 1. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

image —

An image stream.
max_candidates (Integer) (defaults to: 1) —

Maximum number of candidate descriptions to
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2202

def describe_image_in_stream_async(image, max_candidates:1, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'describe'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'maxCandidates' => max_candidates,'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageDescription.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#describe_image_in_stream_with_http_info(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

be returned. The default is 1. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

image —

An image stream.
max_candidates (Integer) (defaults to: 1) —

Maximum number of candidate descriptions to
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2173
2174
2175

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2173

def describe_image_in_stream_with_http_info(image, max_candidates:1, language:nil, custom_headers:nil)
  describe_image_in_stream_async(image, max_candidates:max_candidates, language:language, custom_headers:custom_headers).value!
end

#describe_image_with_http_info(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

be returned. The default is 1. parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
max_candidates (Integer) (defaults to: 1) —

Maximum number of candidate descriptions to
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



366
367
368

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 366

def describe_image_with_http_info(url, max_candidates:1, language:nil, custom_headers:nil)
  describe_image_async(url, max_candidates:max_candidates, language:language, custom_headers:custom_headers).value!
end

#detect_objects(url, custom_headers: nil) ⇒ `DetectResult`

Performs object detection on the specified image. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(DetectResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 473

def detect_objects(url, custom_headers:nil)
  response = detect_objects_async(url, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#detect_objects_async(url, custom_headers: nil) ⇒ `Concurrent::Promise`

Performs object detection on the specified image. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 510

def detect_objects_async(url, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'detect'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::DetectResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#detect_objects_in_stream(image, custom_headers: nil) ⇒ `DetectResult`

Performs object detection on the specified image. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

will be added to the HTTP request.

Parameters:

image —

An image stream.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(DetectResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2282

def detect_objects_in_stream(image, custom_headers:nil)
  response = detect_objects_in_stream_async(image, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#detect_objects_in_stream_async(image, custom_headers: nil) ⇒ `Concurrent::Promise`

Performs object detection on the specified image. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

to the HTTP request.

Parameters:

image —

An image stream.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2319

def detect_objects_in_stream_async(image, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'detect'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::DetectResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#detect_objects_in_stream_with_http_info(image, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Performs object detection on the specified image. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

will be added to the HTTP request.

Parameters:

image —

An image stream.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2301
2302
2303

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2301

def detect_objects_in_stream_with_http_info(image, custom_headers:nil)
  detect_objects_in_stream_async(image, custom_headers:custom_headers).value!
end

#detect_objects_with_http_info(url, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Performs object detection on the specified image. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



492
493
494

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 492

def detect_objects_with_http_info(url, custom_headers:nil)
  detect_objects_async(url, custom_headers:custom_headers).value!
end

#generate_thumbnail(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ `NOT_IMPLEMENTED`

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

1 and 1024. Recommended minimum of 50. between 1 and 1024. Recommended minimum of 50. will be added to the HTTP request.

Parameters:

width (Integer) —

Width of the thumbnail, in pixels. It must be between
height (Integer) —

Height of the thumbnail, in pixels. It must be
url (String) —

Publicly reachable URL of an image.
smart_cropping (Boolean) (defaults to: false) —

Boolean flag for enabling smart cropping.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(NOT_IMPLEMENTED) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1138

def generate_thumbnail(width, height, url, smart_cropping:false, custom_headers:nil)
  response = generate_thumbnail_async(width, height, url, smart_cropping:smart_cropping, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#generate_thumbnail_async(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

1 and 1024. Recommended minimum of 50. between 1 and 1024. Recommended minimum of 50. to the HTTP request.

Parameters:

width (Integer) —

Width of the thumbnail, in pixels. It must be between
height (Integer) —

Height of the thumbnail, in pixels. It must be
url (String) —

Publicly reachable URL of an image.
smart_cropping (Boolean) (defaults to: false) —

Boolean flag for enabling smart cropping.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1197

def generate_thumbnail_async(width, height, url, smart_cropping:false, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'width is nil' if width.nil?
  fail ArgumentError, "'width' should satisfy the constraint - 'InclusiveMaximum': '1024'" if !width.nil? && width > 1024
  fail ArgumentError, "'width' should satisfy the constraint - 'InclusiveMinimum': '1'" if !width.nil? && width < 1
  fail ArgumentError, 'height is nil' if height.nil?
  fail ArgumentError, "'height' should satisfy the constraint - 'InclusiveMaximum': '1024'" if !height.nil? && height > 1024
  fail ArgumentError, "'height' should satisfy the constraint - 'InclusiveMinimum': '1'" if !height.nil? && height < 1
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'generateThumbnail'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'width' => width,'height' => height,'smartCropping' => smart_cropping},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Stream'
          }
        }
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#generate_thumbnail_in_stream(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ `NOT_IMPLEMENTED`

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

1 and 1024. Recommended minimum of 50. between 1 and 1024. Recommended minimum of 50. will be added to the HTTP request.

Parameters:

width (Integer) —

Width of the thumbnail, in pixels. It must be between
height (Integer) —

Height of the thumbnail, in pixels. It must be
image —

An image stream.
smart_cropping (Boolean) (defaults to: false) —

Boolean flag for enabling smart cropping.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(NOT_IMPLEMENTED) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2409

def generate_thumbnail_in_stream(width, height, image, smart_cropping:false, custom_headers:nil)
  response = generate_thumbnail_in_stream_async(width, height, image, smart_cropping:smart_cropping, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#generate_thumbnail_in_stream_async(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

1 and 1024. Recommended minimum of 50. between 1 and 1024. Recommended minimum of 50. to the HTTP request.

Parameters:

width (Integer) —

Width of the thumbnail, in pixels. It must be between
height (Integer) —

Height of the thumbnail, in pixels. It must be
image —

An image stream.
smart_cropping (Boolean) (defaults to: false) —

Boolean flag for enabling smart cropping.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2468

def generate_thumbnail_in_stream_async(width, height, image, smart_cropping:false, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'width is nil' if width.nil?
  fail ArgumentError, "'width' should satisfy the constraint - 'InclusiveMaximum': '1024'" if !width.nil? && width > 1024
  fail ArgumentError, "'width' should satisfy the constraint - 'InclusiveMinimum': '1'" if !width.nil? && width < 1
  fail ArgumentError, 'height is nil' if height.nil?
  fail ArgumentError, "'height' should satisfy the constraint - 'InclusiveMaximum': '1024'" if !height.nil? && height > 1024
  fail ArgumentError, "'height' should satisfy the constraint - 'InclusiveMinimum': '1'" if !height.nil? && height < 1
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'generateThumbnail'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'width' => width,'height' => height,'smartCropping' => smart_cropping},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Stream'
          }
        }
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#generate_thumbnail_in_stream_with_http_info(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

1 and 1024. Recommended minimum of 50. between 1 and 1024. Recommended minimum of 50. will be added to the HTTP request.

Parameters:

width (Integer) —

Width of the thumbnail, in pixels. It must be between
height (Integer) —

Height of the thumbnail, in pixels. It must be
image —

An image stream.
smart_cropping (Boolean) (defaults to: false) —

Boolean flag for enabling smart cropping.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2439
2440
2441

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2439

def generate_thumbnail_in_stream_with_http_info(width, height, image, smart_cropping:false, custom_headers:nil)
  generate_thumbnail_in_stream_async(width, height, image, smart_cropping:smart_cropping, custom_headers:custom_headers).value!
end

#generate_thumbnail_with_http_info(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

1 and 1024. Recommended minimum of 50. between 1 and 1024. Recommended minimum of 50. will be added to the HTTP request.

Parameters:

width (Integer) —

Width of the thumbnail, in pixels. It must be between
height (Integer) —

Height of the thumbnail, in pixels. It must be
url (String) —

Publicly reachable URL of an image.
smart_cropping (Boolean) (defaults to: false) —

Boolean flag for enabling smart cropping.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1168
1169
1170

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1168

def generate_thumbnail_with_http_info(width, height, url, smart_cropping:false, custom_headers:nil)
  generate_thumbnail_async(width, height, url, smart_cropping:smart_cropping, custom_headers:custom_headers).value!
end

#get_area_of_interest(url, custom_headers: nil) ⇒ `AreaOfInterestResult`

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(AreaOfInterestResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1290

def get_area_of_interest(url, custom_headers:nil)
  response = get_area_of_interest_async(url, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_area_of_interest_async(url, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1331

def get_area_of_interest_async(url, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'areaOfInterest'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::AreaOfInterestResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_area_of_interest_in_stream(image, custom_headers: nil) ⇒ `AreaOfInterestResult`

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

will be added to the HTTP request.

Parameters:

image —

An image stream.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(AreaOfInterestResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2012

def get_area_of_interest_in_stream(image, custom_headers:nil)
  response = get_area_of_interest_in_stream_async(image, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_area_of_interest_in_stream_async(image, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

to the HTTP request.

Parameters:

image —

An image stream.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2053

def get_area_of_interest_in_stream_async(image, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'areaOfInterest'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::AreaOfInterestResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_area_of_interest_in_stream_with_http_info(image, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

will be added to the HTTP request.

Parameters:

image —

An image stream.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2033
2034
2035

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2033

def get_area_of_interest_in_stream_with_http_info(image, custom_headers:nil)
  get_area_of_interest_in_stream_async(image, custom_headers:custom_headers).value!
end

#get_area_of_interest_with_http_info(url, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1311
1312
1313

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1311

def get_area_of_interest_with_http_info(url, custom_headers:nil)
  get_area_of_interest_async(url, custom_headers:custom_headers).value!
end

#get_read_operation_result(operation_id, custom_headers: nil) ⇒ `ReadOperationResult`

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from ‘Operation-Location’ field returned from Batch Read File interface.

the ‘Batch Read File’ interface. will be added to the HTTP request.

Parameters:

operation_id (String) —

Id of read operation returned in the response of
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(ReadOperationResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1712

def get_read_operation_result(operation_id, custom_headers:nil)
  response = get_read_operation_result_async(operation_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_read_operation_result_async(operation_id, custom_headers: nil) ⇒ `Concurrent::Promise`

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from ‘Operation-Location’ field returned from Batch Read File interface.

the ‘Batch Read File’ interface. to the HTTP request.

Parameters:

operation_id (String) —

Id of read operation returned in the response of
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1745

def get_read_operation_result_async(operation_id, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'operation_id is nil' if operation_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?
  path_template = 'read/operations/{operationId}'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'operationId' => operation_id},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ReadOperationResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_read_operation_result_with_http_info(operation_id, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from ‘Operation-Location’ field returned from Batch Read File interface.

the ‘Batch Read File’ interface. will be added to the HTTP request.

Parameters:

operation_id (String) —

Id of read operation returned in the response of
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1729
1730
1731

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1729

def get_read_operation_result_with_http_info(operation_id, custom_headers:nil)
  get_read_operation_result_async(operation_id, custom_headers:custom_headers).value!
end

#get_text_operation_result(operation_id, custom_headers: nil) ⇒ `TextOperationResult`

This interface is used for getting text operation result. The URL to this interface should be retrieved from ‘Operation-Location’ field returned from Recognize Text interface.

response of the ‘Recognize Text’ will be added to the HTTP request.

Parameters:

operation_id (String) —

Id of the text operation returned in the
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(TextOperationResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1511

def get_text_operation_result(operation_id, custom_headers:nil)
  response = get_text_operation_result_async(operation_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_text_operation_result_async(operation_id, custom_headers: nil) ⇒ `Concurrent::Promise`

This interface is used for getting text operation result. The URL to this interface should be retrieved from ‘Operation-Location’ field returned from Recognize Text interface.

response of the ‘Recognize Text’ to the HTTP request.

Parameters:

operation_id (String) —

Id of the text operation returned in the
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1544

def get_text_operation_result_async(operation_id, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'operation_id is nil' if operation_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?
  path_template = 'textOperations/{operationId}'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'operationId' => operation_id},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::TextOperationResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_text_operation_result_with_http_info(operation_id, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This interface is used for getting text operation result. The URL to this interface should be retrieved from ‘Operation-Location’ field returned from Recognize Text interface.

response of the ‘Recognize Text’ will be added to the HTTP request.

Parameters:

operation_id (String) —

Id of the text operation returned in the
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1528
1529
1530

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1528

def get_text_operation_result_with_http_info(operation_id, custom_headers:nil)
  get_text_operation_result_async(operation_id, custom_headers:custom_headers).value!
end

#list_models(custom_headers: nil) ⇒ `ListModelsResult`

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

will be added to the HTTP request.

Parameters:

custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(ListModelsResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 586

def list_models(custom_headers:nil)
  response = list_models_async(custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_models_async(custom_headers: nil) ⇒ `Concurrent::Promise`

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

to the HTTP request.

Parameters:

A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 621

def list_models_async(custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?
  path_template = 'models'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ListModelsResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_models_with_http_info(custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

will be added to the HTTP request.

Parameters:

custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



604
605
606

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 604

def list_models_with_http_info(custom_headers:nil)
  list_models_async(custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ `Hash{String=>String}`

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

method (Symbol) —

with any of the following values :get, :put, :post, :patch, :delete.
path (String) —

the path, relative to #base_url.
options (Hash{String=>String}) (defaults to: {}) —

specifying any request options like :body.

Returns:

(Hash{String=>String}) —

containing the body of the response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 73

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ `Concurrent::Promise`

Makes a request asynchronously.

Parameters:

method (Symbol) —

with any of the following values :get, :put, :post, :patch, :delete.
path (String) —

the path, relative to #base_url.
options (Hash{String=>String}) (defaults to: {}) —

specifying any request options like :body.

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 98

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ `MsRestAzure::AzureOperationResponse`

Makes a request and returns the operation response.

Parameters:

method (Symbol) —

with any of the following values :get, :put, :post, :patch, :delete.
path (String) —

the path, relative to #base_url.
options (Hash{String=>String}) (defaults to: {}) —

specifying any request options like :body.

Returns:

(MsRestAzure::AzureOperationResponse) —

Operation response containing the request, response and status.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 85

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

#recognize_printed_text(detect_orientation, url, language: nil, custom_headers: nil) ⇒ `OcrResult`

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it’s upside-down). detected in the image. The default value is ‘unk’. Possible values include: ‘unk’, ‘zh-Hans’, ‘zh-Hant’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘fi’, ‘fr’, ‘de’, ‘el’, ‘hu’, ‘it’, ‘ja’, ‘ko’, ‘nb’, ‘pl’, ‘pt’, ‘ru’, ‘es’, ‘sv’, ‘tr’, ‘ar’, ‘ro’, ‘sr-Cyrl’, ‘sr-Latn’, ‘sk’ will be added to the HTTP request.

Parameters:

detect_orientation (Boolean) —

Whether detect the text orientation in
url (String) —

Publicly reachable URL of an image.
language (OcrLanguages) (defaults to: nil) —

The BCP-47 language code of the text to be
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(OcrResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 843

def recognize_printed_text(detect_orientation, url, language:nil, custom_headers:nil)
  response = recognize_printed_text_async(detect_orientation, url, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#recognize_printed_text_async(detect_orientation, url, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it’s upside-down). detected in the image. The default value is ‘unk’. Possible values include: ‘unk’, ‘zh-Hans’, ‘zh-Hant’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘fi’, ‘fr’, ‘de’, ‘el’, ‘hu’, ‘it’, ‘ja’, ‘ko’, ‘nb’, ‘pl’, ‘pt’, ‘ru’, ‘es’, ‘sv’, ‘tr’, ‘ar’, ‘ro’, ‘sr-Cyrl’, ‘sr-Latn’, ‘sk’ to the HTTP request.

Parameters:

detect_orientation (Boolean) —

Whether detect the text orientation in
url (String) —

Publicly reachable URL of an image.
language (OcrLanguages) (defaults to: nil) —

The BCP-47 language code of the text to be
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 900

def recognize_printed_text_async(detect_orientation, url, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'detect_orientation is nil' if detect_orientation.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'ocr'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'detectOrientation' => detect_orientation,'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::OcrResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#recognize_printed_text_in_stream(detect_orientation, image, language: nil, custom_headers: nil) ⇒ `OcrResult`

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it’s upside-down). detected in the image. The default value is ‘unk’. Possible values include: ‘unk’, ‘zh-Hans’, ‘zh-Hant’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘fi’, ‘fr’, ‘de’, ‘el’, ‘hu’, ‘it’, ‘ja’, ‘ko’, ‘nb’, ‘pl’, ‘pt’, ‘ru’, ‘es’, ‘sv’, ‘tr’, ‘ar’, ‘ro’, ‘sr-Cyrl’, ‘sr-Latn’, ‘sk’ will be added to the HTTP request.

Parameters:

detect_orientation (Boolean) —

Whether detect the text orientation in
image —

An image stream.
language (OcrLanguages) (defaults to: nil) —

The BCP-47 language code of the text to be
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(OcrResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2720

def recognize_printed_text_in_stream(detect_orientation, image, language:nil, custom_headers:nil)
  response = recognize_printed_text_in_stream_async(detect_orientation, image, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#recognize_printed_text_in_stream_async(detect_orientation, image, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it’s upside-down). detected in the image. The default value is ‘unk’. Possible values include: ‘unk’, ‘zh-Hans’, ‘zh-Hant’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘fi’, ‘fr’, ‘de’, ‘el’, ‘hu’, ‘it’, ‘ja’, ‘ko’, ‘nb’, ‘pl’, ‘pt’, ‘ru’, ‘es’, ‘sv’, ‘tr’, ‘ar’, ‘ro’, ‘sr-Cyrl’, ‘sr-Latn’, ‘sk’ to the HTTP request.

Parameters:

detect_orientation (Boolean) —

Whether detect the text orientation in
image —

An image stream.
language (OcrLanguages) (defaults to: nil) —

The BCP-47 language code of the text to be
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2777

def recognize_printed_text_in_stream_async(detect_orientation, image, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'detect_orientation is nil' if detect_orientation.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'ocr'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'detectOrientation' => detect_orientation,'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::OcrResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#recognize_printed_text_in_stream_with_http_info(detect_orientation, image, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it’s upside-down). detected in the image. The default value is ‘unk’. Possible values include: ‘unk’, ‘zh-Hans’, ‘zh-Hant’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘fi’, ‘fr’, ‘de’, ‘el’, ‘hu’, ‘it’, ‘ja’, ‘ko’, ‘nb’, ‘pl’, ‘pt’, ‘ru’, ‘es’, ‘sv’, ‘tr’, ‘ar’, ‘ro’, ‘sr-Cyrl’, ‘sr-Latn’, ‘sk’ will be added to the HTTP request.

Parameters:

detect_orientation (Boolean) —

Whether detect the text orientation in
image —

An image stream.
language (OcrLanguages) (defaults to: nil) —

The BCP-47 language code of the text to be
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2749
2750
2751

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2749

def recognize_printed_text_in_stream_with_http_info(detect_orientation, image, language:nil, custom_headers:nil)
  recognize_printed_text_in_stream_async(detect_orientation, image, language:language, custom_headers:custom_headers).value!
end

#recognize_printed_text_with_http_info(detect_orientation, url, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it’s upside-down). detected in the image. The default value is ‘unk’. Possible values include: ‘unk’, ‘zh-Hans’, ‘zh-Hant’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘fi’, ‘fr’, ‘de’, ‘el’, ‘hu’, ‘it’, ‘ja’, ‘ko’, ‘nb’, ‘pl’, ‘pt’, ‘ru’, ‘es’, ‘sv’, ‘tr’, ‘ar’, ‘ro’, ‘sr-Cyrl’, ‘sr-Latn’, ‘sk’ will be added to the HTTP request.

Parameters:

detect_orientation (Boolean) —

Whether detect the text orientation in
url (String) —

Publicly reachable URL of an image.
language (OcrLanguages) (defaults to: nil) —

The BCP-47 language code of the text to be
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



872
873
874

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 872

def recognize_printed_text_with_http_info(detect_orientation, url, language:nil, custom_headers:nil)
  recognize_printed_text_async(detect_orientation, url, language:language, custom_headers:custom_headers).value!
end

#recognize_text(url, mode, custom_headers: nil) ⇒ `Object`

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your Get Recognize Text Operation Result operation.

include: ‘Handwritten’, ‘Printed’ will be added to the HTTP request.

Parameters:

mode (TextRecognitionMode) —

Type of text to recognize. Possible values
url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1407

def recognize_text(url, mode, custom_headers:nil)
  response = recognize_text_async(url, mode, custom_headers:custom_headers).value!
  nil
end

#recognize_text_async(url, mode, custom_headers: nil) ⇒ `Concurrent::Promise`

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your Get Recognize Text Operation Result operation.

include: ‘Handwritten’, ‘Printed’ to the HTTP request.

Parameters:

mode (TextRecognitionMode) —

Type of text to recognize. Possible values
url (String) —

Publicly reachable URL of an image.
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1444

def recognize_text_async(url, mode, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'mode is nil' if mode.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'recognizeText'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'mode' => mode},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#recognize_text_in_stream(image, mode, custom_headers: nil) ⇒ `Object`

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your Get Recognize Text Operation Result operation.

include: ‘Handwritten’, ‘Printed’ will be added to the HTTP request.

Parameters:

image —

An image stream.
mode (TextRecognitionMode) —

Type of text to recognize. Possible values
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 3007

def recognize_text_in_stream(image, mode, custom_headers:nil)
  response = recognize_text_in_stream_async(image, mode, custom_headers:custom_headers).value!
  nil
end

#recognize_text_in_stream_async(image, mode, custom_headers: nil) ⇒ `Concurrent::Promise`

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your Get Recognize Text Operation Result operation.

include: ‘Handwritten’, ‘Printed’ to the HTTP request.

Parameters:

image —

An image stream.
mode (TextRecognitionMode) —

Type of text to recognize. Possible values
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 3044

def recognize_text_in_stream_async(image, mode, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?
  fail ArgumentError, 'mode is nil' if mode.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'recognizeText'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'mode' => mode},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#recognize_text_in_stream_with_http_info(image, mode, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your Get Recognize Text Operation Result operation.

include: ‘Handwritten’, ‘Printed’ will be added to the HTTP request.

Parameters:

image —

An image stream.
mode (TextRecognitionMode) —

Type of text to recognize. Possible values
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



3026
3027
3028

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 3026

def recognize_text_in_stream_with_http_info(image, mode, custom_headers:nil)
  recognize_text_in_stream_async(image, mode, custom_headers:custom_headers).value!
end

#recognize_text_with_http_info(url, mode, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your Get Recognize Text Operation Result operation.

include: ‘Handwritten’, ‘Printed’ will be added to the HTTP request.

Parameters:

mode (TextRecognitionMode) —

Type of text to recognize. Possible values
url (String) —

Publicly reachable URL of an image.
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1426
1427
1428

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1426

def recognize_text_with_http_info(url, mode, custom_headers:nil)
  recognize_text_async(url, mode, custom_headers:custom_headers).value!
end

#tag_image(url, language: nil, custom_headers: nil) ⇒ `TagResult`

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag “cello” may be accompanied by the hint “musical instrument”. All tags are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(TagResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 990

def tag_image(url, language:nil, custom_headers:nil)
  response = tag_image_async(url, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#tag_image_async(url, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag “cello” may be accompanied by the hint “musical instrument”. All tags are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1049

def tag_image_async(url, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'url is nil' if url.nil?

  image_url = ImageUrl.new
  unless url.nil?
    image_url.url = url
  end

  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageUrl.mapper()
  request_content = self.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'tag'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::TagResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#tag_image_in_stream(image, language: nil, custom_headers: nil) ⇒ `TagResult`

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag “cello” may be accompanied by the hint “musical instrument”. All tags are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

image —

An image stream.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(TagResult) —

operation results.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2869

def tag_image_in_stream(image, language:nil, custom_headers:nil)
  response = tag_image_in_stream_async(image, language:language, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#tag_image_in_stream_async(image, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag “cello” may be accompanied by the hint “musical instrument”. All tags are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ to the HTTP request.

Parameters:

image —

An image stream.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
A (Hash{String => String}) —

hash of custom headers that will be added

Returns:

(Concurrent::Promise) —

Promise object which holds the HTTP response.

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2928

def tag_image_in_stream_async(image, language:nil, custom_headers:nil)
  fail ArgumentError, 'endpoint is nil' if endpoint.nil?
  fail ArgumentError, 'image is nil' if image.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/octet-stream'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: true,
    serialized_name: 'Image',
    type: {
      name: 'Stream'
    }
  }
  request_content = self.serialize(request_mapper,  image)

  path_template = 'tag'

  request_url = @base_url || self.base_url
request_url = request_url.gsub('{Endpoint}', endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'language' => language},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ComputerVision::V2_0::Models::TagResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#tag_image_in_stream_with_http_info(image, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag “cello” may be accompanied by the hint “musical instrument”. All tags are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

image —

An image stream.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



2899
2900
2901

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 2899

def tag_image_in_stream_with_http_info(image, language:nil, custom_headers:nil)
  tag_image_in_stream_async(image, language:language, custom_headers:custom_headers).value!
end

#tag_image_with_http_info(url, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag “cello” may be accompanied by the hint “musical instrument”. All tags are in English. Two input methods are supported – (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: ‘en’, ‘es’, ‘ja’, ‘pt’, ‘zh’ will be added to the HTTP request.

Parameters:

url (String) —

Publicly reachable URL of an image.
language (Enum) (defaults to: nil) —

The desired language for output generation. If this
custom_headers (Hash{String => String}) (defaults to: nil) —

A hash of custom headers that

Returns:

(MsRestAzure::AzureOperationResponse) —

HTTP response information.



1020
1021
1022

# File 'lib/2.0/generated/azure_cognitiveservices_computervision/computer_vision_client.rb', line 1020

def tag_image_with_http_info(url, language:nil, custom_headers:nil)
  tag_image_async(url, language:language, custom_headers:custom_headers).value!
end

Class: Azure::CognitiveServices::ComputerVision::V2_0::ComputerVisionClient

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, options = nil) ⇒ ComputerVisionClient

Instance Attribute Details

#accept_language ⇒ String

#base_url ⇒ String (readonly)

#credentials ⇒ Object

#credentials1 ⇒ Object (readonly)

#endpoint ⇒ String

#generate_client_request_id ⇒ Boolean

#long_running_operation_retry_timeout ⇒ Integer

Instance Method Details

#analyze_image(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ ImageAnalysis

#analyze_image_async(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#analyze_image_by_domain(model, url, language: nil, custom_headers: nil) ⇒ DomainModelResults

#analyze_image_by_domain_async(model, url, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#analyze_image_by_domain_in_stream(model, image, language: nil, custom_headers: nil) ⇒ DomainModelResults

#analyze_image_by_domain_in_stream_async(model, image, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#analyze_image_by_domain_in_stream_with_http_info(model, image, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#analyze_image_by_domain_with_http_info(model, url, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#analyze_image_in_stream(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ ImageAnalysis

#analyze_image_in_stream_async(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#analyze_image_in_stream_with_http_info(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#analyze_image_with_http_info(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#batch_read_file(url, custom_headers: nil) ⇒ Object

#batch_read_file_async(url, custom_headers: nil) ⇒ Concurrent::Promise

#batch_read_file_in_stream(image, custom_headers: nil) ⇒ Object

#batch_read_file_in_stream_async(image, custom_headers: nil) ⇒ Concurrent::Promise

#batch_read_file_in_stream_with_http_info(image, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#batch_read_file_with_http_info(url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#describe_image(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ ImageDescription

#describe_image_async(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#describe_image_in_stream(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ ImageDescription

#describe_image_in_stream_async(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#describe_image_in_stream_with_http_info(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#describe_image_with_http_info(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#detect_objects(url, custom_headers: nil) ⇒ DetectResult

#detect_objects_async(url, custom_headers: nil) ⇒ Concurrent::Promise

#detect_objects_in_stream(image, custom_headers: nil) ⇒ DetectResult

#detect_objects_in_stream_async(image, custom_headers: nil) ⇒ Concurrent::Promise

#detect_objects_in_stream_with_http_info(image, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#detect_objects_with_http_info(url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#generate_thumbnail(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ NOT_IMPLEMENTED

#generate_thumbnail_async(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ Concurrent::Promise

#generate_thumbnail_in_stream(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ NOT_IMPLEMENTED

#generate_thumbnail_in_stream_async(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ Concurrent::Promise

#generate_thumbnail_in_stream_with_http_info(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#generate_thumbnail_with_http_info(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#get_area_of_interest(url, custom_headers: nil) ⇒ AreaOfInterestResult

#get_area_of_interest_async(url, custom_headers: nil) ⇒ Concurrent::Promise

#get_area_of_interest_in_stream(image, custom_headers: nil) ⇒ AreaOfInterestResult

#get_area_of_interest_in_stream_async(image, custom_headers: nil) ⇒ Concurrent::Promise

#get_area_of_interest_in_stream_with_http_info(image, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#get_area_of_interest_with_http_info(url, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#get_read_operation_result(operation_id, custom_headers: nil) ⇒ ReadOperationResult

#get_read_operation_result_async(operation_id, custom_headers: nil) ⇒ Concurrent::Promise

#get_read_operation_result_with_http_info(operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#get_text_operation_result(operation_id, custom_headers: nil) ⇒ TextOperationResult

#get_text_operation_result_async(operation_id, custom_headers: nil) ⇒ Concurrent::Promise

#get_text_operation_result_with_http_info(operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#list_models(custom_headers: nil) ⇒ ListModelsResult

#list_models_async(custom_headers: nil) ⇒ Concurrent::Promise

#list_models_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

#recognize_printed_text(detect_orientation, url, language: nil, custom_headers: nil) ⇒ OcrResult

#recognize_printed_text_async(detect_orientation, url, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#recognize_printed_text_in_stream(detect_orientation, image, language: nil, custom_headers: nil) ⇒ OcrResult

#recognize_printed_text_in_stream_async(detect_orientation, image, language: nil, custom_headers: nil) ⇒ Concurrent::Promise

#recognize_printed_text_in_stream_with_http_info(detect_orientation, image, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#recognize_printed_text_with_http_info(detect_orientation, url, language: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#recognize_text(url, mode, custom_headers: nil) ⇒ Object

#recognize_text_async(url, mode, custom_headers: nil) ⇒ Concurrent::Promise

#recognize_text_in_stream(image, mode, custom_headers: nil) ⇒ Object

#recognize_text_in_stream_async(image, mode, custom_headers: nil) ⇒ Concurrent::Promise

#recognize_text_in_stream_with_http_info(image, mode, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

#initialize(credentials = nil, options = nil) ⇒ `ComputerVisionClient`

#accept_language ⇒ `String`

#base_url ⇒ `String` (readonly)

#credentials ⇒ `Object`

#credentials1 ⇒ `Object` (readonly)

#endpoint ⇒ `String`

#generate_client_request_id ⇒ `Boolean`

#long_running_operation_retry_timeout ⇒ `Integer`

#analyze_image(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `ImageAnalysis`

#analyze_image_async(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#analyze_image_by_domain(model, url, language: nil, custom_headers: nil) ⇒ `DomainModelResults`

#analyze_image_by_domain_async(model, url, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#analyze_image_by_domain_in_stream(model, image, language: nil, custom_headers: nil) ⇒ `DomainModelResults`

#analyze_image_by_domain_in_stream_async(model, image, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#analyze_image_by_domain_in_stream_with_http_info(model, image, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#analyze_image_by_domain_with_http_info(model, url, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#analyze_image_in_stream(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `ImageAnalysis`

#analyze_image_in_stream_async(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#analyze_image_in_stream_with_http_info(image, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#analyze_image_with_http_info(url, visual_features: nil, details: nil, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#batch_read_file(url, custom_headers: nil) ⇒ `Object`

#batch_read_file_async(url, custom_headers: nil) ⇒ `Concurrent::Promise`

#batch_read_file_in_stream(image, custom_headers: nil) ⇒ `Object`

#batch_read_file_in_stream_async(image, custom_headers: nil) ⇒ `Concurrent::Promise`

#batch_read_file_in_stream_with_http_info(image, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#batch_read_file_with_http_info(url, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#describe_image(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `ImageDescription`

#describe_image_async(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#describe_image_in_stream(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `ImageDescription`

#describe_image_in_stream_async(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#describe_image_in_stream_with_http_info(image, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#describe_image_with_http_info(url, max_candidates: 1, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#detect_objects(url, custom_headers: nil) ⇒ `DetectResult`

#detect_objects_async(url, custom_headers: nil) ⇒ `Concurrent::Promise`

#detect_objects_in_stream(image, custom_headers: nil) ⇒ `DetectResult`

#detect_objects_in_stream_async(image, custom_headers: nil) ⇒ `Concurrent::Promise`

#detect_objects_in_stream_with_http_info(image, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#detect_objects_with_http_info(url, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#generate_thumbnail(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ `NOT_IMPLEMENTED`

#generate_thumbnail_async(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ `Concurrent::Promise`

#generate_thumbnail_in_stream(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ `NOT_IMPLEMENTED`

#generate_thumbnail_in_stream_async(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ `Concurrent::Promise`

#generate_thumbnail_in_stream_with_http_info(width, height, image, smart_cropping: false, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#generate_thumbnail_with_http_info(width, height, url, smart_cropping: false, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#get_area_of_interest(url, custom_headers: nil) ⇒ `AreaOfInterestResult`

#get_area_of_interest_async(url, custom_headers: nil) ⇒ `Concurrent::Promise`

#get_area_of_interest_in_stream(image, custom_headers: nil) ⇒ `AreaOfInterestResult`

#get_area_of_interest_in_stream_async(image, custom_headers: nil) ⇒ `Concurrent::Promise`

#get_area_of_interest_in_stream_with_http_info(image, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#get_area_of_interest_with_http_info(url, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#get_read_operation_result(operation_id, custom_headers: nil) ⇒ `ReadOperationResult`

#get_read_operation_result_async(operation_id, custom_headers: nil) ⇒ `Concurrent::Promise`

#get_read_operation_result_with_http_info(operation_id, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#get_text_operation_result(operation_id, custom_headers: nil) ⇒ `TextOperationResult`

#get_text_operation_result_async(operation_id, custom_headers: nil) ⇒ `Concurrent::Promise`

#get_text_operation_result_with_http_info(operation_id, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#list_models(custom_headers: nil) ⇒ `ListModelsResult`

#list_models_async(custom_headers: nil) ⇒ `Concurrent::Promise`

#list_models_with_http_info(custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#make_request(method, path, options = {}) ⇒ `Hash{String=>String}`

#make_request_async(method, path, options = {}) ⇒ `Concurrent::Promise`

#make_request_with_http_info(method, path, options = {}) ⇒ `MsRestAzure::AzureOperationResponse`

#recognize_printed_text(detect_orientation, url, language: nil, custom_headers: nil) ⇒ `OcrResult`

#recognize_printed_text_async(detect_orientation, url, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#recognize_printed_text_in_stream(detect_orientation, image, language: nil, custom_headers: nil) ⇒ `OcrResult`

#recognize_printed_text_in_stream_async(detect_orientation, image, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#recognize_printed_text_in_stream_with_http_info(detect_orientation, image, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#recognize_printed_text_with_http_info(detect_orientation, url, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#recognize_text(url, mode, custom_headers: nil) ⇒ `Object`

#recognize_text_async(url, mode, custom_headers: nil) ⇒ `Concurrent::Promise`

#recognize_text_in_stream(image, mode, custom_headers: nil) ⇒ `Object`

#recognize_text_in_stream_async(image, mode, custom_headers: nil) ⇒ `Concurrent::Promise`

#recognize_text_in_stream_with_http_info(image, mode, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#recognize_text_with_http_info(url, mode, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#tag_image(url, language: nil, custom_headers: nil) ⇒ `TagResult`

#tag_image_async(url, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#tag_image_in_stream(image, language: nil, custom_headers: nil) ⇒ `TagResult`

#tag_image_in_stream_async(image, language: nil, custom_headers: nil) ⇒ `Concurrent::Promise`

#tag_image_in_stream_with_http_info(image, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`

#tag_image_with_http_info(url, language: nil, custom_headers: nil) ⇒ `MsRestAzure::AzureOperationResponse`