Returns the branches Resource.
Returns the completionConfig Resource.
Returns the completionSuggestions Resource.
Returns the controls Resource.
Returns the conversations Resource.
Returns the customModels Resource.
Returns the models Resource.
Returns the operations Resource.
Returns the schemas Resource.
Returns the servingConfigs Resource.
Returns the sessions Resource.
Returns the siteSearchEngine Resource.
Returns the suggestionDenyListEntries Resource.
Returns the userEvents Resource.
Close httplib2 connections.
Completes the specified user input with keyword suggestions.
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Deletes a DataStore.
Gets a DataStore.
getDocumentProcessingConfig(name, x__xgafv=None)
Gets a DocumentProcessingConfig.
getSiteSearchEngine(name, x__xgafv=None)
Gets the SiteSearchEngine.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the DataStores associated with the project.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a DataStore
trainCustomModel(dataStore, body=None, x__xgafv=None)
Trains a custom model.
updateDocumentProcessingConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
close()
Close httplib2 connections.
completeQuery(dataStore, includeTailSuggestions=None, query=None, queryModel=None, userPseudoId=None, x__xgafv=None)
Completes the specified user input with keyword suggestions.
Args:
dataStore: string, Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. (required)
includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for CompletionService.CompleteQuery method.
"querySuggestions": [ # Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
{ # Suggestions as search queries.
"completableFieldPaths": [ # The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.
"A String",
],
"suggestion": "A String", # The suggestion for the query.
},
],
"tailMatchTriggered": True or False, # True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.
}
create(parent, body=None, cmekConfigName=None, createAdvancedSiteSearch=None, dataStoreId=None, disableCmek=None, skipDefaultSchemaCreation=None, x__xgafv=None)
Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. (required)
body: object, The request body.
The object takes the form of:
{ # DataStore captures global settings and configs at the DataStore level.
"aclEnabled": True or False, # 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.
"advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search.
"disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore.
"disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore.
},
"billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing.
"structuredDataSize": "A String", # Data size for structured data in terms of bytes.
"structuredDataUpdateTime": "A String", # Last updated timestamp for structured data.
"unstructuredDataSize": "A String", # Data size for unstructured data in terms of bytes.
"unstructuredDataUpdateTime": "A String", # Last updated timestamp for unstructured data.
"websiteDataSize": "A String", # Data size for websites in terms of bytes.
"websiteDataUpdateTime": "A String", # Last updated timestamp for websites.
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
"kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
"kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
"state": "A String", # Output only. State of the CmekConfig.
},
"contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
"createTime": "A String", # Output only. Timestamp the DataStore was created at.
"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
"displayName": "A 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.
"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. # Configuration for Document understanding and enrichment.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
},
"idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
"externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
"workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
},
"idpType": "A String", # Identity provider type configured.
},
"industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
"kmsKeyName": "A 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 cmek_config field.
"languageInfo": { # Language info for DataStore. # Language info for DataStore.
"language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
"languageCode": "A String", # The language code for the DataStore.
"normalizedLanguageCode": "A String", # Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.
"region": "A String", # Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
},
"name": "A String", # Immutable. The full resource name of the data store. 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.
"naturalLanguageQueryUnderstandingConfig": { # Configuration for Natural Language Query Understanding. # Optional. Configuration for Natural Language Query Understanding.
"mode": "A String", # Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
},
"servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level.
"disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests.
},
"solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
"A String",
],
"startingSchema": { # Defines the structure and layout of a type of document data. # 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 CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
"fieldConfigs": [ # Output only. Configurations for fields of the schema.
{ # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
"advancedSiteSearchDataSources": [ # If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
"A String",
],
"completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
"dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
"fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
"fieldType": "A String", # Output only. Raw type of the field.
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
"keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
"metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
"recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
"retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
"jsonSchema": "A String", # The JSON representation of the schema.
"name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"structSchema": { # The structured representation of the schema.
"a_key": "", # Properties of the object.
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # 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.
"dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
"superAdminEmailAddress": "A 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.
"superAdminServiceAccount": "A String", # 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.
"type": "A String", # The Google Workspace data source.
},
}
cmekConfigName: string, Resource name of the CmekConfig to use for protecting this DataStore.
createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
dataStoreId: string, Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
disableCmek: boolean, DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.
skipDefaultSchemaCreation: boolean, A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, x__xgafv=None)
Deletes a DataStore.
Args:
name: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets a DataStore.
Args:
name: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # DataStore captures global settings and configs at the DataStore level.
"aclEnabled": True or False, # 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.
"advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search.
"disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore.
"disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore.
},
"billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing.
"structuredDataSize": "A String", # Data size for structured data in terms of bytes.
"structuredDataUpdateTime": "A String", # Last updated timestamp for structured data.
"unstructuredDataSize": "A String", # Data size for unstructured data in terms of bytes.
"unstructuredDataUpdateTime": "A String", # Last updated timestamp for unstructured data.
"websiteDataSize": "A String", # Data size for websites in terms of bytes.
"websiteDataUpdateTime": "A String", # Last updated timestamp for websites.
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
"kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
"kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
"state": "A String", # Output only. State of the CmekConfig.
},
"contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
"createTime": "A String", # Output only. Timestamp the DataStore was created at.
"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
"displayName": "A 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.
"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. # Configuration for Document understanding and enrichment.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
},
"idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
"externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
"workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
},
"idpType": "A String", # Identity provider type configured.
},
"industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
"kmsKeyName": "A 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 cmek_config field.
"languageInfo": { # Language info for DataStore. # Language info for DataStore.
"language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
"languageCode": "A String", # The language code for the DataStore.
"normalizedLanguageCode": "A String", # Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.
"region": "A String", # Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
},
"name": "A String", # Immutable. The full resource name of the data store. 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.
"naturalLanguageQueryUnderstandingConfig": { # Configuration for Natural Language Query Understanding. # Optional. Configuration for Natural Language Query Understanding.
"mode": "A String", # Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
},
"servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level.
"disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests.
},
"solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
"A String",
],
"startingSchema": { # Defines the structure and layout of a type of document data. # 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 CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
"fieldConfigs": [ # Output only. Configurations for fields of the schema.
{ # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
"advancedSiteSearchDataSources": [ # If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
"A String",
],
"completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
"dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
"fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
"fieldType": "A String", # Output only. Raw type of the field.
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
"keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
"metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
"recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
"retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
"jsonSchema": "A String", # The JSON representation of the schema.
"name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"structSchema": { # The structured representation of the schema.
"a_key": "", # Properties of the object.
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # 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.
"dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
"superAdminEmailAddress": "A 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.
"superAdminServiceAccount": "A String", # 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.
"type": "A String", # The Google Workspace data source.
},
}
getDocumentProcessingConfig(name, x__xgafv=None)
Gets a DocumentProcessingConfig.
Args:
name: string, Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
}
getSiteSearchEngine(name, x__xgafv=None)
Gets the SiteSearchEngine.
Args:
name: string, Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
"name": "A String", # The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the DataStores associated with the project.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. (required)
filter: string, Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
pageSize: integer, Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
pageToken: string, A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for DataStoreService.ListDataStores method.
"dataStores": [ # All the customer's DataStores.
{ # DataStore captures global settings and configs at the DataStore level.
"aclEnabled": True or False, # 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.
"advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search.
"disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore.
"disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore.
},
"billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing.
"structuredDataSize": "A String", # Data size for structured data in terms of bytes.
"structuredDataUpdateTime": "A String", # Last updated timestamp for structured data.
"unstructuredDataSize": "A String", # Data size for unstructured data in terms of bytes.
"unstructuredDataUpdateTime": "A String", # Last updated timestamp for unstructured data.
"websiteDataSize": "A String", # Data size for websites in terms of bytes.
"websiteDataUpdateTime": "A String", # Last updated timestamp for websites.
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
"kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
"kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
"state": "A String", # Output only. State of the CmekConfig.
},
"contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
"createTime": "A String", # Output only. Timestamp the DataStore was created at.
"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
"displayName": "A 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.
"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. # Configuration for Document understanding and enrichment.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
},
"idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
"externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
"workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
},
"idpType": "A String", # Identity provider type configured.
},
"industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
"kmsKeyName": "A 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 cmek_config field.
"languageInfo": { # Language info for DataStore. # Language info for DataStore.
"language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
"languageCode": "A String", # The language code for the DataStore.
"normalizedLanguageCode": "A String", # Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.
"region": "A String", # Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
},
"name": "A String", # Immutable. The full resource name of the data store. 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.
"naturalLanguageQueryUnderstandingConfig": { # Configuration for Natural Language Query Understanding. # Optional. Configuration for Natural Language Query Understanding.
"mode": "A String", # Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
},
"servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level.
"disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests.
},
"solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
"A String",
],
"startingSchema": { # Defines the structure and layout of a type of document data. # 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 CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
"fieldConfigs": [ # Output only. Configurations for fields of the schema.
{ # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
"advancedSiteSearchDataSources": [ # If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
"A String",
],
"completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
"dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
"fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
"fieldType": "A String", # Output only. Raw type of the field.
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
"keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
"metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
"recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
"retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
"jsonSchema": "A String", # The JSON representation of the schema.
"name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"structSchema": { # The structured representation of the schema.
"a_key": "", # Properties of the object.
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # 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.
"dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
"superAdminEmailAddress": "A 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.
"superAdminServiceAccount": "A String", # 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.
"type": "A String", # The Google Workspace data source.
},
},
],
"nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a DataStore
Args:
name: string, Immutable. The full resource name of the data store. 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. (required)
body: object, The request body.
The object takes the form of:
{ # DataStore captures global settings and configs at the DataStore level.
"aclEnabled": True or False, # 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.
"advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search.
"disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore.
"disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore.
},
"billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing.
"structuredDataSize": "A String", # Data size for structured data in terms of bytes.
"structuredDataUpdateTime": "A String", # Last updated timestamp for structured data.
"unstructuredDataSize": "A String", # Data size for unstructured data in terms of bytes.
"unstructuredDataUpdateTime": "A String", # Last updated timestamp for unstructured data.
"websiteDataSize": "A String", # Data size for websites in terms of bytes.
"websiteDataUpdateTime": "A String", # Last updated timestamp for websites.
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
"kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
"kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
"state": "A String", # Output only. State of the CmekConfig.
},
"contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
"createTime": "A String", # Output only. Timestamp the DataStore was created at.
"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
"displayName": "A 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.
"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. # Configuration for Document understanding and enrichment.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
},
"idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
"externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
"workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
},
"idpType": "A String", # Identity provider type configured.
},
"industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
"kmsKeyName": "A 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 cmek_config field.
"languageInfo": { # Language info for DataStore. # Language info for DataStore.
"language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
"languageCode": "A String", # The language code for the DataStore.
"normalizedLanguageCode": "A String", # Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.
"region": "A String", # Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
},
"name": "A String", # Immutable. The full resource name of the data store. 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.
"naturalLanguageQueryUnderstandingConfig": { # Configuration for Natural Language Query Understanding. # Optional. Configuration for Natural Language Query Understanding.
"mode": "A String", # Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
},
"servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level.
"disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests.
},
"solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
"A String",
],
"startingSchema": { # Defines the structure and layout of a type of document data. # 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 CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
"fieldConfigs": [ # Output only. Configurations for fields of the schema.
{ # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
"advancedSiteSearchDataSources": [ # If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
"A String",
],
"completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
"dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
"fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
"fieldType": "A String", # Output only. Raw type of the field.
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
"keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
"metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
"recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
"retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
"jsonSchema": "A String", # The JSON representation of the schema.
"name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"structSchema": { # The structured representation of the schema.
"a_key": "", # Properties of the object.
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # 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.
"dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
"superAdminEmailAddress": "A 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.
"superAdminServiceAccount": "A String", # 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.
"type": "A String", # The Google Workspace data source.
},
}
updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # DataStore captures global settings and configs at the DataStore level.
"aclEnabled": True or False, # 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.
"advancedSiteSearchConfig": { # Configuration data for advance site search. # Optional. Configuration for advanced site search.
"disableAutomaticRefresh": True or False, # If set true, automatic refresh is disabled for the DataStore.
"disableInitialIndex": True or False, # If set true, initial indexing is disabled for the DataStore.
},
"billingEstimation": { # Estimation of data size per data store. # Output only. Data size estimation for billing.
"structuredDataSize": "A String", # Data size for structured data in terms of bytes.
"structuredDataUpdateTime": "A String", # Last updated timestamp for structured data.
"unstructuredDataSize": "A String", # Data size for unstructured data in terms of bytes.
"unstructuredDataUpdateTime": "A String", # Last updated timestamp for unstructured data.
"websiteDataSize": "A String", # Data size for websites in terms of bytes.
"websiteDataUpdateTime": "A String", # Last updated timestamp for websites.
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
"kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
"kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
"state": "A String", # Output only. State of the CmekConfig.
},
"contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
"createTime": "A String", # Output only. Timestamp the DataStore was created at.
"defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
"displayName": "A 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.
"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. # Configuration for Document understanding and enrichment.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
},
"idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
"externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
"workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
},
"idpType": "A String", # Identity provider type configured.
},
"industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
"kmsKeyName": "A 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 cmek_config field.
"languageInfo": { # Language info for DataStore. # Language info for DataStore.
"language": "A String", # Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
"languageCode": "A String", # The language code for the DataStore.
"normalizedLanguageCode": "A String", # Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.
"region": "A String", # Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
},
"name": "A String", # Immutable. The full resource name of the data store. 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.
"naturalLanguageQueryUnderstandingConfig": { # Configuration for Natural Language Query Understanding. # Optional. Configuration for Natural Language Query Understanding.
"mode": "A String", # Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
},
"servingConfigDataStore": { # Stores information regarding the serving configurations at DataStore level. # Optional. Stores serving config at DataStore level.
"disabledForServing": True or False, # If set true, the DataStore will not be available for serving search requests.
},
"solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
"A String",
],
"startingSchema": { # Defines the structure and layout of a type of document data. # 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 CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
"fieldConfigs": [ # Output only. Configurations for fields of the schema.
{ # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
"advancedSiteSearchDataSources": [ # If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
"A String",
],
"completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
"dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
"fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
"fieldType": "A String", # Output only. Raw type of the field.
"indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
"keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
"metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
"recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
"retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
"jsonSchema": "A String", # The JSON representation of the schema.
"name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"structSchema": { # The structured representation of the schema.
"a_key": "", # Properties of the object.
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # 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.
"dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
"superAdminEmailAddress": "A 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.
"superAdminServiceAccount": "A String", # 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.
"type": "A String", # The Google Workspace data source.
},
}
trainCustomModel(dataStore, body=None, x__xgafv=None)
Trains a custom model.
Args:
dataStore: string, Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SearchTuningService.TrainCustomModel method.
"errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the data ingestion and training.
"gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
},
"gcsTrainingInput": { # Cloud Storage training data input. # Cloud Storage training input.
"corpusDataPath": "A String", # The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
"queryDataPath": "A String", # The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"}
"testDataPath": "A String", # Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.
"trainDataPath": "A String", # Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1`
},
"modelId": "A String", # If not provided, a UUID will be generated.
"modelType": "A String", # Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
updateDocumentProcessingConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
Args:
name: string, The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
}
updateMask: string, Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"chunkingConfig": { # Configuration for chunking config. # Whether chunking mode is enabled.
"layoutBasedChunkingConfig": { # Configuration for the layout based chunking. # Configuration for the layout based chunking.
"chunkSize": 42, # The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.
"includeAncestorHeadings": True or False, # Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.
},
},
"defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # 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.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
"parsingConfigOverrides": { # 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.
"a_key": { # Related configurations applied to a specific type of document parser.
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
},
"layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
},
"ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
"enhancedDocumentElements": [ # [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.
"A String",
],
"useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
},
},
},
}