azure_cognitiveservices_websearch 0.16.0

data/lib/1.0/generated/azure_cognitiveservices_websearch/models/places.rb

@@ -0,0 +1,135 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::WebSearch::V1_0
+  module Models
+    #
+    # Defines a local entity answer.
+    #
+    class Places < SearchResultsAnswer
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "Places"
+      end
+
+      attr_accessor :_type
+
+      # @return [Array<Thing>] A list of local entities, such as restaurants or
+      # hotels.
+      attr_accessor :value
+
+
+      #
+      # Mapper for Places class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Places',
+          type: {
+            name: 'Composite',
+            class_name: 'Places',
+            model_properties: {
+              _type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: '_type',
+                type: {
+                  name: 'String'
+                }
+              },
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              follow_up_queries: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'followUpQueries',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'QueryElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Query'
+                      }
+                  }
+                }
+              },
+              query_context: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'queryContext',
+                type: {
+                  name: 'Composite',
+                  class_name: 'QueryContext'
+                }
+              },
+              total_estimated_matches: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'totalEstimatedMatches',
+                type: {
+                  name: 'Number'
+                }
+              },
+              is_family_friendly: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isFamilyFriendly',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              value: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'value',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_websearch/models/query.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::WebSearch::V1_0
+  module Models
+    #
+    # Defines a search query.
+    #
+    class Query
+
+      include MsRestAzure
+
+      # @return [String] The query string. Use this string as the query term in
+      # a new search request.
+      attr_accessor :text
+
+      # @return [String] The display version of the query term. This version of
+      # the query term may contain special characters that highlight the search
+      # term found in the query string. The string contains the highlighting
+      # characters only if the query enabled hit highlighting
+      attr_accessor :display_text
+
+      # @return [String] The URL that takes the user to the Bing search results
+      # page for the query.Only related search results include this field.
+      attr_accessor :web_search_url
+
+      # @return [String]
+      attr_accessor :search_link
+
+      # @return [ImageObject]
+      attr_accessor :thumbnail
+
+
+      #
+      # Mapper for Query class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Query',
+          type: {
+            name: 'Composite',
+            class_name: 'Query',
+            model_properties: {
+              text: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              display_text: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'displayText',
+                type: {
+                  name: 'String'
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              search_link: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'searchLink',
+                type: {
+                  name: 'String'
+                }
+              },
+              thumbnail: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'thumbnail',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ImageObject'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_websearch/models/query_context.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::WebSearch::V1_0
+  module Models
+    #
+    # Defines the query context that Bing used for the request.
+    #
+    class QueryContext
+
+      include MsRestAzure
+
+      # @return [String] The query string as specified in the request.
+      attr_accessor :original_query
+
+      # @return [String] The query string used by Bing to perform the query.
+      # Bing uses the altered query string if the original query string
+      # contained spelling mistakes. For example, if the query string is
+      # "saling downwind", the altered query string will be "sailing downwind".
+      # This field is included only if the original query string contains a
+      # spelling mistake.
+      attr_accessor :altered_query
+
+      # @return [String] The query string to use to force Bing to use the
+      # original string. For example, if the query string is "saling downwind",
+      # the override query string will be "+saling downwind". Remember to
+      # encode the query string which results in "%2Bsaling+downwind". This
+      # field is included only if the original query string contains a spelling
+      # mistake.
+      attr_accessor :alteration_override_query
+
+      # @return [Boolean] A Boolean value that indicates whether the specified
+      # query has adult intent. The value is true if the query has adult
+      # intent; otherwise, false.
+      attr_accessor :adult_intent
+
+      # @return [Boolean] A Boolean value that indicates whether Bing requires
+      # the user's location to provide accurate results. If you specified the
+      # user's location by using the X-MSEdge-ClientIP and X-Search-Location
+      # headers, you can ignore this field. For location aware queries, such as
+      # "today's weather" or "restaurants near me" that need the user's
+      # location to provide accurate results, this field is set to true. For
+      # location aware queries that include the location (for example, "Seattle
+      # weather"), this field is set to false. This field is also set to false
+      # for queries that are not location aware, such as "best sellers".
+      attr_accessor :ask_user_for_location
+
+      # @return [Boolean]
+      attr_accessor :is_transactional
+
+
+      #
+      # Mapper for QueryContext class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'QueryContext',
+          type: {
+            name: 'Composite',
+            class_name: 'QueryContext',
+            model_properties: {
+              original_query: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'originalQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              altered_query: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alteredQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              alteration_override_query: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alterationOverrideQuery',
+                type: {
+                  name: 'String'
+                }
+              },
+              adult_intent: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'adultIntent',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              ask_user_for_location: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'askUserForLocation',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              is_transactional: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isTransactional',
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_websearch/models/ranking_ranking_group.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::WebSearch::V1_0
+  module Models
+    #
+    # Defines a search results group, such as mainline.
+    #
+    class RankingRankingGroup
+
+      include MsRestAzure
+
+      # @return [Array<RankingRankingItem>] A list of search result items to
+      # display in the group.
+      attr_accessor :items
+
+
+      #
+      # Mapper for RankingRankingGroup class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Ranking/RankingGroup',
+          type: {
+            name: 'Composite',
+            class_name: 'RankingRankingGroup',
+            model_properties: {
+              items: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'items',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'RankingRankingItemElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'RankingRankingItem'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_websearch/models/ranking_ranking_item.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::WebSearch::V1_0
+  module Models
+    #
+    # Defines a search result item to display
+    #
+    class RankingRankingItem
+
+      include MsRestAzure
+
+      # @return [AnswerType] The answer that contains the item to display. Use
+      # the type to find the answer in the SearchResponse object. The type is
+      # the name of a SearchResponse field. Possible values include:
+      # 'WebPages', 'Images', 'SpellSuggestions', 'News', 'RelatedSearches',
+      # 'Videos', 'Computation', 'TimeZone'. Default value: 'WebPages' .
+      attr_accessor :answer_type
+
+      # @return [Integer] A zero-based index of the item in the answer.If the
+      # item does not include this field, display all items in the answer. For
+      # example, display all news articles in the News answer.
+      attr_accessor :result_index
+
+      # @return [Identifiable] The ID that identifies either an answer to
+      # display or an item of an answer to display. If the ID identifies an
+      # answer, display all items of the answer.
+      attr_accessor :value
+
+      # @return [Integer]
+      attr_accessor :html_index
+
+      # @return [Integer]
+      attr_accessor :textual_index
+
+      # @return [Integer]
+      attr_accessor :screenshot_index
+
+
+      #
+      # Mapper for RankingRankingItem class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Ranking/RankingItem',
+          type: {
+            name: 'Composite',
+            class_name: 'RankingRankingItem',
+            model_properties: {
+              answer_type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'answerType',
+                default_value: 'WebPages',
+                type: {
+                  name: 'String'
+                }
+              },
+              result_index: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'resultIndex',
+                type: {
+                  name: 'Number'
+                }
+              },
+              value: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'value',
+                type: {
+                  name: 'Composite',
+                  class_name: 'Identifiable'
+                }
+              },
+              html_index: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'htmlIndex',
+                type: {
+                  name: 'Number'
+                }
+              },
+              textual_index: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'textualIndex',
+                type: {
+                  name: 'Number'
+                }
+              },
+              screenshot_index: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'screenshotIndex',
+                type: {
+                  name: 'Number'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end