|
3020 | 3020 | ], |
3021 | 3021 | "parameters": { |
3022 | 3022 | "filter": { |
3023 | | - "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: \"user_pseudo_id = some_id\" \"display_name = \\\"some_name\\\"\" \"starred = true\" \"is_pinned=true AND (NOT labels:hidden)\" \"create_time > \\\"1970-01-01T12:00:00Z\\\"\"", |
| 3023 | + "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`", |
3024 | 3024 | "location": "query", |
3025 | 3025 | "type": "string" |
3026 | 3026 | }, |
|
4215 | 4215 | } |
4216 | 4216 | }, |
4217 | 4217 | "resources": { |
| 4218 | + "analytics": { |
| 4219 | + "methods": { |
| 4220 | + "exportMetrics": { |
| 4221 | + "description": "Exports metrics.", |
| 4222 | + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/analytics:exportMetrics", |
| 4223 | + "httpMethod": "POST", |
| 4224 | + "id": "discoveryengine.projects.locations.collections.engines.analytics.exportMetrics", |
| 4225 | + "parameterOrder": [ |
| 4226 | + "analytics" |
| 4227 | + ], |
| 4228 | + "parameters": { |
| 4229 | + "analytics": { |
| 4230 | + "description": "Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/analytics`.", |
| 4231 | + "location": "path", |
| 4232 | + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/analytics$", |
| 4233 | + "required": true, |
| 4234 | + "type": "string" |
| 4235 | + } |
| 4236 | + }, |
| 4237 | + "path": "v1alpha/{+analytics}:exportMetrics", |
| 4238 | + "request": { |
| 4239 | + "$ref": "GoogleCloudDiscoveryengineV1alphaExportMetricsRequest" |
| 4240 | + }, |
| 4241 | + "response": { |
| 4242 | + "$ref": "GoogleLongrunningOperation" |
| 4243 | + }, |
| 4244 | + "scopes": [ |
| 4245 | + "https://www.googleapis.com/auth/cloud-platform" |
| 4246 | + ] |
| 4247 | + } |
| 4248 | + } |
| 4249 | + }, |
4218 | 4250 | "assistants": { |
4219 | 4251 | "methods": { |
4220 | 4252 | "get": { |
|
5123 | 5155 | ], |
5124 | 5156 | "parameters": { |
5125 | 5157 | "filter": { |
5126 | | - "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: \"user_pseudo_id = some_id\" \"display_name = \\\"some_name\\\"\" \"starred = true\" \"is_pinned=true AND (NOT labels:hidden)\" \"create_time > \\\"1970-01-01T12:00:00Z\\\"\"", |
| 5158 | + "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`", |
5127 | 5159 | "location": "query", |
5128 | 5160 | "type": "string" |
5129 | 5161 | }, |
|
7262 | 7294 | ], |
7263 | 7295 | "parameters": { |
7264 | 7296 | "filter": { |
7265 | | - "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: \"user_pseudo_id = some_id\" \"display_name = \\\"some_name\\\"\" \"starred = true\" \"is_pinned=true AND (NOT labels:hidden)\" \"create_time > \\\"1970-01-01T12:00:00Z\\\"\"", |
| 7297 | + "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`", |
7266 | 7298 | "location": "query", |
7267 | 7299 | "type": "string" |
7268 | 7300 | }, |
|
9420 | 9452 | } |
9421 | 9453 | } |
9422 | 9454 | }, |
9423 | | - "revision": "20250724", |
| 9455 | + "revision": "20250728", |
9424 | 9456 | "rootUrl": "https://discoveryengine.googleapis.com/", |
9425 | 9457 | "schemas": { |
9426 | 9458 | "ApiservingMediaRequestInfo": { |
|
15355 | 15387 | "properties": {}, |
15356 | 15388 | "type": "object" |
15357 | 15389 | }, |
| 15390 | + "GoogleCloudDiscoveryengineV1alphaBigQueryDestination": { |
| 15391 | + "description": "The BigQuery output destination configuration.", |
| 15392 | + "id": "GoogleCloudDiscoveryengineV1alphaBigQueryDestination", |
| 15393 | + "properties": { |
| 15394 | + "datasetId": { |
| 15395 | + "description": "Required. The ID of a BigQuery Dataset.", |
| 15396 | + "type": "string" |
| 15397 | + }, |
| 15398 | + "tableId": { |
| 15399 | + "description": "Required. The table_id of exported BigQuery table.", |
| 15400 | + "type": "string" |
| 15401 | + } |
| 15402 | + }, |
| 15403 | + "type": "object" |
| 15404 | + }, |
15358 | 15405 | "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { |
15359 | 15406 | "description": "BigQuery source import data from.", |
15360 | 15407 | "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", |
|
18831 | 18878 | }, |
18832 | 18879 | "type": "object" |
18833 | 18880 | }, |
| 18881 | + "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata": { |
| 18882 | + "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", |
| 18883 | + "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata", |
| 18884 | + "properties": { |
| 18885 | + "createTime": { |
| 18886 | + "description": "Operation create time.", |
| 18887 | + "format": "google-datetime", |
| 18888 | + "type": "string" |
| 18889 | + }, |
| 18890 | + "updateTime": { |
| 18891 | + "description": "Operation last update time. If the operation is done, this is also the finish time.", |
| 18892 | + "format": "google-datetime", |
| 18893 | + "type": "string" |
| 18894 | + } |
| 18895 | + }, |
| 18896 | + "type": "object" |
| 18897 | + }, |
| 18898 | + "GoogleCloudDiscoveryengineV1alphaExportMetricsRequest": { |
| 18899 | + "description": "Request message for the `ExportMetrics` method.", |
| 18900 | + "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsRequest", |
| 18901 | + "properties": { |
| 18902 | + "outputConfig": { |
| 18903 | + "$ref": "GoogleCloudDiscoveryengineV1alphaOutputConfig", |
| 18904 | + "description": "Required. The output location of the data." |
| 18905 | + } |
| 18906 | + }, |
| 18907 | + "type": "object" |
| 18908 | + }, |
| 18909 | + "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse": { |
| 18910 | + "description": "Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", |
| 18911 | + "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse", |
| 18912 | + "properties": {}, |
| 18913 | + "type": "object" |
| 18914 | + }, |
18834 | 18915 | "GoogleCloudDiscoveryengineV1alphaFactChunk": { |
18835 | 18916 | "description": "Fact Chunk.", |
18836 | 18917 | "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", |
|
20518 | 20599 | "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest", |
20519 | 20600 | "properties": { |
20520 | 20601 | "filter": { |
20521 | | - "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: \"user_pseudo_id = some_id\" \"display_name = \\\"some_name\\\"\" \"starred = true\" \"is_pinned=true AND (NOT labels:hidden)\" \"create_time > \\\"1970-01-01T12:00:00Z\\\"\"", |
| 20602 | + "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`", |
20522 | 20603 | "type": "string" |
20523 | 20604 | }, |
20524 | 20605 | "orderBy": { |
|
20698 | 20779 | }, |
20699 | 20780 | "type": "object" |
20700 | 20781 | }, |
| 20782 | + "GoogleCloudDiscoveryengineV1alphaOutputConfig": { |
| 20783 | + "description": "The output configuration setting.", |
| 20784 | + "id": "GoogleCloudDiscoveryengineV1alphaOutputConfig", |
| 20785 | + "properties": { |
| 20786 | + "bigqueryDestination": { |
| 20787 | + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQueryDestination", |
| 20788 | + "description": "The BigQuery location where the output is to be written to." |
| 20789 | + } |
| 20790 | + }, |
| 20791 | + "type": "object" |
| 20792 | + }, |
20701 | 20793 | "GoogleCloudDiscoveryengineV1alphaPageInfo": { |
20702 | 20794 | "description": "Detailed page information.", |
20703 | 20795 | "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", |
|
22202 | 22294 | }, |
22203 | 22295 | "naturalLanguageQueryUnderstandingSpec": { |
22204 | 22296 | "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", |
22205 | | - "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." |
| 22297 | + "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." |
22206 | 22298 | }, |
22207 | 22299 | "offset": { |
22208 | 22300 | "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", |
|
22811 | 22903 | "description": "Specification to enable natural language understanding capabilities for search requests.", |
22812 | 22904 | "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", |
22813 | 22905 | "properties": { |
| 22906 | + "extractedFilterBehavior": { |
| 22907 | + "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", |
| 22908 | + "enum": [ |
| 22909 | + "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", |
| 22910 | + "HARD_FILTER", |
| 22911 | + "SOFT_BOOST" |
| 22912 | + ], |
| 22913 | + "enumDescriptions": [ |
| 22914 | + "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", |
| 22915 | + "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", |
| 22916 | + "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." |
| 22917 | + ], |
| 22918 | + "type": "string" |
| 22919 | + }, |
22814 | 22920 | "filterExtractionCondition": { |
22815 | 22921 | "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", |
22816 | 22922 | "enum": [ |
|
28067 | 28173 | }, |
28068 | 28174 | "naturalLanguageQueryUnderstandingSpec": { |
28069 | 28175 | "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", |
28070 | | - "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." |
| 28176 | + "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." |
28071 | 28177 | }, |
28072 | 28178 | "offset": { |
28073 | 28179 | "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", |
|
28672 | 28778 | "description": "Specification to enable natural language understanding capabilities for search requests.", |
28673 | 28779 | "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", |
28674 | 28780 | "properties": { |
| 28781 | + "extractedFilterBehavior": { |
| 28782 | + "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", |
| 28783 | + "enum": [ |
| 28784 | + "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", |
| 28785 | + "HARD_FILTER", |
| 28786 | + "SOFT_BOOST" |
| 28787 | + ], |
| 28788 | + "enumDescriptions": [ |
| 28789 | + "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", |
| 28790 | + "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", |
| 28791 | + "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." |
| 28792 | + ], |
| 28793 | + "type": "string" |
| 28794 | + }, |
28675 | 28795 | "filterExtractionCondition": { |
28676 | 28796 | "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", |
28677 | 28797 | "enum": [ |
|
0 commit comments