google_api_knowledge_graph_search

v0.1.0

google_api_knowledge_graph_search v0.1.0 GoogleApi.KnowledgeGraphSearch.V1.Api.Entities View Source

API calls for all endpoints tagged Entities.

Link to this section Summary

Functions

kgsearch_entities_search(connection, opts \\ [])

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

Link to this section Functions

Link to this function kgsearch_entities_search(connection, opts \\ []) View Source 
kgsearch_entities_search(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.KnowledgeGraphSearch.V1.Model.SearchResponse.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (GoogleApi.KnowledgeGraphSearch.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (String.t): 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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (String.t): 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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :prefix (boolean()): Enables prefix match against names and aliases of entities
    • :query (String.t): The literal query string for search.
    • :types ([String.t]): 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.
    • :indent (boolean()): Enables indenting of json results.
    • :languages ([String.t]): The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
    • :ids ([String.t]): 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
    • :limit (integer()): Limits the number of entities to be returned.

Returns

{:ok, %GoogleApi.KnowledgeGraphSearch.V1.Model.SearchResponse{}} on success {:error, info} on failure