com.pulumi.gcp.discoveryengine.kotlin.ChatEngineArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.discoveryengine.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.discoveryengine.ChatEngineArgs.builder
import com.pulumi.gcp.discoveryengine.kotlin.inputs.ChatEngineChatEngineConfigArgs
import com.pulumi.gcp.discoveryengine.kotlin.inputs.ChatEngineChatEngineConfigArgsBuilder
import com.pulumi.gcp.discoveryengine.kotlin.inputs.ChatEngineCommonConfigArgs
import com.pulumi.gcp.discoveryengine.kotlin.inputs.ChatEngineCommonConfigArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Vertex chat and Conversation Engine Chat type
* To get more information about ChatEngine, see:
* * [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines)
* * How-to Guides
* * [Vertex AI Conversation](https://cloud.google.com/dialogflow/cx/docs/concept/generative)
* ## Example Usage
* ### Discoveryengine Chat Engine Basic
*
* ```typescript
* 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",
* },
* },
* });
* ```
* ```python
* 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",
* ),
* ))
* ```
* ```csharp
* 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",
* },
* },
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## 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:
* ```sh
* $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}
* ```
* ```sh
* $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default {{project}}/{{location}}/{{collection_id}}/{{engine_id}}
* ```
* ```sh
* $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default {{location}}/{{collection_id}}/{{engine_id}}
* ```
* @property chatEngineConfig Configurations for a chat Engine.
* Structure is documented below.
* @property collectionId The collection ID.
* @property commonConfig Common config spec that specifies the metadata of the engine.
* @property dataStoreIds 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.
* @property displayName The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
* @property engineId The ID to use for chat engine.
* @property industryVertical The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked
* to the engine. Default value: "GENERIC" Possible values: ["GENERIC"]
* @property location Location.
* @property project
*/
public data class ChatEngineArgs(
public val chatEngineConfig: Output? = null,
public val collectionId: Output? = null,
public val commonConfig: Output? = null,
public val dataStoreIds: Output>? = null,
public val displayName: Output? = null,
public val engineId: Output? = null,
public val industryVertical: Output? = null,
public val location: Output? = null,
public val project: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.discoveryengine.ChatEngineArgs =
com.pulumi.gcp.discoveryengine.ChatEngineArgs.builder()
.chatEngineConfig(chatEngineConfig?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.collectionId(collectionId?.applyValue({ args0 -> args0 }))
.commonConfig(commonConfig?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.dataStoreIds(dataStoreIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.engineId(engineId?.applyValue({ args0 -> args0 }))
.industryVertical(industryVertical?.applyValue({ args0 -> args0 }))
.location(location?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ChatEngineArgs].
*/
@PulumiTagMarker
public class ChatEngineArgsBuilder internal constructor() {
private var chatEngineConfig: Output? = null
private var collectionId: Output? = null
private var commonConfig: Output? = null
private var dataStoreIds: Output>? = null
private var displayName: Output? = null
private var engineId: Output? = null
private var industryVertical: Output? = null
private var location: Output? = null
private var project: Output? = null
/**
* @param value Configurations for a chat Engine.
* Structure is documented below.
*/
@JvmName("upxxevirbwiwcuvr")
public suspend fun chatEngineConfig(`value`: Output) {
this.chatEngineConfig = value
}
/**
* @param value The collection ID.
*/
@JvmName("crajvfboyjcqnbhs")
public suspend fun collectionId(`value`: Output) {
this.collectionId = value
}
/**
* @param value Common config spec that specifies the metadata of the engine.
*/
@JvmName("uxchbvixdxhsaefg")
public suspend fun commonConfig(`value`: Output) {
this.commonConfig = value
}
/**
* @param value 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.
*/
@JvmName("khrdompljedrfvhl")
public suspend fun dataStoreIds(`value`: Output>) {
this.dataStoreIds = value
}
@JvmName("gaifpbihaucnucpd")
public suspend fun dataStoreIds(vararg values: Output) {
this.dataStoreIds = Output.all(values.asList())
}
/**
* @param values 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.
*/
@JvmName("unnpbkdofpjlsbxd")
public suspend fun dataStoreIds(values: List>) {
this.dataStoreIds = Output.all(values)
}
/**
* @param value The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
*/
@JvmName("dugvckntdjbdhxhe")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value The ID to use for chat engine.
*/
@JvmName("uodeagnbbtfpaxgt")
public suspend fun engineId(`value`: Output) {
this.engineId = value
}
/**
* @param value The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked
* to the engine. Default value: "GENERIC" Possible values: ["GENERIC"]
*/
@JvmName("kjtfchenmysitsnu")
public suspend fun industryVertical(`value`: Output) {
this.industryVertical = value
}
/**
* @param value Location.
*/
@JvmName("wlhndginfmqhutcm")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value
*/
@JvmName("wavccxrlcxpiowii")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value Configurations for a chat Engine.
* Structure is documented below.
*/
@JvmName("huofgipwhhkxptgk")
public suspend fun chatEngineConfig(`value`: ChatEngineChatEngineConfigArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.chatEngineConfig = mapped
}
/**
* @param argument Configurations for a chat Engine.
* Structure is documented below.
*/
@JvmName("skuheiogdyayxnlx")
public suspend fun chatEngineConfig(argument: suspend ChatEngineChatEngineConfigArgsBuilder.() -> Unit) {
val toBeMapped = ChatEngineChatEngineConfigArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.chatEngineConfig = mapped
}
/**
* @param value The collection ID.
*/
@JvmName("ahnrklgagxckxgcy")
public suspend fun collectionId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.collectionId = mapped
}
/**
* @param value Common config spec that specifies the metadata of the engine.
*/
@JvmName("vpayqnjicuvfrtae")
public suspend fun commonConfig(`value`: ChatEngineCommonConfigArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.commonConfig = mapped
}
/**
* @param argument Common config spec that specifies the metadata of the engine.
*/
@JvmName("vxbmoscqfvcjqvnw")
public suspend fun commonConfig(argument: suspend ChatEngineCommonConfigArgsBuilder.() -> Unit) {
val toBeMapped = ChatEngineCommonConfigArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.commonConfig = mapped
}
/**
* @param value 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.
*/
@JvmName("itsyalxwetucakxx")
public suspend fun dataStoreIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataStoreIds = mapped
}
/**
* @param values 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.
*/
@JvmName("nrmfjrwlrfsvjioc")
public suspend fun dataStoreIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.dataStoreIds = mapped
}
/**
* @param value The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
*/
@JvmName("cympakklediyugsx")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value The ID to use for chat engine.
*/
@JvmName("kbjfjdbtblaclunj")
public suspend fun engineId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.engineId = mapped
}
/**
* @param value The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked
* to the engine. Default value: "GENERIC" Possible values: ["GENERIC"]
*/
@JvmName("yvnbhlcxnsiknang")
public suspend fun industryVertical(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.industryVertical = mapped
}
/**
* @param value Location.
*/
@JvmName("ndiqycmwxfiswlka")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value
*/
@JvmName("emasiswhbgftnikr")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
internal fun build(): ChatEngineArgs = ChatEngineArgs(
chatEngineConfig = chatEngineConfig,
collectionId = collectionId,
commonConfig = commonConfig,
dataStoreIds = dataStoreIds,
displayName = displayName,
engineId = engineId,
industryVertical = industryVertical,
location = location,
project = project,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy