Console
    Contact Us Start free

    REST Resource: projects.locations.collections.dataStores

    Resource: DataStore

    DataStore captures global settings and configs at the DataStore level.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "industryVertical" 
 : 
 enum (  IndustryVertical 
 
) 
 , 
 "solutionTypes" 
 : 
 [ 
 enum (  SolutionType 
 
) 
 ] 
 , 
 "defaultSchemaId" 
 : 
 string 
 , 
 "contentConfig" 
 : 
 enum (  ContentConfig 
 
) 
 , 
 "createTime" 
 : 
 string 
 , 
 "advancedSiteSearchConfig" 
 : 
 { 
 object (  AdvancedSiteSearchConfig 
 
) 
 } 
 , 
 "kmsKeyName" 
 : 
 string 
 , 
 "cmekConfig" 
 : 
 { 
 object (  CmekConfig 
 
) 
 } 
 , 
 "billingEstimation" 
 : 
 { 
 object (  BillingEstimation 
 
) 
 } 
 , 
 "aclEnabled" 
 : 
 boolean 
 , 
 "workspaceConfig" 
 : 
 { 
 object (  WorkspaceConfig 
 
) 
 } 
 , 
 "documentProcessingConfig" 
 : 
 { 
 object (  DocumentProcessingConfig 
 
) 
 } 
 , 
 "startingSchema" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 "healthcareFhirConfig" 
 : 
 { 
 object (  HealthcareFhirConfig 
 
) 
 } 
 , 
 "servingConfigDataStore" 
 : 
 { 
 object (  ServingConfigDataStore 
 
) 
 } 
 , 
 "identityMappingStore" 
 : 
 string 
 , 
 "isInfobotFaqDataStore" 
 : 
 boolean 
 }
    Fields
    name

    string

    Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} .

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.

    displayName

    string

    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.

    industryVertical

    enum ( IndustryVertical )

    Immutable. The industry vertical that the data store registers.

    solutionTypes[]

    enum ( SolutionType )

    The solutions that the data store enrolls. Available solutions for each industryVertical :

    • MEDIA : SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH .
    • SITE_SEARCH : SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.
    defaultSchemaId

    string

    Output only. The ID of the default Schema associated to this data store.

    contentConfig

    enum ( ContentConfig )

    Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT .

    createTime

    string ( Timestamp format)

    Output only. Timestamp the DataStore was created at.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    advancedSiteSearchConfig

    object ( AdvancedSiteSearchConfig )

    Optional. Configuration for advanced site search.

    kmsKeyName

    string

    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.

    cmekConfig

    object ( CmekConfig )

    Output only. CMEK-related information for the DataStore.

    billingEstimation

    object ( BillingEstimation )

    Output only. Data size estimation for billing.

    aclEnabled

    boolean

    Immutable. Whether data in the DataStore has ACL information. If set to true , the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods.

    When ACL is enabled for the DataStore , Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments .

    Currently ACL is only supported in GENERIC industry vertical with non- PUBLIC_WEBSITE content config.

    workspaceConfig

    object ( WorkspaceConfig )

    Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE .

    documentProcessingConfig

    object ( DocumentProcessingConfig )

    Configuration for Document understanding and enrichment.

    startingSchema

    object ( Schema )

    The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

    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 DataStore , use SchemaService.GetSchema API instead.

    The provided schema will be validated against certain rules on schema. Learn more from this doc .

    healthcareFhirConfig

    object ( HealthcareFhirConfig )

    Optional. Configuration for HEALTHCARE_FHIR vertical.

    servingConfigDataStore

    object ( ServingConfigDataStore )

    Optional. Stores serving config at DataStore level.

    identityMappingStore

    string

    Immutable. The fully qualified resource name of the associated IdentityMappingStore . This field can only be set for aclEnabled DataStores with THIRD_PARTY or GSUITE IdP. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore} .

    isInfobotFaqDataStore

    boolean

    Optional. If set, this DataStore is an Infobot FAQ DataStore.

    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

    Configuration data for advance site search.

    JSON representation 
     { 
 "disableInitialIndex" 
 : 
 boolean 
 , 
 "disableAutomaticRefresh" 
 : 
 boolean 
 }
    Fields
    disableInitialIndex

    boolean

    If set true, initial indexing is disabled for the DataStore.
    disableAutomaticRefresh

    boolean

    If set true, automatic refresh is disabled for the DataStore.

    BillingEstimation

    Estimation of data size per data store.

    JSON representation 
     { 
 "structuredDataSize" 
 : 
 string 
 , 
 "unstructuredDataSize" 
 : 
 string 
 , 
 "websiteDataSize" 
 : 
 string 
 , 
 "structuredDataUpdateTime" 
 : 
 string 
 , 
 "unstructuredDataUpdateTime" 
 : 
 string 
 , 
 "websiteDataUpdateTime" 
 : 
 string 
 }
    Fields
    structuredDataSize

    string ( int64 format)

    Data size for structured data in terms of bytes.
    unstructuredDataSize

    string ( int64 format)

    data size for unstructured data in terms of bytes.
    websiteDataSize

    string ( int64 format)

    data size for websites in terms of bytes.
    structuredDataUpdateTime

    string ( Timestamp format)

    Last updated timestamp for structured data.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    unstructuredDataUpdateTime

    string ( Timestamp format)

    Last updated timestamp for unstructured data.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    websiteDataUpdateTime

    string ( Timestamp format)

    Last updated timestamp for websites.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    WorkspaceConfig

    Config to store data store type configuration for workspace data

    JSON representation 
     { 
 "type" 
 : 
 enum (  Type 
 
) 
 , 
 "dasherCustomerId" 
 : 
 string 
 , 
 "superAdminServiceAccount" 
 : 
 string 
 , 
 "superAdminEmailAddress" 
 : 
 string 
 }
    Fields
    type

    enum ( Type )

    The Google Workspace data source.
    dasherCustomerId

    string

    Obfuscated Dasher customer ID.
    superAdminEmailAddress

    string

    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
    GOOGLE_PEOPLE Workspace data store contains People 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 (  ChunkingConfig 
 
) 
 } 
 , 
 "defaultParsingConfig" 
 : 
 { 
 object (  ParsingConfig 
 
) 
 } 
 , 
 "parsingConfigOverrides" 
 : 
 { 
 string 
 : 
 { 
 object (  ParsingConfig 
 
) 
 } 
 , 
 ... 
 } 
 }
    Fields
    name

    string

    The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig .

    chunkingConfig

    object ( ChunkingConfig )

    Whether chunking mode is enabled.

    defaultParsingConfig

    object ( ParsingConfig )

    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.

    parsingConfigOverrides

    map (key: string, value: object ( ParsingConfig ))

    Map from file type to override the default parsing configuration based on the file type. Supported keys:

    • pdf : Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported.
    • html : Override parsing config for HTML files, only digital parsing and layout parsing are supported.
    • docx : Override parsing config for DOCX files, only digital parsing and layout parsing are supported.
    • pptx : Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
    • xlsm : Override parsing config for XLSM files, only digital parsing and layout parsing are supported.
    • xlsx : Override parsing config for XLSX files, only digital parsing and layout parsing are supported.

    ChunkingConfig

    Configuration for chunking config.

    JSON representation 
     { 
 // Union field chunk_mode 
can be only one of the following: 
 "layoutBasedChunkingConfig" 
 : 
 { 
 object (  LayoutBasedChunkingConfig 
 
) 
 } 
 // End of list of possible types for union field chunk_mode 
. 
 }
    Fields
    Union field chunk_mode . Additional configs that defines the behavior of the chunking. chunk_mode can be only one of the following:
    layoutBasedChunkingConfig

    object ( LayoutBasedChunkingConfig )

    Configuration for the layout based chunking.

    LayoutBasedChunkingConfig

    Configuration for the layout based chunking.

    JSON representation 
     { 
 "chunkSize" 
 : 
 integer 
 , 
 "includeAncestorHeadings" 
 : 
 boolean 
 }
    Fields
    chunkSize

    integer

    The token size limit for each chunk.

    Supported values: 100-500 (inclusive). Default value: 500.
    includeAncestorHeadings

    boolean

    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 type_dedicated_config 
can be only one of the following: 
 "digitalParsingConfig" 
 : 
 { 
 object (  DigitalParsingConfig 
 
) 
 } 
 , 
 "ocrParsingConfig" 
 : 
 { 
 object (  OcrParsingConfig 
 
) 
 } 
 , 
 "layoutParsingConfig" 
 : 
 { 
 object (  LayoutParsingConfig 
 
) 
 } 
 // End of list of possible types for union field type_dedicated_config 
. 
 }
    Fields
    Union field type_dedicated_config . Configs for document processing types. type_dedicated_config can be only one of the following:
    digitalParsingConfig

    object ( DigitalParsingConfig )

    Configurations applied to digital parser.

    ocrParsingConfig

    object ( OcrParsingConfig )

    Configurations applied to OCR parser. Currently it only applies to PDFs.

    layoutParsingConfig

    object ( LayoutParsingConfig )

    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)

    string

    [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to layoutParsingConfig .
    useNativeText

    boolean

    If true, will use native text instead of OCR text on pages containing native text.

    LayoutParsingConfig

    The layout parsing configurations for documents.

    JSON representation 
     { 
 "enableTableAnnotation" 
 : 
 boolean 
 , 
 "enableImageAnnotation" 
 : 
 boolean 
 , 
 "structuredContentTypes" 
 : 
 [ 
 string 
 ] 
 , 
 "excludeHtmlElements" 
 : 
 [ 
 string 
 ] 
 , 
 "excludeHtmlClasses" 
 : 
 [ 
 string 
 ] 
 , 
 "excludeHtmlIds" 
 : 
 [ 
 string 
 ] 
 , 
 "enableGetProcessedDocument" 
 : 
 boolean 
 }
    Fields
    enableTableAnnotation

    boolean

    Optional. If true, the LLM based annotation is added to the table during parsing.

    enableImageAnnotation

    boolean

    Optional. If true, the LLM based annotation is added to the image during parsing.

    structuredContentTypes[]

    string

    Optional. Contains the required structure types to extract from the document. Supported values:

    • shareholder-structure
    excludeHtmlElements[]

    string

    Optional. List of HTML elements to exclude from the parsed content.

    excludeHtmlClasses[]

    string

    Optional. List of HTML classes to exclude from the parsed content.

    excludeHtmlIds[]

    string

    Optional. List of HTML ids to exclude from the parsed content.

    enableGetProcessedDocument

    boolean

    Optional. If true, the processed document will be made available for the GetProcessedDocument API.

    HealthcareFhirConfig

    Config to data store for HEALTHCARE_FHIR vertical.

    JSON representation 
     { 
 "enableConfigurableSchema" 
 : 
 boolean 
 , 
 "enableStaticIndexingForBatchIngestion" 
 : 
 boolean 
 }
    Fields
    enableConfigurableSchema

    boolean

    Whether to enable configurable schema for HEALTHCARE_FHIR vertical.

    If set to true , the predefined healthcare fhir schema can be extended for more customized searching and filtering.
    enableStaticIndexingForBatchIngestion

    boolean

    Whether to enable static indexing for HEALTHCARE_FHIR batch ingestion.

    If set to true , the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.

    ServingConfigDataStore

    Stores information regarding the serving configurations at DataStore level.

    JSON representation 
     { 
 "disabledForServing" 
 : 
 boolean 
 }
    Fields
    disabledForServing

    boolean

    Optional. If set true, the DataStore will not be available for serving search requests.

    Methods

    completeQuery

    		Completes the specified user input with keyword suggestions.

    create

    		Creates a DataStore .

    delete

    		Deletes a DataStore .

    get

    		Gets a DataStore .

    getSiteSearchEngine

    		Gets the SiteSearchEngine .

    list

    		Lists all the DataStore s associated with the project.

    patch

    		Updates a DataStore

    trainCustomModel

    		Trains a custom model.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: