2024-04-11
▼ ▲ discoveryengine.projects.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataConnector.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataConnector.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.completeQuery
Path: v1/{+dataStore}:completeQuery
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery
HTTP Method: GET
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`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
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
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
Parameter Order: dataStore
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Completes the specified user input with keyword suggestions.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.create
Path: v1/{+parent}/dataStores
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
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
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.list
Path: v1/{+parent}/dataStores
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: integer
Format: int32
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
filter
Description: Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all the DataStores associated with the project.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}
HTTP Method: PATCH
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a DataStore
▼ ▲ discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the SiteSearchEngine.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Document.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.list
Path: v1/{+parent}/documents
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of Documents 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.
Location: query
Type: integer
Format: int32
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of Documents.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.create
Path: v1/{+parent}/documents
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
documentId
Description: Required. The ID to use for the Document, which will become 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 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Document.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
HTTP Method: PATCH
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
allowMissing
Description: If set to true, and the Document is not found, a new Document will be created.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Document.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Document.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.import
Path: v1/{+parent}/documents:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.purge
Path: v1/{+parent}/documents:purge
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.models.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.models.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import
Path: v1/{+parent}/suggestionDenyListEntries:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import
HTTP Method: POST
Parameters:
parent
Description: Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Imports all SuggestionDenyListEntry for a DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge
Path: v1/{+parent}/suggestionDenyListEntries:purge
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge
HTTP Method: POST
Parameters:
parent
Description: Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Permanently deletes all SuggestionDenyListEntry for a DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.search
Path: v1/{+servingConfig}:search
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: servingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Performs a search.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend
Path: v1/{+servingConfig}:recommend
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend
HTTP Method: POST
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 will be 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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: servingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Makes a recommendation, which requires a contextual user event.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.conversations.converse
Path: v1/{+name}:converse
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse
HTTP Method: POST
Parameters:
name
Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Converses a conversation.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.conversations.create
Path: v1/{+parent}/conversations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations
HTTP Method: POST
Parameters:
parent
Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.conversations.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.conversations.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.conversations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Conversation.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.conversations.list
Path: v1/{+parent}/conversations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations
HTTP Method: GET
Parameters:
parent
Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
Location: query
Type: string
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Conversations by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}
HTTP Method: GET
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Schema.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.list
Path: v1/{+parent}/schemas
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas
HTTP Method: GET
Parameters:
parent
Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of Schemas.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.create
Path: v1/{+parent}/schemas
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas
HTTP Method: POST
Parameters:
parent
Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
schemaId
Description: Required. The ID to use for the Schema, which will become 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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Schema.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}
HTTP Method: PATCH
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
allowMissing
Description: If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Schema.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}
HTTP Method: DELETE
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Schema.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.schemas.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch
Path: v1/{+siteSearchEngine}:enableAdvancedSiteSearch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch
HTTP Method: POST
Parameters:
siteSearchEngine
Description: Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Upgrade from basic site search to advanced site search.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch
Path: v1/{+siteSearchEngine}:disableAdvancedSiteSearch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch
HTTP Method: POST
Parameters:
siteSearchEngine
Description: Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Downgrade from advanced site search to basic site search.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris
Path: v1/{+siteSearchEngine}:recrawlUris
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris
HTTP Method: POST
Parameters:
siteSearchEngine
Description: Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Request on-demand recrawl for a list of URIs.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites
Path: v1/{+parent}:batchVerifyTargetSites
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource shared by all TargetSites being verified. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus
Path: v1/{+siteSearchEngine}:fetchDomainVerificationStatus
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus
HTTP Method: GET
Parameters:
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`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
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.
Location: query
Type: integer
Format: int32
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
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create
Path: v1/{+parent}/targetSites
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method: POST
Parameters:
parent
Description: Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate
Path: v1/{+parent}/targetSites:batchCreate
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates TargetSite in a batch.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method: PATCH
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list
Path: v1/{+parent}/targetSites
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
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.
Location: query
Type: integer
Format: int32
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of TargetSites.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.write
Path: v1/{+parent}/userEvents:write
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write
HTTP Method: POST
Parameters:
parent
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Writes a single user event.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.collect
Path: v1/{+parent}/userEvents:collect
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect
HTTP Method: GET
Parameters:
parent
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
userEvent
Description: Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
Location: query
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
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.
Location: query
Type: string
Format: int64
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.import
Path: v1/{+parent}/userEvents:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import
HTTP Method: POST
Parameters:
parent
Description: Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.engines.create
Path: v1/{+parent}/engines
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}
HTTP Method: PATCH
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_number}/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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an Engine
▼ ▲ discoveryengine.projects.locations.collections.engines.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Engine.
▼ ▲ discoveryengine.projects.locations.collections.engines.list
Path: v1/{+parent}/engines
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines
HTTP Method: GET
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Not supported.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Not supported.
Location: query
Type: string
filter
Description: Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all the Engines associated with the project.
▼ ▲ discoveryengine.projects.locations.collections.engines.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.collections.engines.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.search
Path: v1/{+servingConfig}:search
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: servingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Performs a search.
▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.recommend
Path: v1/{+servingConfig}:recommend
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend
HTTP Method: POST
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 will be 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.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: servingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Makes a recommendation, which requires a contextual user event.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.converse
Path: v1/{+name}:converse
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse
HTTP Method: POST
Parameters:
name
Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Converses a conversation.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.create
Path: v1/{+parent}/conversations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations
HTTP Method: POST
Parameters:
parent
Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Conversation.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.list
Path: v1/{+parent}/conversations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations
HTTP Method: GET
Parameters:
parent
Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
Location: query
Type: string
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Conversations by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.completeQuery
Path: v1/{+dataStore}:completeQuery
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery
HTTP Method: GET
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`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
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
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
Parameter Order: dataStore
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Completes the specified user input with keyword suggestions.
▼ ▲ discoveryengine.projects.locations.dataStores.create
Path: v1/{+parent}/dataStores
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
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
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.list
Path: v1/{+parent}/dataStores
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: integer
Format: int32
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
filter
Description: Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all the DataStores associated with the project.
▼ ▲ discoveryengine.projects.locations.dataStores.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}
HTTP Method: PATCH
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a DataStore
▼ ▲ discoveryengine.projects.locations.dataStores.getSiteSearchEngine
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the SiteSearchEngine.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.list
Path: v1/{+parent}/documents
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of Documents 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.
Location: query
Type: integer
Format: int32
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of Documents.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.create
Path: v1/{+parent}/documents
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
documentId
Description: Required. The ID to use for the Document, which will become 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 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
HTTP Method: PATCH
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
allowMissing
Description: If set to true, and the Document is not found, a new Document will be created.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.import
Path: v1/{+parent}/documents:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.purge
Path: v1/{+parent}/documents:purge
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.models.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.dataStores.models.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ discoveryengine.projects.locations.dataStores.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import
Path: v1/{+parent}/suggestionDenyListEntries:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import
HTTP Method: POST
Parameters:
parent
Description: Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Imports all SuggestionDenyListEntry for a DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge
Path: v1/{+parent}/suggestionDenyListEntries:purge
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge
HTTP Method: POST
Parameters:
parent
Description: Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/.*$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Permanently deletes all SuggestionDenyListEntry for a DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.search
Path: v1/{+servingConfig}:search
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: servingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Performs a search.
▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.recommend
Path: v1/{+servingConfig}:recommend
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend
HTTP Method: POST
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 will be 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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: servingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Makes a recommendation, which requires a contextual user event.
▼ ▲ discoveryengine.projects.locations.dataStores.conversations.converse
Path: v1/{+name}:converse
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse
HTTP Method: POST
Parameters:
name
Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Converses a conversation.
▼ ▲ discoveryengine.projects.locations.dataStores.conversations.create
Path: v1/{+parent}/conversations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations
HTTP Method: POST
Parameters:
parent
Description: Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.dataStores.conversations.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.dataStores.conversations.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.dataStores.conversations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Conversation.
▼ ▲ discoveryengine.projects.locations.dataStores.conversations.list
Path: v1/{+parent}/conversations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations
HTTP Method: GET
Parameters:
parent
Description: Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
Location: query
Type: string
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Conversations by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.schemas.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}
HTTP Method: GET
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Schema.
▼ ▲ discoveryengine.projects.locations.dataStores.schemas.list
Path: v1/{+parent}/schemas
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas
HTTP Method: GET
Parameters:
parent
Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of Schemas.
▼ ▲ discoveryengine.projects.locations.dataStores.schemas.create
Path: v1/{+parent}/schemas
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas
HTTP Method: POST
Parameters:
parent
Description: Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
schemaId
Description: Required. The ID to use for the Schema, which will become 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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Schema.
▼ ▲ discoveryengine.projects.locations.dataStores.schemas.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}
HTTP Method: PATCH
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
allowMissing
Description: If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Schema.
▼ ▲ discoveryengine.projects.locations.dataStores.schemas.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}
HTTP Method: DELETE
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}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Schema.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch
Path: v1/{+siteSearchEngine}:enableAdvancedSiteSearch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch
HTTP Method: POST
Parameters:
siteSearchEngine
Description: Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Upgrade from basic site search to advanced site search.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch
Path: v1/{+siteSearchEngine}:disableAdvancedSiteSearch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch
HTTP Method: POST
Parameters:
siteSearchEngine
Description: Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Downgrade from advanced site search to basic site search.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris
Path: v1/{+siteSearchEngine}:recrawlUris
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris
HTTP Method: POST
Parameters:
siteSearchEngine
Description: Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: siteSearchEngine
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Request on-demand recrawl for a list of URIs.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create
Path: v1/{+parent}/targetSites
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method: POST
Parameters:
parent
Description: Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate
Path: v1/{+parent}/targetSites:batchCreate
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates TargetSite in a batch.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method: GET
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method: PATCH
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method: DELETE
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list
Path: v1/{+parent}/targetSites
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location: path
Required: Yes
Type: string
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.
Location: query
Type: integer
Format: int32
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of TargetSites.
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.write
Path: v1/{+parent}/userEvents:write
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write
HTTP Method: POST
Parameters:
parent
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Writes a single user event.
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.collect
Path: v1/{+parent}/userEvents:collect
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect
HTTP Method: GET
Parameters:
parent
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
userEvent
Description: Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
Location: query
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
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.
Location: query
Type: string
Format: int64
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.import
Path: v1/{+parent}/userEvents:import
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import
HTTP Method: POST
Parameters:
parent
Description: Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.