garf-knowledge-graph-api 1.0.0

description

garf for Knowledge Graph Search API

garf-knowledge-graph-api simplifies fetching data from Knowledge Graph Search API using SQL-like queries.

Prerequisites

• Knowledge Graph Search API enabled.
• API key to access to access Knowledge Graph Search API.

  Once generated expose API key as export KG_API_KEY=<YOUR_API_KEY>

Installation

pip install garf-knowledge-graph-api

Usage

Run as a library

from garf.community.google.knowledge_graph import report_fetcher
from garf.io import writer


# Specify query
query = """
  SELECT
    result_score,
    @id AS id,
    @type AS type,
    description,
    image.url AS url
  FROM query
  WHERE {query}
""

# Fetch report
fetched_report = (
  report_fetcher.KnowledgeGraphApiReportFetcher()
  .fetch(query, query="<YOUR_SEARCH_QUERY_HERE">)
)

# Write report to console
console_writer = writer.create_writer('console')
console_writer.write(fetched_report, 'output')

Run via CLI

Install garf-executors package to run queries via CLI (pip install garf-executors).

garf <PATH_TO_QUERIES> --source knowledge-graph-api \
  --output <OUTPUT_TYPE> \
  --source.<SOURCE_PARAMETER=VALUE>

where:

• <PATH_TO_QUERIES> - local or remove files containing queries
• <OUTPUT_TYPE> - output supported by garf-io library.
• <SOURCE_PARAMETER=VALUE - key-value pairs to refine fetching, check available source parameters.

Available source parameters

name	values	comments
ids	One or many Knowledge Graph Ids	Multiple ids are supported, should be comma-separated
query	Search query	i.e. "Radiohead"