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)
  },
  "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,
  "federatedSearchConfig": {
    object (FederatedSearchConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "configurableBillingApproachUpdateTime": string,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  },
  "iconUri": 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)

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

languageInfo

object (LanguageInfo)

פרטי השפה של DataStore.

naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

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

kmsKeyName

string

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

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

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

cmekConfig

object (CmekConfig)

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

idpConfig

object (IdpConfig)

פלט בלבד. הגדרת ספק זהויות ברמת מאגר הנתונים.

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".

dataProtectionPolicy

object (DataProtectionPolicy)

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

iconUri

string

פלט בלבד. מספק את ה-URI של הסמל של מקור המחבר של מאגר הנתונים, אם זהו מאגר נתונים שמגובה על ידי מחבר. השדה ריק במאגרי נתונים שלא משויך אליהם מקור מחבר.

ב-DataStoreService.ListDataStores וב-DataStoreService.GetDataStore, הערך הזה מאוכלס רק כשמתבצעת בקשה ל-DataStoreView.DATA_STORE_VIEW_FULL דרך ListDataStoresRequest.view או GetDataStoreRequest.view בהתאמה.

Methods

addPatientFilter

הוספת קבוצה של מזהי מטופלים כמסנן מטופלים למאגר הנתונים.

completeQuery

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

create

יצירת DataStore.

delete

מחיקת DataStore.

deletePatientFilter

מוחק את כל המסנן של המטופלים במאגר הנתונים.

get

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

getCompletionConfig

מקבלים CompletionConfig

getDocumentProcessingConfig

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

getSiteSearchEngine

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

list

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

patch

עדכון של DataStore

removePatientFilter

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

replacePatientFilter

החלפה של מסנן המטופלים בחנות הנתונים.

updateCompletionConfig

מעדכנים את CompletionConfig.

updateDocumentProcessingConfig

עדכון של DocumentProcessingConfig.