- Resource: DataStore
- JSON representation
- ContentConfig
- AdvancedSiteSearchConfig
- LanguageInfo
- NaturalLanguageQueryUnderstandingConfig
- Mode
- CmekConfig
- State
- BillingEstimation
- WorkspaceConfig
- Type
- DocumentProcessingConfig
- ChunkingConfig
- LayoutBasedChunkingConfig
- ParsingConfig
- DigitalParsingConfig
- OcrParsingConfig
- LayoutParsingConfig
- ServingConfigDataStore
- Methods
Resource: DataStore
DataStore captures global settings and configs at the DataStore level.
JSON representation |
---|
{ "name": string, "displayName": string, "industryVertical": enum ( |
Fields | |
---|---|
name |
Immutable. The full resource name of the data store. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
display |
Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
industry |
Immutable. The industry vertical that the data store registers. |
solution |
The solutions that the data store enrolls. Available solutions for each
|
default |
Output only. The id of the default |
content |
Immutable. The content config of the data store. If this field is unset, the server behavior defaults to |
create |
Output only. Timestamp the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
advanced |
Optional. Configuration for advanced site search. |
language |
Language info for DataStore. |
natural |
Optional. Configuration for Natural Language Query Understanding. |
kms |
Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmekConfig field. |
cmek |
Output only. CMEK-related information for the DataStore. |
billing |
Output only. data size estimation for billing. |
workspace |
Config to store data store type configuration for workspace data. This must be set when |
document |
Configuration for Document understanding and enrichment. |
starting |
The start schema to use for this This field is only used by [dataStores.create][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [dataStores.create][] API. To retrieve a schema of a The provided schema will be validated against certain rules on schema. Learn more from this doc. |
serving |
Optional. Stores serving config at DataStore level. |
ContentConfig
Content config of the data store.
Enums | |
---|---|
CONTENT_CONFIG_UNSPECIFIED |
Default value. |
NO_CONTENT |
Only contains documents without any Document.content . |
CONTENT_REQUIRED |
Only contains documents with Document.content . |
PUBLIC_WEBSITE |
The data store is used for public website search. |
GOOGLE_WORKSPACE |
The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig . |
AdvancedSiteSearchConfig
This type has no fields.
Configuration data for advance site search.
LanguageInfo
Language info for DataStore.
JSON representation |
---|
{ "languageCode": string, "normalizedLanguageCode": string, "language": string, "region": string } |
Fields | |
---|---|
language |
The language code for the DataStore. |
normalized |
Output only. This is the normalized form of languageCode. E.g.: languageCode of |
language |
Output only. Language part of normalizedLanguageCode. E.g.: |
region |
Output only. Region part of normalizedLanguageCode, if present. E.g.: |
NaturalLanguageQueryUnderstandingConfig
Configuration for Natural Language Query Understanding.
JSON representation |
---|
{
"mode": enum ( |
Fields | |
---|---|
mode |
Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to |
Mode
Mode of Natural Language Query Understanding. When the NaturalLanguageQueryUnderstandingConfig.Mode is ENABLED, the natural language understanding capabilities will be enabled for a search request if the NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition in the SearchRequest is ENABLED.
Enums | |
---|---|
MODE_UNSPECIFIED |
Default value. |
DISABLED |
Natural Language Query Understanding is disabled. |
ENABLED |
Natural Language Query Understanding is enabled. |
CmekConfig
Configurations used to enable CMEK data encryption with Cloud KMS keys.
JSON representation |
---|
{
"name": string,
"kmsKey": string,
"kmsKeyVersion": string,
"state": enum ( |
Fields | |
---|---|
name |
Required. name of the CmekConfig, of the form |
kms |
Kms key resource name which will be used to encrypt resources |
kms |
Kms key version resource name which will be used to encrypt resources |
state |
Output only. state of the CmekConfig. |
is |
Output only. The default CmekConfig for the Customer. |
last |
Output only. The timestamp of the last key rotation. |
State
States of the CmekConfig.
Enums | |
---|---|
STATE_UNSPECIFIED |
The CmekConfig state is unknown. |
CREATING |
The CmekConfig is creating. |
ACTIVE |
The CmekConfig can be used with DataStores. |
KEY_ISSUE |
The CmekConfig is unavailable, most likely due to the KMS Key being revoked. |
DELETING |
The CmekConfig is deleting. |
UNUSABLE |
The CmekConfig is not usable, most likely due to some internal issue. |
ACTIVE_ROTATING |
The KMS key version is being rotated. |
BillingEstimation
Estimation of data size per data store.
JSON representation |
---|
{ "structuredDataSize": string, "unstructuredDataSize": string, "websiteDataSize": string, "structuredDataUpdateTime": string, "unstructuredDataUpdateTime": string, "websiteDataUpdateTime": string } |
Fields | |
---|---|
structured |
data size for structured data in terms of bytes. |
unstructured |
data size for unstructured data in terms of bytes. |
website |
data size for websites in terms of bytes. |
structured |
Last updated timestamp for structured data. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
unstructured |
Last updated timestamp for unstructured data. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
website |
Last updated timestamp for websites. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
WorkspaceConfig
Config to store data store type configuration for workspace data
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
The Google Workspace data source. |
dasher |
Obfuscated Dasher customer id. |
super |
Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. |
super |
Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. |
Type
Specifies the type of Workspace App supported by this DataStore
Enums | |
---|---|
TYPE_UNSPECIFIED |
Defaults to an unspecified Workspace type. |
GOOGLE_DRIVE |
Workspace data Store contains Drive data |
GOOGLE_MAIL |
Workspace data Store contains mail data |
GOOGLE_SITES |
Workspace data Store contains Sites data |
GOOGLE_CALENDAR |
Workspace data Store contains Calendar data |
GOOGLE_CHAT |
Workspace data Store contains Chat data |
GOOGLE_GROUPS |
Workspace data Store contains Groups data |
GOOGLE_KEEP |
Workspace data Store contains Keep data |
DocumentProcessingConfig
A singleton resource of DataStore
. If it's empty when DataStore
is created and DataStore
is set to DataStore.ContentConfig.CONTENT_REQUIRED
, the default parser will default to digital parser.
JSON representation |
---|
{ "name": string, "chunkingConfig": { object ( |
Fields | |
---|---|
name |
The full resource name of the Document Processing Config. Format: |
chunking |
Whether chunking mode is enabled. |
default |
Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. |
parsing |
Map from file type to override the default parsing configuration based on the file type. Supported keys:
|
ChunkingConfig
Configuration for chunking config.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field chunk_mode . Additional configs that defines the behavior of the chunking. chunk_mode can be only one of the following: |
|
layout |
Configuration for the layout based chunking. |
LayoutBasedChunkingConfig
Configuration for the layout based chunking.
JSON representation |
---|
{ "chunkSize": integer, "includeAncestorHeadings": boolean } |
Fields | |
---|---|
chunk |
The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. |
include |
Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. |
ParsingConfig
Related configurations applied to a specific type of document parser.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field type_dedicated_config . Configs for document processing types. type_dedicated_config can be only one of the following: |
|
digital |
Configurations applied to digital parser. |
ocr |
Configurations applied to OCR parser. Currently it only applies to PDFs. |
layout |
Configurations applied to layout parser. |
DigitalParsingConfig
This type has no fields.
The digital parsing configurations for documents.
OcrParsingConfig
The OCR parsing configurations for documents.
JSON representation |
---|
{ "enhancedDocumentElements": [ string ], "useNativeText": boolean } |
Fields | |
---|---|
enhancedDocumentElements[] |
[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to |
use |
If true, will use native text instead of OCR text on pages containing native text. |
LayoutParsingConfig
This type has no fields.
The layout parsing configurations for documents.
ServingConfigDataStore
Stores information regarding the serving configurations at DataStore level.
JSON representation |
---|
{ "disabledForServing": boolean } |
Fields | |
---|---|
disabled |
If set true, the DataStore will not be available for serving search requests. |
Methods |
|
---|---|
|
Completes the specified user input with keyword suggestions. |
|
Creates a DataStore . |
|
Deletes a DataStore . |
|
Gets a DataStore . |
|
Gets the SiteSearchEngine . |
|
Lists all the DataStore s associated with the project. |
|
Updates a DataStore |
|
Trains a custom model. |