Class: Google::Apis::KgsearchV1::KgsearchService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/kgsearch_v1/service.rb

Overview

Knowledge Graph Search API

Searches the Google Knowledge Graph for entities.

Examples:

require 'google/apis/kgsearch_v1'

Kgsearch = Google::Apis::KgsearchV1 # Alias the module
service = Kgsearch::KgsearchService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://kgsearch.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ KgsearchService

Returns a new instance of KgsearchService.



47
48
49
50
51
52
 
# File 'lib/google/apis/kgsearch_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-kgsearch_v1',
        client_version: Google::Apis::KgsearchV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/kgsearch_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/kgsearch_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#search_entities(ids: nil, indent: nil, languages: nil, limit: nil, prefix: nil, query: nil, types: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::KgsearchV1::SearchResponse

Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

Parameters:

  • ids (Array<String>, String) (defaults to: nil) —

    The list of entity id to be used for search instead of query string. To specify multiple ids in the HTTP request, repeat the parameter in the URL as in ...?ids=A&ids=B

  • indent (Boolean) (defaults to: nil) —

    Enables indenting of json results.

  • languages (Array<String>, String) (defaults to: nil) —

    The list of language codes (defined in ISO 693) to run the query with, e.g. ' en'.

  • limit (Fixnum) (defaults to: nil) —

    Limits the number of entities to be returned.

  • prefix (Boolean) (defaults to: nil) —

    Enables prefix match against names and aliases of entities

  • query (String) (defaults to: nil) —

    The literal query string for search.

  • types (Array<String>, String) (defaults to: nil) —

    Restricts returned entities with these types, e.g. Person (as defined in http:/ /schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/apis/kgsearch_v1/service.rb', line 93

def search_entities(ids: nil, indent: nil, languages: nil, limit: nil, prefix: nil, query: nil, types: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/entities:search', options)
  command.response_representation = Google::Apis::KgsearchV1::SearchResponse::Representation
  command.response_class = Google::Apis::KgsearchV1::SearchResponse
  command.query['ids'] = ids unless ids.nil?
  command.query['indent'] = indent unless indent.nil?
  command.query['languages'] = languages unless languages.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['prefix'] = prefix unless prefix.nil?
  command.query['query'] = query unless query.nil?
  command.query['types'] = types unless types.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end