blob: 6ba3cd184a2f076e6b345383b428513883ca7349 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="contentwarehouse_v1.html">Document AI Warehouse API</a> . <a href="contentwarehouse_v1.projects.html">projects</a> . <a href="contentwarehouse_v1.projects.locations.html">locations</a> . <a href="contentwarehouse_v1.projects.locations.synonymSets.html">synonymSets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all SynonymSets (for all contexts) for the specified location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.
Args:
parent: string, Required. The parent name. Format: projects/{project_number}/locations/{location}. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a list of synonyms for a given context. For example a context &quot;sales&quot; could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
&quot;context&quot;: &quot;A String&quot;, # This is a freeform field. Example contexts can be &quot;sales,&quot; &quot;engineering,&quot; &quot;real estate,&quot; &quot;accounting,&quot; etc. The context can be supplied during search requests.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
&quot;synonyms&quot;: [ # List of Synonyms for the context.
{ # Represents a list of words given by the customer All these words are synonyms of each other.
&quot;words&quot;: [ # For example: sale, invoice, bill, order
&quot;A String&quot;,
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a list of synonyms for a given context. For example a context &quot;sales&quot; could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
&quot;context&quot;: &quot;A String&quot;, # This is a freeform field. Example contexts can be &quot;sales,&quot; &quot;engineering,&quot; &quot;real estate,&quot; &quot;accounting,&quot; etc. The context can be supplied during search requests.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
&quot;synonyms&quot;: [ # List of Synonyms for the context.
{ # Represents a list of words given by the customer All these words are synonyms of each other.
&quot;words&quot;: [ # For example: sale, invoice, bill, order
&quot;A String&quot;,
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.
Args:
name: string, Required. The name of the synonymSet to delete Format: projects/{project_number}/locations/{location}/synonymSets/{context}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist
Args:
name: string, Required. The name of the synonymSet to retrieve Format: projects/{project_number}/locations/{location}/synonymSets/{context}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a list of synonyms for a given context. For example a context &quot;sales&quot; could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
&quot;context&quot;: &quot;A String&quot;, # This is a freeform field. Example contexts can be &quot;sales,&quot; &quot;engineering,&quot; &quot;real estate,&quot; &quot;accounting,&quot; etc. The context can be supplied during search requests.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
&quot;synonyms&quot;: [ # List of Synonyms for the context.
{ # Represents a list of words given by the customer All these words are synonyms of each other.
&quot;words&quot;: [ # For example: sale, invoice, bill, order
&quot;A String&quot;,
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns all SynonymSets (for all contexts) for the specified location.
Args:
parent: string, Required. The parent name. Format: projects/{project_number}/locations/{location}. (required)
pageSize: integer, The maximum number of synonymSets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListSynonymSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSynonymSets` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SynonymSetService.ListSynonymSets.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A page token, received from a previous `ListSynonymSets` call. Provide this to retrieve the subsequent page.
&quot;synonymSets&quot;: [ # The synonymSets from the specified parent.
{ # Represents a list of synonyms for a given context. For example a context &quot;sales&quot; could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
&quot;context&quot;: &quot;A String&quot;, # This is a freeform field. Example contexts can be &quot;sales,&quot; &quot;engineering,&quot; &quot;real estate,&quot; &quot;accounting,&quot; etc. The context can be supplied during search requests.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
&quot;synonyms&quot;: [ # List of Synonyms for the context.
{ # Represents a list of words given by the customer All these words are synonyms of each other.
&quot;words&quot;: [ # For example: sale, invoice, bill, order
&quot;A String&quot;,
],
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.
Args:
name: string, Required. The name of the synonymSet to update Format: projects/{project_number}/locations/{location}/synonymSets/{context}. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a list of synonyms for a given context. For example a context &quot;sales&quot; could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
&quot;context&quot;: &quot;A String&quot;, # This is a freeform field. Example contexts can be &quot;sales,&quot; &quot;engineering,&quot; &quot;real estate,&quot; &quot;accounting,&quot; etc. The context can be supplied during search requests.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
&quot;synonyms&quot;: [ # List of Synonyms for the context.
{ # Represents a list of words given by the customer All these words are synonyms of each other.
&quot;words&quot;: [ # For example: sale, invoice, bill, order
&quot;A String&quot;,
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a list of synonyms for a given context. For example a context &quot;sales&quot; could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
&quot;context&quot;: &quot;A String&quot;, # This is a freeform field. Example contexts can be &quot;sales,&quot; &quot;engineering,&quot; &quot;real estate,&quot; &quot;accounting,&quot; etc. The context can be supplied during search requests.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
&quot;synonyms&quot;: [ # List of Synonyms for the context.
{ # Represents a list of words given by the customer All these words are synonyms of each other.
&quot;words&quot;: [ # For example: sale, invoice, bill, order
&quot;A String&quot;,
],
},
],
}</pre>
</div>
</body></html>