1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. discoveryengine
  5. ChatEngine
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

gcp.discoveryengine.ChatEngine

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

    Vertex chat and Conversation Engine Chat type

    To get more information about ChatEngine, see:

    Example Usage

    Discoveryengine Chat Engine Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const testDataStore = new gcp.discoveryengine.DataStore("test_data_store", {
        location: "global",
        dataStoreId: "data-store",
        displayName: "Structured datastore",
        industryVertical: "GENERIC",
        contentConfig: "NO_CONTENT",
        solutionTypes: ["SOLUTION_TYPE_CHAT"],
    });
    const testDataStore2 = new gcp.discoveryengine.DataStore("test_data_store_2", {
        location: testDataStore.location,
        dataStoreId: "data-store-2",
        displayName: "Structured datastore 2",
        industryVertical: "GENERIC",
        contentConfig: "NO_CONTENT",
        solutionTypes: ["SOLUTION_TYPE_CHAT"],
    });
    const primary = new gcp.discoveryengine.ChatEngine("primary", {
        engineId: "chat-engine-id",
        collectionId: "default_collection",
        location: testDataStore.location,
        displayName: "Chat engine",
        industryVertical: "GENERIC",
        dataStoreIds: [
            testDataStore.dataStoreId,
            testDataStore2.dataStoreId,
        ],
        commonConfig: {
            companyName: "test-company",
        },
        chatEngineConfig: {
            agentCreationConfig: {
                business: "test business name",
                defaultLanguageCode: "en",
                timeZone: "America/Los_Angeles",
            },
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    test_data_store = gcp.discoveryengine.DataStore("test_data_store",
        location="global",
        data_store_id="data-store",
        display_name="Structured datastore",
        industry_vertical="GENERIC",
        content_config="NO_CONTENT",
        solution_types=["SOLUTION_TYPE_CHAT"])
    test_data_store2 = gcp.discoveryengine.DataStore("test_data_store_2",
        location=test_data_store.location,
        data_store_id="data-store-2",
        display_name="Structured datastore 2",
        industry_vertical="GENERIC",
        content_config="NO_CONTENT",
        solution_types=["SOLUTION_TYPE_CHAT"])
    primary = gcp.discoveryengine.ChatEngine("primary",
        engine_id="chat-engine-id",
        collection_id="default_collection",
        location=test_data_store.location,
        display_name="Chat engine",
        industry_vertical="GENERIC",
        data_store_ids=[
            test_data_store.data_store_id,
            test_data_store2.data_store_id,
        ],
        common_config=gcp.discoveryengine.ChatEngineCommonConfigArgs(
            company_name="test-company",
        ),
        chat_engine_config=gcp.discoveryengine.ChatEngineChatEngineConfigArgs(
            agent_creation_config=gcp.discoveryengine.ChatEngineChatEngineConfigAgentCreationConfigArgs(
                business="test business name",
                default_language_code="en",
                time_zone="America/Los_Angeles",
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		testDataStore, err := discoveryengine.NewDataStore(ctx, "test_data_store", &discoveryengine.DataStoreArgs{
    			Location:         pulumi.String("global"),
    			DataStoreId:      pulumi.String("data-store"),
    			DisplayName:      pulumi.String("Structured datastore"),
    			IndustryVertical: pulumi.String("GENERIC"),
    			ContentConfig:    pulumi.String("NO_CONTENT"),
    			SolutionTypes: pulumi.StringArray{
    				pulumi.String("SOLUTION_TYPE_CHAT"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		testDataStore2, err := discoveryengine.NewDataStore(ctx, "test_data_store_2", &discoveryengine.DataStoreArgs{
    			Location:         testDataStore.Location,
    			DataStoreId:      pulumi.String("data-store-2"),
    			DisplayName:      pulumi.String("Structured datastore 2"),
    			IndustryVertical: pulumi.String("GENERIC"),
    			ContentConfig:    pulumi.String("NO_CONTENT"),
    			SolutionTypes: pulumi.StringArray{
    				pulumi.String("SOLUTION_TYPE_CHAT"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = discoveryengine.NewChatEngine(ctx, "primary", &discoveryengine.ChatEngineArgs{
    			EngineId:         pulumi.String("chat-engine-id"),
    			CollectionId:     pulumi.String("default_collection"),
    			Location:         testDataStore.Location,
    			DisplayName:      pulumi.String("Chat engine"),
    			IndustryVertical: pulumi.String("GENERIC"),
    			DataStoreIds: pulumi.StringArray{
    				testDataStore.DataStoreId,
    				testDataStore2.DataStoreId,
    			},
    			CommonConfig: &discoveryengine.ChatEngineCommonConfigArgs{
    				CompanyName: pulumi.String("test-company"),
    			},
    			ChatEngineConfig: &discoveryengine.ChatEngineChatEngineConfigArgs{
    				AgentCreationConfig: &discoveryengine.ChatEngineChatEngineConfigAgentCreationConfigArgs{
    					Business:            pulumi.String("test business name"),
    					DefaultLanguageCode: pulumi.String("en"),
    					TimeZone:            pulumi.String("America/Los_Angeles"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var testDataStore = new Gcp.DiscoveryEngine.DataStore("test_data_store", new()
        {
            Location = "global",
            DataStoreId = "data-store",
            DisplayName = "Structured datastore",
            IndustryVertical = "GENERIC",
            ContentConfig = "NO_CONTENT",
            SolutionTypes = new[]
            {
                "SOLUTION_TYPE_CHAT",
            },
        });
    
        var testDataStore2 = new Gcp.DiscoveryEngine.DataStore("test_data_store_2", new()
        {
            Location = testDataStore.Location,
            DataStoreId = "data-store-2",
            DisplayName = "Structured datastore 2",
            IndustryVertical = "GENERIC",
            ContentConfig = "NO_CONTENT",
            SolutionTypes = new[]
            {
                "SOLUTION_TYPE_CHAT",
            },
        });
    
        var primary = new Gcp.DiscoveryEngine.ChatEngine("primary", new()
        {
            EngineId = "chat-engine-id",
            CollectionId = "default_collection",
            Location = testDataStore.Location,
            DisplayName = "Chat engine",
            IndustryVertical = "GENERIC",
            DataStoreIds = new[]
            {
                testDataStore.DataStoreId,
                testDataStore2.DataStoreId,
            },
            CommonConfig = new Gcp.DiscoveryEngine.Inputs.ChatEngineCommonConfigArgs
            {
                CompanyName = "test-company",
            },
            ChatEngineConfig = new Gcp.DiscoveryEngine.Inputs.ChatEngineChatEngineConfigArgs
            {
                AgentCreationConfig = new Gcp.DiscoveryEngine.Inputs.ChatEngineChatEngineConfigAgentCreationConfigArgs
                {
                    Business = "test business name",
                    DefaultLanguageCode = "en",
                    TimeZone = "America/Los_Angeles",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.discoveryengine.DataStore;
    import com.pulumi.gcp.discoveryengine.DataStoreArgs;
    import com.pulumi.gcp.discoveryengine.ChatEngine;
    import com.pulumi.gcp.discoveryengine.ChatEngineArgs;
    import com.pulumi.gcp.discoveryengine.inputs.ChatEngineCommonConfigArgs;
    import com.pulumi.gcp.discoveryengine.inputs.ChatEngineChatEngineConfigArgs;
    import com.pulumi.gcp.discoveryengine.inputs.ChatEngineChatEngineConfigAgentCreationConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testDataStore = new DataStore("testDataStore", DataStoreArgs.builder()        
                .location("global")
                .dataStoreId("data-store")
                .displayName("Structured datastore")
                .industryVertical("GENERIC")
                .contentConfig("NO_CONTENT")
                .solutionTypes("SOLUTION_TYPE_CHAT")
                .build());
    
            var testDataStore2 = new DataStore("testDataStore2", DataStoreArgs.builder()        
                .location(testDataStore.location())
                .dataStoreId("data-store-2")
                .displayName("Structured datastore 2")
                .industryVertical("GENERIC")
                .contentConfig("NO_CONTENT")
                .solutionTypes("SOLUTION_TYPE_CHAT")
                .build());
    
            var primary = new ChatEngine("primary", ChatEngineArgs.builder()        
                .engineId("chat-engine-id")
                .collectionId("default_collection")
                .location(testDataStore.location())
                .displayName("Chat engine")
                .industryVertical("GENERIC")
                .dataStoreIds(            
                    testDataStore.dataStoreId(),
                    testDataStore2.dataStoreId())
                .commonConfig(ChatEngineCommonConfigArgs.builder()
                    .companyName("test-company")
                    .build())
                .chatEngineConfig(ChatEngineChatEngineConfigArgs.builder()
                    .agentCreationConfig(ChatEngineChatEngineConfigAgentCreationConfigArgs.builder()
                        .business("test business name")
                        .defaultLanguageCode("en")
                        .timeZone("America/Los_Angeles")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      testDataStore:
        type: gcp:discoveryengine:DataStore
        name: test_data_store
        properties:
          location: global
          dataStoreId: data-store
          displayName: Structured datastore
          industryVertical: GENERIC
          contentConfig: NO_CONTENT
          solutionTypes:
            - SOLUTION_TYPE_CHAT
      testDataStore2:
        type: gcp:discoveryengine:DataStore
        name: test_data_store_2
        properties:
          location: ${testDataStore.location}
          dataStoreId: data-store-2
          displayName: Structured datastore 2
          industryVertical: GENERIC
          contentConfig: NO_CONTENT
          solutionTypes:
            - SOLUTION_TYPE_CHAT
      primary:
        type: gcp:discoveryengine:ChatEngine
        properties:
          engineId: chat-engine-id
          collectionId: default_collection
          location: ${testDataStore.location}
          displayName: Chat engine
          industryVertical: GENERIC
          dataStoreIds:
            - ${testDataStore.dataStoreId}
            - ${testDataStore2.dataStoreId}
          commonConfig:
            companyName: test-company
          chatEngineConfig:
            agentCreationConfig:
              business: test business name
              defaultLanguageCode: en
              timeZone: America/Los_Angeles
    

    Create ChatEngine Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ChatEngine(name: string, args: ChatEngineArgs, opts?: CustomResourceOptions);
    @overload
    def ChatEngine(resource_name: str,
                   args: ChatEngineArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ChatEngine(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   chat_engine_config: Optional[ChatEngineChatEngineConfigArgs] = None,
                   collection_id: Optional[str] = None,
                   data_store_ids: Optional[Sequence[str]] = None,
                   display_name: Optional[str] = None,
                   engine_id: Optional[str] = None,
                   location: Optional[str] = None,
                   common_config: Optional[ChatEngineCommonConfigArgs] = None,
                   industry_vertical: Optional[str] = None,
                   project: Optional[str] = None)
    func NewChatEngine(ctx *Context, name string, args ChatEngineArgs, opts ...ResourceOption) (*ChatEngine, error)
    public ChatEngine(string name, ChatEngineArgs args, CustomResourceOptions? opts = null)
    public ChatEngine(String name, ChatEngineArgs args)
    public ChatEngine(String name, ChatEngineArgs args, CustomResourceOptions options)
    
    type: gcp:discoveryengine:ChatEngine
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ChatEngineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ChatEngineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ChatEngineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChatEngineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChatEngineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var chatEngineResource = new Gcp.DiscoveryEngine.ChatEngine("chatEngineResource", new()
    {
        ChatEngineConfig = new Gcp.DiscoveryEngine.Inputs.ChatEngineChatEngineConfigArgs
        {
            AgentCreationConfig = new Gcp.DiscoveryEngine.Inputs.ChatEngineChatEngineConfigAgentCreationConfigArgs
            {
                DefaultLanguageCode = "string",
                TimeZone = "string",
                Business = "string",
                Location = "string",
            },
        },
        CollectionId = "string",
        DataStoreIds = new[]
        {
            "string",
        },
        DisplayName = "string",
        EngineId = "string",
        Location = "string",
        CommonConfig = new Gcp.DiscoveryEngine.Inputs.ChatEngineCommonConfigArgs
        {
            CompanyName = "string",
        },
        IndustryVertical = "string",
        Project = "string",
    });
    
    example, err := discoveryengine.NewChatEngine(ctx, "chatEngineResource", &discoveryengine.ChatEngineArgs{
    	ChatEngineConfig: &discoveryengine.ChatEngineChatEngineConfigArgs{
    		AgentCreationConfig: &discoveryengine.ChatEngineChatEngineConfigAgentCreationConfigArgs{
    			DefaultLanguageCode: pulumi.String("string"),
    			TimeZone:            pulumi.String("string"),
    			Business:            pulumi.String("string"),
    			Location:            pulumi.String("string"),
    		},
    	},
    	CollectionId: pulumi.String("string"),
    	DataStoreIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    	EngineId:    pulumi.String("string"),
    	Location:    pulumi.String("string"),
    	CommonConfig: &discoveryengine.ChatEngineCommonConfigArgs{
    		CompanyName: pulumi.String("string"),
    	},
    	IndustryVertical: pulumi.String("string"),
    	Project:          pulumi.String("string"),
    })
    
    var chatEngineResource = new ChatEngine("chatEngineResource", ChatEngineArgs.builder()        
        .chatEngineConfig(ChatEngineChatEngineConfigArgs.builder()
            .agentCreationConfig(ChatEngineChatEngineConfigAgentCreationConfigArgs.builder()
                .defaultLanguageCode("string")
                .timeZone("string")
                .business("string")
                .location("string")
                .build())
            .build())
        .collectionId("string")
        .dataStoreIds("string")
        .displayName("string")
        .engineId("string")
        .location("string")
        .commonConfig(ChatEngineCommonConfigArgs.builder()
            .companyName("string")
            .build())
        .industryVertical("string")
        .project("string")
        .build());
    
    chat_engine_resource = gcp.discoveryengine.ChatEngine("chatEngineResource",
        chat_engine_config=gcp.discoveryengine.ChatEngineChatEngineConfigArgs(
            agent_creation_config=gcp.discoveryengine.ChatEngineChatEngineConfigAgentCreationConfigArgs(
                default_language_code="string",
                time_zone="string",
                business="string",
                location="string",
            ),
        ),
        collection_id="string",
        data_store_ids=["string"],
        display_name="string",
        engine_id="string",
        location="string",
        common_config=gcp.discoveryengine.ChatEngineCommonConfigArgs(
            company_name="string",
        ),
        industry_vertical="string",
        project="string")
    
    const chatEngineResource = new gcp.discoveryengine.ChatEngine("chatEngineResource", {
        chatEngineConfig: {
            agentCreationConfig: {
                defaultLanguageCode: "string",
                timeZone: "string",
                business: "string",
                location: "string",
            },
        },
        collectionId: "string",
        dataStoreIds: ["string"],
        displayName: "string",
        engineId: "string",
        location: "string",
        commonConfig: {
            companyName: "string",
        },
        industryVertical: "string",
        project: "string",
    });
    
    type: gcp:discoveryengine:ChatEngine
    properties:
        chatEngineConfig:
            agentCreationConfig:
                business: string
                defaultLanguageCode: string
                location: string
                timeZone: string
        collectionId: string
        commonConfig:
            companyName: string
        dataStoreIds:
            - string
        displayName: string
        engineId: string
        industryVertical: string
        location: string
        project: string
    

    ChatEngine Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ChatEngine resource accepts the following input properties:

    ChatEngineConfig ChatEngineChatEngineConfig
    Configurations for a chat Engine. Structure is documented below.
    CollectionId string
    The collection ID.
    DataStoreIds List<string>
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    The ID to use for chat engine.
    Location string
    Location.
    CommonConfig ChatEngineCommonConfig
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    IndustryVertical string
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ChatEngineConfig ChatEngineChatEngineConfigArgs
    Configurations for a chat Engine. Structure is documented below.
    CollectionId string
    The collection ID.
    DataStoreIds []string
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    The ID to use for chat engine.
    Location string
    Location.
    CommonConfig ChatEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    IndustryVertical string
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    chatEngineConfig ChatEngineChatEngineConfig
    Configurations for a chat Engine. Structure is documented below.
    collectionId String
    The collection ID.
    dataStoreIds List<String>
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    The ID to use for chat engine.
    location String
    Location.
    commonConfig ChatEngineCommonConfig
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    industryVertical String
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    chatEngineConfig ChatEngineChatEngineConfig
    Configurations for a chat Engine. Structure is documented below.
    collectionId string
    The collection ID.
    dataStoreIds string[]
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    displayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId string
    The ID to use for chat engine.
    location string
    Location.
    commonConfig ChatEngineCommonConfig
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    industryVertical string
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    chat_engine_config ChatEngineChatEngineConfigArgs
    Configurations for a chat Engine. Structure is documented below.
    collection_id str
    The collection ID.
    data_store_ids Sequence[str]
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    display_name str
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engine_id str
    The ID to use for chat engine.
    location str
    Location.
    common_config ChatEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    industry_vertical str
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    chatEngineConfig Property Map
    Configurations for a chat Engine. Structure is documented below.
    collectionId String
    The collection ID.
    dataStoreIds List<String>
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    The ID to use for chat engine.
    location String
    Location.
    commonConfig Property Map
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    industryVertical String
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ChatEngine resource produces the following output properties:

    ChatEngineMetadatas List<ChatEngineChatEngineMetadata>
    Additional information of the Chat Engine. Structure is documented below.
    CreateTime string
    Timestamp the Engine was created at.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    UpdateTime string
    Timestamp the Engine was last updated.
    ChatEngineMetadatas []ChatEngineChatEngineMetadata
    Additional information of the Chat Engine. Structure is documented below.
    CreateTime string
    Timestamp the Engine was created at.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    UpdateTime string
    Timestamp the Engine was last updated.
    chatEngineMetadatas List<ChatEngineChatEngineMetadata>
    Additional information of the Chat Engine. Structure is documented below.
    createTime String
    Timestamp the Engine was created at.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    updateTime String
    Timestamp the Engine was last updated.
    chatEngineMetadatas ChatEngineChatEngineMetadata[]
    Additional information of the Chat Engine. Structure is documented below.
    createTime string
    Timestamp the Engine was created at.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    updateTime string
    Timestamp the Engine was last updated.
    chat_engine_metadatas Sequence[ChatEngineChatEngineMetadata]
    Additional information of the Chat Engine. Structure is documented below.
    create_time str
    Timestamp the Engine was created at.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    update_time str
    Timestamp the Engine was last updated.
    chatEngineMetadatas List<Property Map>
    Additional information of the Chat Engine. Structure is documented below.
    createTime String
    Timestamp the Engine was created at.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    updateTime String
    Timestamp the Engine was last updated.

    Look up Existing ChatEngine Resource

    Get an existing ChatEngine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ChatEngineState, opts?: CustomResourceOptions): ChatEngine
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            chat_engine_config: Optional[ChatEngineChatEngineConfigArgs] = None,
            chat_engine_metadatas: Optional[Sequence[ChatEngineChatEngineMetadataArgs]] = None,
            collection_id: Optional[str] = None,
            common_config: Optional[ChatEngineCommonConfigArgs] = None,
            create_time: Optional[str] = None,
            data_store_ids: Optional[Sequence[str]] = None,
            display_name: Optional[str] = None,
            engine_id: Optional[str] = None,
            industry_vertical: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            update_time: Optional[str] = None) -> ChatEngine
    func GetChatEngine(ctx *Context, name string, id IDInput, state *ChatEngineState, opts ...ResourceOption) (*ChatEngine, error)
    public static ChatEngine Get(string name, Input<string> id, ChatEngineState? state, CustomResourceOptions? opts = null)
    public static ChatEngine get(String name, Output<String> id, ChatEngineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ChatEngineConfig ChatEngineChatEngineConfig
    Configurations for a chat Engine. Structure is documented below.
    ChatEngineMetadatas List<ChatEngineChatEngineMetadata>
    Additional information of the Chat Engine. Structure is documented below.
    CollectionId string
    The collection ID.
    CommonConfig ChatEngineCommonConfig
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    CreateTime string
    Timestamp the Engine was created at.
    DataStoreIds List<string>
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    The ID to use for chat engine.
    IndustryVertical string
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    Location string
    Location.
    Name string
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    Timestamp the Engine was last updated.
    ChatEngineConfig ChatEngineChatEngineConfigArgs
    Configurations for a chat Engine. Structure is documented below.
    ChatEngineMetadatas []ChatEngineChatEngineMetadataArgs
    Additional information of the Chat Engine. Structure is documented below.
    CollectionId string
    The collection ID.
    CommonConfig ChatEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    CreateTime string
    Timestamp the Engine was created at.
    DataStoreIds []string
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    DisplayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    The ID to use for chat engine.
    IndustryVertical string
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    Location string
    Location.
    Name string
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    Timestamp the Engine was last updated.
    chatEngineConfig ChatEngineChatEngineConfig
    Configurations for a chat Engine. Structure is documented below.
    chatEngineMetadatas List<ChatEngineChatEngineMetadata>
    Additional information of the Chat Engine. Structure is documented below.
    collectionId String
    The collection ID.
    commonConfig ChatEngineCommonConfig
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    createTime String
    Timestamp the Engine was created at.
    dataStoreIds List<String>
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    The ID to use for chat engine.
    industryVertical String
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    location String
    Location.
    name String
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    Timestamp the Engine was last updated.
    chatEngineConfig ChatEngineChatEngineConfig
    Configurations for a chat Engine. Structure is documented below.
    chatEngineMetadatas ChatEngineChatEngineMetadata[]
    Additional information of the Chat Engine. Structure is documented below.
    collectionId string
    The collection ID.
    commonConfig ChatEngineCommonConfig
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    createTime string
    Timestamp the Engine was created at.
    dataStoreIds string[]
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    displayName string
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId string
    The ID to use for chat engine.
    industryVertical string
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    location string
    Location.
    name string
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime string
    Timestamp the Engine was last updated.
    chat_engine_config ChatEngineChatEngineConfigArgs
    Configurations for a chat Engine. Structure is documented below.
    chat_engine_metadatas Sequence[ChatEngineChatEngineMetadataArgs]
    Additional information of the Chat Engine. Structure is documented below.
    collection_id str
    The collection ID.
    common_config ChatEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    create_time str
    Timestamp the Engine was created at.
    data_store_ids Sequence[str]
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    display_name str
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engine_id str
    The ID to use for chat engine.
    industry_vertical str
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    location str
    Location.
    name str
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    update_time str
    Timestamp the Engine was last updated.
    chatEngineConfig Property Map
    Configurations for a chat Engine. Structure is documented below.
    chatEngineMetadatas List<Property Map>
    Additional information of the Chat Engine. Structure is documented below.
    collectionId String
    The collection ID.
    commonConfig Property Map
    Common config spec that specifies the metadata of the engine. Structure is documented below.
    createTime String
    Timestamp the Engine was created at.
    dataStoreIds List<String>
    The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be SOLUTION_TYPE_CHAT. Adding or removing data stores will force recreation.
    displayName String
    The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    The ID to use for chat engine.
    industryVertical String
    The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is GENERIC. Possible values are: GENERIC.
    location String
    Location.
    name String
    The unique full resource name of the chat engine. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    Timestamp the Engine was last updated.

    Supporting Types

    ChatEngineChatEngineConfig, ChatEngineChatEngineConfigArgs

    AgentCreationConfig ChatEngineChatEngineConfigAgentCreationConfig
    The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.
    AgentCreationConfig ChatEngineChatEngineConfigAgentCreationConfig
    The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.
    agentCreationConfig ChatEngineChatEngineConfigAgentCreationConfig
    The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.
    agentCreationConfig ChatEngineChatEngineConfigAgentCreationConfig
    The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.
    agent_creation_config ChatEngineChatEngineConfigAgentCreationConfig
    The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.
    agentCreationConfig Property Map
    The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.

    ChatEngineChatEngineConfigAgentCreationConfig, ChatEngineChatEngineConfigAgentCreationConfigArgs

    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    TimeZone string
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    Business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    Location string
    Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.


    DefaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    TimeZone string
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    Business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    Location string
    Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.


    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    timeZone String
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business String
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    location String
    Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.


    defaultLanguageCode string
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    timeZone string
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business string
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    location string
    Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.


    default_language_code str
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    time_zone str
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business str
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    location str
    Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.


    defaultLanguageCode String
    The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
    timeZone String
    The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
    business String
    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
    location String
    Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.


    ChatEngineChatEngineMetadata, ChatEngineChatEngineMetadataArgs

    DialogflowAgent string
    (Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.
    DialogflowAgent string
    (Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.
    dialogflowAgent String
    (Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.
    dialogflowAgent string
    (Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.
    dialogflow_agent str
    (Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.
    dialogflowAgent String
    (Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.

    ChatEngineCommonConfig, ChatEngineCommonConfigArgs

    CompanyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    CompanyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    companyName String
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    companyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    company_name str
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
    companyName String
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.

    Import

    ChatEngine can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}

    • {{project}}/{{location}}/{{collection_id}}/{{engine_id}}

    • {{location}}/{{collection_id}}/{{engine_id}}

    When using the pulumi import command, ChatEngine can be imported using one of the formats above. For example:

    $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}
    
    $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default {{project}}/{{location}}/{{collection_id}}/{{engine_id}}
    
    $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default {{location}}/{{collection_id}}/{{engine_id}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi