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

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/kgsearch_v1/service.rb

Overview

Knowledge Graph Search API

Knowledge Graph Search API allows developers to search 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:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeKgsearchService

Returns a new instance of KgsearchService.


46
47
48
# File 'generated/google/apis/kgsearch_v1/service.rb', line 46

def initialize
  super('https://kgsearch.googleapis.com/', '')
end

Instance Attribute Details

#keyString

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.


39
40
41
# File 'generated/google/apis/kgsearch_v1/service.rb', line 39

def key
  @key
end

#quota_userString

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.


44
45
46
# File 'generated/google/apis/kgsearch_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#search_entities(query: nil, ids: nil, languages: nil, types: nil, indent: nil, prefix: nil, limit: 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:

  • query (String) (defaults to: nil)

    The literal query string for search.

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

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

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

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

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

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

  • indent (Boolean) (defaults to: nil)

    Enables indenting of json results.

  • prefix (Boolean) (defaults to: nil)

    Enables prefix match against names and aliases of entities

  • limit (Fixnum) (defaults to: nil)

    Limits the number of entities to be returned.

  • 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:


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# 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