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

API calls for all endpoints tagged Entities.

Link to this section Summary

Functions

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, optional_params \\ [], opts \\ [])

View Source

Specs

kgsearch_entities_search(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.KnowledgeGraphSearch.V1.Model.SearchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Returns

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