azure_cognitiveservices_customsearch 0.16.0

data/lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb

@@ -0,0 +1,228 @@
+# 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::CustomSearch::V1_0
+  module Models
+    #
+    # Defines a webpage that is relevant to the query.
+    #
+    class WebPage < CreativeWork
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "WebPage"
+      end
+
+      attr_accessor :_type
+
+      # @return [String] The display URL of the webpage. The URL is meant for
+      # display purposes only and is not well formed.
+      attr_accessor :display_url
+
+      # @return [String] A snippet of text from the webpage that describes its
+      # contents.
+      attr_accessor :snippet
+
+      # @return [Array<WebPage>] A list of links to related content that Bing
+      # found in the website that contains this webpage. The Webpage object in
+      # this context includes only the name, url, urlPingSuffix, and snippet
+      # fields.
+      attr_accessor :deep_links
+
+      # @return [String] The last time that Bing crawled the webpage. The date
+      # is in the form, YYYY-MM-DDTHH:MM:SS. For example, 2015-04-13T05:23:39.
+      attr_accessor :date_last_crawled
+
+      # @return [Array<WebMetaTag>] A list of search tags that the webpage
+      # owner specified on the webpage. The API returns only indexed search
+      # tags. The name field of the MetaTag object contains the indexed search
+      # tag. Search tags begin with search.* (for example, search.assetId). The
+      # content field contains the tag's value.
+      attr_accessor :search_tags
+
+
+      #
+      # Mapper for WebPage class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'WebPage',
+          type: {
+            name: 'Composite',
+            class_name: 'WebPage',
+            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'
+                }
+              },
+              name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'url',
+                type: {
+                  name: 'String'
+                }
+              },
+              description: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'description',
+                type: {
+                  name: 'String'
+                }
+              },
+              bing_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'bingId',
+                type: {
+                  name: 'String'
+                }
+              },
+              thumbnail_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'thumbnailUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              provider: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'provider',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              text: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              display_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'displayUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              snippet: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'snippet',
+                type: {
+                  name: 'String'
+                }
+              },
+              deep_links: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'deepLinks',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'WebPageElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'WebPage'
+                      }
+                  }
+                }
+              },
+              date_last_crawled: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'dateLastCrawled',
+                type: {
+                  name: 'String'
+                }
+              },
+              search_tags: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'searchTags',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'WebMetaTagElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'WebMetaTag'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb

@@ -0,0 +1,149 @@
+# 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::CustomSearch::V1_0
+  module Models
+    #
+    # Defines a list of relevant webpage links.
+    #
+    class WebWebAnswer < SearchResultsAnswer
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "Web/WebAnswer"
+      end
+
+      attr_accessor :_type
+
+      # @return [Array<WebPage>] A list of webpages that are relevant to the
+      # query.
+      attr_accessor :value
+
+      # @return [Boolean] A Boolean value that indicates whether the response
+      # excluded some results from the answer. If Bing excluded some results,
+      # the value is true.
+      attr_accessor :some_results_removed
+
+
+      #
+      # Mapper for WebWebAnswer class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Web/WebAnswer',
+          type: {
+            name: 'Composite',
+            class_name: 'WebWebAnswer',
+            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: 'WebPageElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'WebPage'
+                      }
+                  }
+                }
+              },
+              some_results_removed: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'someResultsRemoved',
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_customsearch/module_definition.rb

@@ -0,0 +1,9 @@
+# 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 end
+module Azure::CognitiveServices end
+module Azure::CognitiveServices::CustomSearch end
+module Azure::CognitiveServices::CustomSearch::V1_0 end

data/lib/azure_cognitiveservices_customsearch.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+require '1.0/generated/azure_cognitiveservices_customsearch'
+require 'profiles/latest/customsearch_latest_profile_client'

data/lib/module_definition.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module Azure end
+module Azure::CognitiveServices end
+module Azure::CognitiveServices::CustomSearch end

data/lib/profiles/latest/customsearch_latest_profile_client.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+require 'profiles/latest/customsearch_module_definition'
+require 'profiles/latest/modules/customsearch_profile_module'
+
+module Azure::CustomSearch::Profiles::Latest
+  #
+  # Client class for the Latest profile SDK.
+  #
+  class Client < CustomSearchDataClass
+    include MsRestAzure::Common::Configurable
+
+    #
+    # Initializes a new instance of the Client class.
+    # @param options [Hash] hash of client options.
+    #    options = {
+    #      tenant_id: 'YOUR TENANT ID',
+    #      client_id: 'YOUR CLIENT ID',
+    #      client_secret: 'YOUR CLIENT SECRET',
+    #      subscription_id: 'YOUR SUBSCRIPTION ID',
+    #      credentials: credentials,
+    #      active_directory_settings: active_directory_settings,
+    #      base_url: 'YOUR BASE URL',
+    #      options: options
+    #    }
+    #   'credentials' are optional and if not passed in the hash, will be obtained
+    #   from MsRest::TokenCredentials using MsRestAzure::ApplicationTokenProvider.
+    #
+    #   Also, base_url, active_directory_settings & options are optional.
+    #
+    def initialize(options = {})
+      super(options)
+    end
+
+  end
+end

data/lib/profiles/latest/customsearch_module_definition.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module Azure end
+module Azure::CustomSearch end
+module Azure::CustomSearch::Profiles end
+module Azure::CustomSearch::Profiles::Latest end