Docs Home
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
gcp.discoveryengine.DataStore
Explore with Pulumi AI
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:
- API documentation
- How-to Guides
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,
});
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)
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
})
}
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,
});
});
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());
}
}
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
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,
},
}],
},
});
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,
},
}],
})
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
})
}
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,
},
},
},
},
});
});
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()
.build())
.parsingConfigOverrides(DataStoreDocumentProcessingConfigParsingConfigOverrideArgs.builder()
.fileType("pdf")
.ocrParsingConfig(DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs.builder()
.useNativeText(true)
.build())
.build())
.build())
.build());
}
}
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
Create DataStore Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataStore(name: string, args: DataStoreArgs, opts?: CustomResourceOptions);@overload
def DataStore(resource_name: str,
args: DataStoreArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataStore(resource_name: str,
opts: Optional[ResourceOptions] = None,
content_config: Optional[str] = None,
data_store_id: Optional[str] = None,
display_name: Optional[str] = None,
industry_vertical: Optional[str] = None,
location: Optional[str] = None,
create_advanced_site_search: Optional[bool] = None,
document_processing_config: Optional[DataStoreDocumentProcessingConfigArgs] = None,
project: Optional[str] = None,
skip_default_schema_creation: Optional[bool] = None,
solution_types: Optional[Sequence[str]] = None)func NewDataStore(ctx *Context, name string, args DataStoreArgs, opts ...ResourceOption) (*DataStore, error)public DataStore(string name, DataStoreArgs args, CustomResourceOptions? opts = null)
public DataStore(String name, DataStoreArgs args)
public DataStore(String name, DataStoreArgs args, CustomResourceOptions options)
type: gcp:discoveryengine:DataStore
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 DataStoreArgs
- 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 DataStoreArgs
- 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 DataStoreArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataStoreArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataStoreArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dataStoreResource = new Gcp.DiscoveryEngine.DataStore("dataStoreResource", new()
{
ContentConfig = "string",
DataStoreId = "string",
DisplayName = "string",
IndustryVertical = "string",
Location = "string",
CreateAdvancedSiteSearch = false,
DocumentProcessingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigArgs
{
ChunkingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigChunkingConfigArgs
{
LayoutBasedChunkingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfigArgs
{
ChunkSize = 0,
IncludeAncestorHeadings = false,
},
},
DefaultParsingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigDefaultParsingConfigArgs
{
DigitalParsingConfig = null,
LayoutParsingConfig = null,
OcrParsingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfigArgs
{
UseNativeText = false,
},
},
Name = "string",
ParsingConfigOverrides = new[]
{
new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigParsingConfigOverrideArgs
{
FileType = "string",
DigitalParsingConfig = null,
LayoutParsingConfig = null,
OcrParsingConfig = new Gcp.DiscoveryEngine.Inputs.DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs
{
UseNativeText = false,
},
},
},
},
Project = "string",
SkipDefaultSchemaCreation = false,
SolutionTypes = new[]
{
"string",
},
});
example, err := discoveryengine.NewDataStore(ctx, "dataStoreResource", &discoveryengine.DataStoreArgs{
ContentConfig: pulumi.String("string"),
DataStoreId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IndustryVertical: pulumi.String("string"),
Location: pulumi.String("string"),
CreateAdvancedSiteSearch: pulumi.Bool(false),
DocumentProcessingConfig: &discoveryengine.DataStoreDocumentProcessingConfigArgs{
ChunkingConfig: &discoveryengine.DataStoreDocumentProcessingConfigChunkingConfigArgs{
LayoutBasedChunkingConfig: &discoveryengine.DataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfigArgs{
ChunkSize: pulumi.Int(0),
IncludeAncestorHeadings: pulumi.Bool(false),
},
},
DefaultParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigDefaultParsingConfigArgs{
DigitalParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigDefaultParsingConfigDigitalParsingConfigArgs{},
LayoutParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigDefaultParsingConfigLayoutParsingConfigArgs{},
OcrParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfigArgs{
UseNativeText: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
ParsingConfigOverrides: discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideArray{
&discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideArgs{
FileType: pulumi.String("string"),
DigitalParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideDigitalParsingConfigArgs{},
LayoutParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideLayoutParsingConfigArgs{},
OcrParsingConfig: &discoveryengine.DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs{
UseNativeText: pulumi.Bool(false),
},
},
},
},
Project: pulumi.String("string"),
SkipDefaultSchemaCreation: pulumi.Bool(false),
SolutionTypes: pulumi.StringArray{
pulumi.String("string"),
},
})
var dataStoreResource = new DataStore("dataStoreResource", DataStoreArgs.builder()
.contentConfig("string")
.dataStoreId("string")
.displayName("string")
.industryVertical("string")
.location("string")
.createAdvancedSiteSearch(false)
.documentProcessingConfig(DataStoreDocumentProcessingConfigArgs.builder()
.chunkingConfig(DataStoreDocumentProcessingConfigChunkingConfigArgs.builder()
.layoutBasedChunkingConfig(DataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfigArgs.builder()
.chunkSize(0)
.includeAncestorHeadings(false)
.build())
.build())
.defaultParsingConfig(DataStoreDocumentProcessingConfigDefaultParsingConfigArgs.builder()
.digitalParsingConfig()
.layoutParsingConfig()
.ocrParsingConfig(DataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfigArgs.builder()
.useNativeText(false)
.build())
.build())
.name("string")
.parsingConfigOverrides(DataStoreDocumentProcessingConfigParsingConfigOverrideArgs.builder()
.fileType("string")
.digitalParsingConfig()
.layoutParsingConfig()
.ocrParsingConfig(DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs.builder()
.useNativeText(false)
.build())
.build())
.build())
.project("string")
.skipDefaultSchemaCreation(false)
.solutionTypes("string")
.build());
data_store_resource = gcp.discoveryengine.DataStore("dataStoreResource",
content_config="string",
data_store_id="string",
display_name="string",
industry_vertical="string",
location="string",
create_advanced_site_search=False,
document_processing_config={
"chunking_config": {
"layout_based_chunking_config": {
"chunk_size": 0,
"include_ancestor_headings": False,
},
},
"default_parsing_config": {
"digital_parsing_config": {},
"layout_parsing_config": {},
"ocr_parsing_config": {
"use_native_text": False,
},
},
"name": "string",
"parsing_config_overrides": [{
"file_type": "string",
"digital_parsing_config": {},
"layout_parsing_config": {},
"ocr_parsing_config": {
"use_native_text": False,
},
}],
},
project="string",
skip_default_schema_creation=False,
solution_types=["string"])
const dataStoreResource = new gcp.discoveryengine.DataStore("dataStoreResource", {
contentConfig: "string",
dataStoreId: "string",
displayName: "string",
industryVertical: "string",
location: "string",
createAdvancedSiteSearch: false,
documentProcessingConfig: {
chunkingConfig: {
layoutBasedChunkingConfig: {
chunkSize: 0,
includeAncestorHeadings: false,
},
},
defaultParsingConfig: {
digitalParsingConfig: {},
layoutParsingConfig: {},
ocrParsingConfig: {
useNativeText: false,
},
},
name: "string",
parsingConfigOverrides: [{
fileType: "string",
digitalParsingConfig: {},
layoutParsingConfig: {},
ocrParsingConfig: {
useNativeText: false,
},
}],
},
project: "string",
skipDefaultSchemaCreation: false,
solutionTypes: ["string"],
});
type: gcp:discoveryengine:DataStore
properties:
contentConfig: string
createAdvancedSiteSearch: false
dataStoreId: string
displayName: string
documentProcessingConfig:
chunkingConfig:
layoutBasedChunkingConfig:
chunkSize: 0
includeAncestorHeadings: false
defaultParsingConfig:
digitalParsingConfig: {}
layoutParsingConfig: {}
ocrParsingConfig:
useNativeText: false
name: string
parsingConfigOverrides:
- digitalParsingConfig: {}
fileType: string
layoutParsingConfig: {}
ocrParsingConfig:
useNativeText: false
industryVertical: string
location: string
project: string
skipDefaultSchemaCreation: false
solutionTypes:
- string
DataStore Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataStore resource accepts the following input properties:
- Content
Config string - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - Data
Store stringId - The unique id of the data store.
- Display
Name string - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Industry
Vertical string - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Create
Advanced boolSite Search - 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.
- Document
Processing DataConfig Store Document Processing Config - Configuration for Document understanding and enrichment. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Skip
Default boolSchema Creation - 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_schemais specified. - Solution
Types List<string> - 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.
- Content
Config string - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - Data
Store stringId - The unique id of the data store.
- Display
Name string - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Industry
Vertical string - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Create
Advanced boolSite Search - 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.
- Document
Processing DataConfig Store Document Processing Config Args - Configuration for Document understanding and enrichment. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Skip
Default boolSchema Creation - 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_schemais specified. - Solution
Types []string - 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.
- content
Config String - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - data
Store StringId - The unique id of the data store.
- display
Name String - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- industry
Vertical String - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- create
Advanced BooleanSite Search - 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.
- document
Processing DataConfig Store Document Processing Config - Configuration for Document understanding and enrichment. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- skip
Default BooleanSchema Creation - 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_schemais specified. - solution
Types List<String> - 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.
- content
Config string - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - data
Store stringId - The unique id of the data store.
- display
Name string - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- industry
Vertical string - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- create
Advanced booleanSite Search - 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.
- document
Processing DataConfig Store Document Processing Config - Configuration for Document understanding and enrichment. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- skip
Default booleanSchema Creation - 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_schemais specified. - solution
Types string[] - 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.
- content_
config str - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - data_
store_ strid - The unique id of the data store.
- display_
name str - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- industry_
vertical str - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location str
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- create_
advanced_ boolsite_ search - 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.
- document_
processing_ Dataconfig Store Document Processing Config Args - Configuration for Document understanding and enrichment. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- skip_
default_ boolschema_ creation - 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_schemais specified. - solution_
types Sequence[str] - 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.
- content
Config String - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - data
Store StringId - The unique id of the data store.
- display
Name String - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- industry
Vertical String - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- create
Advanced BooleanSite Search - 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.
- document
Processing Property MapConfig - Configuration for Document understanding and enrichment. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- skip
Default BooleanSchema Creation - 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_schemais specified. - solution
Types List<String> - 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataStore resource produces the following output properties:
- Create
Time string - Timestamp when the DataStore was created.
- Default
Schema stringId - The id of the default Schema associated with this data store.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- Create
Time string - Timestamp when the DataStore was created.
- Default
Schema stringId - The id of the default Schema associated with this data store.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- create
Time String - Timestamp when the DataStore was created.
- default
Schema StringId - The id of the default Schema associated with this data store.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- create
Time string - Timestamp when the DataStore was created.
- default
Schema stringId - The id of the default Schema associated with this data store.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- create_
time str - Timestamp when the DataStore was created.
- default_
schema_ strid - The id of the default Schema associated with this data store.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- create
Time String - Timestamp when the DataStore was created.
- default
Schema StringId - The id of the default Schema associated with this data store.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Look up Existing DataStore Resource
Get an existing DataStore 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?: DataStoreState, opts?: CustomResourceOptions): DataStore@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
content_config: Optional[str] = None,
create_advanced_site_search: Optional[bool] = None,
create_time: Optional[str] = None,
data_store_id: Optional[str] = None,
default_schema_id: Optional[str] = None,
display_name: Optional[str] = None,
document_processing_config: Optional[DataStoreDocumentProcessingConfigArgs] = None,
industry_vertical: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
skip_default_schema_creation: Optional[bool] = None,
solution_types: Optional[Sequence[str]] = None) -> DataStorefunc GetDataStore(ctx *Context, name string, id IDInput, state *DataStoreState, opts ...ResourceOption) (*DataStore, error)public static DataStore Get(string name, Input<string> id, DataStoreState? state, CustomResourceOptions? opts = null)public static DataStore get(String name, Output<String> id, DataStoreState 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.
- Content
Config string - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - Create
Advanced boolSite Search - 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.
- Create
Time string - Timestamp when the DataStore was created.
- Data
Store stringId - The unique id of the data store.
- Default
Schema stringId - The id of the default Schema associated with this data store.
- Display
Name string - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Document
Processing DataConfig Store Document Processing Config - Configuration for Document understanding and enrichment. Structure is documented below.
- Industry
Vertical string - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Name string
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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.
- Skip
Default boolSchema Creation - 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_schemais specified. - Solution
Types List<string> - 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.
- Content
Config string - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - Create
Advanced boolSite Search - 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.
- Create
Time string - Timestamp when the DataStore was created.
- Data
Store stringId - The unique id of the data store.
- Default
Schema stringId - The id of the default Schema associated with this data store.
- Display
Name string - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Document
Processing DataConfig Store Document Processing Config Args - Configuration for Document understanding and enrichment. Structure is documented below.
- Industry
Vertical string - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Name string
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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.
- Skip
Default boolSchema Creation - 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_schemais specified. - Solution
Types []string - 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.
- content
Config String - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - create
Advanced BooleanSite Search - 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.
- create
Time String - Timestamp when the DataStore was created.
- data
Store StringId - The unique id of the data store.
- default
Schema StringId - The id of the default Schema associated with this data store.
- display
Name String - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- document
Processing DataConfig Store Document Processing Config - Configuration for Document understanding and enrichment. Structure is documented below.
- industry
Vertical String - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name String
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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.
- skip
Default BooleanSchema Creation - 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_schemais specified. - solution
Types List<String> - 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.
- content
Config string - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - create
Advanced booleanSite Search - 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.
- create
Time string - Timestamp when the DataStore was created.
- data
Store stringId - The unique id of the data store.
- default
Schema stringId - The id of the default Schema associated with this data store.
- display
Name string - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- document
Processing DataConfig Store Document Processing Config - Configuration for Document understanding and enrichment. Structure is documented below.
- industry
Vertical string - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name string
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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.
- skip
Default booleanSchema Creation - 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_schemais specified. - solution
Types string[] - 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.
- content_
config str - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - create_
advanced_ boolsite_ search - 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.
- create_
time str - Timestamp when the DataStore was created.
- data_
store_ strid - The unique id of the data store.
- default_
schema_ strid - The id of the default Schema associated with this data store.
- display_
name str - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- document_
processing_ Dataconfig Store Document Processing Config Args - Configuration for Document understanding and enrichment. Structure is documented below.
- industry_
vertical str - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location str
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name str
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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.
- skip_
default_ boolschema_ creation - 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_schemais specified. - solution_
types Sequence[str] - 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.
- content
Config String - The content config of the data store.
Possible values are:
NO_CONTENT,CONTENT_REQUIRED,PUBLIC_WEBSITE. - create
Advanced BooleanSite Search - 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.
- create
Time String - Timestamp when the DataStore was created.
- data
Store StringId - The unique id of the data store.
- default
Schema StringId - The id of the default Schema associated with this data store.
- display
Name String - The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- document
Processing Property MapConfig - Configuration for Document understanding and enrichment. Structure is documented below.
- industry
Vertical String - The industry vertical that the data store registers.
Possible values are:
GENERIC,MEDIA,HEALTHCARE_FHIR. - location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name String
- The unique full resource name of the data store. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_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.
- skip
Default BooleanSchema Creation - 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_schemais specified. - solution
Types List<String> - 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.
Supporting Types
DataStoreDocumentProcessingConfig, DataStoreDocumentProcessingConfigArgs
- Chunking
Config DataStore Document Processing Config Chunking Config - Whether chunking mode is enabled. Structure is documented below.
- Default
Parsing DataConfig Store Document Processing Config Default Parsing Config - Configurations for default Document parser. If not specified, this resource will be configured to use a default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. Structure is documented below.
- Name string
- (Output)
The full resource name of the Document Processing Config. Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig. - Parsing
Config List<DataOverrides Store Document Processing Config Parsing Config Override> - Map from file type to override the default parsing configuration based on the file type. Supported keys:
- Chunking
Config DataStore Document Processing Config Chunking Config - Whether chunking mode is enabled. Structure is documented below.
- Default
Parsing DataConfig Store Document Processing Config Default Parsing Config - Configurations for default Document parser. If not specified, this resource will be configured to use a default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. Structure is documented below.
- Name string
- (Output)
The full resource name of the Document Processing Config. Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig. - Parsing
Config []DataOverrides Store Document Processing Config Parsing Config Override - Map from file type to override the default parsing configuration based on the file type. Supported keys:
- chunking
Config DataStore Document Processing Config Chunking Config - Whether chunking mode is enabled. Structure is documented below.
- default
Parsing DataConfig Store Document Processing Config Default Parsing Config - Configurations for default Document parser. If not specified, this resource will be configured to use a default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. Structure is documented below.
- name String
- (Output)
The full resource name of the Document Processing Config. Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig. - parsing
Config List<DataOverrides Store Document Processing Config Parsing Config Override> - Map from file type to override the default parsing configuration based on the file type. Supported keys:
- chunking
Config DataStore Document Processing Config Chunking Config - Whether chunking mode is enabled. Structure is documented below.
- default
Parsing DataConfig Store Document Processing Config Default Parsing Config - Configurations for default Document parser. If not specified, this resource will be configured to use a default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. Structure is documented below.
- name string
- (Output)
The full resource name of the Document Processing Config. Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig. - parsing
Config DataOverrides Store Document Processing Config Parsing Config Override[] - Map from file type to override the default parsing configuration based on the file type. Supported keys:
- chunking_
config DataStore Document Processing Config Chunking Config - Whether chunking mode is enabled. Structure is documented below.
- default_
parsing_ Dataconfig Store Document Processing Config Default Parsing Config - Configurations for default Document parser. If not specified, this resource will be configured to use a default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. Structure is documented below.
- name str
- (Output)
The full resource name of the Document Processing Config. Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig. - parsing_
config_ Sequence[Dataoverrides Store Document Processing Config Parsing Config Override] - Map from file type to override the default parsing configuration based on the file type. Supported keys:
- chunking
Config Property Map - Whether chunking mode is enabled. Structure is documented below.
- default
Parsing Property MapConfig - Configurations for default Document parser. If not specified, this resource will be configured to use a default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. Structure is documented below.
- name String
- (Output)
The full resource name of the Document Processing Config. Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig. - parsing
Config List<Property Map>Overrides - Map from file type to override the default parsing configuration based on the file type. Supported keys:
DataStoreDocumentProcessingConfigChunkingConfig, DataStoreDocumentProcessingConfigChunkingConfigArgs
- Layout
Based DataChunking Config Store Document Processing Config Chunking Config Layout Based Chunking Config - Configuration for the layout based chunking. Structure is documented below.
- Layout
Based DataChunking Config Store Document Processing Config Chunking Config Layout Based Chunking Config - Configuration for the layout based chunking. Structure is documented below.
- layout
Based DataChunking Config Store Document Processing Config Chunking Config Layout Based Chunking Config - Configuration for the layout based chunking. Structure is documented below.
- layout
Based DataChunking Config Store Document Processing Config Chunking Config Layout Based Chunking Config - Configuration for the layout based chunking. Structure is documented below.
- layout_
based_ Datachunking_ config Store Document Processing Config Chunking Config Layout Based Chunking Config - Configuration for the layout based chunking. Structure is documented below.
- layout
Based Property MapChunking Config - Configuration for the layout based chunking. Structure is documented below.
DataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig, DataStoreDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfigArgs
- Chunk
Size int - The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
- Include
Ancestor boolHeadings - Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
- Chunk
Size int - The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
- Include
Ancestor boolHeadings - Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
- chunk
Size Integer - The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
- include
Ancestor BooleanHeadings - Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
- chunk
Size number - The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
- include
Ancestor booleanHeadings - Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
- chunk_
size int - The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
- include_
ancestor_ boolheadings - Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
- chunk
Size Number - The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
- include
Ancestor BooleanHeadings - Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
DataStoreDocumentProcessingConfigDefaultParsingConfig, DataStoreDocumentProcessingConfigDefaultParsingConfigArgs
- Digital
Parsing DataConfig Store Document Processing Config Default Parsing Config Digital Parsing Config - Configurations applied to digital parser.
- Layout
Parsing DataConfig Store Document Processing Config Default Parsing Config Layout Parsing Config - Configurations applied to layout parser.
- Ocr
Parsing DataConfig Store Document Processing Config Default Parsing Config Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- Digital
Parsing DataConfig Store Document Processing Config Default Parsing Config Digital Parsing Config - Configurations applied to digital parser.
- Layout
Parsing DataConfig Store Document Processing Config Default Parsing Config Layout Parsing Config - Configurations applied to layout parser.
- Ocr
Parsing DataConfig Store Document Processing Config Default Parsing Config Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- digital
Parsing DataConfig Store Document Processing Config Default Parsing Config Digital Parsing Config - Configurations applied to digital parser.
- layout
Parsing DataConfig Store Document Processing Config Default Parsing Config Layout Parsing Config - Configurations applied to layout parser.
- ocr
Parsing DataConfig Store Document Processing Config Default Parsing Config Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- digital
Parsing DataConfig Store Document Processing Config Default Parsing Config Digital Parsing Config - Configurations applied to digital parser.
- layout
Parsing DataConfig Store Document Processing Config Default Parsing Config Layout Parsing Config - Configurations applied to layout parser.
- ocr
Parsing DataConfig Store Document Processing Config Default Parsing Config Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- digital_
parsing_ Dataconfig Store Document Processing Config Default Parsing Config Digital Parsing Config - Configurations applied to digital parser.
- layout_
parsing_ Dataconfig Store Document Processing Config Default Parsing Config Layout Parsing Config - Configurations applied to layout parser.
- ocr_
parsing_ Dataconfig Store Document Processing Config Default Parsing Config Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- digital
Parsing Property MapConfig - Configurations applied to digital parser.
- layout
Parsing Property MapConfig - Configurations applied to layout parser.
- ocr
Parsing Property MapConfig - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
DataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfig, DataStoreDocumentProcessingConfigDefaultParsingConfigOcrParsingConfigArgs
- Use
Native boolText - If true, will use native text instead of OCR text on pages containing native text.
- Use
Native boolText - If true, will use native text instead of OCR text on pages containing native text.
- use
Native BooleanText - If true, will use native text instead of OCR text on pages containing native text.
- use
Native booleanText - If true, will use native text instead of OCR text on pages containing native text.
- use_
native_ booltext - If true, will use native text instead of OCR text on pages containing native text.
- use
Native BooleanText - If true, will use native text instead of OCR text on pages containing native text.
DataStoreDocumentProcessingConfigParsingConfigOverride, DataStoreDocumentProcessingConfigParsingConfigOverrideArgs
- File
Type string - The identifier for this object. Format specified above.
- Digital
Parsing DataConfig Store Document Processing Config Parsing Config Override Digital Parsing Config - Configurations applied to digital parser.
- Layout
Parsing DataConfig Store Document Processing Config Parsing Config Override Layout Parsing Config - Configurations applied to layout parser.
- Ocr
Parsing DataConfig Store Document Processing Config Parsing Config Override Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- File
Type string - The identifier for this object. Format specified above.
- Digital
Parsing DataConfig Store Document Processing Config Parsing Config Override Digital Parsing Config - Configurations applied to digital parser.
- Layout
Parsing DataConfig Store Document Processing Config Parsing Config Override Layout Parsing Config - Configurations applied to layout parser.
- Ocr
Parsing DataConfig Store Document Processing Config Parsing Config Override Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- file
Type String - The identifier for this object. Format specified above.
- digital
Parsing DataConfig Store Document Processing Config Parsing Config Override Digital Parsing Config - Configurations applied to digital parser.
- layout
Parsing DataConfig Store Document Processing Config Parsing Config Override Layout Parsing Config - Configurations applied to layout parser.
- ocr
Parsing DataConfig Store Document Processing Config Parsing Config Override Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- file
Type string - The identifier for this object. Format specified above.
- digital
Parsing DataConfig Store Document Processing Config Parsing Config Override Digital Parsing Config - Configurations applied to digital parser.
- layout
Parsing DataConfig Store Document Processing Config Parsing Config Override Layout Parsing Config - Configurations applied to layout parser.
- ocr
Parsing DataConfig Store Document Processing Config Parsing Config Override Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- file_
type str - The identifier for this object. Format specified above.
- digital_
parsing_ Dataconfig Store Document Processing Config Parsing Config Override Digital Parsing Config - Configurations applied to digital parser.
- layout_
parsing_ Dataconfig Store Document Processing Config Parsing Config Override Layout Parsing Config - Configurations applied to layout parser.
- ocr_
parsing_ Dataconfig Store Document Processing Config Parsing Config Override Ocr Parsing Config - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
- file
Type String - The identifier for this object. Format specified above.
- digital
Parsing Property MapConfig - Configurations applied to digital parser.
- layout
Parsing Property MapConfig - Configurations applied to layout parser.
- ocr
Parsing Property MapConfig - Configurations applied to OCR parser. Currently it only applies to PDFs. Structure is documented below.
DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfig, DataStoreDocumentProcessingConfigParsingConfigOverrideOcrParsingConfigArgs
- Use
Native boolText - If true, will use native text instead of OCR text on pages containing native text.
- Use
Native boolText - If true, will use native text instead of OCR text on pages containing native text.
- use
Native BooleanText - If true, will use native text instead of OCR text on pages containing native text.
- use
Native booleanText - If true, will use native text instead of OCR text on pages containing native text.
- use_
native_ booltext - If true, will use native text instead of OCR text on pages containing native text.
- use
Native BooleanText - If true, will use native text instead of OCR text on pages containing native text.
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}}
$ pulumi import gcp:discoveryengine/dataStore:DataStore default {{project}}/{{location}}/{{data_store_id}}
$ pulumi import gcp:discoveryengine/dataStore:DataStore default {{location}}/{{data_store_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-betaTerraform Provider.