Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / cloudsearch_v1.settings.searchapplications.html
blob: de864a0c27686a4465b9cbe283ef2e26f5a09a21 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a> . <a href="cloudsearch_v1.settings.searchapplications.html">searchapplications</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Gets the specified search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]90 <code><a href="#list">list(debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Lists all search applications. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Updates a search application. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107<div class="method">
108 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
109 <pre>Creates a search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 The object takes the form of:
114
115{ # SearchApplication
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]116 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
117 { # Restriction on Datasource.
118 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
119 { # Filter options to be applied on query.
120 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
121 &quot;compositeFilter&quot;: {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]122 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]123 &quot;subFilters&quot;: [ # Sub filters.
124 # Object with schema name: Filter
125 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]126 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]127 &quot;valueFilter&quot;: {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]128 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]129 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]130 &quot;booleanValue&quot;: True or False,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]131 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]132 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
133 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]134 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]135 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]136 &quot;doubleValue&quot;: 3.14,
137 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]138 &quot;stringValue&quot;: &quot;A String&quot;,
139 &quot;timestampValue&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]140 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]141 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]143 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
144 },
145 ],
146 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]147 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]148 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]149 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]150 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]151 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]152 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
153 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
154 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
155 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
156 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
157 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
158 },
159 ],
160 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
161 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
162 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
163 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]164 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]165 &quot;enableAuditLog&quot;: True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]166 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]167 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
168 &quot;A String&quot;,
169 ],
yoshi-code-bot07708072021-07-20 00:20:24 -0700[diff] [blame]170 &quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
171 &quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
172 &quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
173 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]174 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
175 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
176 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
177 },
178 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
179 { # Configurations for a source while processing a Search or Suggest request.
180 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
181 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
182 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
183 },
184 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
185 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
186 },
187 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
188 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
189 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
190 },
191 },
192 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]193}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194
195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]203 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]204 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
205 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
206 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
207 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
208 {
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
211 ],
212 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
213 },
214 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
215 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
216 },
217 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
218 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
219 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
220 },
221}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222</div>
223
224<div class="method">
225 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]226 <pre>Deletes a search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]229 name: string, The name of the search application to be deleted. Format: applications/{application_id}. (required)
230 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
235
236Returns:
237 An object of the form:
238
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]239 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]240 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
241 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
242 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
243 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
244 {
245 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
246 },
247 ],
248 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
249 },
250 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
251 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
252 },
253 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
254 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
255 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
256 },
257}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258</div>
259
260<div class="method">
261 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]262 <pre>Gets the specified search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]263
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]265 name: string, Name of the search application. Format: searchapplications/{application_id}. (required)
266 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 x__xgafv: string, V1 error format.
268 Allowed values
269 1 - v1 error format
270 2 - v2 error format
271
272Returns:
273 An object of the form:
274
275 { # SearchApplication
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]276 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
277 { # Restriction on Datasource.
278 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
279 { # Filter options to be applied on query.
280 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
281 &quot;compositeFilter&quot;: {
282 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
283 &quot;subFilters&quot;: [ # Sub filters.
284 # Object with schema name: Filter
285 ],
286 },
287 &quot;valueFilter&quot;: {
288 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
289 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
290 &quot;booleanValue&quot;: True or False,
291 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
292 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
293 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
294 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]295 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]296 &quot;doubleValue&quot;: 3.14,
297 &quot;integerValue&quot;: &quot;A String&quot;,
298 &quot;stringValue&quot;: &quot;A String&quot;,
299 &quot;timestampValue&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]300 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]301 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]302 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]303 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]304 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]305 ],
306 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
307 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
308 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]309 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]310 },
311 ],
312 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
313 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
314 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
315 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
316 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
317 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
318 },
319 ],
320 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
321 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
322 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
323 },
324 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]325 &quot;enableAuditLog&quot;: True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]326 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
327 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
328 &quot;A String&quot;,
329 ],
yoshi-code-bot07708072021-07-20 00:20:24 -0700[diff] [blame]330 &quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
331 &quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
332 &quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
333 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]334 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
335 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
336 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
337 },
338 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
339 { # Configurations for a source while processing a Search or Suggest request.
340 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
341 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
342 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
343 },
344 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
345 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
346 },
347 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
348 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
349 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
350 },
351 },
352 ],
353}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354</div>
355
356<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]357 <code class="details" id="list">list(debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]358 <pre>Lists all search applications. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]359
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]361 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]362 pageSize: integer, The maximum number of items to return.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]363 pageToken: string, The next_page_token value returned from a previous List request, if any. The default value is 10
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 x__xgafv: string, V1 error format.
365 Allowed values
366 1 - v1 error format
367 2 - v2 error format
368
369Returns:
370 An object of the form:
371
372 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]373 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
374 &quot;searchApplications&quot;: [
375 { # SearchApplication
376 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
377 { # Restriction on Datasource.
378 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
379 { # Filter options to be applied on query.
380 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
381 &quot;compositeFilter&quot;: {
382 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
383 &quot;subFilters&quot;: [ # Sub filters.
384 # Object with schema name: Filter
385 ],
386 },
387 &quot;valueFilter&quot;: {
388 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
389 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
390 &quot;booleanValue&quot;: True or False,
391 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
392 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
393 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
394 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]395 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]396 &quot;doubleValue&quot;: 3.14,
397 &quot;integerValue&quot;: &quot;A String&quot;,
398 &quot;stringValue&quot;: &quot;A String&quot;,
399 &quot;timestampValue&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]400 },
401 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]402 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]403 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]404 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]405 ],
406 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
407 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
408 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]409 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]410 },
411 ],
412 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
413 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
414 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
415 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
416 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
417 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
418 },
419 ],
420 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
421 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
422 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]423 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]424 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]425 &quot;enableAuditLog&quot;: True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]426 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
427 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
428 &quot;A String&quot;,
429 ],
yoshi-code-bot07708072021-07-20 00:20:24 -0700[diff] [blame]430 &quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
431 &quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
432 &quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
433 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]434 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
435 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
436 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
437 },
438 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
439 { # Configurations for a source while processing a Search or Suggest request.
440 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
441 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
442 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
443 },
444 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
445 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
446 },
447 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
448 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
449 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
450 },
451 },
452 ],
453 },
454 ],
455}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456</div>
457
458<div class="method">
459 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
460 <pre>Retrieves the next page of results.
461
462Args:
463 previous_request: The request for the previous page. (required)
464 previous_response: The response from the request for the previous page. (required)
465
466Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]467 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]468 page. Returns None if there are no more items in the collection.
469 </pre>
470</div>
471
472<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]473 <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]474 <pre>Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]475
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]476Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]477 name: string, The name of the search application to be reset. Format: applications/{application_id}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]478 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 The object takes the form of:
480
481{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]482 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
483 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
484 },
485}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486
487 x__xgafv: string, V1 error format.
488 Allowed values
489 1 - v1 error format
490 2 - v2 error format
491
492Returns:
493 An object of the form:
494
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]495 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]496 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
497 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
498 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
499 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
500 {
501 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
502 },
503 ],
504 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
505 },
506 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
507 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
508 },
509 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
510 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
511 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
512 },
513}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]514</div>
515
516<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]517 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]518 <pre>Updates a search application. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]519
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]521 name: string, Name of the Search Application. Format: searchapplications/{application_id}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]522 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]523 The object takes the form of:
524
525{ # SearchApplication
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]526 &quot;dataSourceRestrictions&quot;: [ # Retrictions applied to the configurations. The maximum number of elements is 10.
527 { # Restriction on Datasource.
528 &quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.
529 { # Filter options to be applied on query.
530 &quot;filter&quot;: { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
531 &quot;compositeFilter&quot;: {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]532 &quot;logicOperator&quot;: &quot;A String&quot;, # The logic operator of the sub filter.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]533 &quot;subFilters&quot;: [ # Sub filters.
534 # Object with schema name: Filter
535 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]536 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]537 &quot;valueFilter&quot;: {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]538 &quot;operatorName&quot;: &quot;A String&quot;, # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]539 &quot;value&quot;: { # Definition of a single value with generic type. # The value to be compared with.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]540 &quot;booleanValue&quot;: True or False,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]541 &quot;dateValue&quot;: { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]542 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
543 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]544 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]545 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]546 &quot;doubleValue&quot;: 3.14,
547 &quot;integerValue&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]548 &quot;stringValue&quot;: &quot;A String&quot;,
549 &quot;timestampValue&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]550 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]551 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]552 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]553 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
554 },
555 ],
556 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source of restriction.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]557 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]558 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]559 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]560 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]561 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]562 &quot;defaultFacetOptions&quot;: [ # The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
563 { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
564 &quot;numFacetBuckets&quot;: 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
565 &quot;objectType&quot;: &quot;A String&quot;, # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
566 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
567 &quot;sourceName&quot;: &quot;A String&quot;, # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
568 },
569 ],
570 &quot;defaultSortOptions&quot;: { # The default options for sorting the search results
571 &quot;operatorName&quot;: &quot;A String&quot;, # Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
572 &quot;sortOrder&quot;: &quot;A String&quot;, # Ascending is the default sort order
573 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]574 &quot;displayName&quot;: &quot;A String&quot;, # Display name of the Search Application. The maximum length is 300 characters.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]575 &quot;enableAuditLog&quot;: True or False, # Indicates whether audit logging is on/off for requests made for the search application in query APIs.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]576 &quot;name&quot;: &quot;A String&quot;, # Name of the Search Application. Format: searchapplications/{application_id}.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]577 &quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
578 &quot;A String&quot;,
579 ],
yoshi-code-bot07708072021-07-20 00:20:24 -0700[diff] [blame]580 &quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
581 &quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
582 &quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
583 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]584 &quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
585 &quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
586 &quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
587 },
588 &quot;sourceConfig&quot;: [ # Configuration for a sources specified in data_source_restrictions.
589 { # Configurations for a source while processing a Search or Suggest request.
590 &quot;crowdingConfig&quot;: { # Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host &quot;crowd out&quot; other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source. # The crowding configuration for the source.
591 &quot;numResults&quot;: 42, # Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
592 &quot;numSuggestions&quot;: 42, # Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
593 },
594 &quot;scoringConfig&quot;: { # Set the scoring configuration. This allows modifying the ranking of results for a source. # The scoring configuration for the source.
595 &quot;sourceImportance&quot;: &quot;A String&quot;, # Importance of the source.
596 },
597 &quot;source&quot;: { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.
598 &quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
599 &quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
600 },
601 },
602 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]603}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]604
605 x__xgafv: string, V1 error format.
606 Allowed values
607 1 - v1 error format
608 2 - v2 error format
609
610Returns:
611 An object of the form:
612
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]613 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]614 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
615 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
616 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
617 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
618 {
619 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
620 },
621 ],
622 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
623 },
624 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
625 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
626 },
627 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
628 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
629 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
630 },
631}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632</div>
633
634</body></html>