engines

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

Overview

Name	engines
Type	Resource
Id	google.discoveryengine.engines

Fields

Name	Datatype	Description
name	string	Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
chatEngineConfig	object	Configurations for a Chat Engine.
chatEngineMetadata	object	Additional information of a Chat Engine. Fields in this message are output only.
commonConfig	object	Common configurations for an Engine.
createTime	string	Output only. Timestamp the Recommendation Engine was created at.
dataStoreIds	array	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.
displayName	string	Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
industryVertical	string	The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore linked to the engine.
searchEngineConfig	object	Configurations for a Search Engine.
solutionType	string	Required. The solutions of the engine.
updateTime	string	Output only. Timestamp the Recommendation Engine was last updated.

Methods

Name	Accessible by	Required Params	Description
projects_locations_collections_engines_get	SELECT	collectionsId, enginesId, locationsId, projectsId	Gets a Engine.
projects_locations_collections_engines_list	SELECT	collectionsId, locationsId, projectsId	Lists all the Engines associated with the project.
projects_locations_collections_engines_create	INSERT	collectionsId, locationsId, projectsId	Creates a Engine.
projects_locations_collections_engines_delete	DELETE	collectionsId, enginesId, locationsId, projectsId	Deletes a Engine.
projects_locations_collections_engines_patch	UPDATE	collectionsId, enginesId, locationsId, projectsId	Updates an Engine

SELECT examples

Lists all the Engines associated with the project.

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

INSERT example

Use the following StackQL query and manifest file to create a new engines resource.

All Properties

/*+ create */
INSERT INTO google.discoveryengine.engines (
collectionsId,
locationsId,
projectsId,
chatEngineConfig,
searchEngineConfig,
name,
displayName,
dataStoreIds,
solutionType,
industryVertical,
commonConfig
)
SELECT 
'{{ collectionsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ chatEngineConfig }}',
'{{ searchEngineConfig }}',
'{{ name }}',
'{{ displayName }}',
'{{ dataStoreIds }}',
'{{ solutionType }}',
'{{ industryVertical }}',
'{{ commonConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: chatEngineConfig
      value:
        - name: agentCreationConfig
          value:
            - name: business
              value: string
            - name: defaultLanguageCode
              value: string
            - name: timeZone
              value: string
            - name: location
              value: string
        - name: dialogflowAgentToLink
          value: string
    - name: searchEngineConfig
      value:
        - name: searchTier
          value: string
        - name: searchAddOns
          value:
            - string
    - name: chatEngineMetadata
      value:
        - name: dialogflowAgent
          value: string
    - name: name
      value: string
    - name: displayName
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: dataStoreIds
      value:
        - string
    - name: solutionType
      value: string
    - name: industryVertical
      value: string
    - name: commonConfig
      value:
        - name: companyName
          value: string

UPDATE example

Updates a engines resource.

/*+ update */
UPDATE google.discoveryengine.engines
SET 
chatEngineConfig = '{{ chatEngineConfig }}',
searchEngineConfig = '{{ searchEngineConfig }}',
name = '{{ name }}',
displayName = '{{ displayName }}',
dataStoreIds = '{{ dataStoreIds }}',
solutionType = '{{ solutionType }}',
industryVertical = '{{ industryVertical }}',
commonConfig = '{{ commonConfig }}'
WHERE 
collectionsId = '{{ collectionsId }}'
AND enginesId = '{{ enginesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified engines resource.

/*+ delete */
DELETE FROM google.discoveryengine.engines
WHERE collectionsId = '{{ collectionsId }}'
AND enginesId = '{{ enginesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';