REST Resource: projects.locations.collections.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,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  }
}
שדות
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 כוללים מידע על רשימת בקרת גישה (ACL). אם הערך הוא 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)

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

string

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

boolean

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

object (FederatedSearchConfig)

זה שינוי אופציונלי. אם המאפיין מוגדר, מאגר הנתונים הזה הוא מאגר נתונים של חיפוש מאוחד.
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)

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

ContentConfig

הגדרת התוכן של מאגר הנתונים.

טיפוסים בני מנייה (enum)
CONTENT_CONFIG_UNSPECIFIED ערך ברירת המחדל.
NO_CONTENT כולל רק מסמכים בלי Document.content.
CONTENT_REQUIRED כולל רק מסמכים עם Document.content.
PUBLIC_WEBSITE מאגר הנתונים משמש לחיפוש באתרים ציבוריים.
GOOGLE_WORKSPACE מאגר הנתונים משמש לחיפוש ב-Workspace. פרטים על מאגר הנתונים של Workspace מפורטים בWorkspaceConfig.

AdvancedSiteSearchConfig

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

ייצוג ב-JSON 
{
  "disableInitialIndex": boolean,
  "disableAutomaticRefresh": boolean
}
שדות
disableInitialIndex

boolean

אם המדיניות מוגדרת כ-True, האינדוקס הראשוני מושבת ב-DataStore.
disableAutomaticRefresh

boolean

אם המדיניות מוגדרת כ-True, הרענון האוטומטי מושבת ב-DataStore.

NaturalLanguageQueryUnderstandingConfig

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

ייצוג ב-JSON 
{
  "mode": enum (Mode)
}
שדות
mode

enum (Mode)

מצב של הבנת שאילתות בשפה טבעית. אם השדה הזה לא מוגדר, ההתנהגות בברירת המחדל היא NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.

מצב

מצב של הבנת שאילתות בשפה טבעית. כשהערך של NaturalLanguageQueryUnderstandingConfig.Mode הוא ENABLED, היכולות של הבנת שאילתות בשפה טבעית מופעלות לבקשת חיפוש אם הערך של NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition ב-SearchRequest הוא ENABLED.

טיפוסים בני מנייה (enum)
MODE_UNSPECIFIED ערך ברירת המחדל.
DISABLED ההגדרה 'הבנת שאילתות בשפה טבעית' מושבתת.
ENABLED התכונה 'הבנת שאילתות בשפה טבעית' מופעלת.

BillingEstimation

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

ייצוג ב-JSON 
{
  "structuredDataSize": string,
  "unstructuredDataSize": string,
  "websiteDataSize": string,
  "structuredDataUpdateTime": string,
  "unstructuredDataUpdateTime": string,
  "websiteDataUpdateTime": string
}
שדות
structuredDataSize

string (int64 format)

גודל הנתונים של הנתונים המובְנים בבייטים.
unstructuredDataSize

string (int64 format)

גודל הנתונים של נתונים לא מובנים בבייטים.
websiteDataSize

string (int64 format)

גודל הנתונים של אתרים בבייטים.
structuredDataUpdateTime

string (Timestamp format)

חותמת זמן של העדכון האחרון של הנתונים המובְנים.

הפורמט הוא 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".
unstructuredDataUpdateTime

string (Timestamp format)

חותמת הזמן של העדכון האחרון של נתונים לא מובנים.

הפורמט הוא 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".
websiteDataUpdateTime

string (Timestamp format)

חותמת הזמן של העדכון האחרון של האתרים.

הפורמט הוא 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".

WorkspaceConfig

הגדרה לאחסון הגדרות של סוג מאגר נתונים לנתוני Workspace

ייצוג ב-JSON 
{
  "type": enum (Type),
  "dasherCustomerId": string,
  "superAdminServiceAccount": string,
  "superAdminEmailAddress": string
}
שדות
type

enum (Type)

מקור הנתונים של Google Workspace.
dasherCustomerId

string

פלט בלבד. מזהה הלקוח ב-Dasher שעבר טשטוש. הערך נגזר על ידי השרת מארגון ה-GCP של הפרויקט בזמן יצירת מאגר הנתונים. המערכת מתעלמת מכל ערך שמועבר במטען הייעודי (payload) של הבקשה.
superAdminServiceAccount

string

זה שינוי אופציונלי. חשבון השירות של הסופר-אדמין ב-Workspace שישמש ליצירת אסימון גישה. בשלב הזה, אנחנו משתמשים בו רק להעברת נתונים של מחבר Google Drive מקורי.
superAdminEmailAddress

string

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

סוג

המדיניות הזו מגדירה את סוג אפליקציית Workspace שנתמכת על ידי DataStore הזה

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ברירת המחדל היא סוג Workspace לא מוגדר.
GOOGLE_DRIVE מאגר הנתונים של Workspace מכיל נתונים מ-Drive
GOOGLE_MAIL מאגר הנתונים של Workspace מכיל נתוני דואר
GOOGLE_SITES מאגר הנתונים של Workspace מכיל נתונים של Sites
GOOGLE_CALENDAR מאגר הנתונים של Workspace מכיל נתונים מיומן Google
GOOGLE_CHAT מאגר הנתונים של Workspace מכיל נתונים מ-Chat
GOOGLE_GROUPS מאגר הנתונים של Workspace מכיל נתונים של קבוצות
GOOGLE_KEEP מאגר הנתונים של Workspace מכיל נתונים של Keep
GOOGLE_PEOPLE מאגר הנתונים של Workspace מכיל נתונים של אנשים
GOOGLE_WORKSPACE מאגר הנתונים של Workspace מכיל את כל הנתונים של אפליקציות Workspace

DocumentProcessingConfig

משאב Singleton של DataStore. אם השדה הזה ריק כשיוצרים את DataStore והפרמטר DataStore מוגדר לערך DataStore.ContentConfig.CONTENT_REQUIRED, מנתח ברירת המחדל יהיה מנתח דיגיטלי.

ייצוג ב-JSON 
{
  "name": string,
  "chunkingConfig": {
    object (ChunkingConfig)
  },
  "defaultParsingConfig": {
    object (ParsingConfig)
  },
  "parsingConfigOverrides": {
    string: {
      object (ParsingConfig)
    },
    ...
  }
}
שדות
name

string

השם המלא של המשאב של הגדרת עיבוד המסמכים. פורמט: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig
chunkingConfig

object (ChunkingConfig)

האם מצב חלוקת התוכן לחלקים מופעל.
defaultParsingConfig

object (ParsingConfig)

הגדרות ברירת המחדל של כלי הניתוח של מסמכים. אם לא מציינים הגדרה, המערכת תגדיר אותה כ-DigitalParsingConfig כברירת מחדל, והגדרת ברירת המחדל של הניתוח תחול על כל סוגי הקבצים לניתוח מסמכים.
parsingConfigOverrides

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

מיפוי מסוג קובץ כדי לשנות את הגדרות ברירת המחדל של הניתוח בהתאם לסוג הקובץ. מקשים נתמכים:

  • ‫pdf: עקיפת הגדרת הניתוח לקובצי PDF. נתמכים ניתוח דיגיטלי, ניתוח OCR או ניתוח פריסה.
  • ‫html: החלפת הגדרות הניתוח לקובצי HTML. נתמכים רק ניתוח דיגיטלי וניתוח פריסה.
  • ‫docx: עקיפת הגדרת הניתוח לקבצי DOCX. נתמכים רק ניתוח דיגיטלי וניתוח פריסה.
  • ‫pptx: החלפת הגדרת הניתוח לקובצי PPTX. נתמכים רק ניתוח דיגיטלי וניתוח פריסה.
  • ‫xlsm: החלפת הגדרות הניתוח לקבצי XLSM. נתמכים רק ניתוח דיגיטלי וניתוח פריסה.
  • ‫xlsx: החלפת הגדרות הניתוח לקובצי XLSX. נתמכים רק ניתוח דיגיטלי וניתוח פריסה.

ChunkingConfig

הגדרות לחלוקה לחלקים.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "layoutBasedChunkingConfig": {
    object (LayoutBasedChunkingConfig)
  }
  // End of mutually exclusive fields.
}
שדות
הגדרות נוספות שמגדירות את ההתנהגות של חלוקת הנתונים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
layoutBasedChunkingConfig

object (LayoutBasedChunkingConfig)

הגדרות לפילוח לפי פריסה.
סוף השדות הבלעדיים.

LayoutBasedChunkingConfig

הגדרות לפילוח לפי פריסה.

ייצוג ב-JSON 
{
  "chunkSize": integer,
  "includeAncestorHeadings": boolean
}
שדות
chunkSize

integer

מגבלת גודל הטוקן לכל נתח.

ערכים נתמכים: 100-500 (כולל). ערך ברירת המחדל: 500.
includeAncestorHeadings

boolean

האם לצרף רמות שונות של כותרות לחלקים מאמצע המסמך כדי למנוע אובדן הקשר.

ערך ברירת המחדל: False.

ParsingConfig

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

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "digitalParsingConfig": {
    object (DigitalParsingConfig)
  },
  "ocrParsingConfig": {
    object (OcrParsingConfig)
  },
  "layoutParsingConfig": {
    object (LayoutParsingConfig)
  }
  // End of mutually exclusive fields.
}
שדות
הגדרות לעיבוד סוגי מסמכים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
digitalParsingConfig

object (DigitalParsingConfig)

ההגדרות הופעלו במנתח הדיגיטלי.
ocrParsingConfig

object (OcrParsingConfig)

ההגדרות הופעלו בניתוח ה-OCR. בשלב הזה, ההגדרה חלה רק על קובצי PDF.
layoutParsingConfig

object (LayoutParsingConfig)

ההגדרות הופעלו בניתוח הפריסה.
סוף השדות הבלעדיים.

DigitalParsingConfig

בסוג הזה אין שדות.

הגדרות הניתוח הדיגיטלי של מסמכים.

OcrParsingConfig

הגדרות הניתוח של זיהוי תווים אופטי (OCR) למסמכים.

ייצוג ב-JSON 
{
  "enhancedDocumentElements": [
    string
  ],
  "useNativeText": boolean
}
שדות
enhancedDocumentElements[]
(deprecated)

string

‫[DEPRECATED] השדה הזה הוצא משימוש. כדי להשתמש בעיבוד המשופר של רכיבי מסמך נוספים, צריך לעבור אל layoutParsingConfig.
useNativeText

boolean

אם הערך הוא true, המערכת תשתמש בטקסט מקורי במקום בטקסט OCR בדפים שמכילים טקסט מקורי.

LayoutParsingConfig

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

ייצוג ב-JSON 
{
  "enableTableAnnotation": boolean,
  "enableImageAnnotation": boolean,
  "enableLlmLayoutParsing": boolean,
  "structuredContentTypes": [
    string
  ],
  "excludeHtmlElements": [
    string
  ],
  "excludeHtmlClasses": [
    string
  ],
  "excludeHtmlIds": [
    string
  ],
  "enableGetProcessedDocument": boolean
}
שדות
enableTableAnnotation

boolean

זה שינוי אופציונלי. אם הערך הוא true, ההערה שמבוססת על LLM מתווספת לטבלה במהלך הניתוח.
enableImageAnnotation

boolean

זה שינוי אופציונלי. אם הערך הוא True, ההערה שמבוססת על LLM מתווספת לתמונה במהלך הניתוח.
enableLlmLayoutParsing

boolean

זה שינוי אופציונלי. אם הערך הוא true, פריסת ה-PDF תעבור שיפור באמצעות LLM.
structuredContentTypes[]

string

זה שינוי אופציונלי. מכיל את סוגי המבנים הנדרשים לחילוץ מהמסמך. ערכים נתמכים:

  • shareholder-structure
excludeHtmlElements[]

string

זה שינוי אופציונלי. רשימה של רכיבי HTML שיוחרגו מהתוכן המנותח.
excludeHtmlClasses[]

string

זה שינוי אופציונלי. רשימה של מחלקות HTML להחרגה מהתוכן המנותח.
excludeHtmlIds[]

string

זה שינוי אופציונלי. רשימה של מזהי HTML להחרגה מהתוכן המנותח.
enableGetProcessedDocument

boolean

זה שינוי אופציונלי. אם הערך הוא True, המסמך שעבר עיבוד יהיה זמין ל-GetProcessedDocument API.

HealthcareFhirConfig

הגדרות של מאגר נתונים עבור תחום אנכי של HEALTHCARE_FHIR.

ייצוג ב-JSON 
{
  "enableConfigurableSchema": boolean,
  "enableStaticIndexingForBatchIngestion": boolean,
  "initialFilterGroups": [
    string
  ]
}
שדות
enableConfigurableSchema

boolean

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

אם ההגדרה היא true, אפשר להרחיב את סכימת ה-FHIR המוגדרת מראש של שירותי הבריאות כדי לבצע חיפוש וסינון בהתאמה אישית.
enableStaticIndexingForBatchIngestion

boolean

האם להפעיל הוספה סטטית לאינדקס עבור העברת נתונים של קבוצות HEALTHCARE_FHIR.

אם ההגדרה היא true, העיבוד של קבוצת הפריטים לייבוא יתבצע במצב אינדוקס סטטי, שהוא איטי יותר אבל יכול להתמודד עם נפח גדול יותר.
initialFilterGroups[]

string

זה שינוי אופציונלי. שמות של משאבי קבוצה שישמשו כבסיס לסינון הראשוני של המטופלים, בפורמט projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhir_store_id}/fhir/Group/{groupId}. קבוצת המסננים צריכה להיות שם משאב FHIR מסוג Group, והמסנן יורכב מהחברים הישירים בקבוצה שהם משאבי Patient.

ServingConfigDataStore

מאחסן מידע לגבי הגדרות ההצגה ברמת DataStore.

ייצוג ב-JSON 
{
  "disabledForServing": boolean
}
שדות
disabledForServing

boolean

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

FederatedSearchConfig

מאחסן מידע לחיפוש מאוחד.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "alloyDbConfig": {
    object (AlloyDbConfig)
  },
  "thirdPartyOauthConfig": {
    object (ThirdPartyOauthConfig)
  },
  "notebooklmConfig": {
    object (NotebooklmConfig)
  }
  // End of mutually exclusive fields.
}
שדות
ההגדרה של מקור הנתונים שאליו מאגר הנתונים הזה מחובר. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
alloyDbConfig

object (AlloyDbConfig)

הגדרת AlloyDB. אם מוגדר, מאגר הנתונים הזה מחובר ל-AlloyDB.
thirdPartyOauthConfig

object (ThirdPartyOauthConfig)

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

object (NotebooklmConfig)

הגדרות NotebookLM. אם מוגדר, מאגר הנתונים הזה מחובר ל-NotebookLM Enterprise.
סוף השדות הבלעדיים.

AlloyDbConfig

מאחסן מידע לצורך התחברות ל-AlloyDB.

ייצוג ב-JSON 
{
  "alloydbConnectionConfig": {
    object (AlloyDbConnectionConfig)
  },
  "alloydbAiNlConfig": {
    object (AlloyDbAiNaturalLanguageConfig)
  },
  "returnedFields": [
    string
  ]
}
שדות
alloydbConnectionConfig

object (AlloyDbConnectionConfig)

חובה. הגדרות לחיבור ל-AlloyDB.
alloydbAiNlConfig

object (AlloyDbAiNaturalLanguageConfig)

זה שינוי אופציונלי. הגדרות של תכונות ה-AI הגנרטיבי.
returnedFields[]

string

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

AlloyDbConnectionConfig

הגדרות לחיבור ל-AlloyDB.

ייצוג ב-JSON 
{
  "instance": string,
  "database": string,
  "user": string,
  "password": string,
  "authMode": enum (AuthMode),
  "enablePsvs": boolean
}
שדות
instance

string

חובה. מופע AlloyDB שאליו רוצים להתחבר.
database

string

חובה. מסד הנתונים של AlloyDB שאליו רוצים להתחבר.
user

string

חובה. משתמש במסד נתונים.

אם authMode = END_USER_ACCOUNT, אפשר לבטל את ההגדרה. במקרה כזה, המשתמש יוסק בצד של AlloyDB על סמך המשתמש המאומת.
password

string

חובה. הסיסמה של מסד הנתונים.

אם authMode = END_USER_ACCOUNT, אפשר לבטל את ההגדרה. במקרה כזה, הסיסמה תוסק בצד של AlloyDB על סמך המשתמש המאומת.
authMode

enum (AuthMode)

זה שינוי אופציונלי. מצב אימות.
enablePsvs

boolean

זה שינוי אופציונלי. אם הערך הוא True, ‏ PSVS מופעל ב-AlloyDB.

AuthMode

מצב אימות.

טיפוסים בני מנייה (enum)
AUTH_MODE_UNSPECIFIED
AUTH_MODE_SERVICE_ACCOUNT משתמש ב-P4SA כש-VAIS מתקשר עם AlloyDB.
AUTH_MODE_END_USER_ACCOUNT משתמש ב-EUC כש-VAIS מדבר עם AlloyDB.

AlloyDbAiNaturalLanguageConfig

הגדרה של שפה טבעית ב-AlloyDB AI.

ייצוג ב-JSON 
{
  "nlConfigId": string
}
שדות
nlConfigId

string

זה שינוי אופציונלי. מזהה ההגדרה של שפה טבעית ב-AlloyDb AI, כלומר הערך ששימש לקריאה ל-SELECT alloydb_ai_nl.g_create_configuration(...). יכול להיות ריק.

ThirdPartyOauthConfig

מאחסן מידע על OAuth של אפליקציות צד שלישי.

ייצוג ב-JSON 
{
  "appName": string,
  "instanceName": string
}
שדות
appName

string

זה שינוי אופציונלי. סוג האפליקציה. למשל, ‫jira,‏ box וכו'.
instanceName

string

זה שינוי אופציונלי. שם המופע שמזהה את אפליקציית הצד השלישי, למשל, vaissptbots-my. הערך הזה שונה מ-instanceUri, שהיא כתובת ה-URL המלאה של אפליקציית צד ג', לדוגמה, https://vaissptbots-my.sharepoint.com.

NotebooklmConfig

הגדרות לחיבור אל NotebookLM Enterprise.

ייצוג ב-JSON 
{
  "searchConfig": string,
  "notebooks": [
    string
  ]
}
שדות
searchConfig

string

חובה. מחפשים את שם ההגדרה.

פורמט: projects/*/locations/global/notebookLmSearchConfigs/*
notebooks[]

string

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

כל רשומה היא שם מלא של משאב נוטבוק, כמו projects/*/locations/*/notebooks/*.

ההיקף נאכף על התוצאות וגם על הבקשה במעלה הזרם, כך שמחברת שלא מופיעה ברשימה הזו לא יכולה להופיע בתגובה לחיפוש דרך מאגר הנתונים הזה, גם אם ה-Backend מחזיר אותה.

ConfigurableBillingApproach

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

טיפוסים בני מנייה (enum)
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED ערך ברירת המחדל. ל-Spark ולגישת חיוב לא ניתנת להגדרה שאינה Spark.
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE משתמשים במינוי הבסיסי + חיוב על חריגה לצורך חיוב על הוספה לאינדקס של ליבת האחסון שלא משמשת להטמעה.
CONFIGURABLE_CONSUMPTION_EMBEDDING שימוש בחיוב תשלום לפי שימוש עבור תוסף אחסון להטמעה.

Methods

completeQuery

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

create

 יצירת DataStore.

delete

 מחיקת DataStore.

get

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

getIamPolicy

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

getSiteSearchEngine

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

list

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

patch

 עדכון של DataStore

setIamPolicy

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

trainCustomModel

 מאמן מודל בהתאמה אישית.