pulumi-gcp-kotlin/com.pulumi.gcp.discoveryengine.kotlin/DataStoreArgs

DataStoreArgs

data class DataStoreArgs(val advancedSiteSearchConfig: Output<DataStoreAdvancedSiteSearchConfigArgs>? = null, val contentConfig: Output<String>? = null, val createAdvancedSiteSearch: Output<Boolean>? = null, val dataStoreId: Output<String>? = null, val displayName: Output<String>? = null, val documentProcessingConfig: Output<DataStoreDocumentProcessingConfigArgs>? = null, val industryVertical: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val skipDefaultSchemaCreation: Output<Boolean>? = null, val solutionTypes: Output<List<String>>? = null) : ConvertibleToJava<DataStoreArgs>

Data store is a collection of websites and documents used to find answers for end-user's questions in Discovery Engine (a.k.a. Vertex AI Search and Conversation). To get more information about DataStore, see:

Example Usage

Discoveryengine Datastore Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basic = new gcp.discoveryengine.DataStore("basic", {
    location: "global",
    dataStoreId: "data-store-id",
    displayName: "tf-test-structured-datastore",
    industryVertical: "GENERIC",
    contentConfig: "NO_CONTENT",
    solutionTypes: ["SOLUTION_TYPE_SEARCH"],
    createAdvancedSiteSearch: false,
    skipDefaultSchemaCreation: false,
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
basic = gcp.discoveryengine.DataStore("basic",
    location="global",
    data_store_id="data-store-id",
    display_name="tf-test-structured-datastore",
    industry_vertical="GENERIC",
    content_config="NO_CONTENT",
    solution_types=["SOLUTION_TYPE_SEARCH"],
    create_advanced_site_search=False,
    skip_default_schema_creation=False)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.DiscoveryEngine.DataStore("basic", new()
    {
        Location = "global",
        DataStoreId = "data-store-id",
        DisplayName = "tf-test-structured-datastore",
        IndustryVertical = "GENERIC",
        ContentConfig = "NO_CONTENT",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_SEARCH",
        },
        CreateAdvancedSiteSearch = false,
        SkipDefaultSchemaCreation = false,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("data-store-id"),
			DisplayName:      pulumi.String("tf-test-structured-datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_SEARCH"),
			},
			CreateAdvancedSiteSearch:  pulumi.Bool(false),
			SkipDefaultSchemaCreation: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 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 basic = new DataStore("basic", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("data-store-id")
            .displayName("tf-test-structured-datastore")
            .industryVertical("GENERIC")
            .contentConfig("NO_CONTENT")
            .solutionTypes("SOLUTION_TYPE_SEARCH")
            .createAdvancedSiteSearch(false)
            .skipDefaultSchemaCreation(false)
            .build());
    }
}
Content copied to clipboard
resources:
  basic:
    type: gcp:discoveryengine:DataStore
    properties:
      location: global
      dataStoreId: data-store-id
      displayName: tf-test-structured-datastore
      industryVertical: GENERIC
      contentConfig: NO_CONTENT
      solutionTypes:
        - SOLUTION_TYPE_SEARCH
      createAdvancedSiteSearch: false
      skipDefaultSchemaCreation: false
Content copied to clipboard

Discoveryengine Datastore Document Processing Config

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const documentProcessingConfig = new gcp.discoveryengine.DataStore("document_processing_config", {
    location: "global",
    dataStoreId: "data-store-id",
    displayName: "tf-test-structured-datastore",
    industryVertical: "GENERIC",
    contentConfig: "NO_CONTENT",
    solutionTypes: ["SOLUTION_TYPE_SEARCH"],
    createAdvancedSiteSearch: false,
    documentProcessingConfig: {
        defaultParsingConfig: {
            digitalParsingConfig: {},
        },
        parsingConfigOverrides: [{
            fileType: "pdf",
            ocrParsingConfig: {
                useNativeText: true,
            },
        }],
    },
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
document_processing_config = gcp.discoveryengine.DataStore("document_processing_config",
    location="global",
    data_store_id="data-store-id",
    display_name="tf-test-structured-datastore",
    industry_vertical="GENERIC",
    content_config="NO_CONTENT",
    solution_types=["SOLUTION_TYPE_SEARCH"],
    create_advanced_site_search=False,
    document_processing_config={
        "default_parsing_config": {
            "digital_parsing_config": {},
        },
        "parsing_config_overrides": [{
            "file_type": "pdf",
            "ocr_parsing_config": {
                "use_native_text": True,
            },
        }],
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var documentProcessingConfig = new Gcp.DiscoveryEngine.DataStore("document_processing_config", new()
    {
        Location = "global",
        DataStoreId = "data-store-id",
        DisplayName = "tf-test-structured-datastore",
        IndustryVertical = "GENERIC",
        ContentConfig = "NO_CONTENT",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_SEARCH",
        },
        CreateAdvancedSiteSearch = false,
        DocumentProcessingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigArgs
        {
            DefaultParsingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigDefaultParsingConfigArgs
            {
                DigitalParsingConfig = null,
            },
            ParsingConfigOverrides = new[]
            {
                new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigParsingConfigOverrideArgs
                {
                    FileType = "pdf",
                    OcrParsingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs
                    {
                        UseNativeText = true,
                    },
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := discoveryengine.NewDataStore(ctx, "document_processing_config", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("data-store-id"),
			DisplayName:      pulumi.String("tf-test-structured-datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_SEARCH"),
			},
			CreateAdvancedSiteSearch: pulumi.Bool(false),
			DocumentProcessingConfig: &discoveryengine.DataStoreDocumentProcessingConfigArgs{
				DefaultParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigDefaultParsingConfigArgs{
					DigitalParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigDefaultParsingConfigDigitalParsingConfigArgs{},
				},
				ParsingConfigOverrides: discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideArray{
					&discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideArgs{
						FileType: pulumi.String("pdf"),
						OcrParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs{
							UseNativeText: pulumi.Bool(true),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.inputs.DataStoreDocumentProcessingConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.DataStoreDocumentProcessingConfigDefaultParsingConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.DataStoreDocumentProcessingConfigDefaultParsingConfigDigitalParsingConfigArgs;
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 documentProcessingConfig = new DataStore("documentProcessingConfig", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("data-store-id")
            .displayName("tf-test-structured-datastore")
            .industryVertical("GENERIC")
            .contentConfig("NO_CONTENT")
            .solutionTypes("SOLUTION_TYPE_SEARCH")
            .createAdvancedSiteSearch(false)
            .documentProcessingConfig(DataStoreDocumentProcessingConfigArgs.builder()
                .defaultParsingConfig(DataStoreDocumentProcessingConfigDefaultParsingConfigArgs.builder()
                    .digitalParsingConfig(DataStoreDocumentProcessingConfigDefaultParsingConfigDigitalParsingConfigArgs.builder()
                        .build())
                    .build())
                .parsingConfigOverrides(DataStoreDocumentProcessingConfigParsingConfigOverrideArgs.builder()
                    .fileType("pdf")
                    .ocrParsingConfig(DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs.builder()
                        .useNativeText(true)
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  documentProcessingConfig:
    type: gcp:discoveryengine:DataStore
    name: document_processing_config
    properties:
      location: global
      dataStoreId: data-store-id
      displayName: tf-test-structured-datastore
      industryVertical: GENERIC
      contentConfig: NO_CONTENT
      solutionTypes:
        - SOLUTION_TYPE_SEARCH
      createAdvancedSiteSearch: false
      documentProcessingConfig:
        defaultParsingConfig:
          digitalParsingConfig: {}
        parsingConfigOverrides:
          - fileType: pdf
            ocrParsingConfig:
              useNativeText: true
Content copied to clipboard

Discoveryengine Datastore Advanced Site Search Config

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const advancedSiteSearchConfig = new gcp.discoveryengine.DataStore("advanced_site_search_config", {
    location: "global",
    dataStoreId: "data-store-id",
    displayName: "tf-test-advanced-site-search-config-datastore",
    industryVertical: "GENERIC",
    contentConfig: "PUBLIC_WEBSITE",
    solutionTypes: ["SOLUTION_TYPE_CHAT"],
    createAdvancedSiteSearch: true,
    skipDefaultSchemaCreation: false,
    advancedSiteSearchConfig: {
        disableInitialIndex: true,
        disableAutomaticRefresh: true,
    },
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
advanced_site_search_config = gcp.discoveryengine.DataStore("advanced_site_search_config",
    location="global",
    data_store_id="data-store-id",
    display_name="tf-test-advanced-site-search-config-datastore",
    industry_vertical="GENERIC",
    content_config="PUBLIC_WEBSITE",
    solution_types=["SOLUTION_TYPE_CHAT"],
    create_advanced_site_search=True,
    skip_default_schema_creation=False,
    advanced_site_search_config={
        "disable_initial_index": True,
        "disable_automatic_refresh": True,
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var advancedSiteSearchConfig = new Gcp.DiscoveryEngine.DataStore("advanced_site_search_config", new()
    {
        Location = "global",
        DataStoreId = "data-store-id",
        DisplayName = "tf-test-advanced-site-search-config-datastore",
        IndustryVertical = "GENERIC",
        ContentConfig = "PUBLIC_WEBSITE",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_CHAT",
        },
        CreateAdvancedSiteSearch = true,
        SkipDefaultSchemaCreation = false,
        AdvancedSiteSearchConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreAdvancedSiteSearchConfigArgs
        {
            DisableInitialIndex = true,
            DisableAutomaticRefresh = true,
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := discoveryengine.NewDataStore(ctx, "advanced_site_search_config", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("data-store-id"),
			DisplayName:      pulumi.String("tf-test-advanced-site-search-config-datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("PUBLIC_WEBSITE"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_CHAT"),
			},
			CreateAdvancedSiteSearch:  pulumi.Bool(true),
			SkipDefaultSchemaCreation: pulumi.Bool(false),
			AdvancedSiteSearchConfig: &discoveryengine.DataStoreAdvancedSiteSearchConfigArgs{
				DisableInitialIndex:     pulumi.Bool(true),
				DisableAutomaticRefresh: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.inputs.DataStoreAdvancedSiteSearchConfigArgs;
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 advancedSiteSearchConfig = new DataStore("advancedSiteSearchConfig", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("data-store-id")
            .displayName("tf-test-advanced-site-search-config-datastore")
            .industryVertical("GENERIC")
            .contentConfig("PUBLIC_WEBSITE")
            .solutionTypes("SOLUTION_TYPE_CHAT")
            .createAdvancedSiteSearch(true)
            .skipDefaultSchemaCreation(false)
            .advancedSiteSearchConfig(DataStoreAdvancedSiteSearchConfigArgs.builder()
                .disableInitialIndex(true)
                .disableAutomaticRefresh(true)
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  advancedSiteSearchConfig:
    type: gcp:discoveryengine:DataStore
    name: advanced_site_search_config
    properties:
      location: global
      dataStoreId: data-store-id
      displayName: tf-test-advanced-site-search-config-datastore
      industryVertical: GENERIC
      contentConfig: PUBLIC_WEBSITE
      solutionTypes:
        - SOLUTION_TYPE_CHAT
      createAdvancedSiteSearch: true
      skipDefaultSchemaCreation: false
      advancedSiteSearchConfig:
        disableInitialIndex: true
        disableAutomaticRefresh: true
Content copied to clipboard

Import

DataStore can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}

  • {{project}}/{{location}}/{{data_store_id}}

  • {{location}}/{{data_store_id}} When using the pulumi import command, DataStore can be imported using one of the formats above. For example:

$ pulumi import gcp:discoveryengine/dataStore:DataStore default projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}
Content copied to clipboard
$ pulumi import gcp:discoveryengine/dataStore:DataStore default {{project}}/{{location}}/{{data_store_id}}
Content copied to clipboard
$ pulumi import gcp:discoveryengine/dataStore:DataStore default {{location}}/{{data_store_id}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(advancedSiteSearchConfig: Output<DataStoreAdvancedSiteSearchConfigArgs>? = null, contentConfig: Output<String>? = null, createAdvancedSiteSearch: Output<Boolean>? = null, dataStoreId: Output<String>? = null, displayName: Output<String>? = null, documentProcessingConfig: Output<DataStoreDocumentProcessingConfigArgs>? = null, industryVertical: Output<String>? = null, location: Output<String>? = null, project: Output<String>? = null, skipDefaultSchemaCreation: Output<Boolean>? = null, solutionTypes: Output<List<String>>? = null)

Properties

Link copied to clipboard
val advancedSiteSearchConfig: Output<DataStoreAdvancedSiteSearchConfigArgs>? = null

Configuration data for advance site search. Structure is documented below.

Link copied to clipboard
val contentConfig: Output<String>? = null

The content config of the data store. Possible values are: NO_CONTENT, CONTENT_REQUIRED, PUBLIC_WEBSITE.

Link copied to clipboard
val createAdvancedSiteSearch: Output<Boolean>? = null

If true, an advanced data store for site search will be created. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE contentConfig), this flag will be ignored.

Link copied to clipboard
val dataStoreId: Output<String>? = null

The unique id of the data store.

Link copied to clipboard
val displayName: Output<String>? = null

The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.

Link copied to clipboard
val documentProcessingConfig: Output<DataStoreDocumentProcessingConfigArgs>? = null

Configuration for Document understanding and enrichment. Structure is documented below.

Link copied to clipboard
val industryVertical: Output<String>? = null

The industry vertical that the data store registers. Possible values are: GENERIC, MEDIA, HEALTHCARE_FHIR.

Link copied to clipboard
val location: Output<String>? = null

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

Link copied to clipboard
val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val skipDefaultSchemaCreation: Output<Boolean>? = null

A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if data_store.starting_schema is specified.

Link copied to clipboard
val solutionTypes: Output<List<String>>? = null

The solutions that the data store enrolls. Each value may be one of: SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT.

Functions

Link copied to clipboard
open override fun toJava(): DataStoreArgs