class Google::Apis::KgsearchV1::KgsearchService

Knowledge Graph Search API

Knowledge Graph Search API allows developers to search the Google Knowledge

Graph for entities.

@example

require 'google/apis/kgsearch_v1'

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

@see developers.google.com/knowledge-graph/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method Google::Apis::Core::BaseService.new
# File generated/google/apis/kgsearch_v1/service.rb, line 46
def initialize
  super('https://kgsearch.googleapis.com/', '')
end

Public Instance Methods

search_entities(query: nil, ids: nil, languages: nil, types: nil, indent: nil, prefix: nil, limit: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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 schema.org @param [String] query

The literal query string for search.

@param [Array<String>, String] ids

The list of entity id to be used for search instead of query string.

@param [Array<String>, String] languages

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

@param [Array<String>, String] types

Restricts returned entities with these types, e.g. Person (as defined in http:/
/schema.org/Person).

@param [Boolean] indent

Enables indenting of json results.

@param [Boolean] prefix

Enables prefix match against names and aliases of entities

@param [Fixnum] limit

Limits the number of entities to be returned.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] #quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::KgsearchV1::SearchResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::KgsearchV1::SearchResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File generated/google/apis/kgsearch_v1/service.rb, line 86
def search_entities(query: nil, ids: nil, languages: nil, types: nil, indent: nil, prefix: nil, limit: 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['query'] = query unless query.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['languages'] = languages unless languages.nil?
  command.query['types'] = types unless types.nil?
  command.query['indent'] = indent unless indent.nil?
  command.query['prefix'] = prefix unless prefix.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File generated/google/apis/kgsearch_v1/service.rb, line 104
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end