docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/kgsearch_v1.entities.html b/docs/dyn/kgsearch_v1.entities.html
index ed032ab..4894b25 100644
--- a/docs/dyn/kgsearch_v1.entities.html
+++ b/docs/dyn/kgsearch_v1.entities.html
@@ -75,44 +75,44 @@
<h1><a href="kgsearch_v1.html">Knowledge Graph Search API</a> . <a href="kgsearch_v1.entities.html">entities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#search">search(prefix=None, query=None, x__xgafv=None, languages=None, types=None, indent=None, ids=None, limit=None)</a></code></p>
+ <code><a href="#search">search(languages=None, types=None, ids=None, indent=None, prefix=None, query=None, limit=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches Knowledge Graph for entities that match the constraints.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="search">search(prefix=None, query=None, x__xgafv=None, languages=None, types=None, indent=None, ids=None, limit=None)</code>
+ <code class="details" id="search">search(languages=None, types=None, ids=None, indent=None, prefix=None, query=None, limit=None, x__xgafv=None)</code>
<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
Args:
+ languages: string, The list of language codes (defined in ISO 693) to run the query with,
+e.g. 'en'. (repeated)
+ 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)
+ 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&ids=B (repeated)
+ indent: boolean, Enables indenting of json results.
prefix: boolean, Enables prefix match against names and aliases of entities
query: string, The literal query string for search.
+ limit: integer, Limits the number of entities to be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- languages: string, The list of language codes (defined in ISO 693) to run the query with,
-e.g. 'en'. (repeated)
- 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)
- indent: boolean, Enables indenting of json results.
- 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&ids=B (repeated)
- limit: integer, Limits the number of entities to be returned.
Returns:
An object of the form:
{ # Response message includes the context and a list of matching results
# which contain the detail of associated entities.
- "@context": "", # The local context applicable for the response. See more details at
- # http://www.w3.org/TR/json-ld/#context-definitions.
- "itemListElement": [ # The item list of search results.
- "",
+ "itemListElement": [ # The item list of search results.
+ "",
],
- "@type": "", # The schema type of top-level JSON-LD object, e.g. ItemList.
+ "@context": "", # The local context applicable for the response. See more details at
+ # http://www.w3.org/TR/json-ld/#context-definitions.
+ "@type": "", # The schema type of top-level JSON-LD object, e.g. ItemList.
}</pre>
</div>