REST Resource: projects.locations.dataStores

משאב: DataStore

‫DataStore מתעד הגדרות וקובצי הגדרה גלובליים ברמת DataStore.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "industryVertical": enum (IndustryVertical),
  "solutionTypes": [
    enum (SolutionType)
  ],
  "defaultSchemaId": string,
  "contentConfig": enum (ContentConfig),
  "createTime": string,
  "advancedSiteSearchConfig": {
    object (AdvancedSiteSearchConfig)
  },
  "naturalLanguageQueryUnderstandingConfig": {
    object (NaturalLanguageQueryUnderstandingConfig)
  },
  "kmsKeyName": string,
  "cmekConfig": {
    object (CmekConfig)
  },
  "billingEstimation": {
    object (BillingEstimation)
  },
  "aclEnabled": boolean,
  "workspaceConfig": {
    object (WorkspaceConfig)
  },
  "documentProcessingConfig": {
    object (DocumentProcessingConfig)
  },
  "startingSchema": {
    object (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },
  "servingConfigDataStore": {
    object (ServingConfigDataStore)
  },
  "identityMappingStore": string,
  "isInfobotFaqDataStore": boolean,
  "federatedSearchConfig": {
    object (FederatedSearchConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "configurableBillingApproachUpdateTime": string
}
שדות
name

string

אי אפשר לשנות. מזהה. השם המלא של המשאב של מאגר הנתונים. פורמט: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.
displayName

string

חובה. השם המוצג של מאגר הנתונים.

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
industryVertical

enum (IndustryVertical)

אי אפשר לשנות. הענף שבו מאוחסנים הנתונים.
solutionTypes[]

enum (SolutionType)

הפתרונות שרשומים במאגר הנתונים. פתרונות זמינים לכל industryVertical:

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION וגם SOLUTION_TYPE_SEARCH.
  • ‫SITE_SEARCH: SOLUTION_TYPE_SEARCH נרשם אוטומטית. אי אפשר להירשם לפתרונות אחרים.
defaultSchemaId

string

פלט בלבד. המזהה של Schema ברירת המחדל שמשויך למאגר הנתונים הזה.
contentConfig

enum (ContentConfig)

אי אפשר לשנות. הגדרת התוכן של מאגר הנתונים. אם השדה הזה לא מוגדר, התנהגות השרת בברירת המחדל היא ContentConfig.NO_CONTENT.
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה נוצר DataStore.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

זה שינוי אופציונלי. הגדרות לחיפוש מתקדם באתר.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

זה שינוי אופציונלי. הגדרה של הבנת שאילתות בשפה טבעית.
kmsKeyName

string

קלט בלבד. מפתח KMS שישמש להגנה על מאגר הנתונים הזה בזמן היצירה.

צריך להגדיר את ההגדרה הזו לבקשות שצריכות לעמוד בדרישות של מדיניות הארגון בנושא CMEK.

אם השדה הזה מוגדר והעיבוד שלו מצליח, מאגר הנתונים מוגן על ידי מפתח ה-KMS, כפי שמצוין בשדה cmekConfig.
cmekConfig

object (CmekConfig)

פלט בלבד. מידע שקשור ל-CMEK ב-DataStore.
billingEstimation

object (BillingEstimation)

פלט בלבד. הערכת גודל הנתונים לחיוב.
aclEnabled

boolean

אי אפשר לשנות. האם הנתונים ב-DataStore כוללים מידע על רשימת בקרת גישה. אם הערך הוא true, לנתוני המקור צריכה להיות רשימת ACL. רשימת בקרת הגישה (ACL) תוטמע כשהנתונים יוטמעו באמצעות שיטות DocumentService.ImportDocuments.

כש-ACL מופעל עבור DataStore, אי אפשר לגשת אל Document באמצעות התקשרות אל DocumentService.GetDocument או DocumentService.ListDocuments.

בשלב הזה, רשימת בקרת גישה נתמכת רק בGENERIC ענף עם הגדרת תוכן שאינו PUBLIC_WEBSITE.
workspaceConfig

object (WorkspaceConfig)

הגדרה לאחסון הגדרות של סוג מאגר נתונים לנתוני Workspace. צריך להגדיר את הערך הזה כשמגדירים את DataStore.content_config כ-DataStore.ContentConfig.GOOGLE_WORKSPACE.
documentProcessingConfig

object (DocumentProcessingConfig)

הגדרה של הבנת מסמכים והעשרה שלהם.
startingSchema

object (Schema)

סכימת ההתחלה שבה יש להשתמש עבור DataStore הזה כשמקצים לו הרשאות. אם לא מגדירים את המאפיין, המערכת תשתמש בסכימה אנכית מיוחדת שמוגדרת כברירת מחדל.

השדה הזה משמש רק ב-dataStores.create API, ויתעלמו ממנו אם משתמשים בו בממשקי API אחרים. השדה הזה לא יופיע בכל התשובות של ה-API, כולל dataStores.create API. כדי לאחזר סכמה של DataStore, צריך להשתמש ב-SchemaService.GetSchema API.

הסכימה שסיפקתם תאומת בהתאם לכללים מסוימים לגבי סכימה. מידע נוסף זמין במסמך הזה.
healthcareFhirConfig

object (HealthcareFhirConfig)

זה שינוי אופציונלי. הגדרות ל-HEALTHCARE_FHIR אנכי.
servingConfigDataStore

object (ServingConfigDataStore)

זה שינוי אופציונלי. מאחסן את הגדרות השרת ברמת מאגר הנתונים.
identityMappingStore

string

אי אפשר לשנות. שם המשאב שמוגדר במלואו של IdentityMappingStore המשויך. אפשר להגדיר את השדה הזה רק למאגרי נתונים עם aclEnabled עם IdP מסוג THIRD_PARTY או GSUITE. פורמט: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
isInfobotFaqDataStore

boolean

זה שינוי אופציונלי. אם המאפיין הזה מוגדר, מאגר הנתונים הזה הוא מאגר נתונים של שאלות נפוצות של Infobot.
federatedSearchConfig

object (FederatedSearchConfig)

זה שינוי אופציונלי. אם ההגדרה הזו מוגדרת, ה-DataStore הזה הוא DataStore של חיפוש מאוחד.
configurableBillingApproach

enum (ConfigurableBillingApproach)

זה שינוי אופציונלי. הגדרה של גישת חיוב שניתנת להתאמה אישית. לראות
configurableBillingApproachUpdateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה העדכון האחרון של configurableBillingApproach בוצע.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

Methods

completeQuery

 משלים את קלט של משתמשים שצוין בעזרת הצעות למילות מפתח.

create

 יצירת DataStore.

delete

 מחיקת DataStore.

get

 הפונקציה מחזירה DataStore.

getIamPolicy

 מקבל את מדיניות בקרת הגישה ב-IAM עבור DataStore.

getSiteSearchEngine

 הפונקציה מחזירה את ה-SiteSearchEngine.

list

 רשימה של כל DataStore שמשויכים לפרויקט.

patch

 עדכון של DataStore

setIamPolicy

 הגדרת מדיניות בקרת הגישה ב-IAM עבור DataStore.