blob: 7d0315e850ac3d44458d11fa404ed2c8d1c84675 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="kgsearch_v1.html">Knowledge Graph Search API</a> . <a href="kgsearch_v1.entities.html">entities</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#search">search(query=None, limit=None, languages=None, indent=None, ids=None, types=None, prefix=None, x__xgafv=None)</a></code></p>
82<p class="firstline">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</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90 <code class="details" id="search">search(query=None, limit=None, languages=None, indent=None, ids=None, types=None, prefix=None, x__xgafv=None)</code>
91 <pre>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
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080092
93Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094 query: string, The literal query string for search.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070095 limit: integer, Limits the number of entities to be returned.
96 languages: string, The list of language codes (defined in ISO 693) to run the query with, e.g. &#x27;en&#x27;. (repeated)
97 indent: boolean, Enables indenting of json results.
98 ids: string, 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&amp;ids=B (repeated)
99 types: string, 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. (repeated)
100 prefix: boolean, Enables prefix match against names and aliases of entities
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800101 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800105
106Returns:
107 An object of the form:
108
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 { # Response message includes the context and a list of matching results which contain the detail of associated entities.
110 &quot;@context&quot;: &quot;&quot;, # The local context applicable for the response. See more details at http://www.w3.org/TR/json-ld/#context-definitions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;itemListElement&quot;: [ # The item list of search results.
112 &quot;&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800113 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 &quot;@type&quot;: &quot;&quot;, # The schema type of top-level JSON-LD object, e.g. ItemList.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800115 }</pre>
116</div>
117
118</body></html>