{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://discoveryengine.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Discovery Engine",
"description": "Discovery Engine API.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/",
"location": "asia-northeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/",
"location": "europe-west2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://discoveryengine.us.rep.googleapis.com/",
"location": "us"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
"location": "eu"
}
],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "discoveryengine:v1beta",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://discoveryengine.mtls.googleapis.com/",
"name": "discoveryengine",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"provision": {
"description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.",
"flatPath": "v1beta/projects/{projectsId}:provision",
"httpMethod": "POST",
"id": "discoveryengine.projects.provision",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:provision",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaProvisionProjectRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"locations": {
"methods": {
"getCmekConfig": {
"description": "Gets the CmekConfig.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.getCmekConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"obtainCrawlRate": {
"description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.obtainCrawlRate",
"parameterOrder": [
"location"
],
"parameters": {
"location": {
"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+location}:obtainCrawlRate",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"removeDedicatedCrawlRate": {
"description": "Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.removeDedicatedCrawlRate",
"parameterOrder": [
"location"
],
"parameters": {
"location": {
"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+location}:removeDedicatedCrawlRate",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setDedicatedCrawlRate": {
"description": "Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.setDedicatedCrawlRate",
"parameterOrder": [
"location"
],
"parameters": {
"location": {
"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+location}:setDedicatedCrawlRate",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateCmekConfig": {
"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.updateCmekConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
"required": true,
"type": "string"
},
"setDefault": {
"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"cmekConfigs": {
"methods": {
"delete": {
"description": "De-provisions a CmekConfig.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.cmekConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the CmekConfig.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.cmekConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all the CmekConfigs with the project.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.cmekConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/cmekConfigs",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.cmekConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
"required": true,
"type": "string"
},
"setDefault": {
"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"collections": {
"resources": {
"dataConnector": {
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataConnector.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataConnector.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"dataStores": {
"methods": {
"completeQuery": {
"description": "Completes the specified user input with keyword suggestions.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.completeQuery",
"parameterOrder": [
"dataStore"
],
"parameters": {
"dataStore": {
"description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"includeTailSuggestions": {
"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
"location": "query",
"type": "boolean"
},
"query": {
"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.",
"location": "query",
"type": "string"
},
"queryModel": {
"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
"location": "query",
"type": "string"
},
"userPseudoId": {
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+dataStore}:completeQuery",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.create",
"parameterOrder": [
"parent"
],
"parameters": {
"cmekConfigName": {
"description": "Resource name of the CmekConfig to use for protecting this DataStore.",
"location": "query",
"type": "string"
},
"createAdvancedSiteSearch": {
"description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.",
"location": "query",
"type": "boolean"
},
"dataStoreId": {
"description": "Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"location": "query",
"type": "string"
},
"disableCmek": {
"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
"required": true,
"type": "string"
},
"skipDefaultSchemaCreation": {
"description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+parent}/dataStores",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getSiteSearchEngine": {
"description": "Gets the SiteSearchEngine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all the DataStores associated with the project.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/dataStores",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListDataStoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a DataStore",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"trainCustomModel": {
"description": "Trains a custom model.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel",
"parameterOrder": [
"dataStore"
],
"parameters": {
"dataStore": {
"description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+dataStore}:trainCustomModel",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"branches": {
"methods": {
"batchGetDocumentsMetadata": {
"description": "Gets index freshness metadata for Documents. Supported for website search only.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata",
"parameterOrder": [
"parent"
],
"parameters": {
"matcher.fhirMatcher.fhirResources": {
"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}",
"location": "query",
"repeated": true,
"type": "string"
},
"matcher.urisMatcher.uris": {
"description": "The exact URIs to match by.",
"location": "query",
"repeated": true,
"type": "string"
},
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/batchGetDocumentsMetadata",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"documents": {
"methods": {
"create": {
"description": "Creates a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"documentId": {
"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of Documents.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "If set to `true` and the Document is not found, a new Document is be created.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:cancel",
"request": {
"$ref": "GoogleLongrunningCancelOperationRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"completionConfig": {
"methods": {
"completeQuery": {
"description": "Completes the user input with advanced keyword suggestions.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery",
"parameterOrder": [
"completionConfig"
],
"parameters": {
"completionConfig": {
"description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+completionConfig}:completeQuery",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"completionSuggestions": {
"methods": {
"import": {
"description": "Imports CompletionSuggestions for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/completionSuggestions:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Permanently deletes all CompletionSuggestions for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*/locations/*/collections/*/dataStores/*.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/completionSuggestions:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"controls": {
"methods": {
"create": {
"description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.controls.create",
"parameterOrder": [
"parent"
],
"parameters": {
"controlId": {
"description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/controls",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.controls.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Control.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.controls.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Controls by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.controls.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/controls",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.controls.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"conversations": {
"methods": {
"converse": {
"description": "Converses a conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.converse",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:converse",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Conversations by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"customModels": {
"methods": {
"list": {
"description": "Gets a list of all the custom models.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.customModels.list",
"parameterOrder": [
"dataStore"
],
"parameters": {
"dataStore": {
"description": "Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+dataStore}/customModels",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"models": {
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.models.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.models.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"schemas": {
"methods": {
"create": {
"description": "Creates a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"schemaId": {
"description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/schemas",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of Schemas.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/schemas",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSchemasResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"servingConfigs": {
"methods": {
"answer": {
"description": "Answer query method.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:answer",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all ServingConfigs linked to this dataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/servingConfigs",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"recommend": {
"description": "Makes a recommendation, which requires a contextual user event.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:recommend",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"search": {
"description": "Performs a search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.search",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:search",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"searchLite": {
"description": "Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:searchLite",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"streamAnswer": {
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:streamAnswer",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sessions": {
"methods": {
"create": {
"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sessions",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Session.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.get",
"parameterOrder": [
"name"
],
"parameters": {
"includeAnswerDetails": {
"description": "Optional. If set to true, the full session including all answer details will be returned.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Sessions by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sessions",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"answers": {
"methods": {
"get": {
"description": "Gets a Answer.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"siteSearchEngine": {
"methods": {
"batchVerifyTargetSites": {
"description": "Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource shared by all TargetSites being verified. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:batchVerifyTargetSites",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"disableAdvancedSiteSearch": {
"description": "Downgrade from advanced site search to basic site search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"siteSearchEngine": {
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"enableAdvancedSiteSearch": {
"description": "Upgrade from basic site search to advanced site search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"siteSearchEngine": {
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"fetchDomainVerificationStatus": {
"description": "Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"pageSize": {
"description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"siteSearchEngine": {
"description": "Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:fetchDomainVerificationStatus",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"recrawlUris": {
"description": "Request on-demand recrawl for a list of URIs.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"siteSearchEngine": {
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:recrawlUris",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sitemaps": {
"methods": {
"create": {
"description": "Creates a Sitemap.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sitemaps",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSitemap"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Sitemap.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"fetch": {
"description": "Fetch Sitemaps in a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch",
"parameterOrder": [
"parent"
],
"parameters": {
"matcher.urisMatcher.uris": {
"description": "The Sitemap uris.",
"location": "query",
"repeated": true,
"type": "string"
},
"parent": {
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sitemaps:fetch",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"targetSites": {
"methods": {
"batchCreate": {
"description": "Creates TargetSite in a batch.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/targetSites:batchCreate",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/targetSites",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of TargetSites.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/targetSites",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"suggestionDenyListEntries": {
"methods": {
"import": {
"description": "Imports all SuggestionDenyListEntry for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/suggestionDenyListEntries:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Permanently deletes all SuggestionDenyListEntry for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/suggestionDenyListEntries:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"userEvents": {
"methods": {
"collect": {
"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect",
"parameterOrder": [
"parent"
],
"parameters": {
"ets": {
"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
"format": "int64",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"uri": {
"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
"location": "query",
"type": "string"
},
"userEvent": {
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:collect",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"write": {
"description": "Writes a single user event.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.dataStores.userEvents.write",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"writeAsync": {
"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+parent}/userEvents:write",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"engines": {
"methods": {
"create": {
"description": "Creates a Engine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.create",
"parameterOrder": [
"parent"
],
"parameters": {
"engineId": {
"description": "Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/engines",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Engine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Engine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all the Engines associated with the project.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Not supported.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Not supported.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/engines",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListEnginesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an Engine",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.engines.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"pause": {
"description": "Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:pause",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.pause",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:pause",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPauseEngineRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"resume": {
"description": "Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:resume",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:resume",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaResumeEngineRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"tune": {
"description": "Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:tune",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.tune",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:tune",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaTuneEngineRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"completionConfig": {
"methods": {
"completeQuery": {
"description": "Completes the user input with advanced keyword suggestions.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery",
"parameterOrder": [
"completionConfig"
],
"parameters": {
"completionConfig": {
"description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+completionConfig}:completeQuery",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"removeSuggestion": {
"description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion",
"parameterOrder": [
"completionConfig"
],
"parameters": {
"completionConfig": {
"description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+completionConfig}:removeSuggestion",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"controls": {
"methods": {
"create": {
"description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.controls.create",
"parameterOrder": [
"parent"
],
"parameters": {
"controlId": {
"description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/controls",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.controls.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Control.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.controls.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Controls by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.controls.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/controls",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.engines.controls.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"conversations": {
"methods": {
"converse": {
"description": "Converses a conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.conversations.converse",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:converse",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.conversations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.conversations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.conversations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Conversations by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.conversations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.engines.conversations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"servingConfigs": {
"methods": {
"answer": {
"description": "Answer query method.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:answer",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all ServingConfigs linked to this dataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/servingConfigs",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"recommend": {
"description": "Makes a recommendation, which requires a contextual user event.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.recommend",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:recommend",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"search": {
"description": "Performs a search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.search",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:search",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"searchLite": {
"description": "Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:searchLite",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:searchLite",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"streamAnswer": {
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:streamAnswer",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sessions": {
"methods": {
"create": {
"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.sessions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sessions",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.sessions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Session.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.sessions.get",
"parameterOrder": [
"name"
],
"parameters": {
"includeAnswerDetails": {
"description": "Optional. If set to true, the full session including all answer details will be returned.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Sessions by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.sessions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sessions",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.collections.engines.sessions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"answers": {
"methods": {
"get": {
"description": "Gets a Answer.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"dataStores": {
"methods": {
"completeQuery": {
"description": "Completes the specified user input with keyword suggestions.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.completeQuery",
"parameterOrder": [
"dataStore"
],
"parameters": {
"dataStore": {
"description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"includeTailSuggestions": {
"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
"location": "query",
"type": "boolean"
},
"query": {
"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.",
"location": "query",
"type": "string"
},
"queryModel": {
"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
"location": "query",
"type": "string"
},
"userPseudoId": {
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+dataStore}:completeQuery",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.create",
"parameterOrder": [
"parent"
],
"parameters": {
"cmekConfigName": {
"description": "Resource name of the CmekConfig to use for protecting this DataStore.",
"location": "query",
"type": "string"
},
"createAdvancedSiteSearch": {
"description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.",
"location": "query",
"type": "boolean"
},
"dataStoreId": {
"description": "Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"location": "query",
"type": "string"
},
"disableCmek": {
"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.",
"location": "query",
"type": "boolean"
},
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"skipDefaultSchemaCreation": {
"description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+parent}/dataStores",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getSiteSearchEngine": {
"description": "Gets the SiteSearchEngine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.getSiteSearchEngine",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all the DataStores associated with the project.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/dataStores",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListDataStoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a DataStore",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"branches": {
"methods": {
"batchGetDocumentsMetadata": {
"description": "Gets index freshness metadata for Documents. Supported for website search only.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata",
"parameterOrder": [
"parent"
],
"parameters": {
"matcher.fhirMatcher.fhirResources": {
"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}",
"location": "query",
"repeated": true,
"type": "string"
},
"matcher.urisMatcher.uris": {
"description": "The exact URIs to match by.",
"location": "query",
"repeated": true,
"type": "string"
},
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/batchGetDocumentsMetadata",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"documents": {
"methods": {
"create": {
"description": "Creates a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.create",
"parameterOrder": [
"parent"
],
"parameters": {
"documentId": {
"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of Documents.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Document.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "If set to `true` and the Document is not found, a new Document is be created.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.branches.documents.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/documents:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:cancel",
"request": {
"$ref": "GoogleLongrunningCancelOperationRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.branches.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.branches.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"completionConfig": {
"methods": {
"completeQuery": {
"description": "Completes the user input with advanced keyword suggestions.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.completionConfig.completeQuery",
"parameterOrder": [
"completionConfig"
],
"parameters": {
"completionConfig": {
"description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+completionConfig}:completeQuery",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"completionSuggestions": {
"methods": {
"import": {
"description": "Imports CompletionSuggestions for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.completionSuggestions.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/completionSuggestions:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Permanently deletes all CompletionSuggestions for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.completionSuggestions.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*/locations/*/collections/*/dataStores/*.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/completionSuggestions:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"controls": {
"methods": {
"create": {
"description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.controls.create",
"parameterOrder": [
"parent"
],
"parameters": {
"controlId": {
"description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/controls",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.controls.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Control.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.controls.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Controls by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.controls.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/controls",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.controls.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"conversations": {
"methods": {
"converse": {
"description": "Converses a conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.conversations.converse",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:converse",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.conversations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.conversations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Conversation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.conversations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Conversations by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.conversations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.conversations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"models": {
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.models.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.models.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"schemas": {
"methods": {
"create": {
"description": "Creates a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.schemas.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"schemaId": {
"description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/schemas",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.schemas.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.schemas.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of Schemas.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.schemas.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/schemas",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSchemasResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Schema.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.schemas.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"servingConfigs": {
"methods": {
"answer": {
"description": "Answer query method.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:answer",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all ServingConfigs linked to this dataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/servingConfigs",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"recommend": {
"description": "Makes a recommendation, which requires a contextual user event.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.recommend",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:recommend",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"search": {
"description": "Performs a search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.search",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:search",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"searchLite": {
"description": "Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.searchLite",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:searchLite",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"streamAnswer": {
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer",
"parameterOrder": [
"servingConfig"
],
"parameters": {
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+servingConfig}:streamAnswer",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sessions": {
"methods": {
"create": {
"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.sessions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sessions",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.sessions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Session.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.sessions.get",
"parameterOrder": [
"name"
],
"parameters": {
"includeAnswerDetails": {
"description": "Optional. If set to true, the full session including all answer details will be returned.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Sessions by their parent DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.sessions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sessions",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.sessions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"answers": {
"methods": {
"get": {
"description": "Gets a Answer.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.sessions.answers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswer"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"siteSearchEngine": {
"methods": {
"disableAdvancedSiteSearch": {
"description": "Downgrade from advanced site search to basic site search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"siteSearchEngine": {
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"enableAdvancedSiteSearch": {
"description": "Upgrade from basic site search to advanced site search.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"siteSearchEngine": {
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"recrawlUris": {
"description": "Request on-demand recrawl for a list of URIs.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris",
"parameterOrder": [
"siteSearchEngine"
],
"parameters": {
"siteSearchEngine": {
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+siteSearchEngine}:recrawlUris",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"sitemaps": {
"methods": {
"create": {
"description": "Creates a Sitemap.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sitemaps",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSitemap"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Sitemap.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"fetch": {
"description": "Fetch Sitemaps in a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch",
"parameterOrder": [
"parent"
],
"parameters": {
"matcher.urisMatcher.uris": {
"description": "The Sitemap uris.",
"location": "query",
"repeated": true,
"type": "string"
},
"parent": {
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sitemaps:fetch",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"targetSites": {
"methods": {
"batchCreate": {
"description": "Creates TargetSite in a batch.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/targetSites:batchCreate",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/targetSites",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of TargetSites.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/targetSites",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a TargetSite.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"suggestionDenyListEntries": {
"methods": {
"import": {
"description": "Imports all SuggestionDenyListEntry for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/suggestionDenyListEntries:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Permanently deletes all SuggestionDenyListEntry for a DataStore.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/.*$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/suggestionDenyListEntries:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"userEvents": {
"methods": {
"collect": {
"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.dataStores.userEvents.collect",
"parameterOrder": [
"parent"
],
"parameters": {
"ets": {
"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
"format": "int64",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"uri": {
"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
"location": "query",
"type": "string"
},
"userEvent": {
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:collect",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.userEvents.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purge": {
"description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.userEvents.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:purge",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"write": {
"description": "Writes a single user event.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.dataStores.userEvents.write",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
"required": true,
"type": "string"
},
"writeAsync": {
"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+parent}/userEvents:write",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"evaluations": {
"methods": {
"create": {
"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.evaluations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluations",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.evaluations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of Evaluations.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.evaluations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/evaluations",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"listResults": {
"description": "Gets a list of results for a given a Evaluation.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.evaluations.listResults",
"parameterOrder": [
"evaluation"
],
"parameters": {
"evaluation": {
"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+evaluation}:listResults",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.evaluations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"groundingConfigs": {
"methods": {
"check": {
"description": "Performs a grounding check.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.groundingConfigs.check",
"parameterOrder": [
"groundingConfig"
],
"parameters": {
"groundingConfig": {
"description": "Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+groundingConfig}:check",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"identityMappingStores": {
"methods": {
"create": {
"description": "Creates a new Identity Mapping Store.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.identityMappingStores.create",
"parameterOrder": [
"parent"
],
"parameters": {
"cmekConfigName": {
"description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.",
"location": "query",
"type": "string"
},
"disableCmek": {
"description": "Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.",
"location": "query",
"type": "boolean"
},
"identityMappingStoreId": {
"description": "Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/identityMappingStores",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the Identity Mapping Store.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.identityMappingStores.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the Identity Mapping Store.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.identityMappingStores.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"importIdentityMappings": {
"description": "Imports a list of Identity Mapping Entries to an Identity Mapping Store.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings",
"parameterOrder": [
"identityMappingStore"
],
"parameters": {
"identityMappingStore": {
"description": "Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+identityMappingStore}:importIdentityMappings",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all Identity Mapping Stores.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.identityMappingStores.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/identityMappingStores",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"listIdentityMappings": {
"description": "Lists Identity Mappings in an Identity Mapping Store.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings",
"parameterOrder": [
"identityMappingStore"
],
"parameters": {
"identityMappingStore": {
"description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+identityMappingStore}:listIdentityMappings",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"purgeIdentityMappings": {
"description": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings",
"parameterOrder": [
"identityMappingStore"
],
"parameters": {
"identityMappingStore": {
"description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+identityMappingStore}:purgeIdentityMappings",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.identityMappingStores.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.identityMappingStores.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"podcasts": {
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/podcasts/{podcastsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.podcasts.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/podcasts/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"rankingConfigs": {
"methods": {
"rank": {
"description": "Ranks a list of text records based on the given input query.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.rankingConfigs.rank",
"parameterOrder": [
"rankingConfig"
],
"parameters": {
"rankingConfig": {
"description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+rankingConfig}:rank",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaRankRequest"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaRankResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sampleQuerySets": {
"methods": {
"create": {
"description": "Creates a SampleQuerySet",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.sampleQuerySets.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"sampleQuerySetId": {
"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/sampleQuerySets",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a SampleQuerySet.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.sampleQuerySets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a SampleQuerySet.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.sampleQuerySets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of SampleQuerySets.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.sampleQuerySets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sampleQuerySets",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a SampleQuerySet.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.sampleQuerySets.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"sampleQueries": {
"methods": {
"create": {
"description": "Creates a SampleQuery",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
"required": true,
"type": "string"
},
"sampleQueryId": {
"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/sampleQueries",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a SampleQuery.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a SampleQuery.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sampleQueries:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets a list of SampleQuerys.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/sampleQueries",
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a SampleQuery.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}",
"httpMethod": "PATCH",
"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"userEvents": {
"methods": {
"collect": {
"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.userEvents.collect",
"parameterOrder": [
"parent"
],
"parameters": {
"ets": {
"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
"format": "int64",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"uri": {
"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
"location": "query",
"type": "string"
},
"userEvent": {
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:collect",
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:import",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.userEvents.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/userEvents:import",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"write": {
"description": "Writes a single user event.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.userEvents.write",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"writeAsync": {
"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta/{+parent}/userEvents:write",
"request": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"response": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/operations",
"httpMethod": "GET",
"id": "discoveryengine.projects.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20250419",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
"id": "GoogleApiDistribution",
"properties": {
"bucketCounts": {
"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"bucketOptions": {
"$ref": "GoogleApiDistributionBucketOptions",
"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
},
"count": {
"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
"format": "int64",
"type": "string"
},
"exemplars": {
"description": "Must be in increasing order of `value` field.",
"items": {
"$ref": "GoogleApiDistributionExemplar"
},
"type": "array"
},
"mean": {
"description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
"format": "double",
"type": "number"
},
"range": {
"$ref": "GoogleApiDistributionRange",
"description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero."
},
"sumOfSquaredDeviation": {
"description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleApiDistributionBucketOptions": {
"description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
"id": "GoogleApiDistributionBucketOptions",
"properties": {
"explicitBuckets": {
"$ref": "GoogleApiDistributionBucketOptionsExplicit",
"description": "The explicit buckets."
},
"exponentialBuckets": {
"$ref": "GoogleApiDistributionBucketOptionsExponential",
"description": "The exponential buckets."
},
"linearBuckets": {
"$ref": "GoogleApiDistributionBucketOptionsLinear",
"description": "The linear bucket."
}
},
"type": "object"
},
"GoogleApiDistributionBucketOptionsExplicit": {
"description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
"id": "GoogleApiDistributionBucketOptionsExplicit",
"properties": {
"bounds": {
"description": "The values must be monotonically increasing.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleApiDistributionBucketOptionsExponential": {
"description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).",
"id": "GoogleApiDistributionBucketOptionsExponential",
"properties": {
"growthFactor": {
"description": "Must be greater than 1.",
"format": "double",
"type": "number"
},
"numFiniteBuckets": {
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
},
"scale": {
"description": "Must be greater than 0.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleApiDistributionBucketOptionsLinear": {
"description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).",
"id": "GoogleApiDistributionBucketOptionsLinear",
"properties": {
"numFiniteBuckets": {
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
},
"offset": {
"description": "Lower bound of the first bucket.",
"format": "double",
"type": "number"
},
"width": {
"description": "Must be greater than 0.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleApiDistributionExemplar": {
"description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.",
"id": "GoogleApiDistributionExemplar",
"properties": {
"attachments": {
"description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"timestamp": {
"description": "The observation (sampling) time of the above value.",
"format": "google-datetime",
"type": "string"
},
"value": {
"description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleApiDistributionRange": {
"description": "The range of the population values.",
"id": "GoogleApiDistributionRange",
"properties": {
"max": {
"description": "The maximum of the population values.",
"format": "double",
"type": "number"
},
"min": {
"description": "The minimum of the population values.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleApiHttpBody": {
"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.",
"id": "GoogleApiHttpBody",
"properties": {
"contentType": {
"description": "The HTTP Content-Type header value specifying the content type of the body.",
"type": "string"
},
"data": {
"description": "The HTTP request/response body as raw binary.",
"format": "byte",
"type": "string"
},
"extensions": {
"description": "Application specific response metadata. Must be set in the first response for streaming APIs.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"GoogleApiMetric": {
"description": "A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.",
"id": "GoogleApiMetric",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.",
"type": "object"
},
"type": {
"description": "An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.",
"type": "string"
}
},
"type": "object"
},
"GoogleApiMonitoredResource": {
"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"project_id\"`, `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }}",
"id": "GoogleApiMonitoredResource",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `\"project_id\"`, `\"instance_id\"`, and `\"zone\"`.",
"type": "object"
},
"type": {
"description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.",
"type": "string"
}
},
"type": "object"
},
"GoogleApiMonitoredResourceMetadata": {
"description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.",
"id": "GoogleApiMonitoredResourceMetadata",
"properties": {
"systemLabels": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { \"name\": \"my-test-instance\", \"security_group\": [\"a\", \"b\", \"c\"], \"spot_instance\": false }",
"type": "object"
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. A map of user-defined metadata labels.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": {
"description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`",
"id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
"properties": {
"connectorRun": {
"description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
"type": "string"
},
"dataConnector": {
"description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
"type": "string"
},
"endTime": {
"description": "The time when the connector run ended.",
"format": "google-datetime",
"type": "string"
},
"entity": {
"description": "The entity to sync for the connector run.",
"type": "string"
},
"operation": {
"description": "The operation resource name of the LRO to sync the connector.",
"type": "string"
},
"startTime": {
"description": "The time when the connector run started.",
"format": "google-datetime",
"type": "string"
},
"syncType": {
"description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingErrorContext": {
"description": "A description of the context in which an error occurred.",
"id": "GoogleCloudDiscoveryengineLoggingErrorContext",
"properties": {
"httpRequest": {
"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext",
"description": "The HTTP request which was processed when the error was triggered."
},
"reportLocation": {
"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation",
"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingErrorLog": {
"description": "An error log which is reported to the Error Reporting system.",
"id": "GoogleCloudDiscoveryengineLoggingErrorLog",
"properties": {
"connectorRunPayload": {
"$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
"description": "The error payload that is populated on LRO connector sync APIs."
},
"context": {
"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext",
"description": "A description of the context in which the error occurred."
},
"importPayload": {
"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext",
"description": "The error payload that is populated on LRO import APIs."
},
"message": {
"description": "A message describing the error.",
"type": "string"
},
"requestPayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`",
"type": "object"
},
"responsePayload": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`",
"type": "object"
},
"serviceContext": {
"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext",
"description": "The service context in which this error has occurred."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The RPC status associated with the error log."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingHttpRequestContext": {
"description": "HTTP request data that is related to a reported error.",
"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext",
"properties": {
"responseStatusCode": {
"description": "The HTTP response status code for the request.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingImportErrorContext": {
"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`",
"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext",
"properties": {
"document": {
"description": "The detailed content which caused the error on importing a document.",
"type": "string"
},
"gcsPath": {
"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.",
"type": "string"
},
"lineNumber": {
"description": "Line number of the content in file. Should be empty for permission or batch operation error.",
"type": "string"
},
"operation": {
"description": "The operation resource name of the LRO.",
"type": "string"
},
"userEvent": {
"description": "The detailed content which caused the error on importing a user event.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingServiceContext": {
"description": "Describes a running service that sends errors.",
"id": "GoogleCloudDiscoveryengineLoggingServiceContext",
"properties": {
"service": {
"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineLoggingSourceLocation": {
"description": "Indicates a location in the source code of the service for which errors are reported.",
"id": "GoogleCloudDiscoveryengineLoggingSourceLocation",
"properties": {
"functionName": {
"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": {
"description": "Configuration data for advance site search.",
"id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
"properties": {
"disableAutomaticRefresh": {
"description": "If set true, automatic refresh is disabled for the DataStore.",
"type": "boolean"
},
"disableInitialIndex": {
"description": "If set true, initial indexing is disabled for the DataStore.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1AnswerGenerationSpec": {
"description": "The specification for answer generation.",
"id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec",
"properties": {
"userDefinedClassifierSpec": {
"$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec",
"description": "Optional. The specification for user specified classifier spec."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": {
"description": "The specification for user defined classifier.",
"id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec",
"properties": {
"enableUserDefinedClassifier": {
"description": "Optional. Whether or not to enable and include user defined classifier.",
"type": "boolean"
},
"modelId": {
"description": "Optional. The model id to be used for the user defined classifier.",
"type": "string"
},
"preamble": {
"description": "Optional. The preamble to be used for the user defined classifier.",
"type": "string"
},
"seed": {
"description": "Optional. The seed value to be used for the user defined classifier.",
"format": "int32",
"type": "integer"
},
"taskMarker": {
"description": "Optional. The task marker to be used for the user defined classifier.",
"type": "string"
},
"temperature": {
"description": "Optional. The temperature value to be used for the user defined classifier.",
"format": "double",
"type": "number"
},
"topK": {
"description": "Optional. The top-k value to be used for the user defined classifier.",
"format": "int64",
"type": "string"
},
"topP": {
"description": "Optional. The top-p value to be used for the user defined classifier.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": {
"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.",
"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse",
"properties": {
"targetSites": {
"description": "TargetSites created.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1TargetSite"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1CmekConfig": {
"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
"id": "GoogleCloudDiscoveryengineV1CmekConfig",
"properties": {
"isDefault": {
"description": "Output only. The default CmekConfig for the Customer.",
"readOnly": true,
"type": "boolean"
},
"kmsKey": {
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
"type": "string"
},
"kmsKeyVersion": {
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
"type": "string"
},
"lastRotationTimestampMicros": {
"description": "Output only. The timestamp of the last key rotation.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
"type": "string"
},
"notebooklmState": {
"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
"enum": [
"NOTEBOOK_LM_STATE_UNSPECIFIED",
"NOTEBOOK_LM_NOT_READY",
"NOTEBOOK_LM_READY",
"NOTEBOOK_LM_NOT_ENABLED"
],
"enumDescriptions": [
"The NotebookLM state is unknown.",
"The NotebookLM is not ready.",
"The NotebookLM is ready to be used.",
"The NotebookLM is not enabled."
],
"readOnly": true,
"type": "string"
},
"singleRegionKeys": {
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey"
},
"type": "array"
},
"state": {
"description": "Output only. The states of the CmekConfig.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"KEY_ISSUE",
"DELETING",
"DELETE_FAILED",
"UNUSABLE",
"ACTIVE_ROTATING"
],
"enumDescriptions": [
"The CmekConfig state is unknown.",
"The CmekConfig is creating.",
"The CmekConfig can be used with DataStores.",
"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.",
"The CmekConfig is deleting.",
"The CmekConfig deletion process failed.",
"The CmekConfig is not usable, most likely due to some internal issue.",
"The KMS key version is being rotated."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1Condition": {
"description": "Defines circumstances to be checked before allowing a behavior",
"id": "GoogleCloudDiscoveryengineV1Condition",
"properties": {
"activeTimeRange": {
"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange"
},
"type": "array"
},
"queryRegex": {
"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.",
"type": "string"
},
"queryTerms": {
"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ConditionQueryTerm": {
"description": "Matcher for search request query",
"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm",
"properties": {
"fullMatch": {
"description": "Whether the search query needs to exactly match the query term.",
"type": "boolean"
},
"value": {
"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ConditionTimeRange": {
"description": "Used for time-dependent conditions.",
"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange",
"properties": {
"endTime": {
"description": "End of time range. Range is inclusive. Must be in the future.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start of time range. Range is inclusive.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1Control": {
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
"id": "GoogleCloudDiscoveryengineV1Control",
"properties": {
"associatedServingConfigIds": {
"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"boostAction": {
"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction",
"description": "Defines a boost-type control"
},
"conditions": {
"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1Condition"
},
"type": "array"
},
"displayName": {
"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
},
"filterAction": {
"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction",
"description": "Defines a filter-type control Currently not supported by Recommendation"
},
"name": {
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
"type": "string"
},
"promoteAction": {
"$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
},
"redirectAction": {
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
"description": "Defines a redirect-type control."
},
"solutionType": {
"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"synonymsAction": {
"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction",
"description": "Treats a group of terms as synonyms of one another."
},
"useCases": {
"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.",
"items": {
"enum": [
"SEARCH_USE_CASE_UNSPECIFIED",
"SEARCH_USE_CASE_SEARCH",
"SEARCH_USE_CASE_BROWSE"
],
"enumDescriptions": [
"Value used when unset. Will not occur in CSS.",
"Search use case. Expects the traffic has a non-empty query.",
"Browse use case. Expects the traffic has an empty query."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlBoostAction": {
"description": "Adjusts order of products in returned list.",
"id": "GoogleCloudDiscoveryengineV1ControlBoostAction",
"properties": {
"boost": {
"deprecated": true,
"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
"format": "float",
"type": "number"
},
"dataStore": {
"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
"type": "string"
},
"filter": {
"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
},
"fixedBoost": {
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
"format": "float",
"type": "number"
},
"interpolationBoostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec",
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": {
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
"id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec",
"properties": {
"attributeType": {
"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
"enum": [
"ATTRIBUTE_TYPE_UNSPECIFIED",
"NUMERICAL",
"FRESHNESS"
],
"enumDescriptions": [
"Unspecified AttributeType.",
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
],
"type": "string"
},
"controlPoints": {
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint"
},
"type": "array"
},
"fieldName": {
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
"type": "string"
},
"interpolationType": {
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
"enum": [
"INTERPOLATION_TYPE_UNSPECIFIED",
"LINEAR"
],
"enumDescriptions": [
"Interpolation type is unspecified. In this case, it defaults to Linear.",
"Piecewise linear interpolation will be applied."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint": {
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
"id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint",
"properties": {
"attributeValue": {
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
"type": "string"
},
"boostAmount": {
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlFilterAction": {
"description": "Specified which products may be included in results. Uses same filter as boost.",
"id": "GoogleCloudDiscoveryengineV1ControlFilterAction",
"properties": {
"dataStore": {
"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
"type": "string"
},
"filter": {
"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlPromoteAction": {
"description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
"id": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
"properties": {
"dataStore": {
"description": "Required. Data store with which this promotion is attached to.",
"type": "string"
},
"searchLinkPromotion": {
"$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
"description": "Required. Promotion attached to this action."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlRedirectAction": {
"description": "Redirects a shopper to the provided URI.",
"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
"properties": {
"redirectUri": {
"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ControlSynonymsAction": {
"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".",
"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction",
"properties": {
"synonyms": {
"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": {
"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1CreateEngineMetadata": {
"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": {
"description": "Metadata for Create Schema LRO.",
"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DataStore": {
"description": "DataStore captures global settings and configs at the DataStore level.",
"id": "GoogleCloudDiscoveryengineV1DataStore",
"properties": {
"aclEnabled": {
"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
"type": "boolean"
},
"advancedSiteSearchConfig": {
"$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
"description": "Optional. Configuration for advanced site search."
},
"billingEstimation": {
"$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation",
"description": "Output only. Data size estimation for billing.",
"readOnly": true
},
"cmekConfig": {
"$ref": "GoogleCloudDiscoveryengineV1CmekConfig",
"description": "Output only. CMEK-related information for the DataStore.",
"readOnly": true
},
"contentConfig": {
"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
"enum": [
"CONTENT_CONFIG_UNSPECIFIED",
"NO_CONTENT",
"CONTENT_REQUIRED",
"PUBLIC_WEBSITE",
"GOOGLE_WORKSPACE"
],
"enumDescriptions": [
"Default value.",
"Only contains documents without any Document.content.",
"Only contains documents with Document.content.",
"The data store is used for public website search.",
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
],
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp the DataStore was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"defaultSchemaId": {
"description": "Output only. The id of the default Schema associated to this data store.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"documentProcessingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig",
"description": "Configuration for Document understanding and enrichment."
},
"healthcareFhirConfig": {
"$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
},
"identityMappingStore": {
"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
"type": "string"
},
"industryVertical": {
"description": "Immutable. The industry vertical that the data store registers.",
"enum": [
"INDUSTRY_VERTICAL_UNSPECIFIED",
"GENERIC",
"MEDIA",
"HEALTHCARE_FHIR"
],
"enumDescriptions": [
"Value used when unset.",
"The generic vertical for documents that are not specific to any industry vertical.",
"The media industry vertical.",
"The healthcare FHIR vertical."
],
"type": "string"
},
"isInfobotFaqDataStore": {
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
"type": "boolean"
},
"kmsKeyName": {
"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"servingConfigDataStore": {
"$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore",
"description": "Optional. Stores serving config at DataStore level."
},
"solutionTypes": {
"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.",
"items": {
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"type": "array"
},
"startingSchema": {
"$ref": "GoogleCloudDiscoveryengineV1Schema",
"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
},
"workspaceConfig": {
"$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": {
"description": "Estimation of data size per data store.",
"id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation",
"properties": {
"structuredDataSize": {
"description": "Data size for structured data in terms of bytes.",
"format": "int64",
"type": "string"
},
"structuredDataUpdateTime": {
"description": "Last updated timestamp for structured data.",
"format": "google-datetime",
"type": "string"
},
"unstructuredDataSize": {
"description": "Data size for unstructured data in terms of bytes.",
"format": "int64",
"type": "string"
},
"unstructuredDataUpdateTime": {
"description": "Last updated timestamp for unstructured data.",
"format": "google-datetime",
"type": "string"
},
"websiteDataSize": {
"description": "Data size for websites in terms of bytes.",
"format": "int64",
"type": "string"
},
"websiteDataUpdateTime": {
"description": "Last updated timestamp for websites.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": {
"description": "Stores information regarding the serving configurations at DataStore level.",
"id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore",
"properties": {
"disabledForServing": {
"description": "If set true, the DataStore will not be available for serving search requests.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": {
"description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": {
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": {
"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata": {
"description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": {
"description": "Metadata for DeleteSchema LRO.",
"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": {
"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": {
"description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig",
"properties": {
"chunkingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig",
"description": "Whether chunking mode is enabled."
},
"defaultParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig",
"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing."
},
"name": {
"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.",
"type": "string"
},
"parsingConfigOverrides": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig"
},
"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": {
"description": "Configuration for chunking config.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig",
"properties": {
"layoutBasedChunkingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig",
"description": "Configuration for the layout based chunking."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": {
"description": "Configuration for the layout based chunking.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig",
"properties": {
"chunkSize": {
"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.",
"format": "int32",
"type": "integer"
},
"includeAncestorHeadings": {
"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": {
"description": "Related configurations applied to a specific type of document parser.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig",
"properties": {
"digitalParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig",
"description": "Configurations applied to digital parser."
},
"layoutParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig",
"description": "Configurations applied to layout parser."
},
"ocrParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig",
"description": "Configurations applied to OCR parser. Currently it only applies to PDFs."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": {
"description": "The digital parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": {
"description": "The layout parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig",
"properties": {
"enableImageAnnotation": {
"description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
"type": "boolean"
},
"enableTableAnnotation": {
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
"type": "boolean"
},
"excludeHtmlClasses": {
"description": "Optional. List of HTML classes to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
},
"excludeHtmlElements": {
"description": "Optional. List of HTML elements to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
},
"excludeHtmlIds": {
"description": "Optional. List of HTML ids to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": {
"description": "The OCR parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig",
"properties": {
"enhancedDocumentElements": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.",
"items": {
"type": "string"
},
"type": "array"
},
"useNativeText": {
"description": "If true, will use native text instead of OCR text on pages containing native text.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": {
"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1Engine": {
"description": "Metadata that describes the training and serving parameters of an Engine.",
"id": "GoogleCloudDiscoveryengineV1Engine",
"properties": {
"chatEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig",
"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT."
},
"chatEngineMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata",
"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.",
"readOnly": true
},
"commonConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
"description": "Common config spec that specifies the metadata of the engine."
},
"createTime": {
"description": "Output only. Timestamp the Recommendation Engine was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataStoreIds": {
"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
"items": {
"type": "string"
},
"type": "array"
},
"disableAnalytics": {
"description": "Optional. Whether to disable analytics for searches performed on this engine.",
"type": "boolean"
},
"displayName": {
"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
"type": "string"
},
"industryVertical": {
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
"enum": [
"INDUSTRY_VERTICAL_UNSPECIFIED",
"GENERIC",
"MEDIA",
"HEALTHCARE_FHIR"
],
"enumDescriptions": [
"Value used when unset.",
"The generic vertical for documents that are not specific to any industry vertical.",
"The media industry vertical.",
"The healthcare FHIR vertical."
],
"type": "string"
},
"mediaRecommendationEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig",
"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
},
"name": {
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"searchEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig",
"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH."
},
"solutionType": {
"description": "Required. The solutions of the engine.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp the Recommendation Engine was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": {
"description": "Configurations for a Chat Engine.",
"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig",
"properties": {
"agentCreationConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig",
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
},
"allowCrossRegion": {
"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
"type": "boolean"
},
"dialogflowAgentToLink": {
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": {
"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig",
"properties": {
"business": {
"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.",
"type": "string"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.",
"type": "string"
},
"location": {
"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.",
"type": "string"
},
"timeZone": {
"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": {
"description": "Additional information of a Chat Engine. Fields in this message are output only.",
"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata",
"properties": {
"dialogflowAgent": {
"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineCommonConfig": {
"description": "Common configurations for an Engine.",
"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
"properties": {
"companyName": {
"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": {
"description": "Additional config specs for a Media Recommendation engine.",
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig",
"properties": {
"engineFeaturesConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig",
"description": "Optional. Additional engine features config."
},
"optimizationObjective": {
"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`",
"type": "string"
},
"optimizationObjectiveConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)."
},
"trainingState": {
"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.",
"enum": [
"TRAINING_STATE_UNSPECIFIED",
"PAUSED",
"TRAINING"
],
"enumDescriptions": [
"Unspecified training state.",
"The engine training is paused.",
"The engine is training."
],
"type": "string"
},
"type": {
"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": {
"description": "More feature configs of the selected engine type.",
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig",
"properties": {
"mostPopularConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
"description": "Most popular engine feature config."
},
"recommendedForYouConfig": {
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
"description": "Recommended for you engine feature config."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": {
"description": "Feature configurations that are required for creating a Most Popular engine.",
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
"properties": {
"timeWindowDays": {
"description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": {
"description": "Custom threshold for `cvr` optimization_objective.",
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
"properties": {
"targetField": {
"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.",
"type": "string"
},
"targetFieldValueFloat": {
"description": "Required. The threshold to be applied to the target (e.g., 0.5).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": {
"description": "Additional feature configurations for creating a `recommended-for-you` engine.",
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
"properties": {
"contextEventType": {
"description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": {
"description": "Configurations for a Search Engine.",
"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig",
"properties": {
"searchAddOns": {
"description": "The add-on that this search engine enables.",
"items": {
"enum": [
"SEARCH_ADD_ON_UNSPECIFIED",
"SEARCH_ADD_ON_LLM"
],
"enumDescriptions": [
"Default value when the enum is unspecified. This is invalid to use.",
"Large language model add-on."
],
"type": "string"
},
"type": "array"
},
"searchTier": {
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.",
"enum": [
"SEARCH_TIER_UNSPECIFIED",
"SEARCH_TIER_STANDARD",
"SEARCH_TIER_ENTERPRISE"
],
"enumDescriptions": [
"Default value when the enum is unspecified. This is invalid to use.",
"Standard tier.",
"Enterprise tier."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1HealthcareFhirConfig": {
"description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
"id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
"properties": {
"enableConfigurableSchema": {
"description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.",
"type": "boolean"
},
"enableStaticIndexingForBatchIngestion": {
"description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": {
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata",
"properties": {
"failureCount": {
"description": "The number of IdentityMappingEntries that failed to be processed.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "The number of IdentityMappingEntries that were successfully processed.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "The total number of IdentityMappingEntries that were processed.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": {
"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of CompletionSuggestions that failed to be imported.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of CompletionSuggestions successfully imported.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": {
"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": {
"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were processed successfully.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "Total count of entries that were processed.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": {
"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
"description": "Echoes the destination for the complete errors in the request if set."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportErrorConfig": {
"description": "Configuration of destination for Import related errors.",
"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
"properties": {
"gcsPrefix": {
"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": {
"description": "Response message for IdentityMappingStoreService.ImportIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": {
"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": {
"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"failedEntriesCount": {
"description": "Count of deny list entries that failed to be imported.",
"format": "int64",
"type": "string"
},
"importedEntriesCount": {
"description": "Count of deny list entries successfully imported.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": {
"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were processed successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": {
"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
"description": "Echoes the destination for the complete errors if this field was set in the request."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"joinedEventsCount": {
"description": "Count of user events imported with complete existing Documents.",
"format": "int64",
"type": "string"
},
"unjoinedEventsCount": {
"description": "Count of user events imported, but with Document information not found in the existing Branch.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1Project": {
"description": "Metadata and configurations for a Google Cloud project in the service.",
"id": "GoogleCloudDiscoveryengineV1Project",
"properties": {
"createTime": {
"description": "Output only. The timestamp when this project is created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
"readOnly": true,
"type": "string"
},
"provisionCompletionTime": {
"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"serviceTermsMap": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms"
},
"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ProjectServiceTerms": {
"description": "Metadata about the terms of service.",
"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms",
"properties": {
"acceptTime": {
"description": "The last time when the project agreed to the terms of service.",
"format": "google-datetime",
"type": "string"
},
"declineTime": {
"description": "The last time when the project declined or revoked the agreement to terms of service.",
"format": "google-datetime",
"type": "string"
},
"id": {
"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
"type": "string"
},
"state": {
"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
"enum": [
"STATE_UNSPECIFIED",
"TERMS_ACCEPTED",
"TERMS_PENDING",
"TERMS_DECLINED"
],
"enumDescriptions": [
"The default value of the enum. This value is not actually used.",
"The project has given consent to the terms of service.",
"The project is pending to review and accept the terms of service.",
"The project has declined or revoked the agreement to terms of service."
],
"type": "string"
},
"version": {
"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": {
"description": "Metadata associated with a project provision operation.",
"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": {
"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": {
"description": "Response message for CompletionService.PurgeCompletionSuggestions method.",
"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"purgeSucceeded": {
"description": "Whether the completion suggestions were successfully purged.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": {
"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"ignoredCount": {
"description": "Count of entries that were ignored as entries were not found.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were deleted successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": {
"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse",
"properties": {
"purgeCount": {
"description": "The total count of documents purged as a result of the operation.",
"format": "int64",
"type": "string"
},
"purgeSample": {
"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": {
"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": {
"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"purgeCount": {
"description": "Number of suggestion deny list entries purged.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1Schema": {
"description": "Defines the structure and layout of a type of document data.",
"id": "GoogleCloudDiscoveryengineV1Schema",
"properties": {
"jsonSchema": {
"description": "The JSON representation of the schema.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"structSchema": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured representation of the schema.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchLinkPromotion": {
"description": "Promotion proto includes uri and other helping information to display the promotion.",
"id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
"properties": {
"description": {
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
"type": "string"
},
"document": {
"description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.",
"type": "string"
},
"enabled": {
"description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
"type": "boolean"
},
"imageUri": {
"description": "Optional. The promotion thumbnail image url.",
"type": "string"
},
"title": {
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
"type": "string"
},
"uri": {
"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": {
"description": "A specification for configuring the behavior of content search.",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
"properties": {
"chunkSpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
},
"extractiveContentSpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
},
"searchResultMode": {
"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
"enum": [
"SEARCH_RESULT_MODE_UNSPECIFIED",
"DOCUMENTS",
"CHUNKS"
],
"enumDescriptions": [
"Default value.",
"Returns documents in the search result.",
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
],
"type": "string"
},
"snippetSpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
},
"summarySpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
"description": "If `summarySpec` is not specified, summaries are not included in the search response."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": {
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
"properties": {
"numNextChunks": {
"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
"format": "int32",
"type": "integer"
},
"numPreviousChunks": {
"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": {
"description": "A specification for configuring the extractive content in a search response.",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
"properties": {
"maxExtractiveAnswerCount": {
"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.",
"format": "int32",
"type": "integer"
},
"maxExtractiveSegmentCount": {
"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
"format": "int32",
"type": "integer"
},
"numNextSegments": {
"description": "Return at most `num_next_segments` segments after each selected segments.",
"format": "int32",
"type": "integer"
},
"numPreviousSegments": {
"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
"format": "int32",
"type": "integer"
},
"returnExtractiveSegmentScore": {
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": {
"description": "A specification for configuring snippets in a search response.",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
"properties": {
"maxSnippetCount": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
"format": "int32",
"type": "integer"
},
"referenceOnly": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
"type": "boolean"
},
"returnSnippet": {
"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": {
"description": "A specification for configuring a summary returned in a search response.",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
"properties": {
"ignoreAdversarialQuery": {
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreJailBreakingQuery": {
"description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreLowRelevantContent": {
"description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.",
"type": "boolean"
},
"ignoreNonSummarySeekingQuery": {
"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.",
"type": "boolean"
},
"includeCitations": {
"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
"type": "boolean"
},
"languageCode": {
"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
"type": "string"
},
"modelPromptSpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
"description": "If specified, the spec will be used to modify the prompt provided to the LLM."
},
"modelSpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
},
"summaryResultCount": {
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
"format": "int32",
"type": "integer"
},
"useSemanticChunks": {
"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
"description": "Specification of the prompt to use with the model.",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
"properties": {
"preamble": {
"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": {
"description": "Specification of the model.",
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
"properties": {
"version": {
"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ServingConfig": {
"description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.",
"id": "GoogleCloudDiscoveryengineV1ServingConfig",
"properties": {
"answerGenerationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec",
"description": "Optional. The specification for answer generation."
},
"boostControlIds": {
"description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "Output only. ServingConfig created timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"dissociateControlIds": {
"description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"diversityLevel": {
"description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"type": "string"
},
"filterControlIds": {
"description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.",
"items": {
"type": "string"
},
"type": "array"
},
"genericConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
"description": "The GenericConfig of the serving configuration."
},
"ignoreControlIds": {
"description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.",
"items": {
"type": "string"
},
"type": "array"
},
"mediaConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
"description": "The MediaConfig of the serving configuration."
},
"modelId": {
"description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"type": "string"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
"type": "string"
},
"onewaySynonymsControlIds": {
"description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"promoteControlIds": {
"description": "Condition promote specifications. Maximum number of specifications is 100.",
"items": {
"type": "string"
},
"type": "array"
},
"rankingExpression": {
"description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
"type": "string"
},
"redirectControlIds": {
"description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"replacementControlIds": {
"description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"solutionType": {
"description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"synonymsControlIds": {
"description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"updateTime": {
"description": "Output only. ServingConfig updated timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": {
"description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
"id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
"properties": {
"contentSearchSpec": {
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
"description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": {
"description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
"properties": {
"contentFreshnessCutoffDays": {
"description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
"format": "int32",
"type": "integer"
},
"contentWatchedPercentageThreshold": {
"description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
"format": "float",
"type": "number"
},
"contentWatchedSecondsThreshold": {
"description": "Specifies the content watched minutes threshold for demotion.",
"format": "float",
"type": "number"
},
"demoteContentWatchedPastDays": {
"description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.",
"format": "int32",
"type": "integer"
},
"demotionEventType": {
"description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SingleRegionKey": {
"description": "Metadata for single-regional CMEKs.",
"id": "GoogleCloudDiscoveryengineV1SingleRegionKey",
"properties": {
"kmsKey": {
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1SiteVerificationInfo": {
"description": "Verification information for target sites in advanced site search.",
"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
"properties": {
"siteVerificationState": {
"description": "Site verification state indicating the ownership and validity.",
"enum": [
"SITE_VERIFICATION_STATE_UNSPECIFIED",
"VERIFIED",
"UNVERIFIED",
"EXEMPTED"
],
"enumDescriptions": [
"Defaults to VERIFIED.",
"Site ownership verified.",
"Site ownership pending verification or verification failed.",
"Site exempt from verification, e.g., a public website that opens to all."
],
"type": "string"
},
"verifyTime": {
"description": "Latest site verification time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1Sitemap": {
"description": "A sitemap for the SiteSearchEngine.",
"id": "GoogleCloudDiscoveryengineV1Sitemap",
"properties": {
"createTime": {
"description": "Output only. The sitemap's creation time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1TargetSite": {
"description": "A target site for the SiteSearchEngine.",
"id": "GoogleCloudDiscoveryengineV1TargetSite",
"properties": {
"exactMatch": {
"description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
"type": "boolean"
},
"failureReason": {
"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason",
"description": "Output only. Failure reason.",
"readOnly": true
},
"generatedUriPattern": {
"description": "Output only. This is system-generated based on the provided_uri_pattern.",
"readOnly": true,
"type": "string"
},
"indexingStatus": {
"description": "Output only. Indexing status.",
"enum": [
"INDEXING_STATUS_UNSPECIFIED",
"PENDING",
"FAILED",
"SUCCEEDED",
"DELETING",
"CANCELLABLE",
"CANCELLED"
],
"enumDescriptions": [
"Defaults to SUCCEEDED.",
"The target site is in the update queue and will be picked up by indexing pipeline.",
"The target site fails to be indexed.",
"The target site has been indexed.",
"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.",
"The target site change is pending but cancellable.",
"The target site change is cancelled."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.",
"readOnly": true,
"type": "string"
},
"providedUriPattern": {
"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.",
"type": "string"
},
"rootDomainUri": {
"description": "Output only. Root domain of the provided_uri_pattern.",
"readOnly": true,
"type": "string"
},
"siteVerificationInfo": {
"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
"description": "Output only. Site ownership and validity verification status.",
"readOnly": true
},
"type": {
"description": "The type of the target site, e.g., whether the site is to be included or excluded.",
"enum": [
"TYPE_UNSPECIFIED",
"INCLUDE",
"EXCLUDE"
],
"enumDescriptions": [
"This value is unused. In this case, server behavior defaults to Type.INCLUDE.",
"Include the target site.",
"Exclude the target site."
],
"type": "string"
},
"updateTime": {
"description": "Output only. The target site's last updated time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": {
"description": "Site search indexing failure reasons.",
"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason",
"properties": {
"quotaFailure": {
"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure",
"description": "Failed due to insufficient quota."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": {
"description": "Failed due to insufficient quota.",
"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure",
"properties": {
"totalRequiredQuota": {
"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": {
"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1TrainCustomModelResponse": {
"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
"description": "Echoes the destination for the complete errors in the request if set."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the data.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"metrics": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"description": "The metrics of the trained model.",
"type": "object"
},
"modelName": {
"description": "Fully qualified name of the CustomTuningModel.",
"type": "string"
},
"modelStatus": {
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata": {
"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": {
"description": "Metadata for UpdateSchema LRO.",
"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1WorkspaceConfig": {
"description": "Config to store data store type configuration for workspace data",
"id": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
"properties": {
"dasherCustomerId": {
"description": "Obfuscated Dasher customer ID.",
"type": "string"
},
"superAdminEmailAddress": {
"description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
"type": "string"
},
"superAdminServiceAccount": {
"description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
"type": "string"
},
"type": {
"description": "The Google Workspace data source.",
"enum": [
"TYPE_UNSPECIFIED",
"GOOGLE_DRIVE",
"GOOGLE_MAIL",
"GOOGLE_SITES",
"GOOGLE_CALENDAR",
"GOOGLE_CHAT",
"GOOGLE_GROUPS",
"GOOGLE_KEEP",
"GOOGLE_PEOPLE"
],
"enumDescriptions": [
"Defaults to an unspecified Workspace type.",
"Workspace Data Store contains Drive data",
"Workspace Data Store contains Mail data",
"Workspace Data Store contains Sites data",
"Workspace Data Store contains Calendar data",
"Workspace Data Store contains Chat data",
"Workspace Data Store contains Groups data",
"Workspace Data Store contains Keep data",
"Workspace Data Store contains People data"
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAclConfig": {
"description": "Access Control Configuration.",
"id": "GoogleCloudDiscoveryengineV1alphaAclConfig",
"properties": {
"idpConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
"description": "Identity provider config."
},
"name": {
"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaActionConfig": {
"description": "Informations to support actions on the connector.",
"id": "GoogleCloudDiscoveryengineV1alphaActionConfig",
"properties": {
"actionParams": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
"type": "object"
},
"isActionConfigured": {
"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
"readOnly": true,
"type": "boolean"
},
"serviceName": {
"description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": {
"description": "Configuration data for advance site search.",
"id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
"properties": {
"disableAutomaticRefresh": {
"description": "If set true, automatic refresh is disabled for the DataStore.",
"type": "boolean"
},
"disableInitialIndex": {
"description": "If set true, initial indexing is disabled for the DataStore.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": {
"description": "The connector level alert config.",
"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig",
"properties": {
"alertEnrollments": {
"description": "Optional. The enrollment states of each alert.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment"
},
"type": "array"
},
"alertPolicyName": {
"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": {
"description": "The alert enrollment status.",
"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment",
"properties": {
"alertId": {
"description": "Immutable. The id of an alert.",
"type": "string"
},
"enrollState": {
"description": "Required. The enrollment status of a customer.",
"enum": [
"ENROLL_STATES_UNSPECIFIED",
"ENROLLED",
"DECLINED"
],
"enumDescriptions": [
"Default value. Used for customers who have not responded to the alert policy.",
"Customer is enrolled in this policy.",
"Customer declined this policy."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswer": {
"description": "Defines an answer.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswer",
"properties": {
"answerSkippedReasons": {
"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.",
"items": {
"enum": [
"ANSWER_SKIPPED_REASON_UNSPECIFIED",
"ADVERSARIAL_QUERY_IGNORED",
"NON_ANSWER_SEEKING_QUERY_IGNORED",
"OUT_OF_DOMAIN_QUERY_IGNORED",
"POTENTIAL_POLICY_VIOLATION",
"NO_RELEVANT_CONTENT",
"JAIL_BREAKING_QUERY_IGNORED",
"CUSTOMER_POLICY_VIOLATION",
"NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
"LOW_GROUNDED_ANSWER"
],
"enumDescriptions": [
"Default value. The answer skipped reason is not specified.",
"The adversarial query ignored case.",
"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.",
"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.",
"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.",
"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.",
"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.",
"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.",
"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated."
],
"type": "string"
},
"type": "array"
},
"answerText": {
"description": "The textual answer.",
"type": "string"
},
"blobAttachments": {
"description": "List of blob attachments in the answer.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
},
"type": "array"
},
"citations": {
"description": "Citations.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation"
},
"type": "array"
},
"completeTime": {
"description": "Output only. Answer completed timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. Answer creation timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"groundingScore": {
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
"format": "double",
"type": "number"
},
"groundingSupports": {
"description": "Optional. Grounding supports.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport"
},
"type": "array"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
"type": "string"
},
"queryUnderstandingInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
"description": "Query understanding information."
},
"references": {
"description": "References.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference"
},
"type": "array"
},
"relatedQuestions": {
"description": "Suggested related questions.",
"items": {
"type": "string"
},
"type": "array"
},
"safetyRatings": {
"description": "Optional. Safety ratings.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSafetyRating"
},
"type": "array"
},
"state": {
"description": "The state of the answer generation.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"FAILED",
"SUCCEEDED",
"STREAMING"
],
"enumDescriptions": [
"Unknown.",
"Answer generation is currently in progress.",
"Answer generation currently failed.",
"Answer generation has succeeded.",
"Answer generation is currently in progress."
],
"type": "string"
},
"steps": {
"description": "Answer generation steps.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment": {
"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment",
"properties": {
"attributionType": {
"description": "Output only. The attribution type of the blob.",
"enum": [
"ATTRIBUTION_TYPE_UNSPECIFIED",
"CORPUS",
"GENERATED"
],
"enumDescriptions": [
"Unspecified attribution type.",
"The attachment data is from the corpus.",
"The attachment data is generated by the model through code generation."
],
"readOnly": true,
"type": "string"
},
"data": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
"description": "Output only. The mime type and data of the blob.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob": {
"description": "The media type and data of the blob.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
"properties": {
"data": {
"description": "Output only. Raw bytes.",
"format": "byte",
"readOnly": true,
"type": "string"
},
"mimeType": {
"description": "Output only. The media type (MIME type) of the generated or retrieved data.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerCitation": {
"description": "Citation info for a segment.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
"properties": {
"endIndex": {
"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
"format": "int64",
"type": "string"
},
"sources": {
"description": "Citation sources for the attributed segment.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
},
"type": "array"
},
"startIndex": {
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": {
"description": "Citation source.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource",
"properties": {
"referenceId": {
"description": "ID of the citation source.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": {
"description": "Grounding support for a claim in `answer_text`.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport",
"properties": {
"endIndex": {
"description": "Required. End of the claim, exclusive.",
"format": "int64",
"type": "string"
},
"groundingCheckRequired": {
"description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.",
"type": "boolean"
},
"groundingScore": {
"description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.",
"format": "double",
"type": "number"
},
"sources": {
"description": "Optional. Citation sources for the claim.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
},
"type": "array"
},
"startIndex": {
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": {
"description": "Query understanding information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
"properties": {
"queryClassificationInfo": {
"description": "Query classification information.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": {
"description": "Query classification information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo",
"properties": {
"positive": {
"description": "Classification output.",
"type": "boolean"
},
"type": {
"description": "Query classification type.",
"enum": [
"TYPE_UNSPECIFIED",
"ADVERSARIAL_QUERY",
"NON_ANSWER_SEEKING_QUERY",
"JAIL_BREAKING_QUERY",
"NON_ANSWER_SEEKING_QUERY_V2"
],
"enumDescriptions": [
"Unspecified query classification type.",
"Adversarial query classification type.",
"Non-answer-seeking query classification type, for chit chat.",
"Jail-breaking query classification type.",
"Non-answer-seeking query classification type, for no clear intent."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerReference": {
"description": "Reference.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference",
"properties": {
"chunkInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
"description": "Chunk information."
},
"structuredDocumentInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo",
"description": "Structured document information."
},
"unstructuredDocumentInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo",
"description": "Unstructured document information."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": {
"description": "Chunk information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
"properties": {
"blobAttachmentIndexes": {
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"chunk": {
"description": "Chunk resource name.",
"type": "string"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"documentMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata",
"description": "Document metadata."
},
"relevanceScore": {
"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": {
"description": "Document metadata.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata",
"properties": {
"document": {
"description": "Document resource name.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
"type": "object"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": {
"description": "Structured search information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo",
"properties": {
"document": {
"description": "Document resource name.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Structured search data.",
"type": "object"
},
"title": {
"description": "Output only. The title of the document.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Output only. The URI of the document.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": {
"description": "Unstructured document information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo",
"properties": {
"chunkContents": {
"description": "List of cited chunk contents derived from document content.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent"
},
"type": "array"
},
"document": {
"description": "Document resource name.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
"type": "object"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": {
"description": "Chunk content.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent",
"properties": {
"blobAttachmentIndexes": {
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
},
"relevanceScore": {
"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStep": {
"description": "Step information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep",
"properties": {
"actions": {
"description": "Actions.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction"
},
"type": "array"
},
"description": {
"description": "The description of the step.",
"type": "string"
},
"state": {
"description": "The state of the step.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"FAILED",
"SUCCEEDED"
],
"enumDescriptions": [
"Unknown.",
"Step is currently in progress.",
"Step currently failed.",
"Step has succeeded."
],
"type": "string"
},
"thought": {
"description": "The thought of the step.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": {
"description": "Action.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction",
"properties": {
"observation": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation",
"description": "Observation."
},
"searchAction": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction",
"description": "Search action."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": {
"description": "Observation.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation",
"properties": {
"searchResults": {
"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": {
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult",
"properties": {
"chunkInfo": {
"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo"
},
"type": "array"
},
"document": {
"description": "Document resource name.",
"type": "string"
},
"snippetInfo": {
"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo"
},
"type": "array"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.",
"type": "object"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": {
"description": "Chunk information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo",
"properties": {
"chunk": {
"description": "Chunk resource name.",
"type": "string"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"relevanceScore": {
"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": {
"description": "Snippet information.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo",
"properties": {
"snippet": {
"description": "Snippet content.",
"type": "string"
},
"snippetStatus": {
"description": "Status of the snippet defined by the search team.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": {
"description": "Search action.",
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction",
"properties": {
"query": {
"description": "The query to search.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaBAPConfig": {
"description": "The configuration for the BAP connector.",
"id": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
"properties": {
"supportedConnectorModes": {
"description": "Required. The supported connector modes for the associated BAP connection.",
"items": {
"enum": [
"CONNECTOR_MODE_UNSPECIFIED",
"DATA_INGESTION",
"ACTIONS"
],
"enumDescriptions": [
"Connector mode unspecified.",
"Connector utilized for data ingestion.",
"Connector utilized for Actions"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": {
"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.",
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse",
"properties": {
"targetSites": {
"description": "TargetSites created.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCmekConfig": {
"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
"id": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
"properties": {
"isDefault": {
"description": "Output only. The default CmekConfig for the Customer.",
"readOnly": true,
"type": "boolean"
},
"kmsKey": {
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
"type": "string"
},
"kmsKeyVersion": {
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
"type": "string"
},
"lastRotationTimestampMicros": {
"description": "Output only. The timestamp of the last key rotation.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
"type": "string"
},
"notebooklmState": {
"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
"enum": [
"NOTEBOOK_LM_STATE_UNSPECIFIED",
"NOTEBOOK_LM_NOT_READY",
"NOTEBOOK_LM_READY",
"NOTEBOOK_LM_NOT_ENABLED"
],
"enumDescriptions": [
"The NotebookLM state is unknown.",
"The NotebookLM is not ready.",
"The NotebookLM is ready to be used.",
"The NotebookLM is not enabled."
],
"readOnly": true,
"type": "string"
},
"singleRegionKeys": {
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey"
},
"type": "array"
},
"state": {
"description": "Output only. The states of the CmekConfig.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"KEY_ISSUE",
"DELETING",
"DELETE_FAILED",
"UNUSABLE",
"ACTIVE_ROTATING"
],
"enumDescriptions": [
"The CmekConfig state is unknown.",
"The CmekConfig is creating.",
"The CmekConfig can be used with DataStores.",
"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.",
"The CmekConfig is deleting.",
"The CmekConfig deletion process failed.",
"The CmekConfig is not usable, most likely due to some internal issue.",
"The KMS key version is being rotated."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCollection": {
"description": "Collection is a container for configuring resources and access to a set of DataStores.",
"id": "GoogleCloudDiscoveryengineV1alphaCollection",
"properties": {
"createTime": {
"description": "Output only. Timestamp the Collection was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataConnector": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector",
"description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method.",
"readOnly": true
},
"displayName": {
"description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCondition": {
"description": "Defines circumstances to be checked before allowing a behavior",
"id": "GoogleCloudDiscoveryengineV1alphaCondition",
"properties": {
"activeTimeRange": {
"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange"
},
"type": "array"
},
"queryRegex": {
"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.",
"type": "string"
},
"queryTerms": {
"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": {
"description": "Matcher for search request query",
"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm",
"properties": {
"fullMatch": {
"description": "Whether the search query needs to exactly match the query term.",
"type": "boolean"
},
"value": {
"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": {
"description": "Used for time-dependent conditions.",
"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange",
"properties": {
"endTime": {
"description": "End of time range. Range is inclusive. Must be in the future.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start of time range. Range is inclusive.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaConnectorRun": {
"description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //",
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRun",
"properties": {
"endTime": {
"description": "Output only. The time when the connector run ended.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"entityRuns": {
"description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun"
},
"readOnly": true,
"type": "array"
},
"errors": {
"description": "Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"latestPauseTime": {
"description": "Output only. The time when the connector run was most recently paused.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The time when the connector run started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The state of the sync run.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"OVERRUN",
"CANCELLED",
"PENDING",
"WARNING",
"SKIPPED"
],
"enumDescriptions": [
"Default value.",
"The data sync is ongoing.",
"The data sync is finished.",
"The data sync is failed.",
"Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
"Data sync was scheduled but has been cancelled.",
"Data sync is about to start.",
"The data sync completed with non-fatal errors.",
"An ongoing connector run has been running longer than expected, causing this run to be skipped."
],
"readOnly": true,
"type": "string"
},
"stateUpdateTime": {
"description": "Timestamp at which the connector run sync state was last updated.",
"format": "google-datetime",
"type": "string"
},
"trigger": {
"description": "Output only. The trigger for this ConnectorRun.",
"enum": [
"TRIGGER_UNSPECIFIED",
"SCHEDULER",
"INITIALIZATION",
"RESUME",
"MANUAL"
],
"enumDescriptions": [
"Default value.",
"ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.",
"ConnectorRun auto triggered by connector initialization.",
"ConnectorRun auto triggered by resuming connector.",
"ConnectorRun triggered by user manually."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": {
"description": "Represents an entity that was synced in this ConnectorRun.",
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
"properties": {
"deletedRecordCount": {
"description": "The number of documents deleted.",
"format": "int64",
"type": "string"
},
"entityName": {
"description": "The name of the source entity.",
"type": "string"
},
"errorRecordCount": {
"description": "The total number of documents failed at sync at any stage (extraction, indexing, etc).",
"format": "int64",
"type": "string"
},
"errors": {
"description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"extractedRecordCount": {
"description": "The number of documents extracted from connector source, ready to be ingested to UCS.",
"format": "int64",
"type": "string"
},
"indexedRecordCount": {
"description": "The number of documents indexed.",
"format": "int64",
"type": "string"
},
"progress": {
"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress",
"description": "Metadata to generate the progress bar."
},
"sourceApiRequestCount": {
"description": "The number of requests sent to 3p API.",
"format": "int64",
"type": "string"
},
"state": {
"description": "The state of the entity's sync run.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"OVERRUN",
"CANCELLED",
"PENDING",
"WARNING",
"SKIPPED"
],
"enumDescriptions": [
"Default value.",
"The data sync is ongoing.",
"The data sync is finished.",
"The data sync is failed.",
"Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
"Data sync was scheduled but has been cancelled.",
"Data sync is about to start.",
"The data sync completed with non-fatal errors.",
"An ongoing connector run has been running longer than expected, causing this run to be skipped."
],
"type": "string"
},
"stateUpdateTime": {
"description": "Timestamp at which the entity sync state was last updated.",
"format": "google-datetime",
"type": "string"
},
"statsUpdateTime": {
"description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.",
"format": "google-datetime",
"type": "string"
},
"syncType": {
"description": "Sync type of this run.",
"enum": [
"SYNC_TYPE_UNSPECIFIED",
"FULL",
"INCREMENTAL",
"REALTIME"
],
"enumDescriptions": [
"Sync type unspecified.",
"Sync triggers full sync of all documents.",
"Incremental sync of updated documents.",
"Realtime sync."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": {
"description": "Represents the progress of a sync run.",
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress",
"properties": {
"currentCount": {
"description": "The current progress.",
"format": "int64",
"type": "string"
},
"percentile": {
"description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.",
"format": "float",
"type": "number"
},
"totalCount": {
"description": "The total.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControl": {
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
"id": "GoogleCloudDiscoveryengineV1alphaControl",
"properties": {
"associatedServingConfigIds": {
"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"boostAction": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction",
"description": "Defines a boost-type control"
},
"conditions": {
"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCondition"
},
"type": "array"
},
"displayName": {
"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
},
"filterAction": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction",
"description": "Defines a filter-type control Currently not supported by Recommendation"
},
"name": {
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
"type": "string"
},
"promoteAction": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
},
"redirectAction": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
"description": "Defines a redirect-type control."
},
"solutionType": {
"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"synonymsAction": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction",
"description": "Treats a group of terms as synonyms of one another."
},
"useCases": {
"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.",
"items": {
"enum": [
"SEARCH_USE_CASE_UNSPECIFIED",
"SEARCH_USE_CASE_SEARCH",
"SEARCH_USE_CASE_BROWSE"
],
"enumDescriptions": [
"Value used when unset. Will not occur in CSS.",
"Search use case. Expects the traffic has a non-empty query.",
"Browse use case. Expects the traffic has an empty query."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlBoostAction": {
"description": "Adjusts order of products in returned list.",
"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction",
"properties": {
"boost": {
"deprecated": true,
"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
"format": "float",
"type": "number"
},
"dataStore": {
"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
"type": "string"
},
"filter": {
"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
},
"fixedBoost": {
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
"format": "float",
"type": "number"
},
"interpolationBoostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec",
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": {
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
"id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec",
"properties": {
"attributeType": {
"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
"enum": [
"ATTRIBUTE_TYPE_UNSPECIFIED",
"NUMERICAL",
"FRESHNESS"
],
"enumDescriptions": [
"Unspecified AttributeType.",
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
],
"type": "string"
},
"controlPoints": {
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint"
},
"type": "array"
},
"fieldName": {
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
"type": "string"
},
"interpolationType": {
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
"enum": [
"INTERPOLATION_TYPE_UNSPECIFIED",
"LINEAR"
],
"enumDescriptions": [
"Interpolation type is unspecified. In this case, it defaults to Linear.",
"Piecewise linear interpolation will be applied."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": {
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
"id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint",
"properties": {
"attributeValue": {
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
"type": "string"
},
"boostAmount": {
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlFilterAction": {
"description": "Specified which products may be included in results. Uses same filter as boost.",
"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction",
"properties": {
"dataStore": {
"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
"type": "string"
},
"filter": {
"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlPromoteAction": {
"description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
"id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
"properties": {
"dataStore": {
"description": "Required. Data store with which this promotion is attached to.",
"type": "string"
},
"searchLinkPromotion": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
"description": "Required. Promotion attached to this action."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
"description": "Redirects a shopper to the provided URI.",
"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
"properties": {
"redirectUri": {
"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": {
"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".",
"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction",
"properties": {
"synonyms": {
"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries": {
"description": "The historical crawl rate timeseries data, used for monitoring.",
"id": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"properties": {
"qpsTimeSeries": {
"$ref": "GoogleMonitoringV3TimeSeries",
"description": "The QPS of the crawl rate."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": {
"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": {
"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": {
"description": "Metadata for EvaluationService.CreateEvaluation method.",
"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": {
"description": "Metadata for Create Schema LRO.",
"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": {
"description": "Defines custom fine tuning spec.",
"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
"properties": {
"enableSearchAdaptor": {
"description": "Whether or not to enable and include custom fine tuned search adaptor model.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataConnector": {
"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.",
"id": "GoogleCloudDiscoveryengineV1alphaDataConnector",
"properties": {
"aclEnabled": {
"description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.",
"type": "boolean"
},
"actionConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
"description": "Optional. Action configurations to make the connector support actions."
},
"alertPolicyConfigs": {
"description": "Optional. The connector level alert config.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig"
},
"type": "array"
},
"autoRunDisabled": {
"description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
"type": "boolean"
},
"bapConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
"description": "Optional. The configuration for establishing a BAP connection."
},
"blockingReasons": {
"description": "Output only. User actions that must be completed before the connector can start syncing data.",
"items": {
"enum": [
"BLOCKING_REASON_UNSPECIFIED",
"ALLOWLIST_STATIC_IP",
"ALLOWLIST_IN_SERVICE_ATTACHMENT"
],
"enumDescriptions": [
"Default value.",
"Connector requires customer to allowlist static IPs.",
"Connector requires customer to allowlist our project in their service attachment."
],
"type": "string"
},
"readOnly": true,
"type": "array"
},
"connectorModes": {
"description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
"items": {
"enum": [
"CONNECTOR_MODE_UNSPECIFIED",
"DATA_INGESTION",
"ACTIONS",
"FEDERATED",
"EUA"
],
"enumDescriptions": [
"Connector mode unspecified.",
"Connector utilized for data ingestion.",
"Connector utilized for actions.",
"Connector utilized for federated search.",
"Connector utilized for End User Authentication."
],
"type": "string"
},
"type": "array"
},
"connectorType": {
"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.",
"enum": [
"CONNECTOR_TYPE_UNSPECIFIED",
"THIRD_PARTY",
"GCP_FHIR",
"BIG_QUERY",
"GCS",
"GOOGLE_MAIL",
"GOOGLE_CALENDAR",
"GOOGLE_DRIVE",
"NATIVE_CLOUD_IDENTITY",
"THIRD_PARTY_FEDERATED"
],
"enumDescriptions": [
"Default value.",
"Third party connector to connector to third party application.",
"Data connector connects between FHIR store and VAIS datastore.",
"Big query connector.",
"Google Cloud Storage connector.",
"Gmail connector.",
"Google Calendar connector.",
"Google Drive connector.",
"Native Cloud Identity connector for people search powered by People API.",
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API."
],
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp the DataConnector was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataSource": {
"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
"type": "string"
},
"destinationConfigs": {
"description": "Optional. Any target destinations used to connect to third-party services.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig"
},
"type": "array"
},
"endUserConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig",
"description": "Optional. Any params and credentials used specifically for EUA connectors."
},
"entities": {
"description": "List of entities from the connected data source to ingest.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity"
},
"type": "array"
},
"errors": {
"description": "Output only. The errors from initialization or from the latest connector run.",
"items": {
"$ref": "GoogleRpcStatus"
},
"readOnly": true,
"type": "array"
},
"identityRefreshInterval": {
"deprecated": true,
"description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
"format": "google-duration",
"type": "string"
},
"identityScheduleConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
},
"kmsKeyName": {
"description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
"type": "string"
},
"lastSyncTime": {
"description": "Output only. For periodic connectors only, the last time a data sync was completed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"latestPauseTime": {
"description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
"readOnly": true,
"type": "string"
},
"nextSyncTime": {
"$ref": "GoogleTypeDateTime",
"description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity."
},
"params": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
"type": "object"
},
"privateConnectivityProjectId": {
"description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.",
"readOnly": true,
"type": "string"
},
"realtimeState": {
"description": "Output only. real-time sync state",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"FAILED",
"RUNNING",
"WARNING",
"INITIALIZATION_FAILED"
],
"enumDescriptions": [
"Default value.",
"The connector is being set up.",
"The connector is successfully set up and awaiting next sync run.",
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
"The connector is actively syncing records from the data source.",
"The connector has completed a sync run, but encountered non-fatal errors.",
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)."
],
"readOnly": true,
"type": "string"
},
"realtimeSyncConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig",
"description": "Optional. The configuration for realtime sync."
},
"refreshInterval": {
"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.",
"format": "google-duration",
"type": "string"
},
"state": {
"description": "Output only. State of the connector.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"FAILED",
"RUNNING",
"WARNING",
"INITIALIZATION_FAILED"
],
"enumDescriptions": [
"Default value.",
"The connector is being set up.",
"The connector is successfully set up and awaiting next sync run.",
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
"The connector is actively syncing records from the data source.",
"The connector has completed a sync run, but encountered non-fatal errors.",
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)."
],
"readOnly": true,
"type": "string"
},
"staticIpAddresses": {
"description": "Output only. The static IP addresses used by this connector.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"staticIpEnabled": {
"description": "Optional. Whether customer has enabled static IP addresses for this connector.",
"type": "boolean"
},
"syncMode": {
"description": "The data synchronization mode supported by the data connector.",
"enum": [
"PERIODIC",
"STREAMING",
"UNSPECIFIED"
],
"enumDescriptions": [
"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
"The data will be synced in real time.",
"Connector that doesn't ingest data will have this value"
],
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp the DataConnector was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": {
"description": "Any params and credentials used specifically for EUA connectors.",
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig",
"properties": {
"additionalParams": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Any additional parameters needed for EUA.",
"type": "object"
},
"authParams": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Any authentication parameters specific to EUA connectors.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": {
"description": "The configuration for realtime sync to store additional params for realtime sync.",
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig",
"properties": {
"realtimeSyncSecret": {
"description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
"type": "string"
},
"webhookUri": {
"description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": {
"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity",
"properties": {
"dataStore": {
"description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.",
"readOnly": true,
"type": "string"
},
"entityName": {
"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
"type": "string"
},
"healthcareFhirConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
},
"keyPropertyMappings": {
"additionalProperties": {
"type": "string"
},
"description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.",
"type": "object"
},
"params": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
"type": "object"
},
"startingSchema": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
"description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataStore": {
"description": "DataStore captures global settings and configs at the DataStore level.",
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
"properties": {
"aclEnabled": {
"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
"type": "boolean"
},
"advancedSiteSearchConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
"description": "Optional. Configuration for advanced site search."
},
"billingEstimation": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
"description": "Output only. Data size estimation for billing.",
"readOnly": true
},
"cmekConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
"description": "Output only. CMEK-related information for the DataStore.",
"readOnly": true
},
"contentConfig": {
"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
"enum": [
"CONTENT_CONFIG_UNSPECIFIED",
"NO_CONTENT",
"CONTENT_REQUIRED",
"PUBLIC_WEBSITE",
"GOOGLE_WORKSPACE"
],
"enumDescriptions": [
"Default value.",
"Only contains documents without any Document.content.",
"Only contains documents with Document.content.",
"The data store is used for public website search.",
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
],
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp the DataStore was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"defaultSchemaId": {
"description": "Output only. The id of the default Schema associated to this data store.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"documentProcessingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
"description": "Configuration for Document understanding and enrichment."
},
"healthcareFhirConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
},
"identityMappingStore": {
"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
"type": "string"
},
"idpConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
"description": "Output only. Data store level identity provider config.",
"readOnly": true
},
"industryVertical": {
"description": "Immutable. The industry vertical that the data store registers.",
"enum": [
"INDUSTRY_VERTICAL_UNSPECIFIED",
"GENERIC",
"MEDIA",
"HEALTHCARE_FHIR"
],
"enumDescriptions": [
"Value used when unset.",
"The generic vertical for documents that are not specific to any industry vertical.",
"The media industry vertical.",
"The healthcare FHIR vertical."
],
"type": "string"
},
"isInfobotFaqDataStore": {
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
"type": "boolean"
},
"kmsKeyName": {
"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.",
"type": "string"
},
"languageInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo",
"description": "Language info for DataStore."
},
"name": {
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"naturalLanguageQueryUnderstandingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig",
"description": "Optional. Configuration for Natural Language Query Understanding."
},
"servingConfigDataStore": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore",
"description": "Optional. Stores serving config at DataStore level."
},
"solutionTypes": {
"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.",
"items": {
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"type": "array"
},
"startingSchema": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
},
"workspaceConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": {
"description": "Estimation of data size per data store.",
"id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
"properties": {
"structuredDataSize": {
"description": "Data size for structured data in terms of bytes.",
"format": "int64",
"type": "string"
},
"structuredDataUpdateTime": {
"description": "Last updated timestamp for structured data.",
"format": "google-datetime",
"type": "string"
},
"unstructuredDataSize": {
"description": "Data size for unstructured data in terms of bytes.",
"format": "int64",
"type": "string"
},
"unstructuredDataUpdateTime": {
"description": "Last updated timestamp for unstructured data.",
"format": "google-datetime",
"type": "string"
},
"websiteDataSize": {
"description": "Data size for websites in terms of bytes.",
"format": "int64",
"type": "string"
},
"websiteDataUpdateTime": {
"description": "Last updated timestamp for websites.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": {
"description": "Stores information regarding the serving configurations at DataStore level.",
"id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore",
"properties": {
"disabledForServing": {
"description": "If set true, the DataStore will not be available for serving search requests.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries": {
"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.",
"id": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries",
"properties": {
"autoRefreshCrawlErrorRate": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"description": "Vertex AI's error rate time series of auto-refresh dedicated crawl."
},
"autoRefreshCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically."
},
"userTriggeredCrawlErrorRate": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"description": "Vertex AI's error rate time series of user triggered dedicated crawl."
},
"userTriggeredCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": {
"description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": {
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": {
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": {
"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata": {
"description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": {
"description": "Metadata for DeleteSchema LRO.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
"description": "Request for DeleteSession method.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
"properties": {
"name": {
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDestinationConfig": {
"description": "Defines target endpoints used to connect to third-party sources.",
"id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig",
"properties": {
"destinations": {
"description": "Optional. The destinations for the corresponding key.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination"
},
"type": "array"
},
"key": {
"description": "Optional. Unique destination identifier that is supported by the connector.",
"type": "string"
},
"params": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Optional. Additional parameters for this destination config.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": {
"description": "Defines a target endpoint",
"id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination",
"properties": {
"host": {
"description": "Publicly routable host.",
"type": "string"
},
"port": {
"description": "Optional. Target port number accepted by the destination.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": {
"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": {
"description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
"properties": {
"chunkingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig",
"description": "Whether chunking mode is enabled."
},
"defaultParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig",
"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing."
},
"name": {
"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.",
"type": "string"
},
"parsingConfigOverrides": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig"
},
"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": {
"description": "Configuration for chunking config.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig",
"properties": {
"layoutBasedChunkingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig",
"description": "Configuration for the layout based chunking."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": {
"description": "Configuration for the layout based chunking.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig",
"properties": {
"chunkSize": {
"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.",
"format": "int32",
"type": "integer"
},
"includeAncestorHeadings": {
"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": {
"description": "Related configurations applied to a specific type of document parser.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig",
"properties": {
"digitalParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig",
"description": "Configurations applied to digital parser."
},
"layoutParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
"description": "Configurations applied to layout parser."
},
"ocrParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig",
"description": "Configurations applied to OCR parser. Currently it only applies to PDFs."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": {
"description": "The digital parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": {
"description": "The layout parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
"properties": {
"enableImageAnnotation": {
"description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
"type": "boolean"
},
"enableTableAnnotation": {
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
"type": "boolean"
},
"excludeHtmlClasses": {
"description": "Optional. List of HTML classes to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
},
"excludeHtmlElements": {
"description": "Optional. List of HTML elements to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
},
"excludeHtmlIds": {
"description": "Optional. List of HTML ids to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": {
"description": "The OCR parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig",
"properties": {
"enhancedDocumentElements": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.",
"items": {
"type": "string"
},
"type": "array"
},
"useNativeText": {
"description": "If true, will use native text instead of OCR text on pages containing native text.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": {
"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngine": {
"description": "Metadata that describes the training and serving parameters of an Engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngine",
"properties": {
"chatEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig",
"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT."
},
"chatEngineMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata",
"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.",
"readOnly": true
},
"commonConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
"description": "Common config spec that specifies the metadata of the engine."
},
"createTime": {
"description": "Output only. Timestamp the Recommendation Engine was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataStoreIds": {
"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
"items": {
"type": "string"
},
"type": "array"
},
"disableAnalytics": {
"description": "Optional. Whether to disable analytics for searches performed on this engine.",
"type": "boolean"
},
"displayName": {
"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
"type": "string"
},
"industryVertical": {
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
"enum": [
"INDUSTRY_VERTICAL_UNSPECIFIED",
"GENERIC",
"MEDIA",
"HEALTHCARE_FHIR"
],
"enumDescriptions": [
"Value used when unset.",
"The generic vertical for documents that are not specific to any industry vertical.",
"The media industry vertical.",
"The healthcare FHIR vertical."
],
"type": "string"
},
"mediaRecommendationEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig",
"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
},
"name": {
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"recommendationMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata",
"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.",
"readOnly": true
},
"searchEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig",
"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH."
},
"similarDocumentsConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig",
"description": "Additional config specs for a `similar-items` engine."
},
"solutionType": {
"description": "Required. The solutions of the engine.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp the Recommendation Engine was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": {
"description": "Configurations for a Chat Engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig",
"properties": {
"agentCreationConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig",
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
},
"allowCrossRegion": {
"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
"type": "boolean"
},
"dialogflowAgentToLink": {
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": {
"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig",
"properties": {
"business": {
"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.",
"type": "string"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.",
"type": "string"
},
"location": {
"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.",
"type": "string"
},
"timeZone": {
"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": {
"description": "Additional information of a Chat Engine. Fields in this message are output only.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata",
"properties": {
"dialogflowAgent": {
"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": {
"description": "Common configurations for an Engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
"properties": {
"companyName": {
"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": {
"description": "Additional config specs for a Media Recommendation engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig",
"properties": {
"engineFeaturesConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
"description": "Optional. Additional engine features config."
},
"optimizationObjective": {
"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`",
"type": "string"
},
"optimizationObjectiveConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)."
},
"trainingState": {
"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.",
"enum": [
"TRAINING_STATE_UNSPECIFIED",
"PAUSED",
"TRAINING"
],
"enumDescriptions": [
"Unspecified training state.",
"The engine training is paused.",
"The engine is training."
],
"type": "string"
},
"type": {
"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": {
"description": "More feature configs of the selected engine type.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
"properties": {
"mostPopularConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
"description": "Most popular engine feature config."
},
"recommendedForYouConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
"description": "Recommended for you engine feature config."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": {
"description": "Feature configurations that are required for creating a Most Popular engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
"properties": {
"timeWindowDays": {
"description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": {
"description": "Custom threshold for `cvr` optimization_objective.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
"properties": {
"targetField": {
"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.",
"type": "string"
},
"targetFieldValueFloat": {
"description": "Required. The threshold to be applied to the target (e.g., 0.5).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": {
"description": "Additional feature configurations for creating a `recommended-for-you` engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
"properties": {
"contextEventType": {
"description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": {
"description": "Additional information of a recommendation engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata",
"properties": {
"dataState": {
"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.",
"enum": [
"DATA_STATE_UNSPECIFIED",
"DATA_OK",
"DATA_ERROR"
],
"enumDescriptions": [
"Unspecified default value, should never be explicitly set.",
"The engine has sufficient training data.",
"The engine does not have sufficient training data. Error messages can be queried via Stackdriver."
],
"readOnly": true,
"type": "string"
},
"lastTuneTime": {
"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"servingState": {
"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.",
"enum": [
"SERVING_STATE_UNSPECIFIED",
"INACTIVE",
"ACTIVE",
"TUNED"
],
"enumDescriptions": [
"Unspecified serving state.",
"The engine is not serving.",
"The engine is serving and can be queried.",
"The engine is trained on tuned hyperparameters and can be queried."
],
"readOnly": true,
"type": "string"
},
"tuningOperation": {
"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": {
"description": "Configurations for a Search Engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig",
"properties": {
"searchAddOns": {
"description": "The add-on that this search engine enables.",
"items": {
"enum": [
"SEARCH_ADD_ON_UNSPECIFIED",
"SEARCH_ADD_ON_LLM"
],
"enumDescriptions": [
"Default value when the enum is unspecified. This is invalid to use.",
"Large language model add-on."
],
"type": "string"
},
"type": "array"
},
"searchTier": {
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.",
"enum": [
"SEARCH_TIER_UNSPECIFIED",
"SEARCH_TIER_STANDARD",
"SEARCH_TIER_ENTERPRISE"
],
"enumDescriptions": [
"Default value when the enum is unspecified. This is invalid to use.",
"Standard tier.",
"Enterprise tier."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": {
"description": "Additional config specs for a `similar-items` engine.",
"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": {
"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": {
"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse",
"properties": {
"dataSizeBytes": {
"description": "Data size in terms of bytes.",
"format": "int64",
"type": "string"
},
"documentCount": {
"description": "Total number of documents.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEvaluation": {
"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.",
"id": "GoogleCloudDiscoveryengineV1alphaEvaluation",
"properties": {
"createTime": {
"description": "Output only. Timestamp the Evaluation was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. Timestamp the Evaluation was completed at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.",
"readOnly": true
},
"errorSamples": {
"description": "Output only. A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"readOnly": true,
"type": "array"
},
"evaluationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec",
"description": "Required. The specification of the evaluation."
},
"name": {
"description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"qualityMetrics": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics",
"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.",
"readOnly": true
},
"state": {
"description": "Output only. The state of the evaluation.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The evaluation is unspecified.",
"The service is preparing to run the evaluation.",
"The evaluation is in progress.",
"The evaluation completed successfully.",
"The evaluation failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": {
"description": "Describes the specification of the evaluation.",
"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec",
"properties": {
"querySetSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
"description": "Required. The specification of the query set."
},
"searchRequest": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": {
"description": "Describes the specification of the query set.",
"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
"properties": {
"sampleQuerySet": {
"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaFieldConfig": {
"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
"properties": {
"advancedSiteSearchDataSources": {
"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.",
"items": {
"enum": [
"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED",
"METATAGS",
"PAGEMAP",
"URI_PATTERN_MAPPING",
"SCHEMA_ORG"
],
"enumDescriptions": [
"Value used when unset.",
"Retrieve value from meta tag.",
"Retrieve value from page map.",
"Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API.",
"Retrieve value from schema.org data."
],
"type": "string"
},
"type": "array"
},
"completableOption": {
"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.",
"enum": [
"COMPLETABLE_OPTION_UNSPECIFIED",
"COMPLETABLE_ENABLED",
"COMPLETABLE_DISABLED"
],
"enumDescriptions": [
"Value used when unset.",
"Completable option enabled for a schema field.",
"Completable option disabled for a schema field."
],
"type": "string"
},
"dynamicFacetableOption": {
"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.",
"enum": [
"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED",
"DYNAMIC_FACETABLE_ENABLED",
"DYNAMIC_FACETABLE_DISABLED"
],
"enumDescriptions": [
"Value used when unset.",
"Dynamic facetable option enabled for a schema field.",
"Dynamic facetable option disabled for a schema field."
],
"type": "string"
},
"fieldPath": {
"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.",
"type": "string"
},
"fieldType": {
"description": "Output only. Raw type of the field.",
"enum": [
"FIELD_TYPE_UNSPECIFIED",
"OBJECT",
"STRING",
"NUMBER",
"INTEGER",
"BOOLEAN",
"GEOLOCATION",
"DATETIME"
],
"enumDescriptions": [
"Field type is unspecified.",
"Field value type is Object.",
"Field value type is String.",
"Field value type is Number.",
"Field value type is Integer.",
"Field value type is Boolean.",
"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.",
"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`"
],
"readOnly": true,
"type": "string"
},
"indexableOption": {
"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.",
"enum": [
"INDEXABLE_OPTION_UNSPECIFIED",
"INDEXABLE_ENABLED",
"INDEXABLE_DISABLED"
],
"enumDescriptions": [
"Value used when unset.",
"Indexable option enabled for a schema field.",
"Indexable option disabled for a schema field."
],
"type": "string"
},
"keyPropertyType": {
"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.",
"readOnly": true,
"type": "string"
},
"metatagName": {
"description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.",
"type": "string"
},
"recsFilterableOption": {
"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.",
"enum": [
"FILTERABLE_OPTION_UNSPECIFIED",
"FILTERABLE_ENABLED",
"FILTERABLE_DISABLED"
],
"enumDescriptions": [
"Value used when unset.",
"Filterable option enabled for a schema field.",
"Filterable option disabled for a schema field."
],
"type": "string"
},
"retrievableOption": {
"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.",
"enum": [
"RETRIEVABLE_OPTION_UNSPECIFIED",
"RETRIEVABLE_ENABLED",
"RETRIEVABLE_DISABLED"
],
"enumDescriptions": [
"Value used when unset.",
"Retrievable option enabled for a schema field.",
"Retrievable option disabled for a schema field."
],
"type": "string"
},
"schemaOrgPaths": {
"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished",
"items": {
"type": "string"
},
"type": "array"
},
"searchableOption": {
"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.",
"enum": [
"SEARCHABLE_OPTION_UNSPECIFIED",
"SEARCHABLE_ENABLED",
"SEARCHABLE_DISABLED"
],
"enumDescriptions": [
"Value used when unset.",
"Searchable option enabled for a schema field.",
"Searchable option disabled for a schema field."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
"description": "Request for GetSession method.",
"id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
"properties": {
"includeAnswerDetails": {
"description": "Optional. If set to true, the full session including all answer details will be returned.",
"type": "boolean"
},
"name": {
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
"properties": {
"documentDataMap": {
"additionalProperties": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"type": "object"
},
"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": {
"description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
"id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
"properties": {
"enableConfigurableSchema": {
"description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.",
"type": "boolean"
},
"enableStaticIndexingForBatchIngestion": {
"description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": {
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata",
"properties": {
"failureCount": {
"description": "The number of IdentityMappingEntries that failed to be processed.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "The number of IdentityMappingEntries that were successfully processed.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "The total number of IdentityMappingEntries that were processed.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": {
"description": "The configuration for the identity data synchronization runs.",
"id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
"properties": {
"nextSyncTime": {
"$ref": "GoogleTypeDateTime",
"description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day."
},
"refreshInterval": {
"description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaIdpConfig": {
"description": "Identity Provider Config.",
"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
"properties": {
"externalIdpConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig",
"description": "External Identity provider config."
},
"idpType": {
"description": "Identity provider type configured.",
"enum": [
"IDP_TYPE_UNSPECIFIED",
"GSUITE",
"THIRD_PARTY"
],
"enumDescriptions": [
"Default value. ACL search not enabled.",
"Google 1P provider.",
"Third party provider."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": {
"description": "Third party IDP Config.",
"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig",
"properties": {
"workforcePoolName": {
"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": {
"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of CompletionSuggestions that failed to be imported.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of CompletionSuggestions successfully imported.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": {
"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": {
"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were processed successfully.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "Total count of entries that were processed.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": {
"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
"description": "Echoes the destination for the complete errors in the request if set."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": {
"description": "Configuration of destination for Import related errors.",
"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
"properties": {
"gcsPrefix": {
"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": {
"description": "Response message for IdentityMappingStoreService.ImportIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": {
"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata",
"properties": {
"createTime": {
"description": "ImportSampleQueries operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of SampleQuerys that failed to be imported.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of SampleQuerys successfully imported.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "Total count of SampleQuerys that were processed.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": {
"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": {
"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": {
"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"failedEntriesCount": {
"description": "Count of deny list entries that failed to be imported.",
"format": "int64",
"type": "string"
},
"importedEntriesCount": {
"description": "Count of deny list entries successfully imported.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": {
"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were processed successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": {
"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
"description": "Echoes the destination for the complete errors if this field was set in the request."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"joinedEventsCount": {
"description": "Count of user events imported with complete existing Documents.",
"format": "int64",
"type": "string"
},
"unjoinedEventsCount": {
"description": "Count of user events imported, but with Document information not found in the existing Branch.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaInterval": {
"description": "A floating point interval.",
"id": "GoogleCloudDiscoveryengineV1alphaInterval",
"properties": {
"exclusiveMaximum": {
"description": "Exclusive upper bound.",
"format": "double",
"type": "number"
},
"exclusiveMinimum": {
"description": "Exclusive lower bound.",
"format": "double",
"type": "number"
},
"maximum": {
"description": "Inclusive upper bound.",
"format": "double",
"type": "number"
},
"minimum": {
"description": "Inclusive lower bound.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaLanguageInfo": {
"description": "Language info for DataStore.",
"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo",
"properties": {
"language": {
"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.",
"readOnly": true,
"type": "string"
},
"languageCode": {
"description": "The language code for the DataStore.",
"type": "string"
},
"normalizedLanguageCode": {
"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.",
"readOnly": true,
"type": "string"
},
"region": {
"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
"description": "Request for ListSessions method.",
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
"properties": {
"filter": {
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
"type": "string"
},
"orderBy": {
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
"type": "string"
},
"parent": {
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
"description": "Response for ListSessions method.",
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
"properties": {
"nextPageToken": {
"description": "Pagination token, if not returned indicates the last page.",
"type": "string"
},
"sessions": {
"description": "All the Sessions for a given data store.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": {
"description": "Configuration for Natural Language Query Understanding.",
"id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig",
"properties": {
"mode": {
"description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.",
"enum": [
"MODE_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Default value.",
"Natural Language Query Understanding is disabled.",
"Natural Language Query Understanding is enabled."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse": {
"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.",
"id": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse",
"properties": {
"dedicatedCrawlRateTimeSeries": {
"$ref": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries",
"description": "The historical dedicated crawl rate timeseries data, used for monitoring."
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Errors from service when handling the request."
},
"organicCrawlRateTimeSeries": {
"$ref": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries",
"description": "The historical organic crawl rate timeseries data, used for monitoring."
},
"state": {
"description": "Output only. The state of the response.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state is unspecified.",
"The state is successful.",
"The state is failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries": {
"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.",
"id": "GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries",
"properties": {
"googleOrganicCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots."
},
"vertexAiOrganicCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaProject": {
"description": "Metadata and configurations for a Google Cloud project in the service.",
"id": "GoogleCloudDiscoveryengineV1alphaProject",
"properties": {
"createTime": {
"description": "Output only. The timestamp when this project is created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
"readOnly": true,
"type": "string"
},
"provisionCompletionTime": {
"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"serviceTermsMap": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms"
},
"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": {
"description": "Metadata about the terms of service.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms",
"properties": {
"acceptTime": {
"description": "The last time when the project agreed to the terms of service.",
"format": "google-datetime",
"type": "string"
},
"declineTime": {
"description": "The last time when the project declined or revoked the agreement to terms of service.",
"format": "google-datetime",
"type": "string"
},
"id": {
"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
"type": "string"
},
"state": {
"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
"enum": [
"STATE_UNSPECIFIED",
"TERMS_ACCEPTED",
"TERMS_PENDING",
"TERMS_DECLINED"
],
"enumDescriptions": [
"The default value of the enum. This value is not actually used.",
"The project has given consent to the terms of service.",
"The project is pending to review and accept the terms of service.",
"The project has declined or revoked the agreement to terms of service."
],
"type": "string"
},
"version": {
"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": {
"description": "Metadata associated with a project provision operation.",
"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": {
"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": {
"description": "Response message for CompletionService.PurgeCompletionSuggestions method.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"purgeSucceeded": {
"description": "Whether the completion suggestions were successfully purged.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": {
"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"ignoredCount": {
"description": "Count of entries that were ignored as entries were not found.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were deleted successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": {
"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse",
"properties": {
"purgeCount": {
"description": "The total count of documents purged as a result of the operation.",
"format": "int64",
"type": "string"
},
"purgeSample": {
"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": {
"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": {
"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"purgeCount": {
"description": "Number of suggestion deny list entries purged.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": {
"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were deleted successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": {
"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse",
"properties": {
"purgeCount": {
"description": "The total count of events purged as a result of the operation.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaQualityMetrics": {
"description": "Describes the metrics produced by the evaluation.",
"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics",
"properties": {
"docNdcg": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
},
"docPrecision": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8"
},
"docRecall": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6"
},
"pageNdcg": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
},
"pageRecall": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": {
"description": "Stores the metric values at specific top-k levels.",
"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
"properties": {
"top1": {
"description": "The top-1 value.",
"format": "double",
"type": "number"
},
"top10": {
"description": "The top-10 value.",
"format": "double",
"type": "number"
},
"top3": {
"description": "The top-3 value.",
"format": "double",
"type": "number"
},
"top5": {
"description": "The top-5 value.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaQuery": {
"description": "Defines a user inputed query.",
"id": "GoogleCloudDiscoveryengineV1alphaQuery",
"properties": {
"queryId": {
"description": "Unique Id for the query.",
"type": "string"
},
"text": {
"description": "Plain text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"invalidUris": {
"description": "Unique URIs in the request that have invalid format. Sample limited to 1000.",
"items": {
"type": "string"
},
"type": "array"
},
"invalidUrisCount": {
"description": "Total number of unique URIs in the request that have invalid format.",
"format": "int32",
"type": "integer"
},
"noindexUris": {
"description": "URIs that have no index meta tag. Sample limited to 1000.",
"items": {
"type": "string"
},
"type": "array"
},
"noindexUrisCount": {
"description": "Total number of URIs that have no index meta tag.",
"format": "int32",
"type": "integer"
},
"pendingCount": {
"description": "Total number of URIs that have yet to be crawled.",
"format": "int32",
"type": "integer"
},
"quotaExceededCount": {
"description": "Total number of URIs that were rejected due to insufficient indexing resources.",
"format": "int32",
"type": "integer"
},
"successCount": {
"description": "Total number of URIs that have been crawled so far.",
"format": "int32",
"type": "integer"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
},
"urisNotMatchingTargetSites": {
"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000.",
"items": {
"type": "string"
},
"type": "array"
},
"urisNotMatchingTargetSitesCount": {
"description": "Total number of URIs that don't match any TargetSites.",
"format": "int32",
"type": "integer"
},
"validUrisCount": {
"description": "Total number of unique URIs in the request that are not in invalid_uris.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": {
"description": "Response message for SiteSearchEngineService.RecrawlUris method.",
"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse",
"properties": {
"failedUris": {
"description": "URIs that were not crawled before the LRO terminated.",
"items": {
"type": "string"
},
"type": "array"
},
"failureSamples": {
"description": "Details for a sample of up to 10 `failed_uris`.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": {
"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.",
"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo",
"properties": {
"failureReasons": {
"description": "List of failure reasons by corpus type (e.g. desktop, mobile).",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason"
},
"type": "array"
},
"uri": {
"description": "URI that failed to be crawled.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": {
"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.",
"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason",
"properties": {
"corpusType": {
"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.",
"enum": [
"CORPUS_TYPE_UNSPECIFIED",
"DESKTOP",
"MOBILE"
],
"enumDescriptions": [
"Default value.",
"Denotes a crawling attempt for the desktop version of a page.",
"Denotes a crawling attempt for the mobile version of a page."
],
"type": "string"
},
"errorMessage": {
"description": "Reason why the URI was not crawled.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata": {
"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse": {
"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
"id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse",
"properties": {
"error": {
"$ref": "GoogleRpcStatus",
"description": "Errors from service when handling the request."
},
"state": {
"description": "Output only. The state of the response.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state is unspecified.",
"The state is successful.",
"The state is failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSafetyRating": {
"description": "Safety rating corresponding to the generated content.",
"id": "GoogleCloudDiscoveryengineV1alphaSafetyRating",
"properties": {
"blocked": {
"description": "Output only. Indicates whether the content was filtered out because of this rating.",
"readOnly": true,
"type": "boolean"
},
"category": {
"description": "Output only. Harm category.",
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_CIVIC_INTEGRITY"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
"The harm category is sexually explicit content.",
"The harm category is civic integrity."
],
"readOnly": true,
"type": "string"
},
"probability": {
"description": "Output only. Harm probability levels in the content.",
"enum": [
"HARM_PROBABILITY_UNSPECIFIED",
"NEGLIGIBLE",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Harm probability unspecified.",
"Negligible level of harm.",
"Low level of harm.",
"Medium level of harm.",
"High level of harm."
],
"readOnly": true,
"type": "string"
},
"probabilityScore": {
"description": "Output only. Harm probability score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"severity": {
"description": "Output only. Harm severity levels in the content.",
"enum": [
"HARM_SEVERITY_UNSPECIFIED",
"HARM_SEVERITY_NEGLIGIBLE",
"HARM_SEVERITY_LOW",
"HARM_SEVERITY_MEDIUM",
"HARM_SEVERITY_HIGH"
],
"enumDescriptions": [
"Harm severity unspecified.",
"Negligible level of harm severity.",
"Low level of harm severity.",
"Medium level of harm severity.",
"High level of harm severity."
],
"readOnly": true,
"type": "string"
},
"severityScore": {
"description": "Output only. Harm severity score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSchema": {
"description": "Defines the structure and layout of a type of document data.",
"id": "GoogleCloudDiscoveryengineV1alphaSchema",
"properties": {
"fieldConfigs": {
"description": "Output only. Configurations for fields of the schema.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig"
},
"readOnly": true,
"type": "array"
},
"jsonSchema": {
"description": "The JSON representation of the schema.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"structSchema": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured representation of the schema.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
"description": "Promotion proto includes uri and other helping information to display the promotion.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
"properties": {
"description": {
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
"type": "string"
},
"document": {
"description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.",
"type": "string"
},
"enabled": {
"description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
"type": "boolean"
},
"imageUri": {
"description": "Optional. The promotion thumbnail image url.",
"type": "string"
},
"title": {
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
"type": "string"
},
"uri": {
"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequest": {
"description": "Request message for SearchService.Search method.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
},
"branch": {
"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.",
"type": "string"
},
"canonicalFilter": {
"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.",
"type": "string"
},
"contentSearchSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec",
"description": "A specification for configuring the behavior of content search."
},
"customFineTuningSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
},
"dataStoreSpecs": {
"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
},
"type": "array"
},
"displaySpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
"description": "Optional. Config for display feature, like match highlighting on search results."
},
"embeddingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
},
"facetSpecs": {
"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec"
},
"type": "array"
},
"filter": {
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
},
"imageQuery": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery",
"description": "Raw image query."
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.",
"type": "string"
},
"naturalLanguageQueryUnderstandingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
"offset": {
"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.",
"format": "int32",
"type": "integer"
},
"oneBoxPageSize": {
"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.",
"format": "int32",
"type": "integer"
},
"orderBy": {
"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
"type": "string"
},
"pageSize": {
"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
},
"params": {
"additionalProperties": {
"type": "any"
},
"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`",
"type": "object"
},
"personalizationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
"description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
},
"query": {
"description": "Raw search query.",
"type": "string"
},
"queryExpansionSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec",
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
},
"rankingExpression": {
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
"type": "string"
},
"rankingExpressionBackend": {
"description": "Optional. The backend to use for the ranking expression evaluation.",
"enum": [
"RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
"BYOE",
"CLEARBOX"
],
"enumDescriptions": [
"Default option for unspecified/unknown values.",
"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
"The expression is compiled into a Clearbox formula."
],
"type": "string"
},
"regionCode": {
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
"type": "string"
},
"relevanceScoreSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
"description": "Optional. The specification for returning the relevance score."
},
"relevanceThreshold": {
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
"enum": [
"RELEVANCE_THRESHOLD_UNSPECIFIED",
"LOWEST",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Default value. In this case, server behavior defaults to Google defined threshold.",
"Lowest relevance threshold.",
"Low relevance threshold.",
"Medium relevance threshold.",
"High relevance threshold."
],
"type": "string"
},
"safeSearch": {
"description": "Whether to turn on safe search. This is only supported for website search.",
"type": "boolean"
},
"searchAsYouTypeSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
},
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"type": "string"
},
"session": {
"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
"type": "string"
},
"sessionSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec",
"description": "Session specification. Can be used only when `session` is set."
},
"spellCorrectionSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
"description": "The spell correction specification that specifies the mode under which spell correction takes effect."
},
"userInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo",
"description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
},
"userPseudoId": {
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": {
"description": "Boost specification to boost certain documents.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
"properties": {
"conditionBoostSpecs": {
"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": {
"description": "Boost applies to documents which match a condition.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec",
"properties": {
"boost": {
"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.",
"format": "float",
"type": "number"
},
"boostControlSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
"description": "Complex specification for custom ranking based on customer defined attribute value."
},
"condition": {
"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": {
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
"properties": {
"attributeType": {
"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
"enum": [
"ATTRIBUTE_TYPE_UNSPECIFIED",
"NUMERICAL",
"FRESHNESS"
],
"enumDescriptions": [
"Unspecified AttributeType.",
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
],
"type": "string"
},
"controlPoints": {
"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint"
},
"type": "array"
},
"fieldName": {
"description": "The name of the field whose value will be used to determine the boost amount.",
"type": "string"
},
"interpolationType": {
"description": "The interpolation type to be applied to connect the control points listed below.",
"enum": [
"INTERPOLATION_TYPE_UNSPECIFIED",
"LINEAR"
],
"enumDescriptions": [
"Interpolation type is unspecified. In this case, it defaults to Linear.",
"Piecewise linear interpolation will be applied."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": {
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint",
"properties": {
"attributeValue": {
"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
"type": "string"
},
"boostAmount": {
"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": {
"description": "A specification for configuring the behavior of content search.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec",
"properties": {
"chunkSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec",
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
},
"extractiveContentSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec",
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
},
"searchResultMode": {
"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
"enum": [
"SEARCH_RESULT_MODE_UNSPECIFIED",
"DOCUMENTS",
"CHUNKS"
],
"enumDescriptions": [
"Default value.",
"Returns documents in the search result.",
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
],
"type": "string"
},
"snippetSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec",
"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
},
"summarySpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec",
"description": "If `summarySpec` is not specified, summaries are not included in the search response."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": {
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec",
"properties": {
"numNextChunks": {
"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
"format": "int32",
"type": "integer"
},
"numPreviousChunks": {
"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": {
"description": "A specification for configuring the extractive content in a search response.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec",
"properties": {
"maxExtractiveAnswerCount": {
"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.",
"format": "int32",
"type": "integer"
},
"maxExtractiveSegmentCount": {
"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
"format": "int32",
"type": "integer"
},
"numNextSegments": {
"description": "Return at most `num_next_segments` segments after each selected segments.",
"format": "int32",
"type": "integer"
},
"numPreviousSegments": {
"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
"format": "int32",
"type": "integer"
},
"returnExtractiveSegmentScore": {
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": {
"description": "A specification for configuring snippets in a search response.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec",
"properties": {
"maxSnippetCount": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
"format": "int32",
"type": "integer"
},
"referenceOnly": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
"type": "boolean"
},
"returnSnippet": {
"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": {
"description": "A specification for configuring a summary returned in a search response.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec",
"properties": {
"ignoreAdversarialQuery": {
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreJailBreakingQuery": {
"description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreLowRelevantContent": {
"description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.",
"type": "boolean"
},
"ignoreNonSummarySeekingQuery": {
"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.",
"type": "boolean"
},
"includeCitations": {
"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
"type": "boolean"
},
"languageCode": {
"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
"type": "string"
},
"modelPromptSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec",
"description": "If specified, the spec will be used to modify the prompt provided to the LLM."
},
"modelSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec",
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
},
"multimodalSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
"description": "Optional. Multimodal specification."
},
"summaryResultCount": {
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
"format": "int32",
"type": "integer"
},
"useSemanticChunks": {
"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
"description": "Specification of the prompt to use with the model.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec",
"properties": {
"preamble": {
"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": {
"description": "Specification of the model.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec",
"properties": {
"version": {
"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
"properties": {
"imageSource": {
"description": "Optional. Source of image returned in the answer.",
"enum": [
"IMAGE_SOURCE_UNSPECIFIED",
"ALL_AVAILABLE_SOURCES",
"CORPUS_IMAGE_ONLY",
"FIGURE_GENERATION_ONLY"
],
"enumDescriptions": [
"Unspecified image source (multimodal feature is disabled by default).",
"Behavior when service determines the pick from all available sources.",
"Includes image from corpus in the answer.",
"Triggers figure generation in the answer."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
"description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
},
"dataStore": {
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
"type": "string"
},
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": {
"description": "Specifies features for display, like match highlighting.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
"properties": {
"matchHighlightingCondition": {
"description": "The condition under which match highlighting should occur.",
"enum": [
"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
"MATCH_HIGHLIGHTING_DISABLED",
"MATCH_HIGHLIGHTING_ENABLED"
],
"enumDescriptions": [
"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
"Disables match highlighting on all documents.",
"Enables match highlighting on all documents."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": {
"description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
"properties": {
"embeddingVectors": {
"description": "The embedding vector used for retrieval. Limit to 1.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": {
"description": "Embedding vector.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector",
"properties": {
"fieldPath": {
"description": "Embedding field path in schema.",
"type": "string"
},
"vector": {
"description": "Query embedding vector.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": {
"description": "A facet specification to perform faceted search.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec",
"properties": {
"enableDynamicPosition": {
"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.",
"type": "boolean"
},
"excludedFilterKeys": {
"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"items": {
"type": "string"
},
"type": "array"
},
"facetKey": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey",
"description": "Required. The facet key specification."
},
"limit": {
"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": {
"description": "Specifies how a facet is computed.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey",
"properties": {
"caseInsensitive": {
"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.",
"type": "boolean"
},
"contains": {
"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.",
"items": {
"type": "string"
},
"type": "array"
},
"intervals": {
"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaInterval"
},
"type": "array"
},
"key": {
"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.",
"type": "string"
},
"orderBy": {
"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.",
"type": "string"
},
"prefixes": {
"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.",
"items": {
"type": "string"
},
"type": "array"
},
"restrictedValues": {
"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": {
"description": "Specifies the image query input.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery",
"properties": {
"imageBytes": {
"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": {
"description": "Specification to enable natural language understanding capabilities for search requests.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"properties": {
"filterExtractionCondition": {
"description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.",
"enum": [
"CONDITION_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Server behavior defaults to `DISABLED`.",
"Disables NL filter extraction.",
"Enables NL filter extraction."
],
"type": "string"
},
"geoSearchQueryDetectionFieldNames": {
"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": {
"description": "The specification for personalization.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
"properties": {
"mode": {
"description": "The personalization mode of the search request. Defaults to Mode.AUTO.",
"enum": [
"MODE_UNSPECIFIED",
"AUTO",
"DISABLED"
],
"enumDescriptions": [
"Default value. In this case, server behavior defaults to Mode.AUTO.",
"Personalization is enabled if data quality requirements are met.",
"Disable personalization."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": {
"description": "Specification to determine under which conditions query expansion should occur.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec",
"properties": {
"condition": {
"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.",
"enum": [
"CONDITION_UNSPECIFIED",
"DISABLED",
"AUTO"
],
"enumDescriptions": [
"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.",
"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.",
"Automatic query expansion built by the Search API."
],
"type": "string"
},
"pinUnexpandedResults": {
"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
"description": "The specification for returning the document relevance score.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
"properties": {
"returnRelevanceScore": {
"description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
"description": "Specification for search as you type in search requests.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
"properties": {
"condition": {
"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.",
"enum": [
"CONDITION_UNSPECIFIED",
"DISABLED",
"ENABLED",
"AUTO"
],
"enumDescriptions": [
"Server behavior defaults to Condition.DISABLED.",
"Disables Search As You Type.",
"Enables Search As You Type.",
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": {
"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec",
"properties": {
"queryId": {
"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.",
"type": "string"
},
"searchResultPersistenceCount": {
"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": {
"description": "The specification for query spell correction.",
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
"properties": {
"mode": {
"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
"enum": [
"MODE_UNSPECIFIED",
"SUGGESTION_ONLY",
"AUTO"
],
"enumDescriptions": [
"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.",
"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.",
"Automatic spell correction built by the Search API. Search will be based on the corrected query if found."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSession": {
"description": "External session proto definition.",
"id": "GoogleCloudDiscoveryengineV1alphaSession",
"properties": {
"displayName": {
"description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.",
"type": "string"
},
"endTime": {
"description": "Output only. The time the session finished.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"isPinned": {
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
"type": "boolean"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
"type": "string"
},
"startTime": {
"description": "Output only. The time the session started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "The state of the session.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS"
],
"enumDescriptions": [
"State is unspecified.",
"The session is currently open."
],
"type": "string"
},
"turns": {
"description": "Turns.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn"
},
"type": "array"
},
"userPseudoId": {
"description": "A unique identifier for tracking users.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSessionTurn": {
"description": "Represents a turn, including a query from the user and a answer from service.",
"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn",
"properties": {
"answer": {
"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
"type": "string"
},
"detailedAnswer": {
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
"readOnly": true
},
"query": {
"$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
"description": "The user query."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata": {
"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse": {
"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
"id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse",
"properties": {
"error": {
"$ref": "GoogleRpcStatus",
"description": "Errors from service when handling the request."
},
"state": {
"description": "Output only. The state of the response.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state is unspecified.",
"The state is successful.",
"The state is failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": {
"description": "Metadata for DataConnectorService.SetUpDataConnector method.",
"id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": {
"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.",
"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSingleRegionKey": {
"description": "Metadata for single-regional CMEKs.",
"id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey",
"properties": {
"kmsKey": {
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": {
"description": "Verification information for target sites in advanced site search.",
"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo",
"properties": {
"siteVerificationState": {
"description": "Site verification state indicating the ownership and validity.",
"enum": [
"SITE_VERIFICATION_STATE_UNSPECIFIED",
"VERIFIED",
"UNVERIFIED",
"EXEMPTED"
],
"enumDescriptions": [
"Defaults to VERIFIED.",
"Site ownership verified.",
"Site ownership pending verification or verification failed.",
"Site exempt from verification, e.g., a public website that opens to all."
],
"type": "string"
},
"verifyTime": {
"description": "Latest site verification time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaSitemap": {
"description": "A sitemap for the SiteSearchEngine.",
"id": "GoogleCloudDiscoveryengineV1alphaSitemap",
"properties": {
"createTime": {
"description": "Output only. The sitemap's creation time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTargetSite": {
"description": "A target site for the SiteSearchEngine.",
"id": "GoogleCloudDiscoveryengineV1alphaTargetSite",
"properties": {
"exactMatch": {
"description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
"type": "boolean"
},
"failureReason": {
"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason",
"description": "Output only. Failure reason.",
"readOnly": true
},
"generatedUriPattern": {
"description": "Output only. This is system-generated based on the provided_uri_pattern.",
"readOnly": true,
"type": "string"
},
"indexingStatus": {
"description": "Output only. Indexing status.",
"enum": [
"INDEXING_STATUS_UNSPECIFIED",
"PENDING",
"FAILED",
"SUCCEEDED",
"DELETING",
"CANCELLABLE",
"CANCELLED"
],
"enumDescriptions": [
"Defaults to SUCCEEDED.",
"The target site is in the update queue and will be picked up by indexing pipeline.",
"The target site fails to be indexed.",
"The target site has been indexed.",
"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.",
"The target site change is pending but cancellable.",
"The target site change is cancelled."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.",
"readOnly": true,
"type": "string"
},
"providedUriPattern": {
"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.",
"type": "string"
},
"rootDomainUri": {
"description": "Output only. Root domain of the provided_uri_pattern.",
"readOnly": true,
"type": "string"
},
"siteVerificationInfo": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo",
"description": "Output only. Site ownership and validity verification status.",
"readOnly": true
},
"type": {
"description": "The type of the target site, e.g., whether the site is to be included or excluded.",
"enum": [
"TYPE_UNSPECIFIED",
"INCLUDE",
"EXCLUDE"
],
"enumDescriptions": [
"This value is unused. In this case, server behavior defaults to Type.INCLUDE.",
"Include the target site.",
"Exclude the target site."
],
"type": "string"
},
"updateTime": {
"description": "Output only. The target site's last updated time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": {
"description": "Site search indexing failure reasons.",
"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason",
"properties": {
"quotaFailure": {
"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure",
"description": "Failed due to insufficient quota."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": {
"description": "Failed due to insufficient quota.",
"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure",
"properties": {
"totalRequiredQuota": {
"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": {
"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": {
"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
"description": "Echoes the destination for the complete errors in the request if set."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the data.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"metrics": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"description": "The metrics of the trained model.",
"type": "object"
},
"modelName": {
"description": "Fully qualified name of the CustomTuningModel.",
"type": "string"
},
"modelStatus": {
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": {
"description": "Metadata associated with a tune operation.",
"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata",
"properties": {
"engine": {
"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": {
"description": "Response associated with a tune operation.",
"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata": {
"description": "Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": {
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": {
"description": "Metadata for UpdateSchema LRO.",
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
"description": "Request for UpdateSession method.",
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
"properties": {
"session": {
"$ref": "GoogleCloudDiscoveryengineV1alphaSession",
"description": "Required. The Session to update."
},
"updateMask": {
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaUserInfo": {
"description": "Information of an end user.",
"id": "GoogleCloudDiscoveryengineV1alphaUserInfo",
"properties": {
"timeZone": {
"description": "Optional. IANA time zone, e.g. Europe/Budapest.",
"type": "string"
},
"userAgent": {
"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
"type": "string"
},
"userId": {
"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": {
"description": "Config to store data store type configuration for workspace data",
"id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
"properties": {
"dasherCustomerId": {
"description": "Obfuscated Dasher customer ID.",
"type": "string"
},
"superAdminEmailAddress": {
"description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
"type": "string"
},
"superAdminServiceAccount": {
"description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
"type": "string"
},
"type": {
"description": "The Google Workspace data source.",
"enum": [
"TYPE_UNSPECIFIED",
"GOOGLE_DRIVE",
"GOOGLE_MAIL",
"GOOGLE_SITES",
"GOOGLE_CALENDAR",
"GOOGLE_CHAT",
"GOOGLE_GROUPS",
"GOOGLE_KEEP",
"GOOGLE_PEOPLE"
],
"enumDescriptions": [
"Defaults to an unspecified Workspace type.",
"Workspace Data Store contains Drive data",
"Workspace Data Store contains Mail data",
"Workspace Data Store contains Sites data",
"Workspace Data Store contains Calendar data",
"Workspace Data Store contains Chat data",
"Workspace Data Store contains Groups data",
"Workspace Data Store contains Keep data",
"Workspace Data Store contains People data"
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest": {
"description": "Request message for CompletionService.AdvancedCompleteQuery method. .",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequest",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec",
"description": "Optional. Specification to boost suggestions matching the condition."
},
"experimentIds": {
"description": "Optional. Experiment ids for this request.",
"items": {
"type": "string"
},
"type": "array"
},
"includeTailSuggestions": {
"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
"type": "boolean"
},
"query": {
"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query.",
"type": "string"
},
"queryModel": {
"description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
"type": "string"
},
"suggestionTypeSpecs": {
"description": "Optional. Specification of each suggestion type.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec"
},
"type": "array"
},
"suggestionTypes": {
"description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.",
"items": {
"enum": [
"SUGGESTION_TYPE_UNSPECIFIED",
"QUERY",
"PEOPLE",
"CONTENT",
"RECENT_SEARCH",
"GOOGLE_WORKSPACE"
],
"enumDescriptions": [
"Default value.",
"Returns query suggestions.",
"Returns people suggestions.",
"Returns content suggestions.",
"Returns recent search suggestions.",
"Returns Google Workspace suggestions."
],
"type": "string"
},
"type": "array"
},
"userInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
},
"userPseudoId": {
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec": {
"description": "Specification to boost suggestions based on the condtion of the suggestion.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec",
"properties": {
"conditionBoostSpecs": {
"description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": {
"description": "Boost applies to suggestions which match a condition.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec",
"properties": {
"boost": {
"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.",
"format": "float",
"type": "number"
},
"condition": {
"description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec": {
"description": "Specification of each suggestion type.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec",
"properties": {
"maxSuggestions": {
"description": "Optional. Maximum number of suggestions to return for each suggestion type.",
"format": "int32",
"type": "integer"
},
"suggestionType": {
"description": "Optional. Suggestion type.",
"enum": [
"SUGGESTION_TYPE_UNSPECIFIED",
"QUERY",
"PEOPLE",
"CONTENT",
"RECENT_SEARCH",
"GOOGLE_WORKSPACE"
],
"enumDescriptions": [
"Default value.",
"Returns query suggestions.",
"Returns people suggestions.",
"Returns content suggestions.",
"Returns recent search suggestions.",
"Returns Google Workspace suggestions."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse": {
"description": "Response message for CompletionService.AdvancedCompleteQuery method.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse",
"properties": {
"contentSuggestions": {
"description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion"
},
"type": "array"
},
"peopleSuggestions": {
"description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion"
},
"type": "array"
},
"querySuggestions": {
"description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion"
},
"type": "array"
},
"recentSearchSuggestions": {
"description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion"
},
"type": "array"
},
"tailMatchTriggered": {
"description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion": {
"description": "Suggestions as content.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseContentSuggestion",
"properties": {
"contentType": {
"description": "The type of the content suggestion.",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"GOOGLE_WORKSPACE",
"THIRD_PARTY"
],
"enumDescriptions": [
"Default value.",
"The suggestion is from a Google Workspace source.",
"The suggestion is from a third party source."
],
"type": "string"
},
"dataStore": {
"description": "The name of the dataStore that this suggestion belongs to.",
"type": "string"
},
"destinationUri": {
"description": "The destination uri of the content suggestion.",
"type": "string"
},
"document": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
"description": "The document data snippet in the suggestion. Only a subset of fields will be populated."
},
"iconUri": {
"description": "The icon uri of the content suggestion.",
"type": "string"
},
"score": {
"description": "The score of each suggestion. The score is in the range of [0, 1].",
"format": "double",
"type": "number"
},
"suggestion": {
"description": "The suggestion for the query.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion": {
"description": "Suggestions as people.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponsePersonSuggestion",
"properties": {
"dataStore": {
"description": "The name of the dataStore that this suggestion belongs to.",
"type": "string"
},
"destinationUri": {
"description": "The destination uri of the person suggestion.",
"type": "string"
},
"displayPhotoUri": {
"description": "The photo uri of the person suggestion.",
"type": "string"
},
"document": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
"description": "The document data snippet in the suggestion. Only a subset of fields is populated."
},
"personType": {
"description": "The type of the person.",
"enum": [
"PERSON_TYPE_UNSPECIFIED",
"CLOUD_IDENTITY",
"THIRD_PARTY_IDENTITY"
],
"enumDescriptions": [
"Default value.",
"The suggestion is from a GOOGLE_IDENTITY source.",
"The suggestion is from a THIRD_PARTY_IDENTITY source."
],
"type": "string"
},
"score": {
"description": "The score of each suggestion. The score is in the range of [0, 1].",
"format": "double",
"type": "number"
},
"suggestion": {
"description": "The suggestion for the query.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion": {
"description": "Suggestions as search queries.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseQuerySuggestion",
"properties": {
"completableFieldPaths": {
"description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.",
"items": {
"type": "string"
},
"type": "array"
},
"dataStore": {
"description": "The name of the dataStore that this suggestion belongs to.",
"items": {
"type": "string"
},
"type": "array"
},
"score": {
"description": "The score of each suggestion. The score is in the range of [0, 1].",
"format": "double",
"type": "number"
},
"suggestion": {
"description": "The suggestion for the query.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion": {
"description": "Suggestions from recent search history.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponseRecentSearchSuggestion",
"properties": {
"recentSearchTime": {
"description": "The time when this recent rearch happened.",
"format": "google-datetime",
"type": "string"
},
"score": {
"description": "The score of each suggestion. The score is in the range of [0, 1].",
"format": "double",
"type": "number"
},
"suggestion": {
"description": "The suggestion for the query.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": {
"description": "Configuration data for advance site search.",
"id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig",
"properties": {
"disableAutomaticRefresh": {
"description": "If set true, automatic refresh is disabled for the DataStore.",
"type": "boolean"
},
"disableInitialIndex": {
"description": "If set true, initial indexing is disabled for the DataStore.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAlloyDbSource": {
"description": "AlloyDB source import data from.",
"id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource",
"properties": {
"clusterId": {
"description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.",
"type": "string"
},
"databaseId": {
"description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.",
"type": "string"
},
"gcsStagingDir": {
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
"type": "string"
},
"locationId": {
"description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.",
"type": "string"
},
"projectId": {
"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
"type": "string"
},
"tableId": {
"description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswer": {
"description": "Defines an answer.",
"id": "GoogleCloudDiscoveryengineV1betaAnswer",
"properties": {
"answerSkippedReasons": {
"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.",
"items": {
"enum": [
"ANSWER_SKIPPED_REASON_UNSPECIFIED",
"ADVERSARIAL_QUERY_IGNORED",
"NON_ANSWER_SEEKING_QUERY_IGNORED",
"OUT_OF_DOMAIN_QUERY_IGNORED",
"POTENTIAL_POLICY_VIOLATION",
"NO_RELEVANT_CONTENT",
"JAIL_BREAKING_QUERY_IGNORED",
"CUSTOMER_POLICY_VIOLATION",
"NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
"LOW_GROUNDED_ANSWER"
],
"enumDescriptions": [
"Default value. The answer skipped reason is not specified.",
"The adversarial query ignored case.",
"The non-answer seeking query ignored case Google skips the answer if the query is chit chat.",
"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.",
"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.",
"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.",
"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.",
"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.",
"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated."
],
"type": "string"
},
"type": "array"
},
"answerText": {
"description": "The textual answer.",
"type": "string"
},
"blobAttachments": {
"description": "List of blob attachments in the answer.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment"
},
"type": "array"
},
"citations": {
"description": "Citations.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitation"
},
"type": "array"
},
"completeTime": {
"description": "Output only. Answer completed timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. Answer creation timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"groundingScore": {
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
"format": "double",
"type": "number"
},
"groundingSupports": {
"description": "Optional. Grounding supports.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport"
},
"type": "array"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
"type": "string"
},
"queryUnderstandingInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo",
"description": "Query understanding information."
},
"references": {
"description": "References.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReference"
},
"type": "array"
},
"relatedQuestions": {
"description": "Suggested related questions.",
"items": {
"type": "string"
},
"type": "array"
},
"safetyRatings": {
"description": "Optional. Safety ratings.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSafetyRating"
},
"type": "array"
},
"state": {
"description": "The state of the answer generation.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"FAILED",
"SUCCEEDED",
"STREAMING"
],
"enumDescriptions": [
"Unknown.",
"Answer generation is currently in progress.",
"Answer generation currently failed.",
"Answer generation has succeeded.",
"Answer generation is currently in progress."
],
"type": "string"
},
"steps": {
"description": "Answer generation steps.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStep"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment": {
"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment",
"properties": {
"attributionType": {
"description": "Output only. The attribution type of the blob.",
"enum": [
"ATTRIBUTION_TYPE_UNSPECIFIED",
"CORPUS",
"GENERATED"
],
"enumDescriptions": [
"Unspecified attribution type.",
"The attachment data is from the corpus.",
"The attachment data is generated by the model through code generation."
],
"readOnly": true,
"type": "string"
},
"data": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob",
"description": "Output only. The mime type and data of the blob.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob": {
"description": "The media type and data of the blob.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob",
"properties": {
"data": {
"description": "Output only. Raw bytes.",
"format": "byte",
"readOnly": true,
"type": "string"
},
"mimeType": {
"description": "Output only. The media type (MIME type) of the generated or retrieved data.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerCitation": {
"description": "Citation info for a segment.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerCitation",
"properties": {
"endIndex": {
"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
"format": "int64",
"type": "string"
},
"sources": {
"description": "Citation sources for the attributed segment.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource"
},
"type": "array"
},
"startIndex": {
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerCitationSource": {
"description": "Citation source.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource",
"properties": {
"referenceId": {
"description": "ID of the citation source.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec": {
"description": "The specification for answer generation.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec",
"properties": {
"userDefinedClassifierSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec",
"description": "Optional. The specification for user specified classifier spec."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec": {
"description": "The specification for user defined classifier.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpecUserDefinedClassifierSpec",
"properties": {
"enableUserDefinedClassifier": {
"description": "Optional. Whether or not to enable and include user defined classifier.",
"type": "boolean"
},
"modelId": {
"description": "Optional. The model id to be used for the user defined classifier.",
"type": "string"
},
"preamble": {
"description": "Optional. The preamble to be used for the user defined classifier.",
"type": "string"
},
"seed": {
"description": "Optional. The seed value to be used for the user defined classifier.",
"format": "int32",
"type": "integer"
},
"taskMarker": {
"description": "Optional. The task marker to be used for the user defined classifier.",
"type": "string"
},
"temperature": {
"description": "Optional. The temperature value to be used for the user defined classifier.",
"format": "double",
"type": "number"
},
"topK": {
"description": "Optional. The top-k value to be used for the user defined classifier.",
"format": "int64",
"type": "string"
},
"topP": {
"description": "Optional. The top-p value to be used for the user defined classifier.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport": {
"description": "Grounding support for a claim in `answer_text`.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport",
"properties": {
"endIndex": {
"description": "Required. End of the claim, exclusive.",
"format": "int64",
"type": "string"
},
"groundingCheckRequired": {
"description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.",
"type": "boolean"
},
"groundingScore": {
"description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.",
"format": "double",
"type": "number"
},
"sources": {
"description": "Optional. Citation sources for the claim.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource"
},
"type": "array"
},
"startIndex": {
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequest": {
"description": "Request message for ConversationalSearchService.AnswerQuery method.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest",
"properties": {
"answerGenerationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec",
"description": "Answer generation specification."
},
"asynchronousMode": {
"deprecated": true,
"description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.",
"type": "boolean"
},
"endUserSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec",
"description": "Optional. End user specification."
},
"groundingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec",
"description": "Optional. Grounding specification."
},
"query": {
"$ref": "GoogleCloudDiscoveryengineV1betaQuery",
"description": "Required. Current user query."
},
"queryUnderstandingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec",
"description": "Query understanding specification."
},
"relatedQuestionsSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec",
"description": "Related questions specification."
},
"safetySpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec",
"description": "Model specification."
},
"searchSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec",
"description": "Search specification."
},
"session": {
"description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.",
"type": "string"
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
},
"userPseudoId": {
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec": {
"description": "Answer generation specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec",
"properties": {
"answerLanguageCode": {
"description": "Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
"type": "string"
},
"ignoreAdversarialQuery": {
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreJailBreakingQuery": {
"description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreLowRelevantContent": {
"description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.",
"type": "boolean"
},
"ignoreNonAnswerSeekingQuery": {
"description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.",
"type": "boolean"
},
"includeCitations": {
"description": "Specifies whether to include citation metadata in the answer. The default value is `false`.",
"type": "boolean"
},
"modelSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec",
"description": "Answer generation model specification."
},
"multimodalSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec",
"description": "Optional. Multimodal specification."
},
"promptSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
"description": "Answer generation prompt specification."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec": {
"description": "Answer Generation Model specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec",
"properties": {
"modelVersion": {
"description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec": {
"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec",
"properties": {
"imageSource": {
"description": "Optional. Source of image returned in the answer.",
"enum": [
"IMAGE_SOURCE_UNSPECIFIED",
"ALL_AVAILABLE_SOURCES",
"CORPUS_IMAGE_ONLY",
"FIGURE_GENERATION_ONLY"
],
"enumDescriptions": [
"Unspecified image source (multimodal feature is disabled by default).",
"Behavior when service determines the pick from all available sources.",
"Includes image from corpus in the answer.",
"Triggers figure generation in the answer."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec": {
"description": "Answer generation prompt specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
"properties": {
"preamble": {
"description": "Customized preamble.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec": {
"description": "End user specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec",
"properties": {
"endUserMetadata": {
"description": "Optional. End user metadata.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData": {
"description": "End user metadata.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData",
"properties": {
"chunkInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo",
"description": "Chunk information."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": {
"description": "Chunk information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo",
"properties": {
"content": {
"description": "Chunk textual content. It is limited to 8000 characters.",
"type": "string"
},
"documentMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata",
"description": "Metadata of the document from the current chunk."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": {
"description": "Document metadata contains the information of the document of the current chunk.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata",
"properties": {
"title": {
"description": "Title of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec": {
"description": "Grounding specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec",
"properties": {
"filteringLevel": {
"description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.",
"enum": [
"FILTERING_LEVEL_UNSPECIFIED",
"FILTERING_LEVEL_LOW",
"FILTERING_LEVEL_HIGH"
],
"enumDescriptions": [
"Default is no filter",
"Filter answers based on a low threshold.",
"Filter answers based on a high threshold."
],
"type": "string"
},
"includeGroundingSupports": {
"description": "Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec": {
"description": "Query understanding specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec",
"properties": {
"disableSpellCorrection": {
"description": "Optional. Whether to disable spell correction. The default value is `false`.",
"type": "boolean"
},
"queryClassificationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
"description": "Query classification specification."
},
"queryRephraserSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec",
"description": "Query rephraser specification."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": {
"description": "Query classification specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
"properties": {
"types": {
"description": "Enabled query classification types.",
"items": {
"enum": [
"TYPE_UNSPECIFIED",
"ADVERSARIAL_QUERY",
"NON_ANSWER_SEEKING_QUERY",
"JAIL_BREAKING_QUERY",
"NON_ANSWER_SEEKING_QUERY_V2"
],
"enumDescriptions": [
"Unspecified query classification type.",
"Adversarial query classification type.",
"Non-answer-seeking query classification type, for chit chat.",
"Jail-breaking query classification type.",
"Non-answer-seeking query classification type, for no clear intent."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": {
"description": "Query rephraser specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec",
"properties": {
"disable": {
"description": "Disable query rephraser.",
"type": "boolean"
},
"maxRephraseSteps": {
"description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.",
"format": "int32",
"type": "integer"
},
"modelSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
"description": "Optional. Query Rephraser Model specification."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": {
"description": "Query Rephraser Model specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
"properties": {
"modelType": {
"description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.",
"enum": [
"MODEL_TYPE_UNSPECIFIED",
"SMALL",
"LARGE"
],
"enumDescriptions": [
"Unspecified model type.",
"Small query rephraser model. Gemini 1.0 XS model.",
"Large query rephraser model. Gemini 1.0 Pro model."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec": {
"description": "Related questions specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec",
"properties": {
"enable": {
"description": "Enable related questions feature if true.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec": {
"description": "Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec",
"properties": {
"enable": {
"description": "Enable the safety filtering on the answer response. It is false by default.",
"type": "boolean"
},
"safetySettings": {
"description": "Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting": {
"description": "Safety settings.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting",
"properties": {
"category": {
"description": "Required. Harm category.",
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_CIVIC_INTEGRITY"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
"The harm category is sexually explicit content.",
"The harm category is civic integrity."
],
"type": "string"
},
"threshold": {
"description": "Required. The harm block threshold.",
"enum": [
"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
"BLOCK_LOW_AND_ABOVE",
"BLOCK_MEDIUM_AND_ABOVE",
"BLOCK_ONLY_HIGH",
"BLOCK_NONE",
"OFF"
],
"enumDescriptions": [
"Unspecified harm block threshold.",
"Block low threshold and above (i.e. block more).",
"Block medium threshold and above.",
"Block only high threshold (i.e. block less).",
"Block none.",
"Turn off the safety filter."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec": {
"description": "Search specification.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec",
"properties": {
"searchParams": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams",
"description": "Search parameters."
},
"searchResultList": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList",
"description": "Search result list."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams": {
"description": "Search parameters.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
"description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)"
},
"dataStoreSpecs": {
"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
},
"type": "array"
},
"filter": {
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
},
"maxReturnResults": {
"description": "Number of search results to return. The default value is 10.",
"format": "int32",
"type": "integer"
},
"naturalLanguageQueryUnderstandingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Specification to enable natural language understanding capabilities for search requests."
},
"orderBy": {
"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
"type": "string"
},
"searchResultMode": {
"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)",
"enum": [
"SEARCH_RESULT_MODE_UNSPECIFIED",
"DOCUMENTS",
"CHUNKS"
],
"enumDescriptions": [
"Default value.",
"Returns documents in the search result.",
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList": {
"description": "Search result list.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList",
"properties": {
"searchResults": {
"description": "Search results.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult": {
"description": "Search result.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult",
"properties": {
"chunkInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo",
"description": "Chunk information."
},
"unstructuredDocumentInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo",
"description": "Unstructured document information."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": {
"description": "Chunk information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo",
"properties": {
"chunk": {
"description": "Chunk resource name.",
"type": "string"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"documentMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata",
"description": "Metadata of the document from the current chunk."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": {
"description": "Document metadata contains the information of the document of the current chunk.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata",
"properties": {
"title": {
"description": "Title of the document.",
"type": "string"
},
"uri": {
"description": "Uri of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": {
"description": "Unstructured document information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo",
"properties": {
"document": {
"description": "Document resource name.",
"type": "string"
},
"documentContexts": {
"description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext"
},
"type": "array"
},
"extractiveAnswers": {
"deprecated": true,
"description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer"
},
"type": "array"
},
"extractiveSegments": {
"description": "List of extractive segments.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment"
},
"type": "array"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": {
"description": "Document context.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext",
"properties": {
"content": {
"description": "Document content to be used for answer generation.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": {
"description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer",
"properties": {
"content": {
"description": "Extractive answer content.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": {
"description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment",
"properties": {
"content": {
"description": "Extractive segment content.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryResponse": {
"description": "Response message for ConversationalSearchService.AnswerQuery method.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse",
"properties": {
"answer": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswer",
"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API."
},
"answerQueryToken": {
"description": "A global unique ID used for logging.",
"type": "string"
},
"session": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession",
"description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo": {
"description": "Query understanding information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo",
"properties": {
"queryClassificationInfo": {
"description": "Query classification information.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo": {
"description": "Query classification information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo",
"properties": {
"positive": {
"description": "Classification output.",
"type": "boolean"
},
"type": {
"description": "Query classification type.",
"enum": [
"TYPE_UNSPECIFIED",
"ADVERSARIAL_QUERY",
"NON_ANSWER_SEEKING_QUERY",
"JAIL_BREAKING_QUERY",
"NON_ANSWER_SEEKING_QUERY_V2"
],
"enumDescriptions": [
"Unspecified query classification type.",
"Adversarial query classification type.",
"Non-answer-seeking query classification type, for chit chat.",
"Jail-breaking query classification type.",
"Non-answer-seeking query classification type, for no clear intent."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerReference": {
"description": "Reference.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerReference",
"properties": {
"chunkInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo",
"description": "Chunk information."
},
"structuredDocumentInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo",
"description": "Structured document information."
},
"unstructuredDocumentInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo",
"description": "Unstructured document information."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo": {
"description": "Chunk information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo",
"properties": {
"blobAttachmentIndexes": {
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"chunk": {
"description": "Chunk resource name.",
"type": "string"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"documentMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata",
"description": "Document metadata."
},
"relevanceScore": {
"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata": {
"description": "Document metadata.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata",
"properties": {
"document": {
"description": "Document resource name.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
"type": "object"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo": {
"description": "Structured search information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo",
"properties": {
"document": {
"description": "Document resource name.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Structured search data.",
"type": "object"
},
"title": {
"description": "Output only. The title of the document.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Output only. The URI of the document.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo": {
"description": "Unstructured document information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo",
"properties": {
"chunkContents": {
"description": "List of cited chunk contents derived from document content.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent"
},
"type": "array"
},
"document": {
"description": "Document resource name.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
"type": "object"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent": {
"description": "Chunk content.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent",
"properties": {
"blobAttachmentIndexes": {
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
},
"relevanceScore": {
"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStep": {
"description": "Step information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerStep",
"properties": {
"actions": {
"description": "Actions.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepAction"
},
"type": "array"
},
"description": {
"description": "The description of the step.",
"type": "string"
},
"state": {
"description": "The state of the step.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"FAILED",
"SUCCEEDED"
],
"enumDescriptions": [
"Unknown.",
"Step is currently in progress.",
"Step currently failed.",
"Step has succeeded."
],
"type": "string"
},
"thought": {
"description": "The thought of the step.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStepAction": {
"description": "Action.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerStepAction",
"properties": {
"observation": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation",
"description": "Observation."
},
"searchAction": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction",
"description": "Search action."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation": {
"description": "Observation.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation",
"properties": {
"searchResults": {
"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult": {
"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult",
"properties": {
"chunkInfo": {
"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo"
},
"type": "array"
},
"document": {
"description": "Document resource name.",
"type": "string"
},
"snippetInfo": {
"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo"
},
"type": "array"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.",
"type": "object"
},
"title": {
"description": "Title.",
"type": "string"
},
"uri": {
"description": "URI for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo": {
"description": "Chunk information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo",
"properties": {
"chunk": {
"description": "Chunk resource name.",
"type": "string"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"relevanceScore": {
"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo": {
"description": "Snippet information.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo",
"properties": {
"snippet": {
"description": "Snippet content.",
"type": "string"
},
"snippetStatus": {
"description": "Status of the snippet defined by the search team.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction": {
"description": "Search action.",
"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction",
"properties": {
"query": {
"description": "The query to search.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest": {
"description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.",
"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest",
"properties": {
"requests": {
"description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": {
"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.",
"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse",
"properties": {
"targetSites": {
"description": "TargetSites created.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse": {
"description": "Response message for DocumentService.BatchGetDocumentsMetadata method.",
"id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse",
"properties": {
"documentsMetadata": {
"description": "The metadata of the Documents.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata": {
"description": "The metadata of a Document.",
"id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata",
"properties": {
"dataIngestionSource": {
"description": "The data ingestion source of the Document. Allowed values are: * `batch`: Data ingested via Batch API, e.g., ImportDocuments. * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.",
"type": "string"
},
"lastRefreshedTime": {
"description": "The timestamp of the last time the Document was last indexed.",
"format": "google-datetime",
"type": "string"
},
"matcherValue": {
"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue",
"description": "The value of the matcher that was used to match the Document."
},
"state": {
"description": "The state of the document.",
"enum": [
"STATE_UNSPECIFIED",
"INDEXED",
"NOT_IN_TARGET_SITE",
"NOT_IN_INDEX"
],
"enumDescriptions": [
"Should never be set.",
"The Document is indexed.",
"The Document is not indexed because its URI is not in the TargetSite.",
"The Document is not indexed."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": {
"description": "The value of the matcher that was used to match the Document.",
"id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue",
"properties": {
"fhirResource": {
"description": "Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}",
"type": "string"
},
"uri": {
"description": "If match by URI, the URI of the Document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest": {
"description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
"id": "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBigQuerySource": {
"description": "BigQuery source import data from.",
"id": "GoogleCloudDiscoveryengineV1betaBigQuerySource",
"properties": {
"dataSchema": {
"description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.",
"type": "string"
},
"datasetId": {
"description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.",
"type": "string"
},
"gcsStagingDir": {
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.",
"type": "string"
},
"partitionDate": {
"$ref": "GoogleTypeDate",
"description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format."
},
"projectId": {
"description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
"type": "string"
},
"tableId": {
"description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBigtableOptions": {
"description": "The Bigtable Options object that contains information to support the import.",
"id": "GoogleCloudDiscoveryengineV1betaBigtableOptions",
"properties": {
"families": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily"
},
"description": "The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.",
"type": "object"
},
"keyFieldName": {
"description": "The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn": {
"description": "The column of the Bigtable.",
"id": "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn",
"properties": {
"encoding": {
"description": "The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.",
"enum": [
"ENCODING_UNSPECIFIED",
"TEXT",
"BINARY"
],
"enumDescriptions": [
"The encoding is unspecified.",
"Text encoding.",
"Binary encoding."
],
"type": "string"
},
"fieldName": {
"description": "The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.",
"type": "string"
},
"qualifier": {
"description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.",
"format": "byte",
"type": "string"
},
"type": {
"description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.",
"enum": [
"TYPE_UNSPECIFIED",
"STRING",
"NUMBER",
"INTEGER",
"VAR_INTEGER",
"BIG_NUMERIC",
"BOOLEAN",
"JSON"
],
"enumDescriptions": [
"The type is unspecified.",
"String type.",
"Numerical type.",
"Integer type.",
"Variable length integer type.",
"BigDecimal type.",
"Boolean type.",
"JSON type."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily": {
"description": "The column family of the Bigtable.",
"id": "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily",
"properties": {
"columns": {
"description": "The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn"
},
"type": "array"
},
"encoding": {
"description": "The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.",
"enum": [
"ENCODING_UNSPECIFIED",
"TEXT",
"BINARY"
],
"enumDescriptions": [
"The encoding is unspecified.",
"Text encoding.",
"Binary encoding."
],
"type": "string"
},
"fieldName": {
"description": "The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.",
"type": "string"
},
"type": {
"description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.",
"enum": [
"TYPE_UNSPECIFIED",
"STRING",
"NUMBER",
"INTEGER",
"VAR_INTEGER",
"BIG_NUMERIC",
"BOOLEAN",
"JSON"
],
"enumDescriptions": [
"The type is unspecified.",
"String type.",
"Numerical type.",
"Integer type.",
"Variable length integer type.",
"BigDecimal type.",
"Boolean type.",
"JSON type."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaBigtableSource": {
"description": "The Cloud Bigtable source for importing data.",
"id": "GoogleCloudDiscoveryengineV1betaBigtableSource",
"properties": {
"bigtableOptions": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigtableOptions",
"description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations."
},
"instanceId": {
"description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.",
"type": "string"
},
"projectId": {
"description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
"type": "string"
},
"tableId": {
"description": "Required. The table ID of the Cloud Bigtable that needs to be imported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCheckGroundingRequest": {
"description": "Request message for GroundedGenerationService.CheckGrounding method.",
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingRequest",
"properties": {
"answerCandidate": {
"description": "Answer candidate to check. It can have a maximum length of 4096 tokens.",
"type": "string"
},
"facts": {
"description": "List of facts for the grounding check. We support up to 200 facts.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaGroundingFact"
},
"type": "array"
},
"groundingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec",
"description": "Configuration of the grounding check."
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCheckGroundingResponse": {
"description": "Response message for the GroundedGenerationService.CheckGrounding method.",
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponse",
"properties": {
"citedChunks": {
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaFactChunk"
},
"type": "array"
},
"citedFacts": {
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk"
},
"type": "array"
},
"claims": {
"description": "Claim texts and citation info across all claims in the answer candidate.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim"
},
"type": "array"
},
"supportScore": {
"description": "The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk": {
"description": "Fact chunk for grounding check.",
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk",
"properties": {
"chunkText": {
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim": {
"description": "Text and citation info for a claim in the answer candidate.",
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim",
"properties": {
"citationIndices": {
"description": "A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"claimText": {
"description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.",
"type": "string"
},
"endPos": {
"description": "Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).",
"format": "int32",
"type": "integer"
},
"groundingCheckRequired": {
"description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.",
"type": "boolean"
},
"score": {
"description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.",
"format": "double",
"type": "number"
},
"startPos": {
"description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCheckGroundingSpec": {
"description": "Specification for the grounding check.",
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec",
"properties": {
"citationThreshold": {
"description": "The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.",
"format": "double",
"type": "number"
},
"enableClaimLevelScore": {
"description": "The control flag that enables claim-level grounding score in the response.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaChunk": {
"description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.",
"id": "GoogleCloudDiscoveryengineV1betaChunk",
"properties": {
"annotationContents": {
"description": "Output only. Annotation contents if the current chunk contains annotations.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"chunkMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata",
"description": "Output only. Metadata of the current chunk.",
"readOnly": true
},
"content": {
"description": "Content is a string from a document (parsed content).",
"type": "string"
},
"dataUrls": {
"description": "Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"derivedStructData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.",
"readOnly": true,
"type": "object"
},
"documentMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata",
"description": "Metadata of the document from the current chunk."
},
"id": {
"description": "Unique chunk ID of the current chunk.",
"type": "string"
},
"name": {
"description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"pageSpan": {
"$ref": "GoogleCloudDiscoveryengineV1betaChunkPageSpan",
"description": "Page span of the chunk."
},
"relevanceScore": {
"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.",
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaChunkChunkMetadata": {
"description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.",
"id": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata",
"properties": {
"nextChunks": {
"description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaChunk"
},
"type": "array"
},
"previousChunks": {
"description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaChunk"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata": {
"description": "Document metadata contains the information of the document of the current chunk.",
"id": "GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata",
"properties": {
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.",
"type": "object"
},
"title": {
"description": "Title of the document.",
"type": "string"
},
"uri": {
"description": "Uri of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaChunkPageSpan": {
"description": "Page span of the chunk.",
"id": "GoogleCloudDiscoveryengineV1betaChunkPageSpan",
"properties": {
"pageEnd": {
"description": "The end page of the chunk.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "The start page of the chunk.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCloudSqlSource": {
"description": "Cloud SQL source import data from.",
"id": "GoogleCloudDiscoveryengineV1betaCloudSqlSource",
"properties": {
"databaseId": {
"description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.",
"type": "string"
},
"gcsStagingDir": {
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
"type": "string"
},
"instanceId": {
"description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.",
"type": "string"
},
"offload": {
"description": "Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).",
"type": "boolean"
},
"projectId": {
"description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
"type": "string"
},
"tableId": {
"description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCmekConfig": {
"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
"id": "GoogleCloudDiscoveryengineV1betaCmekConfig",
"properties": {
"isDefault": {
"description": "Output only. The default CmekConfig for the Customer.",
"readOnly": true,
"type": "boolean"
},
"kmsKey": {
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
"type": "string"
},
"kmsKeyVersion": {
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
"type": "string"
},
"lastRotationTimestampMicros": {
"description": "Output only. The timestamp of the last key rotation.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
"type": "string"
},
"notebooklmState": {
"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
"enum": [
"NOTEBOOK_LM_STATE_UNSPECIFIED",
"NOTEBOOK_LM_NOT_READY",
"NOTEBOOK_LM_READY",
"NOTEBOOK_LM_NOT_ENABLED"
],
"enumDescriptions": [
"The NotebookLM state is unknown.",
"The NotebookLM is not ready.",
"The NotebookLM is ready to be used.",
"The NotebookLM is not enabled."
],
"readOnly": true,
"type": "string"
},
"singleRegionKeys": {
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSingleRegionKey"
},
"type": "array"
},
"state": {
"description": "Output only. The states of the CmekConfig.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"KEY_ISSUE",
"DELETING",
"DELETE_FAILED",
"UNUSABLE",
"ACTIVE_ROTATING"
],
"enumDescriptions": [
"The CmekConfig state is unknown.",
"The CmekConfig is creating.",
"The CmekConfig can be used with DataStores.",
"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.",
"The CmekConfig is deleting.",
"The CmekConfig deletion process failed.",
"The CmekConfig is not usable, most likely due to some internal issue.",
"The KMS key version is being rotated."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCompleteQueryResponse": {
"description": "Response message for CompletionService.CompleteQuery method.",
"id": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse",
"properties": {
"querySuggestions": {
"description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion"
},
"type": "array"
},
"tailMatchTriggered": {
"description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion": {
"description": "Suggestions as search queries.",
"id": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion",
"properties": {
"completableFieldPaths": {
"description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestion": {
"description": "The suggestion for the query.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCompletionInfo": {
"description": "Detailed completion information including completion attribution token and clicked completion info.",
"id": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
"properties": {
"selectedPosition": {
"description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.",
"format": "int32",
"type": "integer"
},
"selectedSuggestion": {
"description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCompletionSuggestion": {
"description": "Autocomplete suggestions that are imported from Customer.",
"id": "GoogleCloudDiscoveryengineV1betaCompletionSuggestion",
"properties": {
"alternativePhrases": {
"description": "Alternative matching phrases for this suggestion.",
"items": {
"type": "string"
},
"type": "array"
},
"frequency": {
"description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.",
"format": "int64",
"type": "string"
},
"globalScore": {
"description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.",
"format": "double",
"type": "number"
},
"groupId": {
"description": "If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.",
"type": "string"
},
"groupScore": {
"description": "The score of this suggestion within its group.",
"format": "double",
"type": "number"
},
"languageCode": {
"description": "BCP-47 language code of this suggestion.",
"type": "string"
},
"suggestion": {
"description": "Required. The suggestion text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCondition": {
"description": "Defines circumstances to be checked before allowing a behavior",
"id": "GoogleCloudDiscoveryengineV1betaCondition",
"properties": {
"activeTimeRange": {
"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange"
},
"type": "array"
},
"queryRegex": {
"description": "Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.",
"type": "string"
},
"queryTerms": {
"description": "Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": {
"description": "Matcher for search request query",
"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm",
"properties": {
"fullMatch": {
"description": "Whether the search query needs to exactly match the query term.",
"type": "boolean"
},
"value": {
"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConditionTimeRange": {
"description": "Used for time-dependent conditions.",
"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange",
"properties": {
"endTime": {
"description": "End of time range. Range is inclusive. Must be in the future.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Start of time range. Range is inclusive.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControl": {
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
"id": "GoogleCloudDiscoveryengineV1betaControl",
"properties": {
"associatedServingConfigIds": {
"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"boostAction": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction",
"description": "Defines a boost-type control"
},
"conditions": {
"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCondition"
},
"type": "array"
},
"displayName": {
"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
},
"filterAction": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction",
"description": "Defines a filter-type control Currently not supported by Recommendation"
},
"name": {
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
"type": "string"
},
"promoteAction": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
},
"redirectAction": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
"description": "Defines a redirect-type control."
},
"solutionType": {
"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"synonymsAction": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction",
"description": "Treats a group of terms as synonyms of one another."
},
"useCases": {
"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.",
"items": {
"enum": [
"SEARCH_USE_CASE_UNSPECIFIED",
"SEARCH_USE_CASE_SEARCH",
"SEARCH_USE_CASE_BROWSE"
],
"enumDescriptions": [
"Value used when unset. Will not occur in CSS.",
"Search use case. Expects the traffic has a non-empty query.",
"Browse use case. Expects the traffic has an empty query."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlBoostAction": {
"description": "Adjusts order of products in returned list.",
"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction",
"properties": {
"boost": {
"deprecated": true,
"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
"format": "float",
"type": "number"
},
"dataStore": {
"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
"type": "string"
},
"filter": {
"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
},
"fixedBoost": {
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
"format": "float",
"type": "number"
},
"interpolationBoostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec",
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": {
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
"id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec",
"properties": {
"attributeType": {
"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
"enum": [
"ATTRIBUTE_TYPE_UNSPECIFIED",
"NUMERICAL",
"FRESHNESS"
],
"enumDescriptions": [
"Unspecified AttributeType.",
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
],
"type": "string"
},
"controlPoints": {
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint"
},
"type": "array"
},
"fieldName": {
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
"type": "string"
},
"interpolationType": {
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
"enum": [
"INTERPOLATION_TYPE_UNSPECIFIED",
"LINEAR"
],
"enumDescriptions": [
"Interpolation type is unspecified. In this case, it defaults to Linear.",
"Piecewise linear interpolation will be applied."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": {
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
"id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint",
"properties": {
"attributeValue": {
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
"type": "string"
},
"boostAmount": {
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlFilterAction": {
"description": "Specified which products may be included in results. Uses same filter as boost.",
"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction",
"properties": {
"dataStore": {
"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
"type": "string"
},
"filter": {
"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
"description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
"id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
"properties": {
"dataStore": {
"description": "Required. Data store with which this promotion is attached to.",
"type": "string"
},
"searchLinkPromotion": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
"description": "Required. Promotion attached to this action."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
"description": "Redirects a shopper to the provided URI.",
"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
"properties": {
"redirectUri": {
"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": {
"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".",
"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction",
"properties": {
"synonyms": {
"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConversation": {
"description": "External conversation proto definition.",
"id": "GoogleCloudDiscoveryengineV1betaConversation",
"properties": {
"endTime": {
"description": "Output only. The time the conversation finished.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"messages": {
"description": "Conversation messages.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversationMessage"
},
"type": "array"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
"type": "string"
},
"startTime": {
"description": "Output only. The time the conversation started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "The state of the Conversation.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"COMPLETED"
],
"enumDescriptions": [
"Unknown.",
"Conversation is currently open.",
"Conversation has been completed."
],
"type": "string"
},
"userPseudoId": {
"description": "A unique identifier for tracking users.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConversationContext": {
"description": "Defines context of the conversation",
"id": "GoogleCloudDiscoveryengineV1betaConversationContext",
"properties": {
"activeDocument": {
"description": "The current active document the user opened. It contains the document resource reference.",
"type": "string"
},
"contextDocuments": {
"description": "The current list of documents the user is seeing. It contains the document resource references.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConversationMessage": {
"description": "Defines a conversation message.",
"id": "GoogleCloudDiscoveryengineV1betaConversationMessage",
"properties": {
"createTime": {
"description": "Output only. Message creation timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"reply": {
"$ref": "GoogleCloudDiscoveryengineV1betaReply",
"description": "Search reply."
},
"userInput": {
"$ref": "GoogleCloudDiscoveryengineV1betaTextInput",
"description": "User text input."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConverseConversationRequest": {
"description": "Request message for ConversationalSearchService.ConverseConversation method.",
"id": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
"description": "Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)"
},
"conversation": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation",
"description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session."
},
"filter": {
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
},
"query": {
"$ref": "GoogleCloudDiscoveryengineV1betaTextInput",
"description": "Required. Current user input."
},
"safeSearch": {
"description": "Whether to turn on safe search.",
"type": "boolean"
},
"servingConfig": {
"description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.",
"type": "string"
},
"summarySpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
"description": "A specification for configuring the summary returned in the response."
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaConverseConversationResponse": {
"description": "Response message for ConversationalSearchService.ConverseConversation method.",
"id": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse",
"properties": {
"conversation": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation",
"description": "Updated conversation including the answer."
},
"relatedQuestions": {
"description": "Suggested related questions.",
"items": {
"type": "string"
},
"type": "array"
},
"reply": {
"$ref": "GoogleCloudDiscoveryengineV1betaReply",
"description": "Answer to the current query."
},
"searchResults": {
"description": "Search Results.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": {
"description": "The historical crawl rate timeseries data, used for monitoring.",
"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"properties": {
"qpsTimeSeries": {
"$ref": "GoogleMonitoringV3TimeSeries",
"description": "The QPS of the crawl rate."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": {
"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": {
"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": {
"description": "Metadata for EvaluationService.CreateEvaluation method.",
"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": {
"description": "Metadata for Create Schema LRO.",
"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest": {
"description": "Request message for SiteSearchEngineService.CreateTargetSite method.",
"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest",
"properties": {
"parent": {
"description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.",
"type": "string"
},
"targetSite": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite",
"description": "Required. The TargetSite to create."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCustomAttribute": {
"description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.",
"id": "GoogleCloudDiscoveryengineV1betaCustomAttribute",
"properties": {
"numbers": {
"description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
},
"text": {
"description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaCustomTuningModel": {
"description": "Metadata that describes a custom tuned model.",
"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel",
"properties": {
"createTime": {
"deprecated": true,
"description": "Deprecated: Timestamp the Model was created at.",
"format": "google-datetime",
"type": "string"
},
"displayName": {
"description": "The display name of the model.",
"type": "string"
},
"errorMessage": {
"description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.",
"type": "string"
},
"metrics": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"description": "The metrics of the trained model.",
"type": "object"
},
"modelState": {
"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
"enum": [
"MODEL_STATE_UNSPECIFIED",
"TRAINING_PAUSED",
"TRAINING",
"TRAINING_COMPLETE",
"READY_FOR_SERVING",
"TRAINING_FAILED",
"NO_IMPROVEMENT",
"INPUT_VALIDATION_FAILED"
],
"enumDescriptions": [
"Default value.",
"The model is in a paused training state.",
"The model is currently training.",
"The model has successfully completed training.",
"The model is ready for serving.",
"The model training failed.",
"The model training finished successfully but metrics did not improve.",
"Input data validation failed. Model training didn't start."
],
"type": "string"
},
"modelVersion": {
"description": "The version of the model.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.",
"type": "string"
},
"trainingStartTime": {
"description": "Timestamp the model training was initiated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDataStore": {
"description": "DataStore captures global settings and configs at the DataStore level.",
"id": "GoogleCloudDiscoveryengineV1betaDataStore",
"properties": {
"aclEnabled": {
"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
"type": "boolean"
},
"advancedSiteSearchConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig",
"description": "Optional. Configuration for advanced site search."
},
"billingEstimation": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation",
"description": "Output only. Data size estimation for billing.",
"readOnly": true
},
"cmekConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig",
"description": "Output only. CMEK-related information for the DataStore.",
"readOnly": true
},
"contentConfig": {
"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
"enum": [
"CONTENT_CONFIG_UNSPECIFIED",
"NO_CONTENT",
"CONTENT_REQUIRED",
"PUBLIC_WEBSITE",
"GOOGLE_WORKSPACE"
],
"enumDescriptions": [
"Default value.",
"Only contains documents without any Document.content.",
"Only contains documents with Document.content.",
"The data store is used for public website search.",
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
],
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp the DataStore was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"defaultSchemaId": {
"description": "Output only. The id of the default Schema associated to this data store.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"documentProcessingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig",
"description": "Configuration for Document understanding and enrichment."
},
"healthcareFhirConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
},
"identityMappingStore": {
"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
"type": "string"
},
"industryVertical": {
"description": "Immutable. The industry vertical that the data store registers.",
"enum": [
"INDUSTRY_VERTICAL_UNSPECIFIED",
"GENERIC",
"MEDIA",
"HEALTHCARE_FHIR"
],
"enumDescriptions": [
"Value used when unset.",
"The generic vertical for documents that are not specific to any industry vertical.",
"The media industry vertical.",
"The healthcare FHIR vertical."
],
"type": "string"
},
"isInfobotFaqDataStore": {
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
"type": "boolean"
},
"kmsKeyName": {
"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.",
"type": "string"
},
"languageInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo",
"description": "Language info for DataStore."
},
"name": {
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"naturalLanguageQueryUnderstandingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig",
"description": "Optional. Configuration for Natural Language Query Understanding."
},
"servingConfigDataStore": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore",
"description": "Optional. Stores serving config at DataStore level."
},
"solutionTypes": {
"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.",
"items": {
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"type": "array"
},
"startingSchema": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema",
"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
},
"workspaceConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": {
"description": "Estimation of data size per data store.",
"id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation",
"properties": {
"structuredDataSize": {
"description": "Data size for structured data in terms of bytes.",
"format": "int64",
"type": "string"
},
"structuredDataUpdateTime": {
"description": "Last updated timestamp for structured data.",
"format": "google-datetime",
"type": "string"
},
"unstructuredDataSize": {
"description": "Data size for unstructured data in terms of bytes.",
"format": "int64",
"type": "string"
},
"unstructuredDataUpdateTime": {
"description": "Last updated timestamp for unstructured data.",
"format": "google-datetime",
"type": "string"
},
"websiteDataSize": {
"description": "Data size for websites in terms of bytes.",
"format": "int64",
"type": "string"
},
"websiteDataUpdateTime": {
"description": "Last updated timestamp for websites.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": {
"description": "Stores information regarding the serving configurations at DataStore level.",
"id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore",
"properties": {
"disabledForServing": {
"description": "If set true, the DataStore will not be available for serving search requests.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": {
"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.",
"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
"properties": {
"autoRefreshCrawlErrorRate": {
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"description": "Vertex AI's error rate time series of auto-refresh dedicated crawl."
},
"autoRefreshCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically."
},
"userTriggeredCrawlErrorRate": {
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"description": "Vertex AI's error rate time series of user triggered dedicated crawl."
},
"userTriggeredCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": {
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": {
"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata": {
"description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": {
"description": "Metadata for DeleteSchema LRO.",
"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest": {
"description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": {
"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocument": {
"description": "Document captures all raw metadata information of items to be recommended or searched.",
"id": "GoogleCloudDiscoveryengineV1betaDocument",
"properties": {
"aclInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentAclInfo",
"description": "Access control information for the document."
},
"content": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentContent",
"description": "The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store."
},
"derivedStructData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.",
"readOnly": true,
"type": "object"
},
"id": {
"description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters.",
"type": "string"
},
"indexStatus": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus",
"description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.",
"readOnly": true
},
"indexTime": {
"description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"jsonData": {
"description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"parentDocumentId": {
"description": "The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
"type": "string"
},
"schemaId": {
"description": "The identifier of the schema located in the same data store.",
"type": "string"
},
"structData": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentAclInfo": {
"description": "ACL Information of the Document.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentAclInfo",
"properties": {
"readers": {
"description": "Readers of the document.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction": {
"description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }",
"id": "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction",
"properties": {
"idpWide": {
"description": "All users within the Identity Provider.",
"type": "boolean"
},
"principals": {
"description": "List of principals.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaPrincipal"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentContent": {
"description": "Unstructured data linked to this document.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentContent",
"properties": {
"mimeType": {
"description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.",
"type": "string"
},
"rawBytes": {
"description": "The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.",
"format": "byte",
"type": "string"
},
"uri": {
"description": "The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentIndexStatus": {
"description": "Index status of the document.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"indexTime": {
"description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.",
"format": "google-datetime",
"type": "string"
},
"pendingMessage": {
"description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentInfo": {
"description": "Detailed document information associated with a user event.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentInfo",
"properties": {
"conversionValue": {
"description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.",
"format": "float",
"type": "number"
},
"id": {
"description": "The Document resource ID.",
"type": "string"
},
"joined": {
"description": "Output only. Whether the referenced Document can be found in the data store.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`",
"type": "string"
},
"promotionIds": {
"description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.",
"items": {
"type": "string"
},
"type": "array"
},
"quantity": {
"description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`",
"format": "int32",
"type": "integer"
},
"uri": {
"description": "The Document URI - only allowed for website data stores.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": {
"description": "A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig",
"properties": {
"chunkingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig",
"description": "Whether chunking mode is enabled."
},
"defaultParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig",
"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing."
},
"name": {
"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.",
"type": "string"
},
"parsingConfigOverrides": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig"
},
"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": {
"description": "Configuration for chunking config.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig",
"properties": {
"layoutBasedChunkingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig",
"description": "Configuration for the layout based chunking."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": {
"description": "Configuration for the layout based chunking.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig",
"properties": {
"chunkSize": {
"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.",
"format": "int32",
"type": "integer"
},
"includeAncestorHeadings": {
"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": {
"description": "Related configurations applied to a specific type of document parser.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig",
"properties": {
"digitalParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig",
"description": "Configurations applied to digital parser."
},
"layoutParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
"description": "Configurations applied to layout parser."
},
"ocrParsingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig",
"description": "Configurations applied to OCR parser. Currently it only applies to PDFs."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": {
"description": "The digital parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": {
"description": "The layout parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
"properties": {
"enableImageAnnotation": {
"description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
"type": "boolean"
},
"enableTableAnnotation": {
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
"type": "boolean"
},
"excludeHtmlClasses": {
"description": "Optional. List of HTML classes to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
},
"excludeHtmlElements": {
"description": "Optional. List of HTML elements to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
},
"excludeHtmlIds": {
"description": "Optional. List of HTML ids to exclude from the parsed content.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": {
"description": "The OCR parsing configurations for documents.",
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig",
"properties": {
"enhancedDocumentElements": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.",
"items": {
"type": "string"
},
"type": "array"
},
"useNativeText": {
"description": "If true, will use native text instead of OCR text on pages containing native text.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaDoubleList": {
"description": "Double list.",
"id": "GoogleCloudDiscoveryengineV1betaDoubleList",
"properties": {
"values": {
"description": "Double values.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEmbeddingConfig": {
"description": "Defines embedding config, used for bring your own embeddings feature.",
"id": "GoogleCloudDiscoveryengineV1betaEmbeddingConfig",
"properties": {
"fieldPath": {
"description": "Full field path in the schema mapped as embedding field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest": {
"description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": {
"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.",
"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngine": {
"description": "Metadata that describes the training and serving parameters of an Engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngine",
"properties": {
"chatEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig",
"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT."
},
"chatEngineMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata",
"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.",
"readOnly": true
},
"commonConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
"description": "Common config spec that specifies the metadata of the engine."
},
"createTime": {
"description": "Output only. Timestamp the Recommendation Engine was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataStoreIds": {
"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
"items": {
"type": "string"
},
"type": "array"
},
"disableAnalytics": {
"description": "Optional. Whether to disable analytics for searches performed on this engine.",
"type": "boolean"
},
"displayName": {
"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
"type": "string"
},
"industryVertical": {
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
"enum": [
"INDUSTRY_VERTICAL_UNSPECIFIED",
"GENERIC",
"MEDIA",
"HEALTHCARE_FHIR"
],
"enumDescriptions": [
"Value used when unset.",
"The generic vertical for documents that are not specific to any industry vertical.",
"The media industry vertical.",
"The healthcare FHIR vertical."
],
"type": "string"
},
"mediaRecommendationEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig",
"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
},
"name": {
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"searchEngineConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig",
"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH."
},
"solutionType": {
"description": "Required. The solutions of the engine.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp the Recommendation Engine was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": {
"description": "Configurations for a Chat Engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig",
"properties": {
"agentCreationConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig",
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
},
"allowCrossRegion": {
"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
"type": "boolean"
},
"dialogflowAgentToLink": {
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": {
"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig",
"properties": {
"business": {
"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.",
"type": "string"
},
"defaultLanguageCode": {
"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.",
"type": "string"
},
"location": {
"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.",
"type": "string"
},
"timeZone": {
"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": {
"description": "Additional information of a Chat Engine. Fields in this message are output only.",
"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata",
"properties": {
"dialogflowAgent": {
"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": {
"description": "Common configurations for an Engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
"properties": {
"companyName": {
"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": {
"description": "Additional config specs for a Media Recommendation engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig",
"properties": {
"engineFeaturesConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
"description": "Optional. Additional engine features config."
},
"optimizationObjective": {
"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`",
"type": "string"
},
"optimizationObjectiveConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)."
},
"trainingState": {
"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.",
"enum": [
"TRAINING_STATE_UNSPECIFIED",
"PAUSED",
"TRAINING"
],
"enumDescriptions": [
"Unspecified training state.",
"The engine training is paused.",
"The engine is training."
],
"type": "string"
},
"type": {
"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": {
"description": "More feature configs of the selected engine type.",
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
"properties": {
"mostPopularConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
"description": "Most popular engine feature config."
},
"recommendedForYouConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
"description": "Recommended for you engine feature config."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": {
"description": "Feature configurations that are required for creating a Most Popular engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
"properties": {
"timeWindowDays": {
"description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": {
"description": "Custom threshold for `cvr` optimization_objective.",
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
"properties": {
"targetField": {
"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.",
"type": "string"
},
"targetFieldValueFloat": {
"description": "Required. The threshold to be applied to the target (e.g., 0.5).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": {
"description": "Additional feature configurations for creating a `recommended-for-you` engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
"properties": {
"contextEventType": {
"description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": {
"description": "Configurations for a Search Engine.",
"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig",
"properties": {
"searchAddOns": {
"description": "The add-on that this search engine enables.",
"items": {
"enum": [
"SEARCH_ADD_ON_UNSPECIFIED",
"SEARCH_ADD_ON_LLM"
],
"enumDescriptions": [
"Default value when the enum is unspecified. This is invalid to use.",
"Large language model add-on."
],
"type": "string"
},
"type": "array"
},
"searchTier": {
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.",
"enum": [
"SEARCH_TIER_UNSPECIFIED",
"SEARCH_TIER_STANDARD",
"SEARCH_TIER_ENTERPRISE"
],
"enumDescriptions": [
"Default value when the enum is unspecified. This is invalid to use.",
"Standard tier.",
"Enterprise tier."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEvaluation": {
"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.",
"id": "GoogleCloudDiscoveryengineV1betaEvaluation",
"properties": {
"createTime": {
"description": "Output only. Timestamp the Evaluation was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. Timestamp the Evaluation was completed at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.",
"readOnly": true
},
"errorSamples": {
"description": "Output only. A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"readOnly": true,
"type": "array"
},
"evaluationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec",
"description": "Required. The specification of the evaluation."
},
"name": {
"description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"qualityMetrics": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics",
"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.",
"readOnly": true
},
"state": {
"description": "Output only. The state of the evaluation.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The evaluation is unspecified.",
"The service is preparing to run the evaluation.",
"The evaluation is in progress.",
"The evaluation completed successfully.",
"The evaluation failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": {
"description": "Describes the specification of the evaluation.",
"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec",
"properties": {
"querySetSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
"description": "Required. The specification of the query set."
},
"searchRequest": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest",
"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": {
"description": "Describes the specification of the query set.",
"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
"properties": {
"sampleQuerySet": {
"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaFactChunk": {
"description": "Fact Chunk.",
"id": "GoogleCloudDiscoveryengineV1betaFactChunk",
"properties": {
"chunkText": {
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
"type": "string"
},
"domain": {
"description": "The domain of the source.",
"type": "string"
},
"index": {
"description": "The index of this chunk. Currently, only used for the streaming mode.",
"format": "int32",
"type": "integer"
},
"source": {
"description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.",
"type": "string"
},
"sourceMetadata": {
"additionalProperties": {
"type": "string"
},
"description": "More fine-grained information for the source reference.",
"type": "object"
},
"title": {
"description": "The title of the source.",
"type": "string"
},
"uri": {
"description": "The URI of the source.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": {
"description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
"id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"targetSites": {
"description": "List of TargetSites containing the site verification status.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"type": "array"
},
"totalSize": {
"description": "The total number of items matching the request. This will always be populated in the response.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": {
"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse",
"properties": {
"sitemapsMetadata": {
"description": "List of Sitemaps fetched.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": {
"description": "Contains a Sitemap and its metadata.",
"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata",
"properties": {
"sitemap": {
"$ref": "GoogleCloudDiscoveryengineV1betaSitemap",
"description": "The Sitemap."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaFhirStoreSource": {
"description": "Cloud FhirStore source import data from.",
"id": "GoogleCloudDiscoveryengineV1betaFhirStoreSource",
"properties": {
"fhirStore": {
"description": "Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.",
"type": "string"
},
"gcsStagingDir": {
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.",
"type": "string"
},
"resourceTypes": {
"description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.",
"items": {
"type": "string"
},
"type": "array"
},
"updateFromLatestPredefinedSchema": {
"description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaFirestoreSource": {
"description": "Firestore source import data from.",
"id": "GoogleCloudDiscoveryengineV1betaFirestoreSource",
"properties": {
"collectionId": {
"description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.",
"type": "string"
},
"databaseId": {
"description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.",
"type": "string"
},
"gcsStagingDir": {
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
"type": "string"
},
"projectId": {
"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaGcsSource": {
"description": "Cloud Storage location for input content.",
"id": "GoogleCloudDiscoveryengineV1betaGcsSource",
"properties": {
"dataSchema": {
"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.",
"type": "string"
},
"inputUris": {
"description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaGroundingFact": {
"description": "Grounding Fact.",
"id": "GoogleCloudDiscoveryengineV1betaGroundingFact",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.",
"type": "object"
},
"factText": {
"description": "Text content of the fact. Can be at most 10K characters long.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": {
"description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
"id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
"properties": {
"enableConfigurableSchema": {
"description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.",
"type": "boolean"
},
"enableStaticIndexingForBatchIngestion": {
"description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaIdentityMappingEntry": {
"description": "Identity Mapping Entry that maps an external identity to an internal identity.",
"id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry",
"properties": {
"externalIdentity": {
"description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.",
"type": "string"
},
"groupId": {
"description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.",
"type": "string"
},
"userId": {
"description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": {
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata",
"properties": {
"failureCount": {
"description": "The number of IdentityMappingEntries that failed to be processed.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "The number of IdentityMappingEntries that were successfully processed.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "The total number of IdentityMappingEntries that were processed.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaIdentityMappingStore": {
"description": "Identity Mapping Store which contains Identity Mapping Entries.",
"id": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore",
"properties": {
"cmekConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig",
"description": "Output only. CMEK-related information for the Identity Mapping Store.",
"readOnly": true
},
"kmsKeyName": {
"description": "Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": {
"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of CompletionSuggestions that failed to be imported.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of CompletionSuggestions successfully imported.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest": {
"description": "Request message for CompletionService.ImportCompletionSuggestions method.",
"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest",
"properties": {
"bigquerySource": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource",
"description": "BigQuery input source."
},
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content."
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource",
"description": "The Inline source for suggestion entries."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource": {
"description": "The inline source for CompletionSuggestions.",
"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource",
"properties": {
"suggestions": {
"description": "Required. A list of all denylist entries to import. Max of 1000 items.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCompletionSuggestion"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": {
"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": {
"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were processed successfully.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "Total count of entries that were processed.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportDocumentsRequest": {
"description": "Request message for Import methods.",
"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest",
"properties": {
"alloyDbSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaAlloyDbSource",
"description": "AlloyDB input source."
},
"autoGenerateIds": {
"description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.",
"type": "boolean"
},
"bigquerySource": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource",
"description": "BigQuery input source."
},
"bigtableSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigtableSource",
"description": "Cloud Bigtable input source."
},
"cloudSqlSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaCloudSqlSource",
"description": "Cloud SQL input source."
},
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"fhirStoreSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaFhirStoreSource",
"description": "FhirStore input source."
},
"firestoreSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaFirestoreSource",
"description": "Firestore input source."
},
"forceRefreshContent": {
"description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.",
"type": "boolean"
},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content."
},
"idField": {
"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.",
"type": "string"
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource",
"description": "The Inline source for the input content for documents."
},
"reconciliationMode": {
"description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.",
"enum": [
"RECONCILIATION_MODE_UNSPECIFIED",
"INCREMENTAL",
"FULL"
],
"enumDescriptions": [
"Defaults to `INCREMENTAL`.",
"Inserts new documents or updates existing documents.",
"Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location."
],
"type": "string"
},
"spannerSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaSpannerSource",
"description": "Spanner input source."
},
"updateMask": {
"description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource": {
"description": "The inline source for the input config for ImportDocuments method.",
"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource",
"properties": {
"documents": {
"description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": {
"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "Echoes the destination for the complete errors in the request if set."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportErrorConfig": {
"description": "Configuration of destination for Import related errors.",
"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"properties": {
"gcsPrefix": {
"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest": {
"description": "Request message for IdentityMappingStoreService.ImportIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest",
"properties": {
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource",
"description": "The inline source to import identity mapping entries from."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource": {
"description": "The inline source to import identity mapping entries from.",
"id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource",
"properties": {
"identityMappingEntries": {
"description": "A maximum of 10000 entries can be imported at one time",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": {
"description": "Response message for IdentityMappingStoreService.ImportIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": {
"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata",
"properties": {
"createTime": {
"description": "ImportSampleQueries operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of SampleQuerys that failed to be imported.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of SampleQuerys successfully imported.",
"format": "int64",
"type": "string"
},
"totalCount": {
"description": "Total count of SampleQuerys that were processed.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest": {
"description": "Request message for SampleQueryService.ImportSampleQueries method.",
"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest",
"properties": {
"bigquerySource": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource",
"description": "BigQuery input source."
},
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content."
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource",
"description": "The Inline source for sample query entries."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource": {
"description": "The inline source for SampleQuerys.",
"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource",
"properties": {
"sampleQueries": {
"description": "Required. A list of SampleQuerys to import. Max of 1000 items.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": {
"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the Import."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": {
"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest": {
"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest",
"properties": {
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line."
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource",
"description": "The Inline source for the input content for suggestion deny list entries."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource": {
"description": "The inline source for SuggestionDenyListEntry.",
"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource",
"properties": {
"entries": {
"description": "Required. A list of all denylist entries to import. Max of 1000 items.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": {
"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"failedEntriesCount": {
"description": "Count of deny list entries that failed to be imported.",
"format": "int64",
"type": "string"
},
"importedEntriesCount": {
"description": "Count of deny list entries successfully imported.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": {
"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were processed successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportUserEventsRequest": {
"description": "Request message for the ImportUserEvents request.",
"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest",
"properties": {
"bigquerySource": {
"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource",
"description": "BigQuery input source."
},
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports."
},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content."
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource",
"description": "The Inline source for the input content for UserEvents."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource": {
"description": "The inline source for the input config for ImportUserEvents method.",
"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource",
"properties": {
"userEvents": {
"description": "Required. A list of user events to import. Recommended max of 10k items.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": {
"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "Echoes the destination for the complete errors if this field was set in the request."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"joinedEventsCount": {
"description": "Count of user events imported with complete existing Documents.",
"format": "int64",
"type": "string"
},
"unjoinedEventsCount": {
"description": "Count of user events imported, but with Document information not found in the existing Branch.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaInterval": {
"description": "A floating point interval.",
"id": "GoogleCloudDiscoveryengineV1betaInterval",
"properties": {
"exclusiveMaximum": {
"description": "Exclusive upper bound.",
"format": "double",
"type": "number"
},
"exclusiveMinimum": {
"description": "Exclusive lower bound.",
"format": "double",
"type": "number"
},
"maximum": {
"description": "Inclusive upper bound.",
"format": "double",
"type": "number"
},
"minimum": {
"description": "Inclusive lower bound.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaLanguageInfo": {
"description": "Language info for DataStore.",
"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo",
"properties": {
"language": {
"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.",
"readOnly": true,
"type": "string"
},
"languageCode": {
"description": "The language code for the DataStore.",
"type": "string"
},
"normalizedLanguageCode": {
"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.",
"readOnly": true,
"type": "string"
},
"region": {
"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse": {
"description": "Response message for CmekConfigService.ListCmekConfigs method.",
"id": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse",
"properties": {
"cmekConfigs": {
"description": "All the customer's CmekConfigs.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListControlsResponse": {
"description": "Response for ListControls method.",
"id": "GoogleCloudDiscoveryengineV1betaListControlsResponse",
"properties": {
"controls": {
"description": "All the Controls for a given data store.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
},
"type": "array"
},
"nextPageToken": {
"description": "Pagination token, if not returned indicates the last page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListConversationsResponse": {
"description": "Response for ListConversations method.",
"id": "GoogleCloudDiscoveryengineV1betaListConversationsResponse",
"properties": {
"conversations": {
"description": "All the Conversations for a given data store.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
},
"type": "array"
},
"nextPageToken": {
"description": "Pagination token, if not returned indicates the last page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": {
"description": "Response message for SearchTuningService.ListCustomModels method.",
"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse",
"properties": {
"models": {
"description": "List of custom tuning models.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListDataStoresResponse": {
"description": "Response message for DataStoreService.ListDataStores method.",
"id": "GoogleCloudDiscoveryengineV1betaListDataStoresResponse",
"properties": {
"dataStores": {
"description": "All the customer's DataStores.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaDataStore"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListDocumentsResponse": {
"description": "Response message for DocumentService.ListDocuments method.",
"id": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse",
"properties": {
"documents": {
"description": "The Documents.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListEnginesResponse": {
"description": "Response message for EngineService.ListEngines method.",
"id": "GoogleCloudDiscoveryengineV1betaListEnginesResponse",
"properties": {
"engines": {
"description": "All the customer's Engines.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaEngine"
},
"type": "array"
},
"nextPageToken": {
"description": "Not supported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse": {
"description": "Response message for EvaluationService.ListEvaluationResults method.",
"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse",
"properties": {
"evaluationResults": {
"description": "The evaluation results for the SampleQuerys.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult": {
"description": "Represents the results of an evaluation for a single SampleQuery.",
"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult",
"properties": {
"qualityMetrics": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics",
"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.",
"readOnly": true
},
"sampleQuery": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery",
"description": "Output only. The SampleQuery that was evaluated.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListEvaluationsResponse": {
"description": "Response message for EvaluationService.ListEvaluations method.",
"id": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse",
"properties": {
"evaluations": {
"description": "The Evaluations.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse": {
"description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores",
"id": "GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse",
"properties": {
"identityMappingStores": {
"description": "The Identity Mapping Stores.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingStore"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse": {
"description": "Response message for IdentityMappingStoreService.ListIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse",
"properties": {
"identityMappingEntries": {
"description": "The Identity Mapping Entries.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": {
"description": "Response message for SampleQueryService.ListSampleQueries method.",
"id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"sampleQueries": {
"description": "The SampleQuerys.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse": {
"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.",
"id": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"sampleQuerySets": {
"description": "The SampleQuerySets.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListSchemasResponse": {
"description": "Response message for SchemaService.ListSchemas method.",
"id": "GoogleCloudDiscoveryengineV1betaListSchemasResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"schemas": {
"description": "The Schemas.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListServingConfigsResponse": {
"description": "Response for ListServingConfigs method.",
"id": "GoogleCloudDiscoveryengineV1betaListServingConfigsResponse",
"properties": {
"nextPageToken": {
"description": "Pagination token, if not returned indicates the last page.",
"type": "string"
},
"servingConfigs": {
"description": "All the ServingConfigs for a given dataStore.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfig"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListSessionsResponse": {
"description": "Response for ListSessions method.",
"id": "GoogleCloudDiscoveryengineV1betaListSessionsResponse",
"properties": {
"nextPageToken": {
"description": "Pagination token, if not returned indicates the last page.",
"type": "string"
},
"sessions": {
"description": "All the Sessions for a given data store.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSession"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaListTargetSitesResponse": {
"description": "Response message for SiteSearchEngineService.ListTargetSites method.",
"id": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"targetSites": {
"description": "List of TargetSites.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite"
},
"type": "array"
},
"totalSize": {
"description": "The total number of items matching the request. This will always be populated in the response.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaMediaInfo": {
"description": "Media-specific user event information.",
"id": "GoogleCloudDiscoveryengineV1betaMediaInfo",
"properties": {
"mediaProgressDuration": {
"description": "The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.",
"format": "google-duration",
"type": "string"
},
"mediaProgressPercentage": {
"description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": {
"description": "Configuration for Natural Language Query Understanding.",
"id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig",
"properties": {
"mode": {
"description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.",
"enum": [
"MODE_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Default value.",
"Natural Language Query Understanding is disabled.",
"Natural Language Query Understanding is enabled."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest": {
"description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.",
"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest",
"properties": {
"crawlRateScope": {
"description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": {
"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.",
"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse",
"properties": {
"dedicatedCrawlRateTimeSeries": {
"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
"description": "The historical dedicated crawl rate timeseries data, used for monitoring."
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Errors from service when handling the request."
},
"organicCrawlRateTimeSeries": {
"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
"description": "The historical organic crawl rate timeseries data, used for monitoring."
},
"state": {
"description": "Output only. The state of the response.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state is unspecified.",
"The state is successful.",
"The state is failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": {
"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.",
"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
"properties": {
"googleOrganicCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots."
},
"vertexAiOrganicCrawlRate": {
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPageInfo": {
"description": "Detailed page information.",
"id": "GoogleCloudDiscoveryengineV1betaPageInfo",
"properties": {
"pageCategory": {
"description": "The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `\"pageCategory\" : \"Sales > 2017 Black Friday Deals\"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
},
"pageviewId": {
"description": "A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.",
"type": "string"
},
"referrerUri": {
"description": "The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty.",
"type": "string"
},
"uri": {
"description": "Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPanelInfo": {
"description": "Detailed panel information associated with a user event.",
"id": "GoogleCloudDiscoveryengineV1betaPanelInfo",
"properties": {
"displayName": {
"description": "The display name of the panel.",
"type": "string"
},
"documents": {
"description": "Optional. The document IDs associated with this panel.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentInfo"
},
"type": "array"
},
"panelId": {
"description": "Required. The panel ID.",
"type": "string"
},
"panelPosition": {
"description": "The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.",
"format": "int32",
"type": "integer"
},
"totalPanels": {
"description": "The total number of panels, including this one, shown to the user. Must be set if panel_position is set.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPauseEngineRequest": {
"description": "Request for pausing training of an engine.",
"id": "GoogleCloudDiscoveryengineV1betaPauseEngineRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPrincipal": {
"description": "Principal identifier of a user or a group.",
"id": "GoogleCloudDiscoveryengineV1betaPrincipal",
"properties": {
"groupId": {
"description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.",
"type": "string"
},
"userId": {
"description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaProject": {
"description": "Metadata and configurations for a Google Cloud project in the service.",
"id": "GoogleCloudDiscoveryengineV1betaProject",
"properties": {
"createTime": {
"description": "Output only. The timestamp when this project is created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
"readOnly": true,
"type": "string"
},
"provisionCompletionTime": {
"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"serviceTermsMap": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms"
},
"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
"description": "Metadata about the terms of service.",
"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
"properties": {
"acceptTime": {
"description": "The last time when the project agreed to the terms of service.",
"format": "google-datetime",
"type": "string"
},
"declineTime": {
"description": "The last time when the project declined or revoked the agreement to terms of service.",
"format": "google-datetime",
"type": "string"
},
"id": {
"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
"type": "string"
},
"state": {
"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
"enum": [
"STATE_UNSPECIFIED",
"TERMS_ACCEPTED",
"TERMS_PENDING",
"TERMS_DECLINED"
],
"enumDescriptions": [
"The default value of the enum. This value is not actually used.",
"The project has given consent to the terms of service.",
"The project is pending to review and accept the terms of service.",
"The project has declined or revoked the agreement to terms of service."
],
"type": "string"
},
"version": {
"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": {
"description": "Metadata associated with a project provision operation.",
"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaProvisionProjectRequest": {
"description": "Request for ProjectService.ProvisionProject method.",
"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectRequest",
"properties": {
"acceptDataUseTerms": {
"description": "Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).",
"type": "boolean"
},
"dataUseTermsVersion": {
"description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest": {
"description": "Request message for CompletionService.PurgeCompletionSuggestions method.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": {
"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"failureCount": {
"description": "Count of entries that encountered errors while processing.",
"format": "int64",
"type": "string"
},
"ignoredCount": {
"description": "Count of entries that were ignored as entries were not found.",
"format": "int64",
"type": "string"
},
"successCount": {
"description": "Count of entries that were deleted successfully.",
"format": "int64",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest": {
"description": "Request message for DocumentService.PurgeDocuments method.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig",
"description": "The desired location of errors incurred during the purge."
},
"filter": {
"description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).",
"type": "string"
},
"force": {
"description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.",
"type": "boolean"
},
"gcsSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
"description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line."
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource",
"description": "Inline source for the input content for purge."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource": {
"description": "The inline source for the input config for DocumentService.PurgeDocuments method.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource",
"properties": {
"documents": {
"description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": {
"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse",
"properties": {
"purgeCount": {
"description": "The total count of documents purged as a result of the operation.",
"format": "int64",
"type": "string"
},
"purgeSample": {
"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeErrorConfig": {
"description": "Configuration of destination for Purge related errors.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig",
"properties": {
"gcsPrefix": {
"description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest": {
"description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings",
"id": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest",
"properties": {
"filter": {
"description": "Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 \"zulu\" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time > \"2012-04-23T18:25:43.511Z\" AND update_time < \"2012-04-23T18:30:43.511Z\"` * Deleting all identity mappings for a given external_id: `external_id = \"id1\"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.",
"type": "string"
},
"force": {
"description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.",
"type": "boolean"
},
"inlineSource": {
"$ref": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource",
"description": "The inline source to purge identity mapping entries from."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource": {
"description": "The inline source to purge identity mapping entries from.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource",
"properties": {
"identityMappingEntries": {
"description": "A maximum of 10000 entries can be purged at one time",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntry"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": {
"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest": {
"description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": {
"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse",
"properties": {
"errorSamples": {
"description": "A sample of errors encountered while processing the request.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"purgeCount": {
"description": "Number of suggestion deny list entries purged.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest": {
"description": "Request message for PurgeUserEvents method.",
"id": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest",
"properties": {
"filter": {
"description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.",
"type": "string"
},
"force": {
"description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaQualityMetrics": {
"description": "Describes the metrics produced by the evaluation.",
"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics",
"properties": {
"docNdcg": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
},
"docPrecision": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8"
},
"docRecall": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6"
},
"pageNdcg": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
},
"pageRecall": {
"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": {
"description": "Stores the metric values at specific top-k levels.",
"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
"properties": {
"top1": {
"description": "The top-1 value.",
"format": "double",
"type": "number"
},
"top10": {
"description": "The top-10 value.",
"format": "double",
"type": "number"
},
"top3": {
"description": "The top-3 value.",
"format": "double",
"type": "number"
},
"top5": {
"description": "The top-5 value.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaQuery": {
"description": "Defines a user inputed query.",
"id": "GoogleCloudDiscoveryengineV1betaQuery",
"properties": {
"queryId": {
"description": "Unique Id for the query.",
"type": "string"
},
"text": {
"description": "Plain text.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRankRequest": {
"description": "Request message for RankService.Rank method.",
"id": "GoogleCloudDiscoveryengineV1betaRankRequest",
"properties": {
"ignoreRecordDetailsInResponse": {
"description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.",
"type": "boolean"
},
"model": {
"description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.",
"type": "string"
},
"query": {
"description": "The query to use.",
"type": "string"
},
"records": {
"description": "Required. A list of records to rank. At most 200 records to rank.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaRankingRecord"
},
"type": "array"
},
"topN": {
"description": "The number of results to return. If this is unset or no bigger than zero, returns all results.",
"format": "int32",
"type": "integer"
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRankResponse": {
"description": "Response message for RankService.Rank method.",
"id": "GoogleCloudDiscoveryengineV1betaRankResponse",
"properties": {
"records": {
"description": "A list of records sorted by descending score.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaRankingRecord"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRankingRecord": {
"description": "Record message for RankService.Rank method.",
"id": "GoogleCloudDiscoveryengineV1betaRankingRecord",
"properties": {
"content": {
"description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.",
"type": "string"
},
"id": {
"description": "The unique ID to represent the record.",
"type": "string"
},
"score": {
"description": "The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.",
"format": "float",
"type": "number"
},
"title": {
"description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRecommendRequest": {
"description": "Request message for Recommend method.",
"id": "GoogleCloudDiscoveryengineV1betaRecommendRequest",
"properties": {
"filter": {
"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.",
"type": "string"
},
"pageSize": {
"description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.",
"format": "int32",
"type": "integer"
},
"params": {
"additionalProperties": {
"type": "any"
},
"description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.",
"type": "object"
},
"userEvent": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent",
"description": "Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset."
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
},
"validateOnly": {
"description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRecommendResponse": {
"description": "Response message for Recommend method.",
"id": "GoogleCloudDiscoveryengineV1betaRecommendResponse",
"properties": {
"attributionToken": {
"description": "A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.",
"type": "string"
},
"missingIds": {
"description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.",
"items": {
"type": "string"
},
"type": "array"
},
"results": {
"description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult"
},
"type": "array"
},
"validateOnly": {
"description": "True if RecommendRequest.validate_only was set.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult": {
"description": "RecommendationResult represents a generic recommendation result with associated metadata.",
"id": "GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult",
"properties": {
"document": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
"description": "Set if `returnDocument` is set to true in RecommendRequest.params."
},
"id": {
"description": "Resource ID of the recommended Document.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "any"
},
"description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest": {
"description": "Request message for SiteSearchEngineService.RecrawlUris method.",
"id": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest",
"properties": {
"siteCredential": {
"description": "Optional. Credential id to use for crawling.",
"type": "string"
},
"uris": {
"description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": {
"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest": {
"description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.",
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest",
"properties": {
"crawlRateScope": {
"description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": {
"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse",
"properties": {
"error": {
"$ref": "GoogleRpcStatus",
"description": "Errors from service when handling the request."
},
"state": {
"description": "Output only. The state of the response.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state is unspecified.",
"The state is successful.",
"The state is failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest": {
"description": "Request message for CompletionService.RemoveSuggestion method.",
"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest",
"properties": {
"removeAllSearchHistorySuggestions": {
"description": "Remove all search history suggestions for the user.",
"type": "boolean"
},
"removeTime": {
"description": "Required. Time at which the suggestion was removed. If not set, the current time will be used.",
"format": "google-datetime",
"type": "string"
},
"searchHistorySuggestion": {
"description": "The search history suggestion to be removed.",
"type": "string"
},
"userInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
},
"userPseudoId": {
"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse": {
"description": "Response message for CompletionService.RemoveSuggestion method.",
"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaReply": {
"description": "Defines a reply message to user.",
"id": "GoogleCloudDiscoveryengineV1betaReply",
"properties": {
"references": {
"deprecated": true,
"description": "References in the reply.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaReplyReference"
},
"type": "array"
},
"reply": {
"deprecated": true,
"description": "DEPRECATED: use `summary` instead. Text reply.",
"type": "string"
},
"summary": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
"description": "Summary based on search results."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaReplyReference": {
"deprecated": true,
"description": "Defines reference in reply.",
"id": "GoogleCloudDiscoveryengineV1betaReplyReference",
"properties": {
"anchorText": {
"description": "Anchor text.",
"type": "string"
},
"end": {
"description": "Anchor text end index.",
"format": "int32",
"type": "integer"
},
"start": {
"description": "Anchor text start index.",
"format": "int32",
"type": "integer"
},
"uri": {
"description": "URI link reference.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaResumeEngineRequest": {
"description": "Request for resuming training of an engine.",
"id": "GoogleCloudDiscoveryengineV1betaResumeEngineRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSafetyRating": {
"description": "Safety rating corresponding to the generated content.",
"id": "GoogleCloudDiscoveryengineV1betaSafetyRating",
"properties": {
"blocked": {
"description": "Output only. Indicates whether the content was filtered out because of this rating.",
"readOnly": true,
"type": "boolean"
},
"category": {
"description": "Output only. Harm category.",
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_CIVIC_INTEGRITY"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
"The harm category is sexually explicit content.",
"The harm category is civic integrity."
],
"readOnly": true,
"type": "string"
},
"probability": {
"description": "Output only. Harm probability levels in the content.",
"enum": [
"HARM_PROBABILITY_UNSPECIFIED",
"NEGLIGIBLE",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Harm probability unspecified.",
"Negligible level of harm.",
"Low level of harm.",
"Medium level of harm.",
"High level of harm."
],
"readOnly": true,
"type": "string"
},
"probabilityScore": {
"description": "Output only. Harm probability score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"severity": {
"description": "Output only. Harm severity levels in the content.",
"enum": [
"HARM_SEVERITY_UNSPECIFIED",
"HARM_SEVERITY_NEGLIGIBLE",
"HARM_SEVERITY_LOW",
"HARM_SEVERITY_MEDIUM",
"HARM_SEVERITY_HIGH"
],
"enumDescriptions": [
"Harm severity unspecified.",
"Negligible level of harm severity.",
"Low level of harm severity.",
"Medium level of harm severity.",
"High level of harm severity."
],
"readOnly": true,
"type": "string"
},
"severityScore": {
"description": "Output only. Harm severity score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSampleQuery": {
"description": "Sample Query captures metadata to be used for evaluation.",
"id": "GoogleCloudDiscoveryengineV1betaSampleQuery",
"properties": {
"createTime": {
"description": "Output only. Timestamp the SampleQuery was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"queryEntry": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry",
"description": "The query entry."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry": {
"description": "Query Entry captures metadata to be used for search evaluation.",
"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry",
"properties": {
"query": {
"description": "Required. The query.",
"type": "string"
},
"targets": {
"description": "List of targets for the query.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget": {
"description": "Defines the parameters of the query's expected outcome.",
"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget",
"properties": {
"pageNumbers": {
"description": "Expected page numbers of the target. Each page number must be non negative.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"score": {
"description": "Relevance score of the target.",
"format": "double",
"type": "number"
},
"uri": {
"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSampleQuerySet": {
"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.",
"id": "GoogleCloudDiscoveryengineV1betaSampleQuerySet",
"properties": {
"createTime": {
"description": "Output only. Timestamp the SampleQuerySet was created at.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The description of the SampleQuerySet.",
"type": "string"
},
"displayName": {
"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.",
"type": "string"
},
"name": {
"description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSchema": {
"description": "Defines the structure and layout of a type of document data.",
"id": "GoogleCloudDiscoveryengineV1betaSchema",
"properties": {
"jsonSchema": {
"description": "The JSON representation of the schema.",
"type": "string"
},
"name": {
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
"type": "string"
},
"structSchema": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The structured representation of the schema.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchInfo": {
"description": "Detailed search information.",
"id": "GoogleCloudDiscoveryengineV1betaSearchInfo",
"properties": {
"offset": {
"description": "An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"format": "int32",
"type": "integer"
},
"orderBy": {
"description": "The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
},
"searchQuery": {
"description": "The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
"description": "Promotion proto includes uri and other helping information to display the promotion.",
"id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
"properties": {
"description": {
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
"type": "string"
},
"document": {
"description": "Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.",
"type": "string"
},
"enabled": {
"description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
"type": "boolean"
},
"imageUri": {
"description": "Optional. The promotion thumbnail image url.",
"type": "string"
},
"title": {
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
"type": "string"
},
"uri": {
"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequest": {
"description": "Request message for SearchService.Search method.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
},
"branch": {
"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.",
"type": "string"
},
"canonicalFilter": {
"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.",
"type": "string"
},
"contentSearchSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
"description": "A specification for configuring the behavior of content search."
},
"dataStoreSpecs": {
"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
},
"type": "array"
},
"displaySpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
"description": "Optional. Config for display feature, like match highlighting on search results."
},
"embeddingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
},
"facetSpecs": {
"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec"
},
"type": "array"
},
"filter": {
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
},
"imageQuery": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery",
"description": "Raw image query."
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.",
"type": "string"
},
"naturalLanguageQueryUnderstandingSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
"offset": {
"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.",
"format": "int32",
"type": "integer"
},
"oneBoxPageSize": {
"description": "The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.",
"format": "int32",
"type": "integer"
},
"orderBy": {
"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
"type": "string"
},
"pageSize": {
"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
},
"params": {
"additionalProperties": {
"type": "any"
},
"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`",
"type": "object"
},
"personalizationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
"description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
},
"query": {
"description": "Raw search query.",
"type": "string"
},
"queryExpansionSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
},
"rankingExpression": {
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
"type": "string"
},
"rankingExpressionBackend": {
"description": "Optional. The backend to use for the ranking expression evaluation.",
"enum": [
"RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
"BYOE",
"CLEARBOX"
],
"enumDescriptions": [
"Default option for unspecified/unknown values.",
"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
"The expression is compiled into a Clearbox formula."
],
"type": "string"
},
"regionCode": {
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
"type": "string"
},
"relevanceScoreSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
"description": "Optional. The specification for returning the relevance score."
},
"relevanceThreshold": {
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
"enum": [
"RELEVANCE_THRESHOLD_UNSPECIFIED",
"LOWEST",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Default value. In this case, server behavior defaults to Google defined threshold.",
"Lowest relevance threshold.",
"Low relevance threshold.",
"Medium relevance threshold.",
"High relevance threshold."
],
"type": "string"
},
"safeSearch": {
"description": "Whether to turn on safe search. This is only supported for website search.",
"type": "boolean"
},
"searchAsYouTypeSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
},
"servingConfig": {
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
"type": "string"
},
"session": {
"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
"type": "string"
},
"sessionSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec",
"description": "Session specification. Can be used only when `session` is set."
},
"spellCorrectionSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
"description": "The spell correction specification that specifies the mode under which spell correction takes effect."
},
"userInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
"description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
},
"userLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
"type": "object"
},
"userPseudoId": {
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": {
"description": "Boost specification to boost certain documents.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
"properties": {
"conditionBoostSpecs": {
"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": {
"description": "Boost applies to documents which match a condition.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec",
"properties": {
"boost": {
"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.",
"format": "float",
"type": "number"
},
"boostControlSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
"description": "Complex specification for custom ranking based on customer defined attribute value."
},
"condition": {
"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": {
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
"properties": {
"attributeType": {
"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
"enum": [
"ATTRIBUTE_TYPE_UNSPECIFIED",
"NUMERICAL",
"FRESHNESS"
],
"enumDescriptions": [
"Unspecified AttributeType.",
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
],
"type": "string"
},
"controlPoints": {
"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint"
},
"type": "array"
},
"fieldName": {
"description": "The name of the field whose value will be used to determine the boost amount.",
"type": "string"
},
"interpolationType": {
"description": "The interpolation type to be applied to connect the control points listed below.",
"enum": [
"INTERPOLATION_TYPE_UNSPECIFIED",
"LINEAR"
],
"enumDescriptions": [
"Interpolation type is unspecified. In this case, it defaults to Linear.",
"Piecewise linear interpolation will be applied."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": {
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint",
"properties": {
"attributeValue": {
"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
"type": "string"
},
"boostAmount": {
"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": {
"description": "A specification for configuring the behavior of content search.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
"properties": {
"chunkSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec",
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
},
"extractiveContentSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec",
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
},
"searchResultMode": {
"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
"enum": [
"SEARCH_RESULT_MODE_UNSPECIFIED",
"DOCUMENTS",
"CHUNKS"
],
"enumDescriptions": [
"Default value.",
"Returns documents in the search result.",
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
],
"type": "string"
},
"snippetSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec",
"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
},
"summarySpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
"description": "If `summarySpec` is not specified, summaries are not included in the search response."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": {
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec",
"properties": {
"numNextChunks": {
"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
"format": "int32",
"type": "integer"
},
"numPreviousChunks": {
"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": {
"description": "A specification for configuring the extractive content in a search response.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec",
"properties": {
"maxExtractiveAnswerCount": {
"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.",
"format": "int32",
"type": "integer"
},
"maxExtractiveSegmentCount": {
"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
"format": "int32",
"type": "integer"
},
"numNextSegments": {
"description": "Return at most `num_next_segments` segments after each selected segments.",
"format": "int32",
"type": "integer"
},
"numPreviousSegments": {
"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
"format": "int32",
"type": "integer"
},
"returnExtractiveSegmentScore": {
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": {
"description": "A specification for configuring snippets in a search response.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec",
"properties": {
"maxSnippetCount": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
"format": "int32",
"type": "integer"
},
"referenceOnly": {
"deprecated": true,
"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
"type": "boolean"
},
"returnSnippet": {
"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": {
"description": "A specification for configuring a summary returned in a search response.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
"properties": {
"ignoreAdversarialQuery": {
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreJailBreakingQuery": {
"description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.",
"type": "boolean"
},
"ignoreLowRelevantContent": {
"description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.",
"type": "boolean"
},
"ignoreNonSummarySeekingQuery": {
"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.",
"type": "boolean"
},
"includeCitations": {
"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
"type": "boolean"
},
"languageCode": {
"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
"type": "string"
},
"modelPromptSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec",
"description": "If specified, the spec will be used to modify the prompt provided to the LLM."
},
"modelSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
},
"multimodalSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
"description": "Optional. Multimodal specification."
},
"summaryResultCount": {
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
"format": "int32",
"type": "integer"
},
"useSemanticChunks": {
"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
"description": "Specification of the prompt to use with the model.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec",
"properties": {
"preamble": {
"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": {
"description": "Specification of the model.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
"properties": {
"version": {
"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
"properties": {
"imageSource": {
"description": "Optional. Source of image returned in the answer.",
"enum": [
"IMAGE_SOURCE_UNSPECIFIED",
"ALL_AVAILABLE_SOURCES",
"CORPUS_IMAGE_ONLY",
"FIGURE_GENERATION_ONLY"
],
"enumDescriptions": [
"Unspecified image source (multimodal feature is disabled by default).",
"Behavior when service determines the pick from all available sources.",
"Includes image from corpus in the answer.",
"Triggers figure generation in the answer."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
"properties": {
"boostSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
"description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
},
"dataStore": {
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
"type": "string"
},
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": {
"description": "Specifies features for display, like match highlighting.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
"properties": {
"matchHighlightingCondition": {
"description": "The condition under which match highlighting should occur.",
"enum": [
"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
"MATCH_HIGHLIGHTING_DISABLED",
"MATCH_HIGHLIGHTING_ENABLED"
],
"enumDescriptions": [
"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
"Disables match highlighting on all documents.",
"Enables match highlighting on all documents."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
"description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
"properties": {
"embeddingVectors": {
"description": "The embedding vector used for retrieval. Limit to 1.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": {
"description": "Embedding vector.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector",
"properties": {
"fieldPath": {
"description": "Embedding field path in schema.",
"type": "string"
},
"vector": {
"description": "Query embedding vector.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": {
"description": "A facet specification to perform faceted search.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec",
"properties": {
"enableDynamicPosition": {
"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.",
"type": "boolean"
},
"excludedFilterKeys": {
"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"items": {
"type": "string"
},
"type": "array"
},
"facetKey": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey",
"description": "Required. The facet key specification."
},
"limit": {
"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": {
"description": "Specifies how a facet is computed.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey",
"properties": {
"caseInsensitive": {
"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.",
"type": "boolean"
},
"contains": {
"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.",
"items": {
"type": "string"
},
"type": "array"
},
"intervals": {
"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaInterval"
},
"type": "array"
},
"key": {
"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.",
"type": "string"
},
"orderBy": {
"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.",
"type": "string"
},
"prefixes": {
"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.",
"items": {
"type": "string"
},
"type": "array"
},
"restrictedValues": {
"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": {
"description": "Specifies the image query input.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery",
"properties": {
"imageBytes": {
"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": {
"description": "Specification to enable natural language understanding capabilities for search requests.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"properties": {
"filterExtractionCondition": {
"description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.",
"enum": [
"CONDITION_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"Server behavior defaults to `DISABLED`.",
"Disables NL filter extraction.",
"Enables NL filter extraction."
],
"type": "string"
},
"geoSearchQueryDetectionFieldNames": {
"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": {
"description": "The specification for personalization.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
"properties": {
"mode": {
"description": "The personalization mode of the search request. Defaults to Mode.AUTO.",
"enum": [
"MODE_UNSPECIFIED",
"AUTO",
"DISABLED"
],
"enumDescriptions": [
"Default value. In this case, server behavior defaults to Mode.AUTO.",
"Personalization is enabled if data quality requirements are met.",
"Disable personalization."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": {
"description": "Specification to determine under which conditions query expansion should occur.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",
"properties": {
"condition": {
"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.",
"enum": [
"CONDITION_UNSPECIFIED",
"DISABLED",
"AUTO"
],
"enumDescriptions": [
"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.",
"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.",
"Automatic query expansion built by the Search API."
],
"type": "string"
},
"pinUnexpandedResults": {
"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
"description": "The specification for returning the document relevance score.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
"properties": {
"returnRelevanceScore": {
"description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
"description": "Specification for search as you type in search requests.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
"properties": {
"condition": {
"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.",
"enum": [
"CONDITION_UNSPECIFIED",
"DISABLED",
"ENABLED",
"AUTO"
],
"enumDescriptions": [
"Server behavior defaults to Condition.DISABLED.",
"Disables Search As You Type.",
"Enables Search As You Type.",
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": {
"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec",
"properties": {
"queryId": {
"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.",
"type": "string"
},
"searchResultPersistenceCount": {
"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": {
"description": "The specification for query spell correction.",
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
"properties": {
"mode": {
"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
"enum": [
"MODE_UNSPECIFIED",
"SUGGESTION_ONLY",
"AUTO"
],
"enumDescriptions": [
"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.",
"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.",
"Automatic spell correction built by the Search API. Search will be based on the corrected query if found."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponse": {
"description": "Response message for SearchService.Search method.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponse",
"properties": {
"appliedControls": {
"description": "Controls applied as part of the Control service.",
"items": {
"type": "string"
},
"type": "array"
},
"attributionToken": {
"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.",
"type": "string"
},
"correctedQuery": {
"description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.",
"type": "string"
},
"facets": {
"description": "Results of facets requested by user.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseFacet"
},
"type": "array"
},
"geoSearchDebugInfo": {
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo"
},
"type": "array"
},
"guidedSearchResult": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult",
"description": "Guided search result."
},
"naturalLanguageQueryUnderstandingInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo",
"description": "Natural language query understanding information for the returned results."
},
"nextPageToken": {
"description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"oneBoxResults": {
"description": "A list of One Box results. There can be multiple One Box results of different types.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult"
},
"type": "array"
},
"queryExpansionInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo",
"description": "Query expansion information for the returned results."
},
"redirectUri": {
"description": "The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.",
"type": "string"
},
"results": {
"description": "A list of matched documents. The order represents the ranking.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult"
},
"type": "array"
},
"searchLinkPromotions": {
"description": "Promotions for site search.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion"
},
"type": "array"
},
"sessionInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo",
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
},
"suggestedQuery": {
"description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).",
"type": "string"
},
"summary": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
"description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set."
},
"totalSize": {
"description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseFacet": {
"description": "A facet result.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseFacet",
"properties": {
"dynamicFacet": {
"description": "Whether the facet is dynamically generated.",
"type": "boolean"
},
"key": {
"description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.",
"type": "string"
},
"values": {
"description": "The facet values for this field.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue": {
"description": "A facet value which contains value names and their count.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue",
"properties": {
"count": {
"description": "Number of items that have this facet value.",
"format": "int64",
"type": "string"
},
"interval": {
"$ref": "GoogleCloudDiscoveryengineV1betaInterval",
"description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals."
},
"value": {
"description": "Text value of a facet, such as \"Black\" for facet \"colors\".",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo": {
"description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo",
"properties": {
"errorMessage": {
"description": "The error produced.",
"type": "string"
},
"originalAddressQuery": {
"description": "The address from which forward geocoding ingestion produced issues.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult": {
"description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult",
"properties": {
"followUpQuestions": {
"description": "Suggested follow-up questions.",
"items": {
"type": "string"
},
"type": "array"
},
"refinementAttributes": {
"description": "A list of ranked refinement attributes.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute": {
"description": "Useful attribute for search result refinements.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute",
"properties": {
"attributeKey": {
"description": "Attribute key used to refine the results. For example, `\"movie_type\"`.",
"type": "string"
},
"attributeValue": {
"description": "Attribute value used to refine the results. For example, `\"drama\"`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo": {
"description": "Information describing what natural language understanding was done on the input query.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo",
"properties": {
"classifiedIntents": {
"description": "The classified intents from the input query.",
"items": {
"type": "string"
},
"type": "array"
},
"extractedFilters": {
"description": "The filters that were extracted from the input query.",
"type": "string"
},
"rewrittenQuery": {
"description": "Rewritten input query minus the extracted filters.",
"type": "string"
},
"sqlRequest": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
"description": "Optional. The SQL request that was generated from the natural language query understanding phase."
},
"structuredExtractedFilter": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
"description": "The filters that were extracted from the input query represented in a structured form."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": {
"description": "The SQL request that was generated from the natural language query understanding phase.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
"properties": {
"sqlQuery": {
"description": "Optional. The SQL query in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": {
"description": "The filters that were extracted from the input query represented in a structured form.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
"properties": {
"expression": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression",
"description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": {
"description": "Logical `And` operator.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression",
"properties": {
"expressions": {
"description": "The expressions that were ANDed together.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": {
"description": "The expression denoting the filter that was extracted from the input query.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression",
"properties": {
"andExpr": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression",
"description": "Logical \"And\" compound operator connecting multiple expressions."
},
"geolocationConstraint": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint",
"description": "Geolocation constraint expression."
},
"numberConstraint": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint",
"description": "Numerical constraint expression."
},
"orExpr": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression",
"description": "Logical \"Or\" compound operator connecting multiple expressions."
},
"stringConstraint": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint",
"description": "String constraint expression."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": {
"description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint",
"properties": {
"address": {
"description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.",
"type": "string"
},
"fieldName": {
"description": "The name of the geolocation field as defined in the schema.",
"type": "string"
},
"latitude": {
"description": "The latitude of the geolocation inferred from the input query.",
"format": "double",
"type": "number"
},
"longitude": {
"description": "The longitude of the geolocation inferred from the input query.",
"format": "double",
"type": "number"
},
"radiusInMeters": {
"description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": {
"description": "Constraint expression of a number field. Example: price < 100.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint",
"properties": {
"comparison": {
"description": "The comparison operation performed between the field value and the value specified in the constraint.",
"enum": [
"COMPARISON_UNSPECIFIED",
"EQUALS",
"LESS_THAN_EQUALS",
"LESS_THAN",
"GREATER_THAN_EQUALS",
"GREATER_THAN"
],
"enumDescriptions": [
"Undefined comparison operator.",
"Denotes equality `=` operator.",
"Denotes less than or equal to `<=` operator.",
"Denotes less than `<` operator.",
"Denotes greater than or equal to `>=` operator.",
"Denotes greater than `>` operator."
],
"type": "string"
},
"fieldName": {
"description": "Name of the numerical field as defined in the schema.",
"type": "string"
},
"querySegment": {
"description": "Identifies the keywords within the search query that match a filter.",
"type": "string"
},
"value": {
"description": "The value specified in the numerical constraint.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": {
"description": "Logical `Or` operator.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression",
"properties": {
"expressions": {
"description": "The expressions that were ORed together.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": {
"description": "Constraint expression of a string field.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint",
"properties": {
"fieldName": {
"description": "Name of the string field as defined in the schema.",
"type": "string"
},
"querySegment": {
"description": "Identifies the keywords within the search query that match a filter.",
"type": "string"
},
"values": {
"description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult": {
"description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult",
"properties": {
"oneBoxType": {
"description": "The type of One Box result.",
"enum": [
"ONE_BOX_TYPE_UNSPECIFIED",
"PEOPLE",
"ORGANIZATION",
"SLACK",
"KNOWLEDGE_GRAPH"
],
"enumDescriptions": [
"Default value. Should not be used.",
"One Box result contains people results.",
"One Box result contains organization results.",
"One Box result contains slack results.",
"One Box result contains Knowledge Graph search responses."
],
"type": "string"
},
"searchResults": {
"description": "The search results for this One Box.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo": {
"description": "Information describing query expansion including whether expansion has occurred.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo",
"properties": {
"expandedQuery": {
"description": "Bool describing whether query expansion has occurred.",
"type": "boolean"
},
"pinnedResultCount": {
"description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult": {
"description": "Represents the search results.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult",
"properties": {
"chunk": {
"$ref": "GoogleCloudDiscoveryengineV1betaChunk",
"description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS."
},
"document": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
"description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated."
},
"id": {
"description": "Document.id of the searched Document.",
"type": "string"
},
"modelScores": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1betaDoubleList"
},
"description": "Output only. Google provided available scores.",
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo": {
"description": "Information about the session.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo",
"properties": {
"name": {
"description": "Name of the session. If the auto-session mode is used (when SearchRequest.session ends with \"-\"), this field holds the newly generated session name.",
"type": "string"
},
"queryId": {
"description": "Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummary": {
"description": "Summary of the top N search results specified by the summary spec.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
"properties": {
"safetyAttributes": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes",
"description": "A collection of Safety Attribute categories and their associated confidence scores."
},
"summarySkippedReasons": {
"description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.",
"items": {
"enum": [
"SUMMARY_SKIPPED_REASON_UNSPECIFIED",
"ADVERSARIAL_QUERY_IGNORED",
"NON_SUMMARY_SEEKING_QUERY_IGNORED",
"OUT_OF_DOMAIN_QUERY_IGNORED",
"POTENTIAL_POLICY_VIOLATION",
"LLM_ADDON_NOT_ENABLED",
"NO_RELEVANT_CONTENT",
"JAIL_BREAKING_QUERY_IGNORED",
"CUSTOMER_POLICY_VIOLATION",
"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2",
"TIME_OUT"
],
"enumDescriptions": [
"Default value. The summary skipped reason is not specified.",
"The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.",
"The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.",
"The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.",
"The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.",
"The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.",
"The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.",
"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.",
"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.",
"The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`.",
"The time out case. Google skips the summary if the time out."
],
"type": "string"
},
"type": "array"
},
"summaryText": {
"description": "The summary content.",
"type": "string"
},
"summaryWithMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata",
"description": "Summary with metadata information."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment": {
"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment",
"properties": {
"attributionType": {
"description": "Output only. The attribution type of the blob.",
"enum": [
"ATTRIBUTION_TYPE_UNSPECIFIED",
"CORPUS",
"GENERATED"
],
"enumDescriptions": [
"Unspecified attribution type.",
"The attachment data is from the corpus.",
"The attachment data is generated by the model through code generation."
],
"readOnly": true,
"type": "string"
},
"data": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob",
"description": "Output only. The blob data.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob": {
"description": "Stores type and data of the blob.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob",
"properties": {
"data": {
"description": "Output only. Raw bytes.",
"format": "byte",
"readOnly": true,
"type": "string"
},
"mimeType": {
"description": "Output only. The media type (MIME type) of the generated data.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation": {
"description": "Citation info for a segment.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation",
"properties": {
"endIndex": {
"description": "End of the attributed segment, exclusive.",
"format": "int64",
"type": "string"
},
"sources": {
"description": "Citation sources for the attributed segment.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource"
},
"type": "array"
},
"startIndex": {
"description": "Index indicates the start of the segment, measured in bytes/unicode.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata": {
"description": "Citation metadata.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata",
"properties": {
"citations": {
"description": "Citations for segments.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource": {
"description": "Citation source.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource",
"properties": {
"referenceIndex": {
"description": "Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference": {
"description": "Document reference.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference",
"properties": {
"chunkContents": {
"description": "List of cited chunk contents derived from document content.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent"
},
"type": "array"
},
"document": {
"description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
"type": "string"
},
"title": {
"description": "Title of the document.",
"type": "string"
},
"uri": {
"description": "Cloud Storage or HTTP uri for the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent": {
"description": "Chunk content.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent",
"properties": {
"blobAttachmentIndexes": {
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"content": {
"description": "Chunk textual content.",
"type": "string"
},
"pageIdentifier": {
"description": "Page identifier.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes": {
"description": "Safety Attribute categories and their associated confidence scores.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes",
"properties": {
"categories": {
"description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.",
"items": {
"type": "string"
},
"type": "array"
},
"scores": {
"description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata": {
"description": "Summary with metadata information.",
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata",
"properties": {
"blobAttachments": {
"description": "Output only. Store multimodal data for answer enhancement.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment"
},
"readOnly": true,
"type": "array"
},
"citationMetadata": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata",
"description": "Citation metadata for given summary."
},
"references": {
"description": "Document References.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference"
},
"type": "array"
},
"summary": {
"description": "Summary text with no citation information.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaServingConfig": {
"description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.",
"id": "GoogleCloudDiscoveryengineV1betaServingConfig",
"properties": {
"answerGenerationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerGenerationSpec",
"description": "Optional. The specification for answer generation."
},
"boostControlIds": {
"description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "Output only. ServingConfig created timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
"type": "string"
},
"dissociateControlIds": {
"description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"diversityLevel": {
"description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"type": "string"
},
"embeddingConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaEmbeddingConfig",
"description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config."
},
"filterControlIds": {
"description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.",
"items": {
"type": "string"
},
"type": "array"
},
"genericConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig",
"description": "The GenericConfig of the serving configuration."
},
"ignoreControlIds": {
"description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.",
"items": {
"type": "string"
},
"type": "array"
},
"mediaConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig",
"description": "The MediaConfig of the serving configuration."
},
"modelId": {
"description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"type": "string"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
"type": "string"
},
"onewaySynonymsControlIds": {
"description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"personalizationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
"description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
},
"promoteControlIds": {
"description": "Condition promote specifications. Maximum number of specifications is 100.",
"items": {
"type": "string"
},
"type": "array"
},
"rankingExpression": {
"description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
"type": "string"
},
"redirectControlIds": {
"description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"replacementControlIds": {
"description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"solutionType": {
"description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
"enum": [
"SOLUTION_TYPE_UNSPECIFIED",
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
"SOLUTION_TYPE_GENERATIVE_CHAT"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
],
"type": "string"
},
"synonymsControlIds": {
"description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
"items": {
"type": "string"
},
"type": "array"
},
"updateTime": {
"description": "Output only. ServingConfig updated timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig": {
"description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
"id": "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig",
"properties": {
"contentSearchSpec": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
"description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig": {
"description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"id": "GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig",
"properties": {
"contentFreshnessCutoffDays": {
"description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
"format": "int32",
"type": "integer"
},
"contentWatchedPercentageThreshold": {
"description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
"format": "float",
"type": "number"
},
"contentWatchedSecondsThreshold": {
"description": "Specifies the content watched minutes threshold for demotion.",
"format": "float",
"type": "number"
},
"demoteContentWatchedPastDays": {
"description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.",
"format": "int32",
"type": "integer"
},
"demotionEventType": {
"description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSession": {
"description": "External session proto definition.",
"id": "GoogleCloudDiscoveryengineV1betaSession",
"properties": {
"displayName": {
"description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.",
"type": "string"
},
"endTime": {
"description": "Output only. The time the session finished.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"isPinned": {
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
"type": "boolean"
},
"name": {
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
"type": "string"
},
"startTime": {
"description": "Output only. The time the session started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "The state of the session.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS"
],
"enumDescriptions": [
"State is unspecified.",
"The session is currently open."
],
"type": "string"
},
"turns": {
"description": "Turns.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaSessionTurn"
},
"type": "array"
},
"userPseudoId": {
"description": "A unique identifier for tracking users.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSessionTurn": {
"description": "Represents a turn, including a query from the user and a answer from service.",
"id": "GoogleCloudDiscoveryengineV1betaSessionTurn",
"properties": {
"answer": {
"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
"type": "string"
},
"detailedAnswer": {
"$ref": "GoogleCloudDiscoveryengineV1betaAnswer",
"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
"readOnly": true
},
"query": {
"$ref": "GoogleCloudDiscoveryengineV1betaQuery",
"description": "The user query."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": {
"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest": {
"description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.",
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest",
"properties": {
"crawlRate": {
"description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.",
"format": "int32",
"type": "integer"
},
"crawlRateScope": {
"description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
"type": "string"
},
"crawlType": {
"description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.",
"enum": [
"CRAWL_TYPE_UNSPECIFIED",
"USER_TRIGGERED",
"AUTO_REFRESH"
],
"enumDescriptions": [
"The crawl type is unspecified.",
"The crawl type is user-triggered.",
"The crawl type is auto-refresh."
],
"type": "string"
},
"mode": {
"description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.",
"enum": [
"MODE_UNSPECIFIED",
"AUTOMATIC",
"EXPLICIT"
],
"enumDescriptions": [
"The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.",
"Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.",
"Users explicitly set user-triggered or auto-refresh crawl rate."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": {
"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse",
"properties": {
"error": {
"$ref": "GoogleRpcStatus",
"description": "Errors from service when handling the request."
},
"state": {
"description": "Output only. The state of the response.",
"enum": [
"STATE_UNSPECIFIED",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state is unspecified.",
"The state is successful.",
"The state is failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
"description": "Metadata for single-regional CMEKs.",
"id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",
"properties": {
"kmsKey": {
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSiteSearchEngine": {
"description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.",
"id": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine",
"properties": {
"name": {
"description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": {
"description": "Verification information for target sites in advanced site search.",
"id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo",
"properties": {
"siteVerificationState": {
"description": "Site verification state indicating the ownership and validity.",
"enum": [
"SITE_VERIFICATION_STATE_UNSPECIFIED",
"VERIFIED",
"UNVERIFIED",
"EXEMPTED"
],
"enumDescriptions": [
"Defaults to VERIFIED.",
"Site ownership verified.",
"Site ownership pending verification or verification failed.",
"Site exempt from verification, e.g., a public website that opens to all."
],
"type": "string"
},
"verifyTime": {
"description": "Latest site verification time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSitemap": {
"description": "A sitemap for the SiteSearchEngine.",
"id": "GoogleCloudDiscoveryengineV1betaSitemap",
"properties": {
"createTime": {
"description": "Output only. The sitemap's creation time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSpannerSource": {
"description": "The Spanner source for importing data",
"id": "GoogleCloudDiscoveryengineV1betaSpannerSource",
"properties": {
"databaseId": {
"description": "Required. The database ID of the source Spanner table.",
"type": "string"
},
"enableDataBoost": {
"description": "Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).",
"type": "boolean"
},
"instanceId": {
"description": "Required. The instance ID of the source Spanner table.",
"type": "string"
},
"projectId": {
"description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
"type": "string"
},
"tableId": {
"description": "Required. The table name of the Spanner database that needs to be imported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry": {
"description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.",
"id": "GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry",
"properties": {
"blockPhrase": {
"description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.",
"type": "string"
},
"matchOperator": {
"description": "Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.",
"enum": [
"MATCH_OPERATOR_UNSPECIFIED",
"EXACT_MATCH",
"CONTAINS"
],
"enumDescriptions": [
"Default value. Should not be used",
"If the suggestion is an exact match to the block_phrase, then block it.",
"If the suggestion contains the block_phrase, then block it."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTargetSite": {
"description": "A target site for the SiteSearchEngine.",
"id": "GoogleCloudDiscoveryengineV1betaTargetSite",
"properties": {
"exactMatch": {
"description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
"type": "boolean"
},
"failureReason": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason",
"description": "Output only. Failure reason.",
"readOnly": true
},
"generatedUriPattern": {
"description": "Output only. This is system-generated based on the provided_uri_pattern.",
"readOnly": true,
"type": "string"
},
"indexingStatus": {
"description": "Output only. Indexing status.",
"enum": [
"INDEXING_STATUS_UNSPECIFIED",
"PENDING",
"FAILED",
"SUCCEEDED",
"DELETING",
"CANCELLABLE",
"CANCELLED"
],
"enumDescriptions": [
"Defaults to SUCCEEDED.",
"The target site is in the update queue and will be picked up by indexing pipeline.",
"The target site fails to be indexed.",
"The target site has been indexed.",
"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.",
"The target site change is pending but cancellable.",
"The target site change is cancelled."
],
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.",
"readOnly": true,
"type": "string"
},
"providedUriPattern": {
"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.",
"type": "string"
},
"rootDomainUri": {
"description": "Output only. Root domain of the provided_uri_pattern.",
"readOnly": true,
"type": "string"
},
"siteVerificationInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo",
"description": "Output only. Site ownership and validity verification status.",
"readOnly": true
},
"type": {
"description": "The type of the target site, e.g., whether the site is to be included or excluded.",
"enum": [
"TYPE_UNSPECIFIED",
"INCLUDE",
"EXCLUDE"
],
"enumDescriptions": [
"This value is unused. In this case, server behavior defaults to Type.INCLUDE.",
"Include the target site.",
"Exclude the target site."
],
"type": "string"
},
"updateTime": {
"description": "Output only. The target site's last updated time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason": {
"description": "Site search indexing failure reasons.",
"id": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason",
"properties": {
"quotaFailure": {
"$ref": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure",
"description": "Failed due to insufficient quota."
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure": {
"description": "Failed due to insufficient quota.",
"id": "GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure",
"properties": {
"totalRequiredQuota": {
"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTextInput": {
"description": "Defines text input.",
"id": "GoogleCloudDiscoveryengineV1betaTextInput",
"properties": {
"context": {
"$ref": "GoogleCloudDiscoveryengineV1betaConversationContext",
"description": "Conversation context of the input."
},
"input": {
"description": "Text input.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata": {
"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest": {
"description": "Request message for SearchTuningService.TrainCustomModel method.",
"id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "The desired location of errors incurred during the data ingestion and training."
},
"gcsTrainingInput": {
"$ref": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput",
"description": "Cloud Storage training input."
},
"modelId": {
"description": "If not provided, a UUID will be generated.",
"type": "string"
},
"modelType": {
"description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput": {
"description": "Cloud Storage training data input.",
"id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput",
"properties": {
"corpusDataPath": {
"description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`",
"type": "string"
},
"queryDataPath": {
"description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}",
"type": "string"
},
"testDataPath": {
"description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.",
"type": "string"
},
"trainDataPath": {
"description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse": {
"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.",
"id": "GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse",
"properties": {
"errorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
"description": "Echoes the destination for the complete errors in the request if set."
},
"errorSamples": {
"description": "A sample of errors encountered while processing the data.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"metrics": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"description": "The metrics of the trained model.",
"type": "object"
},
"modelName": {
"description": "Fully qualified name of the CustomTuningModel.",
"type": "string"
},
"modelStatus": {
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTransactionInfo": {
"description": "A transaction represents the entire purchase transaction.",
"id": "GoogleCloudDiscoveryengineV1betaTransactionInfo",
"properties": {
"cost": {
"description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost",
"format": "float",
"type": "number"
},
"currency": {
"description": "Required. Currency code. Use three-character ISO-4217 code.",
"type": "string"
},
"discountValue": {
"description": "The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost",
"format": "float",
"type": "number"
},
"tax": {
"description": "All the taxes associated with the transaction.",
"format": "float",
"type": "number"
},
"transactionId": {
"description": "The transaction ID with a length limit of 128 characters.",
"type": "string"
},
"value": {
"description": "Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTuneEngineMetadata": {
"description": "Metadata associated with a tune operation.",
"id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata",
"properties": {
"engine": {
"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTuneEngineRequest": {
"description": "Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).",
"id": "GoogleCloudDiscoveryengineV1betaTuneEngineRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaTuneEngineResponse": {
"description": "Response associated with a tune operation.",
"id": "GoogleCloudDiscoveryengineV1betaTuneEngineResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": {
"description": "Metadata for UpdateSchema LRO.",
"id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata",
"properties": {
"createTime": {
"description": "Operation create time.",
"format": "google-datetime",
"type": "string"
},
"updateTime": {
"description": "Operation last update time. If the operation is done, this is also the finish time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaUserEvent": {
"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.",
"id": "GoogleCloudDiscoveryengineV1betaUserEvent",
"properties": {
"attributes": {
"additionalProperties": {
"$ref": "GoogleCloudDiscoveryengineV1betaCustomAttribute"
},
"description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.",
"type": "object"
},
"attributionToken": {
"description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.",
"type": "string"
},
"completionInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
"description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search."
},
"conversionType": {
"description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.",
"type": "string"
},
"dataStore": {
"description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.",
"type": "string"
},
"directUserRequest": {
"description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.",
"type": "boolean"
},
"documents": {
"description": "List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentInfo"
},
"type": "array"
},
"engine": {
"description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.",
"type": "string"
},
"eventTime": {
"description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.",
"format": "google-datetime",
"type": "string"
},
"eventType": {
"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.",
"type": "string"
},
"filter": {
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
},
"mediaInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaMediaInfo",
"description": "Media-specific info."
},
"pageInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaPageInfo",
"description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`."
},
"panel": {
"$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo",
"description": "Panel metadata associated with this user event."
},
"panels": {
"description": "Optional. List of panels associated with this event. Used for page-level impression data.",
"items": {
"$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo"
},
"type": "array"
},
"promotionIds": {
"description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.",
"items": {
"type": "string"
},
"type": "array"
},
"searchInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaSearchInfo",
"description": "SearchService.Search details related to the event. This field should be set for `search` event."
},
"sessionId": {
"description": "A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.",
"type": "string"
},
"tagIds": {
"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.",
"items": {
"type": "string"
},
"type": "array"
},
"transactionInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaTransactionInfo",
"description": "The transaction metadata (if any) associated with this user event."
},
"userInfo": {
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
"description": "Information about the end user."
},
"userPseudoId": {
"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaUserInfo": {
"description": "Information of an end user.",
"id": "GoogleCloudDiscoveryengineV1betaUserInfo",
"properties": {
"timeZone": {
"description": "Optional. IANA time zone, e.g. Europe/Budapest.",
"type": "string"
},
"userAgent": {
"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
"type": "string"
},
"userId": {
"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDiscoveryengineV1betaWorkspaceConfig": {
"description": "Config to store data store type configuration for workspace data",
"id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
"properties": {
"dasherCustomerId": {
"description": "Obfuscated Dasher customer ID.",
"type": "string"
},
"superAdminEmailAddress": {
"description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
"type": "string"
},
"superAdminServiceAccount": {
"description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
"type": "string"
},
"type": {
"description": "The Google Workspace data source.",
"enum": [
"TYPE_UNSPECIFIED",
"GOOGLE_DRIVE",
"GOOGLE_MAIL",
"GOOGLE_SITES",
"GOOGLE_CALENDAR",
"GOOGLE_CHAT",
"GOOGLE_GROUPS",
"GOOGLE_KEEP",
"GOOGLE_PEOPLE"
],
"enumDescriptions": [
"Defaults to an unspecified Workspace type.",
"Workspace Data Store contains Drive data",
"Workspace Data Store contains Mail data",
"Workspace Data Store contains Sites data",
"Workspace Data Store contains Calendar data",
"Workspace Data Store contains Chat data",
"Workspace Data Store contains Groups data",
"Workspace Data Store contains Keep data",
"Workspace Data Store contains People data"
],
"type": "string"
}
},
"type": "object"
},
"GoogleLongrunningCancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "GoogleLongrunningCancelOperationRequest",
"properties": {},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "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.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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.",
"type": "object"
},
"name": {
"description": "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}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. 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`.",
"type": "object"
}
},
"type": "object"
},
"GoogleMonitoringV3Point": {
"description": "A single data point in a time series.",
"id": "GoogleMonitoringV3Point",
"properties": {
"interval": {
"$ref": "GoogleMonitoringV3TimeInterval",
"description": "The time interval to which the data point applies. For `GAUGE` metrics, the start time is optional, but if it is supplied, it must equal the end time. For `DELTA` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For `CUMULATIVE` metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
},
"value": {
"$ref": "GoogleMonitoringV3TypedValue",
"description": "The value of the data point."
}
},
"type": "object"
},
"GoogleMonitoringV3TimeInterval": {
"description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
"id": "GoogleMonitoringV3TimeInterval",
"properties": {
"endTime": {
"description": "Required. The end of the time interval.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleMonitoringV3TimeSeries": {
"description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
"id": "GoogleMonitoringV3TimeSeries",
"properties": {
"description": {
"description": "Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.",
"type": "string"
},
"metadata": {
"$ref": "GoogleApiMonitoredResourceMetadata",
"description": "Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored."
},
"metric": {
"$ref": "GoogleApiMetric",
"description": "The associated metric. A fully-specified metric used to identify the time series."
},
"metricKind": {
"description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`.",
"enum": [
"METRIC_KIND_UNSPECIFIED",
"GAUGE",
"DELTA",
"CUMULATIVE"
],
"enumDescriptions": [
"Do not use this default value.",
"An instantaneous measurement of a value.",
"The change in a value during a time interval.",
"A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
],
"type": "string"
},
"points": {
"description": "The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.",
"items": {
"$ref": "GoogleMonitoringV3Point"
},
"type": "array"
},
"resource": {
"$ref": "GoogleApiMonitoredResource",
"description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see [Monitored resources for custom metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources)."
},
"unit": {
"description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.",
"type": "string"
},
"valueType": {
"description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the type of the data in the `points` field.",
"enum": [
"VALUE_TYPE_UNSPECIFIED",
"BOOL",
"INT64",
"DOUBLE",
"STRING",
"DISTRIBUTION",
"MONEY"
],
"enumDescriptions": [
"Do not use this default value.",
"The value is a boolean. This value type can be used only if the metric kind is `GAUGE`.",
"The value is a signed 64-bit integer.",
"The value is a double precision floating point number.",
"The value is a text string. This value type can be used only if the metric kind is `GAUGE`.",
"The value is a `Distribution`.",
"The value is money."
],
"type": "string"
}
},
"type": "object"
},
"GoogleMonitoringV3TypedValue": {
"description": "A single strongly-typed value.",
"id": "GoogleMonitoringV3TypedValue",
"properties": {
"boolValue": {
"description": "A Boolean value: `true` or `false`.",
"type": "boolean"
},
"distributionValue": {
"$ref": "GoogleApiDistribution",
"description": "A distribution value."
},
"doubleValue": {
"description": "A 64-bit double-precision floating-point number. Its magnitude is approximately \u00b110\u00b1300 and it has 16 significant digits of precision.",
"format": "double",
"type": "number"
},
"int64Value": {
"description": "A 64-bit integer. Its range is approximately \u00b19.2x1018.",
"format": "int64",
"type": "string"
},
"stringValue": {
"description": "A variable-length string value.",
"type": "string"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "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); }",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "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).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "GoogleTypeDate",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeDateTime": {
"description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
"id": "GoogleTypeDateTime",
"properties": {
"day": {
"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.",
"format": "int32",
"type": "integer"
},
"hours": {
"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
},
"timeZone": {
"$ref": "GoogleTypeTimeZone",
"description": "Time zone."
},
"utcOffset": {
"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
"format": "google-duration",
"type": "string"
},
"year": {
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeTimeZone": {
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "GoogleTypeTimeZone",
"properties": {
"id": {
"description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
"type": "string"
},
"version": {
"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Discovery Engine API",
"version": "v1beta",
"version_module": true
}