Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, 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 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, 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">
     78   <code><a href="#search">search(prefix=None, query=None, x__xgafv=None, types=None, indent=None, languages=None, ids=None, limit=None)</a></code></p>
     79 <p class="firstline">Searches Knowledge Graph for entities that match the constraints.</p>
     80 <h3>Method Details</h3>
     81 <div class="method">
     82     <code class="details" id="search">search(prefix=None, query=None, x__xgafv=None, types=None, indent=None, languages=None, ids=None, limit=None)</code>
     83   <pre>Searches Knowledge Graph for entities that match the constraints.
     84 A list of matched entities will be returned in response, which will be in
     85 JSON-LD format and compatible with http://schema.org
     86 
     87 Args:
     88   prefix: boolean, Enables prefix match against names and aliases of entities
     89   query: string, The literal query string for search.
     90   x__xgafv: string, V1 error format.
     91     Allowed values
     92       1 - v1 error format
     93       2 - v2 error format
     94   types: string, Restricts returned entities with these types, e.g. Person
     95 (as defined in http://schema.org/Person). If multiple types are specified,
     96 returned entities will contain one or more of these types. (repeated)
     97   indent: boolean, Enables indenting of json results.
     98   languages: string, The list of language codes (defined in ISO 693) to run the query with,
     99 e.g. 'en'. (repeated)
    100   ids: string, The list of entity id to be used for search instead of query string.
    101 To specify multiple ids in the HTTP request, repeat the parameter in the
    102 URL as in ...?ids=A&ids=B (repeated)
    103   limit: integer, Limits the number of entities to be returned.
    104 
    105 Returns:
    106   An object of the form:
    107 
    108     { # Response message includes the context and a list of matching results
    109       # which contain the detail of associated entities.
    110     "@context": "", # The local context applicable for the response. See more details at
    111         # http://www.w3.org/TR/json-ld/#context-definitions.
    112     "itemListElement": [ # The item list of search results.
    113       "",
    114     ],
    115     "@type": "", # The schema type of top-level JSON-LD object, e.g. ItemList.
    116   }</pre>
    117 </div>
    118 
    119 </body></html>