REST Resource: projects.locations.dataStores

Ressource: DataStore

DataStore erfasst globale Einstellungen und Konfigurationen auf DataStore-Ebene.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "industryVertical": enum (IndustryVertical),
  "solutionTypes": [
    enum (SolutionType)
  ],
  "defaultSchemaId": string,
  "contentConfig": enum (ContentConfig),
  "createTime": string,
  "advancedSiteSearchConfig": {
    object (AdvancedSiteSearchConfig)
  },
  "languageInfo": {
    object (LanguageInfo)
  },
  "naturalLanguageQueryUnderstandingConfig": {
    object (NaturalLanguageQueryUnderstandingConfig)
  },
  "kmsKeyName": string,
  "cmekConfig": {
    object (CmekConfig)
  },
  "idpConfig": {
    object (IdpConfig)
  },
  "billingEstimation": {
    object (BillingEstimation)
  },
  "aclEnabled": boolean,
  "workspaceConfig": {
    object (WorkspaceConfig)
  },
  "documentProcessingConfig": {
    object (DocumentProcessingConfig)
  },
  "startingSchema": {
    object (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },
  "servingConfigDataStore": {
    object (ServingConfigDataStore)
  },
  "identityMappingStore": string,
  "isInfobotFaqDataStore": boolean,
  "configurableBillingApproach": enum (ConfigurableBillingApproach)
}
Felder
name

string

Nicht veränderbar. ID. Der vollständige Ressourcenname des Datenspeichers. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
displayName

string

Erforderlich. Der Anzeigename des Datenspeichers.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
industryVertical

enum (IndustryVertical)

Nicht veränderbar. Die Branche, in der der Datenspeicher registriert ist.
solutionTypes[]

enum (SolutionType)

Die Lösungen, für die der Datenspeicher registriert ist. Verfügbare Lösungen für die einzelnen industryVertical:

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION und SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH ist automatisch registriert. Andere Lösungen können nicht registriert werden.
defaultSchemaId

string

Nur Ausgabe. Die ID der Standard-Schema, die diesem Datenspeicher zugeordnet ist.
contentConfig

enum (ContentConfig)

Nicht veränderbar. Die Inhaltskonfiguration des Datenspeichers. Wenn dieses Feld nicht festgelegt ist, wird standardmäßig ContentConfig.NO_CONTENT verwendet.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung von DataStore.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

Optional. Konfiguration für die erweiterte Websitesuche.
languageInfo

object (LanguageInfo)

Sprachinformationen für DataStore.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

Optional. Konfiguration für die Interpretation von Anfragen in natürlicher Sprache.
kmsKeyName

string

Nur Eingabe. Der KMS-Schlüssel, der zum Schutz dieses Datenspeichers bei der Erstellung verwendet werden soll.

Muss für Anfragen festgelegt werden, die den CMEK-Organisationsrichtlinien entsprechen müssen.

Wenn dieses Feld festgelegt und erfolgreich verarbeitet wird, wird der DataStore durch den KMS-Schlüssel geschützt, wie im Feld „cmekConfig“ angegeben.
cmekConfig

object (CmekConfig)

Nur Ausgabe. CMEK-bezogene Informationen für den DataStore.
idpConfig

object (IdpConfig)

Nur Ausgabe. Konfiguration des Identitätsanbieters auf Datenspeicherebene.
billingEstimation

object (BillingEstimation)

Nur Ausgabe. Schätzung der Datengröße für die Abrechnung.
aclEnabled

boolean

Nicht veränderbar. Ob Daten in DataStore ACL-Informationen enthalten. Wenn diese Option auf true festgelegt ist, müssen die Quelldaten eine Zugriffssteuerungsliste haben. ACLs werden aufgenommen, wenn Daten mit DocumentService.ImportDocuments-Methoden aufgenommen werden.

Wenn die ACL für DataStore aktiviert ist, kann auf Document nicht durch Aufrufen von DocumentService.GetDocument oder DocumentService.ListDocuments zugegriffen werden.

Derzeit wird ACL nur in der Branche GENERIC mit einer Inhaltskonfiguration ohne PUBLIC_WEBSITE unterstützt.
workspaceConfig

object (WorkspaceConfig)

Konfiguration zum Speichern der Datenspeichertypkonfiguration für Arbeitsbereichsdaten. Dieser muss festgelegt werden, wenn DataStore.content_config auf DataStore.ContentConfig.GOOGLE_WORKSPACE gesetzt ist.
documentProcessingConfig

object (DocumentProcessingConfig)

Konfiguration für Dokumentverständnis und ‑anreicherung.
startingSchema

object (Schema)

Das Startschema, das für diese DataStore bei der Bereitstellung verwendet werden soll. Wenn kein Wert angegeben ist, wird ein standardspezifisches Schema verwendet.

Dieses Feld wird nur von der dataStores.create API verwendet und wird ignoriert, wenn es in anderen APIs verwendet wird. Dieses Feld wird in allen API-Antworten, einschließlich der dataStores.create API, ausgelassen. Verwenden Sie stattdessen die SchemaService.GetSchema API, um ein Schema für eine DataStore abzurufen.

Das bereitgestellte Schema wird anhand bestimmter Schemaregeln validiert. Weitere Informationen
healthcareFhirConfig

object (HealthcareFhirConfig)

Optional. Konfiguration für die Branche HEALTHCARE_FHIR.
servingConfigDataStore

object (ServingConfigDataStore)

Optional. Konfiguration auf DataStore-Ebene speichern.
identityMappingStore

string

Nicht veränderbar. Der vollständig qualifizierte Ressourcenname der zugehörigen IdentityMappingStore. Dieses Feld kann nur für aclEnabled-Datenspeicher mit dem IdP THIRD_PARTY oder GSUITE festgelegt werden. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}.
isInfobotFaqDataStore

boolean

Optional. Wenn festgelegt, ist dieser DataStore ein Infobot-FAQ-DataStore.
configurableBillingApproach

enum (ConfigurableBillingApproach)

Optional. Konfiguration für den konfigurierbaren Abrechnungsansatz. Siehe

Methoden

completeQuery

 Vervollständigt die angegebene Nutzereingabe mit Keyword-Vorschlägen

create

 Erstellt einen DataStore.

delete

 Löscht ein DataStore.

get

 Erstellt einen DataStore.

getCompletionConfig

 Erstellt einen CompletionConfig

getDocumentProcessingConfig

 Erstellt einen DocumentProcessingConfig.

getSiteSearchEngine

 Ruft die SiteSearchEngine ab.

list

 Listet alle DataStore auf, die dem Projekt zugeordnet sind.

patch

 Aktualisiert eine DataStore

updateCompletionConfig

 Aktualisiert die CompletionConfig.

updateDocumentProcessingConfig

 Aktualisiert den DocumentProcessingConfig.