engines

Creates, updates, deletes, gets or lists an engines resource.

Overview

Name	engines
Type	Resource
Id	google.discoveryengine.engines

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_engines_get

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
chatEngineConfig	object	Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. (id: GoogleCloudDiscoveryengineV1EngineChatEngineConfig)
chatEngineMetadata	object	Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. (id: GoogleCloudDiscoveryengineV1EngineChatEngineMetadata)
commonConfig	object	Common config spec that specifies the metadata of the engine. (id: GoogleCloudDiscoveryengineV1EngineCommonConfig)
createTime	string (google-datetime)	Output only. Timestamp the Recommendation Engine was created at.
dataStoreIds	array	Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
disableAnalytics	boolean	Optional. Whether to disable analytics for searches performed on this engine.
displayName	string	Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
features	object	Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * *: all features, if it's present, all other feature state settings are ignored. * agent-gallery * no-code-agent-builder * prompt-gallery * model-selector * notebook-lm * people-search * people-search-org-chart * bi-directional-audio * feedback * session-sharing * personalization-memory - Enables personalization based on user preferences.
industryVertical	string	Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
mediaRecommendationEngineConfig	object	Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. (id: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig)
searchEngineConfig	object	Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. (id: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig)
solutionType	string	Required. The solutions of the engine.
updateTime	string (google-datetime)	Output only. Timestamp the Recommendation Engine was last updated.

projects_locations_collections_engines_list

Successful response

Name	Datatype	Description
name	string	Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
chatEngineConfig	object	Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. (id: GoogleCloudDiscoveryengineV1EngineChatEngineConfig)
chatEngineMetadata	object	Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. (id: GoogleCloudDiscoveryengineV1EngineChatEngineMetadata)
commonConfig	object	Common config spec that specifies the metadata of the engine. (id: GoogleCloudDiscoveryengineV1EngineCommonConfig)
createTime	string (google-datetime)	Output only. Timestamp the Recommendation Engine was created at.
dataStoreIds	array	Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
disableAnalytics	boolean	Optional. Whether to disable analytics for searches performed on this engine.
displayName	string	Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
features	object	Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * *: all features, if it's present, all other feature state settings are ignored. * agent-gallery * no-code-agent-builder * prompt-gallery * model-selector * notebook-lm * people-search * people-search-org-chart * bi-directional-audio * feedback * session-sharing * personalization-memory - Enables personalization based on user preferences.
industryVertical	string	Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
mediaRecommendationEngineConfig	object	Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. (id: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig)
searchEngineConfig	object	Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. (id: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig)
solutionType	string	Required. The solutions of the engine.
updateTime	string (google-datetime)	Output only. Timestamp the Recommendation Engine was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_engines_get	select	projectsId, locationsId, collectionsId, enginesId		Gets a Engine.
projects_locations_collections_engines_list	select	projectsId, locationsId, collectionsId	pageSize, pageToken, filter	Lists all the Engines associated with the project.
projects_locations_collections_engines_create	insert	projectsId, locationsId, collectionsId	engineId	Creates a Engine.
projects_locations_collections_engines_patch	update	projectsId, locationsId, collectionsId, enginesId	updateMask	Updates an Engine
projects_locations_collections_engines_delete	delete	projectsId, locationsId, collectionsId, enginesId		Deletes a Engine.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
enginesId	string
locationsId	string
projectsId	string
engineId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_collections_engines_get

Gets a Engine.

SELECT
name,
chatEngineConfig,
chatEngineMetadata,
commonConfig,
createTime,
dataStoreIds,
disableAnalytics,
displayName,
features,
industryVertical,
mediaRecommendationEngineConfig,
searchEngineConfig,
solutionType,
updateTime
FROM google.discoveryengine.engines
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required;

projects_locations_collections_engines_list

Lists all the Engines associated with the project.

SELECT
name,
chatEngineConfig,
chatEngineMetadata,
commonConfig,
createTime,
dataStoreIds,
disableAnalytics,
displayName,
features,
industryVertical,
mediaRecommendationEngineConfig,
searchEngineConfig,
solutionType,
updateTime
FROM google.discoveryengine.engines
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

projects_locations_collections_engines_create

Creates a Engine.

INSERT INTO google.discoveryengine.engines (
data__chatEngineConfig,
data__searchEngineConfig,
data__mediaRecommendationEngineConfig,
data__name,
data__displayName,
data__dataStoreIds,
data__solutionType,
data__industryVertical,
data__commonConfig,
data__disableAnalytics,
data__features,
projectsId,
locationsId,
collectionsId,
engineId
)
SELECT 
'{{ chatEngineConfig }}',
'{{ searchEngineConfig }}',
'{{ mediaRecommendationEngineConfig }}',
'{{ name }}',
'{{ displayName }}',
'{{ dataStoreIds }}',
'{{ solutionType }}',
'{{ industryVertical }}',
'{{ commonConfig }}',
{{ disableAnalytics }},
'{{ features }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ engineId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: engines
  props:
    - name: projectsId
      value: string
      description: Required parameter for the engines resource.
    - name: locationsId
      value: string
      description: Required parameter for the engines resource.
    - name: collectionsId
      value: string
      description: Required parameter for the engines resource.
    - name: chatEngineConfig
      value: object
      description: >
        Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
        
    - name: searchEngineConfig
      value: object
      description: >
        Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
        
    - name: mediaRecommendationEngineConfig
      value: object
      description: >
        Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
        
    - name: name
      value: string
      description: >
        Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
        
    - name: displayName
      value: string
      description: >
        Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
        
    - name: dataStoreIds
      value: array
      description: >
        Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
        
    - name: solutionType
      value: string
      description: >
        Required. The solutions of the engine.
        
      valid_values: ['SOLUTION_TYPE_UNSPECIFIED', 'SOLUTION_TYPE_RECOMMENDATION', 'SOLUTION_TYPE_SEARCH', 'SOLUTION_TYPE_CHAT', 'SOLUTION_TYPE_GENERATIVE_CHAT']
    - name: industryVertical
      value: string
      description: >
        Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
        
      valid_values: ['INDUSTRY_VERTICAL_UNSPECIFIED', 'GENERIC', 'MEDIA', 'HEALTHCARE_FHIR']
    - name: commonConfig
      value: object
      description: >
        Common config spec that specifies the metadata of the engine.
        
    - name: disableAnalytics
      value: boolean
      description: >
        Optional. Whether to disable analytics for searches performed on this engine.
        
    - name: features
      value: object
      description: >
        Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
        
    - name: engineId
      value: string

UPDATE examples

projects_locations_collections_engines_patch

Updates an Engine

UPDATE google.discoveryengine.engines
SET 
data__chatEngineConfig = '{{ chatEngineConfig }}',
data__searchEngineConfig = '{{ searchEngineConfig }}',
data__mediaRecommendationEngineConfig = '{{ mediaRecommendationEngineConfig }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__dataStoreIds = '{{ dataStoreIds }}',
data__solutionType = '{{ solutionType }}',
data__industryVertical = '{{ industryVertical }}',
data__commonConfig = '{{ commonConfig }}',
data__disableAnalytics = {{ disableAnalytics }},
data__features = '{{ features }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
chatEngineConfig,
chatEngineMetadata,
commonConfig,
createTime,
dataStoreIds,
disableAnalytics,
displayName,
features,
industryVertical,
mediaRecommendationEngineConfig,
searchEngineConfig,
solutionType,
updateTime;

DELETE examples

projects_locations_collections_engines_delete

Deletes a Engine.

DELETE FROM google.discoveryengine.engines
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required;