- משאב: DataStore
- ייצוג ב-JSON
- ContentConfig
- AdvancedSiteSearchConfig
- LanguageInfo
- NaturalLanguageQueryUnderstandingConfig
- מצב
- BillingEstimation
- WorkspaceConfig
- סוג
- DocumentProcessingConfig
- ChunkingConfig
- LayoutBasedChunkingConfig
- ParsingConfig
- DigitalParsingConfig
- OcrParsingConfig
- LayoutParsingConfig
- HealthcareFhirConfig
- ServingConfigDataStore
- FederatedSearchConfig
- AlloyDbConfig
- AlloyDbConnectionConfig
- AuthMode
- AlloyDbAiNaturalLanguageConfig
- ThirdPartyOauthConfig
- NotebooklmConfig
- ConfigurableBillingApproach
- Methods
משאב: DataStore
DataStore מתעד הגדרות וקובצי הגדרה גלובליים ברמת DataStore.
| ייצוג JSON |
|---|
{ "name": string, "displayName": string, "industryVertical": enum ( |
| שדות | |
|---|---|
name |
אי אפשר לשנות. מזהה. השם המלא של משאב מאגר הנתונים. פורמט: השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים. |
displayName |
חובה. השם המוצג של מאגר הנתונים. השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT. |
industryVertical |
אי אפשר לשנות. הענף שבו מאוחסנים הנתונים. |
solutionTypes[] |
הפתרונות שמאגר הנתונים רשום אליהם. פתרונות זמינים לכל
|
defaultSchemaId |
פלט בלבד. המזהה של |
contentConfig |
אי אפשר לשנות. הגדרת התוכן של מאגר הנתונים. אם השדה הזה לא מוגדר, התנהגות השרת בברירת המחדל היא |
createTime |
פלט בלבד. חותמת הזמן שבה נוצר הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
advancedSiteSearchConfig |
זה שינוי אופציונלי. הגדרות לחיפוש מתקדם באתר. |
languageInfo |
פרטי השפה של DataStore. |
naturalLanguageQueryUnderstandingConfig |
זה שינוי אופציונלי. הגדרה של הבנת שאילתות בשפה טבעית. |
kmsKeyName |
קלט בלבד. מפתח KMS שישמש להגנה על מאגר הנתונים הזה בזמן היצירה. צריך להגדיר את המדיניות הזו לבקשות שצריכות לעמוד בדרישות של מדיניות ארגונית בנושא הגנה באמצעות CMEK. אם השדה הזה מוגדר והעיבוד שלו מצליח, מאגר הנתונים מוגן על ידי מפתח ה-KMS, כפי שמצוין בשדה cmekConfig. |
cmekConfig |
פלט בלבד. מידע שקשור ל-CMEK ב-DataStore. |
billingEstimation |
פלט בלבד. הערכת גודל הנתונים לחיוב. |
aclEnabled |
אי אפשר לשנות. האם הנתונים ב- כש-ACL מופעל עבור בשלב הזה, רשימת בקרת גישה נתמכת רק ב |
workspaceConfig |
הגדרה לאחסון הגדרות של סוג מאגר נתונים לנתוני Workspace. צריך להגדיר את הערך הזה כשמגדירים את |
documentProcessingConfig |
הגדרה של הבנת מסמכים והעשרה שלהם. |
startingSchema |
סכימת ההתחלה שבה יש להשתמש עבור השדה הזה משמש רק ב- הסכימה שסיפקתם תאומת מול כללים מסוימים לגבי סכימה. מידע נוסף זמין במסמך הזה. |
healthcareFhirConfig |
זה שינוי אופציונלי. הגדרות ל- |
servingConfigDataStore |
זה שינוי אופציונלי. מאחסן את הגדרות השרת ברמת מאגר הנתונים. |
identityMappingStore |
אי אפשר לשנות. שם המשאב שמוגדר במלואו של |
isInfobotFaqDataStore |
זה שינוי אופציונלי. אם המאפיין הזה מוגדר, מאגר הנתונים הזה הוא מאגר נתונים של שאלות נפוצות של Infobot. |
federatedSearchConfig |
זה שינוי אופציונלי. אם ההגדרה הזו מוגדרת, DataStore הוא DataStore של חיפוש מאוחד. |
configurableBillingApproach |
זה שינוי אופציונלי. הגדרה של גישת חיוב שניתנת להתאמה אישית. לראות |
configurableBillingApproachUpdateTime |
פלט בלבד. חותמת הזמן שבה העדכון האחרון של configurableBillingApproach בוצע. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
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 |
אם המדיניות מוגדרת כ-True, ההוספה הראשונית לאינדקס מושבתת עבור DataStore. |
disableAutomaticRefresh |
אם המדיניות מוגדרת כ-true, הרענון האוטומטי של מאגר הנתונים מושבת. |
LanguageInfo
פרטי השפה של DataStore.
| ייצוג JSON |
|---|
{ "languageCode": string, "normalizedLanguageCode": string, "language": string, "region": string } |
| שדות | |
|---|---|
languageCode |
קוד השפה של DataStore. |
normalizedLanguageCode |
פלט בלבד. זהו הערך המנורמל של languageCode. לדוגמה: קוד השפה |
language |
פלט בלבד. החלק של השפה ב-normalizedLanguageCode. E.g.: |
region |
פלט בלבד. החלק של האזור בקוד השפה הנורמלי, אם הוא קיים. E.g.: |
NaturalLanguageQueryUnderstandingConfig
הגדרה של הבנת שאילתות בשפה טבעית.
| ייצוג JSON |
|---|
{
"mode": enum ( |
| שדות | |
|---|---|
mode |
מצב ההבנה של שאילתות בשפה טבעית. אם השדה הזה לא מוגדר, ההתנהגות בברירת המחדל היא |
מצב
מצב ההבנה של שאילתות בשפה טבעית. כאשר 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 |
גודל הנתונים של הנתונים המובְנים בבייטים. |
unstructuredDataSize |
גודל הנתונים של נתונים לא מובְנים בבייטים. |
websiteDataSize |
גודל הנתונים של האתרים בבייטים. |
structuredDataUpdateTime |
חותמת הזמן של העדכון האחרון של הנתונים המובְנים. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
unstructuredDataUpdateTime |
חותמת הזמן של העדכון האחרון של נתונים לא מובנים. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
websiteDataUpdateTime |
חותמת הזמן של העדכון האחרון של אתרים. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
WorkspaceConfig
הגדרה לאחסון הגדרות של סוג מאגר נתונים לנתוני Workspace
| ייצוג JSON |
|---|
{
"type": enum ( |
| שדות | |
|---|---|
type |
מקור הנתונים של Google Workspace. |
dasherCustomerId |
פלט בלבד. מזהה הלקוח ב-Dasher שעבר טשטוש. הערך נגזר על ידי השרת מהארגון של הפרויקט ב-GCP בזמן יצירת מאגר הנתונים. המערכת מתעלמת מכל ערך שמועבר במטען הייעודי (payload) של הבקשה. |
superAdminServiceAccount |
זה שינוי אופציונלי. חשבון השירות של הסופר-אדמין ב-Workspace שישמש ליצירת אסימון גישה. בשלב הזה אנחנו משתמשים בו רק להטמעת נתונים של מחבר Google Drive מקורי. |
superAdminEmailAddress |
זה שינוי אופציונלי. כתובת האימייל של הסופר-אדמין בחשבון 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 ( |
| שדות | |
|---|---|
name |
השם המלא של המשאב של Document Processing Config. פורמט: |
chunkingConfig |
האם מצב חלוקה לחלקים מופעל. |
defaultParsingConfig |
הגדרות ברירת המחדל של כלי הניתוח של מסמכים. אם לא מציינים הגדרה, המערכת תגדיר אותה כ-DigitalParsingConfig כברירת מחדל, והגדרת ברירת המחדל של הניתוח תחול על כל סוגי הקבצים לניתוח מסמכים. |
parsingConfigOverrides |
מיפוי מסוג קובץ כדי לבטל את הגדרות ברירת המחדל של הניתוח על סמך סוג הקובץ. מפתחות נתמכים:
|
ChunkingConfig
הגדרת התצורה של חלוקה לחלקים.
| ייצוג JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד chunk_mode. הגדרות נוספות שמגדירות את ההתנהגות של חלוקת הנתונים. הערך chunk_mode יכול להיות רק אחד מהבאים: |
|
layoutBasedChunkingConfig |
הגדרות לחלוקה לקטעים לפי פריסה. |
LayoutBasedChunkingConfig
הגדרות לחלוקה לקטעים לפי פריסה.
| ייצוג JSON |
|---|
{ "chunkSize": integer, "includeAncestorHeadings": boolean } |
| שדות | |
|---|---|
chunkSize |
הגודל המקסימלי של טוקן לכל נתח. ערכים נתמכים: 100-500 (כולל). ערך ברירת המחדל: 500. |
includeAncestorHeadings |
האם לצרף רמות שונות של כותרות לחלקים מאמצע המסמך כדי למנוע אובדן הקשר. ערך ברירת המחדל: False. |
ParsingConfig
הגדרות קשורות שמוחלות על סוג מסוים של כלי לניתוח מסמכים.
| ייצוג JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד type_dedicated_config. הגדרות לעיבוד סוגי מסמכים. הערך type_dedicated_config יכול להיות רק אחד מהבאים: |
|
digitalParsingConfig |
ההגדרות הופעלו במנתח הדיגיטלי. |
ocrParsingConfig |
הגדרות שהופעלו במנתח ה-OCR. בשלב הזה, ההגדרה חלה רק על קובצי PDF. |
layoutParsingConfig |
ההגדרות האישיות שהופעלו בניתוח הפריסה. |
DigitalParsingConfig
בסוג הזה אין שדות.
הגדרות הניתוח הדיגיטלי של מסמכים.
OcrParsingConfig
הגדרות הניתוח של זיהוי תווים אופטי (OCR) למסמכים.
| ייצוג JSON |
|---|
{ "enhancedDocumentElements": [ string ], "useNativeText": boolean } |
| שדות | |
|---|---|
enhancedDocumentElements[] |
[DEPRECATED] השדה הזה הוצא משימוש. כדי להשתמש בעיבוד הנוסף של רכיבי המסמך המשופרים, צריך לעבור אל |
useNativeText |
אם הערך הוא True, נעשה שימוש בטקסט מקורי במקום בטקסט OCR בדפים שמכילים טקסט מקורי. |
LayoutParsingConfig
הגדרות ניתוח הפריסה של מסמכים.
| ייצוג JSON |
|---|
{ "enableTableAnnotation": boolean, "enableImageAnnotation": boolean, "enableLlmLayoutParsing": boolean, "structuredContentTypes": [ string ], "excludeHtmlElements": [ string ], "excludeHtmlClasses": [ string ], "excludeHtmlIds": [ string ], "enableGetProcessedDocument": boolean } |
| שדות | |
|---|---|
enableTableAnnotation |
זה שינוי אופציונלי. אם הערך הוא True, ההערה שמבוססת על LLM מתווספת לטבלה במהלך הניתוח. |
enableImageAnnotation |
זה שינוי אופציונלי. אם הערך הוא True, ההערה שמבוססת על LLM מתווספת לתמונה במהלך הניתוח. |
enableLlmLayoutParsing |
זה שינוי אופציונלי. אם הערך הוא true, פריסת ה-PDF תעבור שיפור באמצעות LLM. |
structuredContentTypes[] |
זה שינוי אופציונלי. מכיל את סוגי המבנים הנדרשים לשליפה מהמסמך. ערכים נתמכים:
|
excludeHtmlElements[] |
זה שינוי אופציונלי. רשימה של רכיבי HTML שיוחרגו מהתוכן המנותח. |
excludeHtmlClasses[] |
זה שינוי אופציונלי. רשימה של מחלקות HTML שרוצים להחריג מהתוכן המנותח. |
excludeHtmlIds[] |
זה שינוי אופציונלי. רשימה של מזהי HTML שצריך להחריג מהתוכן המנותח. |
enableGetProcessedDocument |
זה שינוי אופציונלי. אם הערך הוא True, המסמך שעבר עיבוד יהיה זמין ל-GetProcessedDocument API. |
HealthcareFhirConfig
הגדרות של מאגר נתונים עבור תחום HEALTHCARE_FHIR.
| ייצוג JSON |
|---|
{ "enableConfigurableSchema": boolean, "enableStaticIndexingForBatchIngestion": boolean, "initialFilterGroups": [ string ] } |
| שדות | |
|---|---|
enableConfigurableSchema |
האם להפעיל סכימה שניתנת להגדרה עבור אם ההגדרה היא |
enableStaticIndexingForBatchIngestion |
האם להפעיל אינדוקס סטטי עבור הטמעת נתונים של אם ההגדרה היא |
initialFilterGroups[] |
זה שינוי אופציונלי. שמות של משאבי Group שמשמשים כבסיס לסינון הראשוני של המטופלים, בפורמט |
ServingConfigDataStore
מאחסן מידע לגבי הגדרות ההצגה ברמת DataStore.
| ייצוג JSON |
|---|
{ "disabledForServing": boolean } |
| שדות | |
|---|---|
disabledForServing |
זה שינוי אופציונלי. אם הערך הוא true, אי אפשר להשתמש ב-DataStore כדי להציג תוצאות לבקשות חיפוש. |
FederatedSearchConfig
שומר מידע לחיפוש מאוחד.
| ייצוג JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד data_source_config. ההגדרה של מקור הנתונים שאליו מאגר הנתונים הזה מחובר. הערך data_source_config יכול להיות רק אחד מהבאים: |
|
alloyDbConfig |
הגדרת AlloyDB. אם מוגדר, מאגר הנתונים הזה מחובר ל-AlloyDB. |
thirdPartyOauthConfig |
הגדרת OAuth של צד שלישי. אם מוגדר, מאגר הנתונים הזה מחובר לאפליקציה של צד שלישי. |
notebooklmConfig |
הגדרות NotebookLM. אם מוגדר, מאגר הנתונים הזה מחובר ל-NotebookLM Enterprise. |
AlloyDbConfig
מאחסן מידע לחיבור ל-AlloyDB.
| ייצוג JSON |
|---|
{ "alloydbConnectionConfig": { object ( |
| שדות | |
|---|---|
alloydbConnectionConfig |
חובה. הגדרות לחיבור ל-AlloyDB. |
alloydbAiNlConfig |
זה שינוי אופציונלי. הגדרות של תכונות הקסם. |
returnedFields[] |
זה שינוי אופציונלי. השדות שיוחזרו בתוצאות החיפוש. אם השדה ריק, כל השדות יוחזרו. |
AlloyDbConnectionConfig
הגדרות לחיבור ל-AlloyDB.
| ייצוג JSON |
|---|
{
"instance": string,
"database": string,
"user": string,
"password": string,
"authMode": enum ( |
| שדות | |
|---|---|
instance |
חובה. מופע AlloyDB שאליו רוצים להתחבר. |
database |
חובה. מסד הנתונים של AlloyDB שאליו רוצים להתחבר. |
user |
חובה. משתמש במסד הנתונים. אם authMode = END_USER_ACCOUNT, אפשר לבטל את ההגדרה. במקרה כזה, המשתמש יוסק בצד של AlloyDB על סמך המשתמש המאומת. |
password |
חובה. הסיסמה למסד הנתונים. אם authMode = END_USER_ACCOUNT, אפשר לבטל את ההגדרה. במקרה כזה, הסיסמה תוסק בצד של AlloyDB על סמך המשתמש המאומת. |
authMode |
זה שינוי אופציונלי. מצב אימות. |
enablePsvs |
זה שינוי אופציונלי. אם הערך הוא 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 |
זה שינוי אופציונלי. מזהה ההגדרה של AlloyDb AI NL, כלומר הערך ששימש לקריאה ל- |
ThirdPartyOauthConfig
מאחסן מידע על OAuth של אפליקציות של צד שלישי.
| ייצוג JSON |
|---|
{ "appName": string, "instanceName": string } |
| שדות | |
|---|---|
appName |
זה שינוי אופציונלי. סוג האפליקציה. למשל, "jira", "box" וכו'. |
instanceName |
זה שינוי אופציונלי. שם המופע שמזהה את אפליקציית הצד השלישי, למשל, vaissptbots-my. הערך הזה שונה מ-instanceUri, שהוא כתובת ה-URL המלאה של אפליקציית הצד השלישי, למשל: "https://vaissptbots-my.sharepoint.com". |
NotebooklmConfig
הגדרות לחיבור אל NotebookLM Enterprise.
| ייצוג JSON |
|---|
{ "searchConfig": string } |
| שדות | |
|---|---|
searchConfig |
חובה. מחפשים את שם ההגדרה. פורמט: projects/*/locations/global/notebookLmSearchConfigs/* |
ConfigurableBillingApproach
הגדרה של גישת חיוב שניתנת להתאמה אישית.
| טיפוסים בני מנייה (enum) | |
|---|---|
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED |
ערך ברירת המחדל. ב-Spark ובגישת חיוב שאינה ניתנת להגדרה במוצרים אחרים שאינם Spark. |
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE |
משתמשים במינוי עם חיוב על נפח אחסון בסיסי + חריגה לצורך הוספה לאינדקס של ליבת האחסון שאינה מוטמעת. |
CONFIGURABLE_CONSUMPTION_EMBEDDING |
משתמשים בחיוב לפי צריכה כדי להטמיע את תוסף האחסון. |
Methods |
|
|---|---|
|
משלים את קלט המשתמש שצוין בעזרת הצעות למילות מפתח. |
|
יצירת DataStore. |
|
מחיקת DataStore. |
|
הפונקציה מחזירה את ה-DataStore. |
|
הפונקציה מחזירה את ה-SiteSearchEngine. |
|
הצגת רשימה של כל DataStore שמשויכים לפרויקט. |
|
עדכון של DataStore |
|
מאמנת מודל בהתאמה אישית. |