class Azure::CognitiveServices::ImageSearch::V1_0::Models::ImageInsightsImageCaption

Defines an image's caption.

Attributes

caption[RW]

@return [String] A caption about the image.

data_source_url[RW]

@return [String] The URL to the website where the caption was found. You must attribute the caption to the source. For example, by displaying the domain name from the URL next to the caption and using the URL to link to the source website.

Private Class Methods

mapper() click to toggle source

Mapper for ImageInsightsImageCaption class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/1.0/generated/azure_cognitiveservices_imagesearch/models/image_insights_image_caption.rb, line 34
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ImageInsights/ImageCaption',
    type: {
      name: 'Composite',
      class_name: 'ImageInsightsImageCaption',
      model_properties: {
        caption: {
          client_side_validation: true,
          required: true,
          serialized_name: 'caption',
          type: {
            name: 'String'
          }
        },
        data_source_url: {
          client_side_validation: true,
          required: true,
          serialized_name: 'dataSourceUrl',
          type: {
            name: 'String'
          }
        },
        related_searches: {
          client_side_validation: true,
          required: true,
          serialized_name: 'relatedSearches',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        }
      }
    }
  }
end