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
}
שדות
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".

ContentConfig

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

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

AdvancedSiteSearchConfig

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

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

boolean

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

disableAutomaticRefresh

boolean

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

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

השם המלא של המשאב של Document Processing Config. פורמט: 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
{

  // Union field chunk_mode can be only one of the following:
  "layoutBasedChunkingConfig": {
    object (LayoutBasedChunkingConfig)
  }
  // End of list of possible types for union field chunk_mode.
}
שדות
שדה איחוד chunk_mode. הגדרות נוספות שמגדירות את ההתנהגות של חלוקת הנתונים. הערך chunk_mode יכול להיות רק אחד מהבאים:
layoutBasedChunkingConfig

object (LayoutBasedChunkingConfig)

הגדרות לחלוקה לקטעים לפי פריסה.

LayoutBasedChunkingConfig

הגדרות לחלוקה לקטעים לפי פריסה.

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

integer

הגודל המקסימלי של טוקן לכל נתח.

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

includeAncestorHeadings

boolean

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

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

ParsingConfig

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

ייצוג JSON
{

  // Union field type_dedicated_config can be only one of the following:
  "digitalParsingConfig": {
    object (DigitalParsingConfig)
  },
  "ocrParsingConfig": {
    object (OcrParsingConfig)
  },
  "layoutParsingConfig": {
    object (LayoutParsingConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
שדות
שדה איחוד type_dedicated_config. הגדרות לעיבוד סוגי מסמכים. הערך type_dedicated_config יכול להיות רק אחד מהבאים:
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

זה שינוי אופציונלי. שמות של משאבי Group שמשמשים כבסיס לסינון הראשוני של המטופלים, בפורמט 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
{

  // Union field data_source_config can be only one of the following:
  "alloyDbConfig": {
    object (AlloyDbConfig)
  },
  "thirdPartyOauthConfig": {
    object (ThirdPartyOauthConfig)
  },
  "notebooklmConfig": {
    object (NotebooklmConfig)
  }
  // End of list of possible types for union field data_source_config.
}
שדות
שדה איחוד data_source_config. ההגדרה של מקור הנתונים שאליו מאגר הנתונים הזה מחובר. הערך data_source_config יכול להיות רק אחד מהבאים:
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)

זה שינוי אופציונלי. הגדרות של תכונות הקסם.

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 NL, כלומר הערך ששימש לקריאה ל-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
}
שדות
searchConfig

string

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

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

ConfigurableBillingApproach

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

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

Methods

completeQuery

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

create

יצירת DataStore.

delete

מחיקת DataStore.

get

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

getSiteSearchEngine

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

list

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

patch

עדכון של DataStore

trainCustomModel

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