elastic-app-search 7.4.0 → 7.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23ca08f1c2392f7be42177b5b3d8574b41949eaacffa31699d2b46b482a84021
-  data.tar.gz: 267e8bac44dfd815e42a9d6e6971de0b342feb1a2982887028adfebd83faf0d3
+  metadata.gz: 6ad2aa4de4232586f616793b6f55332dde5d122fbe79ac5f80c62c42fa93bb07
+  data.tar.gz: 5413783fa304ac1c71b317f982a20d4d2d35b2eb6782721df285dd9ce58eadb0
 SHA512:
-  metadata.gz: '0019c22322850583ed5f3e1062365998511e31200a7fe938eb7a3a63ff2a35540977541f666a8144d8cd9ed5cff91307d7f2bb90224859610a94ea99cd5f1ef2'
-  data.tar.gz: 4b22ee129457885c0084d5e6bb931fb78e37b8e0f15f697e650e7804aa075eead085ef7f36729d26634d2f7419f9d4e2a7939592970d0e48d939a83745e2775a
+  metadata.gz: 4896a9fb557f51ad81e44af96114d38463743781c777e93ff4b07d770b8cd941f48cb3cb5e7005a4282ea92d7859e8286bd1572152a10539bd50e63b07593b94
+  data.tar.gz: b235d0390fcb69242ad2dc23e400d042ea33278cdcb8038b06b4c9f32b8aec7cc9ccbd6117aaa06301f7858a88696c020aa8fc1710f2237da493f64de1768f33

data/README.md

@@ -25,7 +25,7 @@ To install the gem, execute:
 gem install elastic-app-search
 ```
 
-Or place `gem 'elastic-app-search', '~> 7.4.0'` in your `Gemfile` and run `bundle install`.
+Or place `gem 'elastic-app-search', '~> 7.4.1'` in your `Gemfile` and run `bundle install`.
 
 ## Versioning
 
@@ -192,7 +192,6 @@ client.search(engine_name, query, options)
 
 ```ruby
 engine_name = 'favorite-videos'
-
 queries = [{
   :query => 'cat',
   :options => { :search_fields => { :title => {} }}
@@ -208,7 +207,6 @@ client.multi_search(engine_name, queries)
 
 ```ruby
 engine_name = 'favorite-videos'
-
 options = {
   :size => 3,
   :types => {
@@ -233,30 +231,29 @@ client.show_settings(engine_name)
 
 ```ruby
 engine_name = 'favorite-videos'
-
 settings = {
-  "search_fields" => {
-    "id" => {
-      "weight" => 1
+  'search_fields' => {
+    'id' => {
+      'weight' => 1
     },
-    "url" => {
-      "weight" => 1
+    'url' => {
+      'weight' => 1
     },
-    "title" => {
-      "weight" => 1
+    'title' => {
+      'weight' => 1
     },
-    "body" => {
-      "weight" => 1
+    'body' => {
+      'weight' => 1
     },
   },
-  "boosts" => {
-    "title" => [
+  'boosts' => {
+    'title' => [
       {
-        "type" => "value",
-        "factor" => 9.5,
-        "operation" => "multiply",
-        "value" => [
-          "Titanic"
+        'type' => 'value',
+        'factor' => 9.5,
+        'operation' => 'multiply',
+        'value' => [
+          'Titanic'
         ]
       }
     ]
@@ -292,10 +289,279 @@ client = Elastic::AppSearch::Client.new(host_identifier: 'host-c5s2mj', api_key:
 client.search('national-parks-demo', 'everglade')
 ```
 
+#### Log click-through
+
+Logging a click through
+
+```ruby
+engine_name = 'favorite-videos'
+options = {
+  :query => 'cat videos',
+  :document_id => 'INscMGmhmX4',
+  :request_id => 'e4c4dea0bd7ad3d2f676575ef16dc7d2',
+  :tags => ['firefox', 'web browser']
+}
+
+client.log_click_through(engine_name, options)
+```
+
+#### Analytics - Number of clicks-throughs received by a document
+
+```ruby
+engine_name = 'favorite-videos'
+options = {
+  :query => 'cats',
+  :page => {
+    :size => 20,
+  },
+  :filters => {
+    :date => {
+      :from => '2019-04-11T00:00:00+00:00',
+      :to => '2019-04-13T00:00:00+00:00'
+    }
+  }
+}
+
+client.get_top_clicks_analytics(engine_name, options)
+```
+
+#### Analytics - Queries, number of queries, and clicks received
+
+```ruby
+engine_name = 'favorite-videos'
+options = {
+  :page => {
+    :size => 20
+  },
+  :filters => {
+    :date => {
+      :from => '2019-04-11T00:00:00+00:00',
+      :to => '2019-04-13T00:00:00+00:00'
+    }
+  }
+}
+
+client.get_top_queries_analytics(engine_name, options)
+```
+
+#### Analytics - Number of clicks and total number of queries
+
+```ruby
+engine_name = 'favorite-videos'
+options = {
+  :filters => {
+    :all => [
+      {
+        :tag => ['mobile', 'web']
+      },{
+        :query => 'cats'
+      }, {
+        :document_id => '163'
+      }, {
+        :date => {
+          :from => '2018-07-05T12:00:00+00:00',
+          :to => '2018-07-05T14:00:00+00:00'
+        }
+      }
+    ]
+  },
+  :interval => 'hour'
+}
+
+client.get_count_analytics(engine_name, options)
+```
+
+#### Creating Synonym Sets
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.create_synonym_set(engine_name, :synonyms => ['park', 'trail'])
+```
+
+#### Retrieving Synonym Sets
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.get_synonym_set(engine_name, 'syn-5d8e6b5d40caae7dcb6e1b9c')
+```
+
+#### Listing Synonym Sets
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.list_synonym_sets(engine_name, :current => 1, :size => 20)
+```
+
+#### Updating Synonym Sets
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.update_synonym_set(engine_name, 'syn-5d8e6b5d40caae7dcb6e1b9c', :synonyms => ['park', 'trail', 'ground'])
+```
+
+#### Destroying Synonym Sets
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.destroy_synonym_set(engine_name, 'syn-5d8e6b5d40caae7dcb6e1b9c')
+```
+
+#### Listing Credentials
+
+```ruby
+client.list_credentials(:current => 1, :size => 20)
+```
+
+#### Retrieving Credentials
+
+```ruby
+client.get_credential('reading-private-key')
+```
+
+#### Creating Credentials
+
+```ruby
+client.create_credential({
+  :name => 'reading-private-key',
+  :type => 'private',
+  :read => true,
+  :write => false,
+  :access_all_engines => false,
+  :engines => [
+    'favorite-videos'
+  ]
+})
+```
+
+#### Updating Credentials
+
+```ruby
+client.update_credential('reading-private-key', {
+  :name => 'reading-private-key',
+  :type => 'private',
+  :read => true,
+  :write => true,
+  :access_all_engines => false,
+  :engines => [
+    'favorite-videos'
+  ]
+})
+```
+
+#### Destroying Credentials
+
+```ruby
+client.destroy_credential('reading-private-key')
+```
+
+#### Retrieving an Engine's Schema
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.get_schema(engine_name)
+```
+
+#### Updating an Engine's Schema or Creating a New Schema Field
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.update_schema(engine_name, 'square_km' => 'number')
+```
+
+#### Creating Curations
+
+```ruby
+engine_name = 'us-national-parks'
+options = {
+  'queries' => [
+    'zion'
+  ],
+  'promoted' => [
+    'doc-5d8e413b40caaedab76e3c96'
+  ],
+  'hidden' => [
+    'doc-5d8e413d40caae335e06c374'
+  ]
+}
+
+client.create_curation(engine_name, options)
+```
+
+#### Retrieving Curations
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.get_curation(engine_name, 'cur-5d9240d640caaeca6506b600')
+```
+
+#### Listing Curations
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.list_curations(engine_name, current: 1, size: 20)
+```
+
+#### Updating Curations
+
+```ruby
+engine_name = 'us-national-parks'
+id = 'cur-5d9240d640caaeca6506b600'
+options = {
+  'queries' => [
+    'zion'
+  ],
+  'promoted' => [
+    'doc-5d8e413b40caaedab76e3c96'
+  ]
+}
+
+client.update_curation(engine_name, id, options)
+```
+
+#### Destroying Curations
+
+```ruby
+engine_name = 'us-national-parks'
+
+client.destroy_curation(engine_name, 'cur-5d9240d640caaeca6506b600')
+```
+
+#### Retrieving API Logs
+
+```ruby
+engine_name = 'us-national-parks'
+options = {
+  'filters' => {
+    'date' => {
+      'from' => '2019-09-23T00:00:00+00:00',
+      'to' => '2019-09-28T00:00:00+00:00'
+    }
+  },
+  'page' => {
+    'total_results' => 100,
+    'size' => 20
+  },
+  'query' => 'search',
+  'sort_direction' => 'desc'
+}
+
+client.get_api_logs(engine_name, options)
+```
+
 ## Running Tests
 
 ```bash
 export AS_API_KEY="[API_KEY]"
+export AS_ADMIN_KEY="[ADMIN_API_KEY]"
 export AS_HOST_IDENTIFIER="[HOST_IDENTIFIER]"
 bundle exec rspec
 ```
@@ -304,6 +570,7 @@ You can also run tests against a local environment by passing a `AS_API_ENDPOINT
 
 ```bash
 export AS_API_KEY="[API_KEY]"
+export AS_ADMIN_KEY="[ADMIN_API_KEY]"
 export AS_API_ENDPOINT="http://[HOST_IDENTIFIER].api.127.0.0.1.ip.es.io:3002/api/as/v1"
 bundle exec rspec
 ```

data/lib/elastic/app-search/client.rb

@@ -7,11 +7,18 @@ module Elastic
   module AppSearch
     # API client for the {Elastic App Search API}[https://www.elastic.co/cloud/app-search-service].
     class Client
+      autoload :Analytics, 'elastic/app-search/client/analytics'
+      autoload :Click, 'elastic/app-search/client/click'
+      autoload :Credentials, 'elastic/app-search/client/credentials'
+      autoload :Curations, 'elastic/app-search/client/curations'
       autoload :Documents, 'elastic/app-search/client/documents'
       autoload :Engines, 'elastic/app-search/client/engines'
+      autoload :Logs, 'elastic/app-search/client/logs'
+      autoload :Schema, 'elastic/app-search/client/schema'
       autoload :Search, 'elastic/app-search/client/search'
-      autoload :QuerySuggestion, 'elastic/app-search/client/query_suggestion'
       autoload :SearchSettings, 'elastic/app-search/client/search_settings'
+      autoload :Synonyms, 'elastic/app-search/client/synonyms'
+      autoload :QuerySuggestion, 'elastic/app-search/client/query_suggestion'
 
       DEFAULT_TIMEOUT = 15
 
@@ -56,12 +63,19 @@ module Elastic
         end
       end
 
+      include Elastic::AppSearch::Client::Analytics
+      include Elastic::AppSearch::Client::Click
+      include Elastic::AppSearch::Client::Credentials
+      include Elastic::AppSearch::Client::Curations
       include Elastic::AppSearch::Client::Documents
       include Elastic::AppSearch::Client::Engines
+      include Elastic::AppSearch::Client::Logs
+      include Elastic::AppSearch::Client::Schema
       include Elastic::AppSearch::Client::Search
+      include Elastic::AppSearch::Client::SearchSettings
       include Elastic::AppSearch::Client::SignedSearchOptions
+      include Elastic::AppSearch::Client::Synonyms
       include Elastic::AppSearch::Client::QuerySuggestion
-      include Elastic::AppSearch::Client::SearchSettings
     end
   end
 end

data/lib/elastic/app-search/client/analytics.rb

@@ -0,0 +1,25 @@
+# Analytics API - https://swiftype.com/documentation/app-search/api/analytics
+module Elastic
+  module AppSearch
+    class Client
+      module Analytics
+
+        # Returns the number of clicks received by a document in descending order.
+        def get_top_clicks_analytics(engine_name, options)
+          post("engines/#{engine_name}/analytics/clicks", options)
+        end
+
+        # Returns queries analytics by usage count
+        def get_top_queries_analytics(engine_name, options)
+          post("engines/#{engine_name}/analytics/queries", options)
+        end
+
+        # Returns the number of clicks and total number of queries over a period.
+        def get_count_analytics(engine_name, options)
+          post("engines/#{engine_name}/analytics/counts", options)
+        end
+
+      end
+    end
+  end
+end

data/lib/elastic/app-search/client/click.rb

@@ -0,0 +1,15 @@
+# Click API - https://swiftype.com/documentation/app-search/api/clickthrough
+module Elastic
+  module AppSearch
+    class Client
+      module Click
+
+        # Send data about clicked results.
+        def log_click_through(engine_name, options)
+          post("engines/#{engine_name}/documents", options)
+        end
+
+      end
+    end
+  end
+end