Skip to content

Commit

Permalink
feat(cloudsearch): update the api
Browse files Browse the repository at this point in the history
#### cloudsearch:v1

The following keys were added:
- schemas.QueryInterpretationConfig (Total Keys: 4)
- schemas.QueryInterpretationOptions.properties.disableSupplementalResults.type (Total Keys: 1)
- schemas.SearchApplication.properties.queryInterpretationConfig.$ref (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Jul 20, 2021
1 parent a830458 commit 4aab613
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/dyn/cloudsearch_v1.query.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ <h3>Method Details</h3>
&quot;query&quot;: &quot;A String&quot;, # The raw query string. See supported search operators in the [Cloud search Cheat Sheet](https://support.google.com/a/users/answer/9299929)
&quot;queryInterpretationOptions&quot;: { # Options to interpret user query. # Options to interpret the user query.
&quot;disableNlInterpretation&quot;: True or False, # Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.
&quot;disableSupplementalResults&quot;: True or False, # Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.
&quot;enableVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.
},
&quot;requestOptions&quot;: { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
Expand Down
16 changes: 16 additions & 0 deletions docs/dyn/cloudsearch_v1.settings.searchapplications.html
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,10 @@ <h3>Method Details</h3>
&quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
&quot;A String&quot;,
],
&quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
&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.
&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.
},
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
&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.
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
Expand Down Expand Up @@ -323,6 +327,10 @@ <h3>Method Details</h3>
&quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
&quot;A String&quot;,
],
&quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
&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.
&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.
},
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
&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.
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
Expand Down Expand Up @@ -419,6 +427,10 @@ <h3>Method Details</h3>
&quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
&quot;A String&quot;,
],
&quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
&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.
&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.
},
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
&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.
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
Expand Down Expand Up @@ -565,6 +577,10 @@ <h3>Method Details</h3>
&quot;operationIds&quot;: [ # Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
&quot;A String&quot;,
],
&quot;queryInterpretationConfig&quot;: { # Default options to interpret user query. # The default options for query interpretation
&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.
&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.
},
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
&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.
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
Expand Down
25 changes: 24 additions & 1 deletion googleapiclient/discovery_cache/documents/cloudsearch.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -1916,7 +1916,7 @@
}
}
},
"revision": "20210629",
"revision": "20210706",
"rootUrl": "https://cloudsearch.googleapis.com/",
"schemas": {
"AuditLoggingSettings": {
Expand Down Expand Up @@ -4008,6 +4008,21 @@
},
"type": "object"
},
"QueryInterpretationConfig": {
"description": "Default options to interpret user query.",
"id": "QueryInterpretationConfig",
"properties": {
"forceDisableSupplementalResults": {
"description": "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.",
"type": "boolean"
},
"forceVerbatimMode": {
"description": "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.",
"type": "boolean"
}
},
"type": "object"
},
"QueryInterpretationOptions": {
"description": "Options to interpret user query.",
"id": "QueryInterpretationOptions",
Expand All @@ -4016,6 +4031,10 @@
"description": "Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.",
"type": "boolean"
},
"disableSupplementalResults": {
"description": "Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.",
"type": "boolean"
},
"enableVerbatimMode": {
"description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.",
"type": "boolean"
Expand Down Expand Up @@ -4435,6 +4454,10 @@
"readOnly": true,
"type": "array"
},
"queryInterpretationConfig": {
"$ref": "QueryInterpretationConfig",
"description": "The default options for query interpretation"
},
"scoringConfig": {
"$ref": "ScoringConfig",
"description": "Configuration for ranking results."
Expand Down

0 comments on commit 4aab613

Please sign in to comment.