- משאב: DataStore
- ייצוג ב-JSON
- AdvancedSiteSearchConfig
- LanguageInfo
- NaturalLanguageQueryUnderstandingConfig
- מצב
- BillingEstimation
- WorkspaceConfig
- DocumentProcessingConfig
- ChunkingConfig
- LayoutBasedChunkingConfig
- ParsingConfig
- DigitalParsingConfig
- OcrParsingConfig
- LayoutParsingConfig
- ServingConfigDataStore
- FederatedSearchConfig
- AlloyDbConfig
- AlloyDbConnectionConfig
- AuthMode
- AlloyDbAiNaturalLanguageConfig
- ThirdPartyOauthConfig
- NotebooklmConfig
- ConfigurableBillingApproach
- Methods
משאב: 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. |
idpConfig |
פלט בלבד. הגדרת ספק זהויות ברמת מאגר הנתונים. |
billingEstimation |
פלט בלבד. הערכת גודל הנתונים לחיוב. |
aclEnabled |
אי אפשר לשנות. האם הנתונים ב- כשרשימת ה-ACL מופעלת עבור בשלב הזה, רשימת בקרת גישה נתמכת רק ב |
workspaceConfig |
הגדרה לאחסון הגדרות של סוג מאגר נתונים לנתוני Workspace. צריך להגדיר את הערך הזה כשמגדירים את |
documentProcessingConfig |
הגדרה של הבנת מסמכים והעשרה שלהם. |
startingSchema |
סכימת ההתחלה שבה יש להשתמש עבור השדה הזה משמש רק את הסכימה שסיפקתם תאומת מול כללים מסוימים לגבי סכימה. מידע נוסף זמין במסמך הזה. |
healthcareFhirConfig |
זה שינוי אופציונלי. ההגדרה של |
servingConfigDataStore |
זה שינוי אופציונלי. מאחסן את הגדרות השרת ברמת DataStore. |
identityMappingStore |
אי אפשר לשנות. שם המשאב שמוגדר במלואו של |
isInfobotFaqDataStore |
זה שינוי אופציונלי. אם המאפיין מוגדר, DataStore הוא מאגר נתונים של שאלות נפוצות של Infobot. |
federatedSearchConfig |
זה שינוי אופציונלי. אם הערך מוגדר, מאגר הנתונים הזה הוא מאגר נתונים של חיפוש מאוחד. |
configurableBillingApproach |
זה שינוי אופציונלי. הגדרה של גישה לחיוב שניתנת להתאמה. לראות |
configurableBillingApproachUpdateTime |
פלט בלבד. חותמת הזמן של העדכון האחרון של configurableBillingApproach. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
AdvancedSiteSearchConfig
נתוני ההגדרה של חיפוש מתקדם באתר.
| ייצוג ב-JSON |
|---|
{ "disableInitialIndex": boolean, "disableAutomaticRefresh": boolean } |
| שדות | |
|---|---|
disableInitialIndex |
אם המדיניות מוגדרת כ-True, ההוספה הראשונית לאינדקס מושבתת עבור DataStore. |
disableAutomaticRefresh |
אם המדיניות מוגדרת כ-true, הרענון האוטומטי מושבת ב-DataStore. |
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 שעבר טשטוש. |
superAdminServiceAccount |
זה שינוי אופציונלי. חשבון השירות של סופר-אדמין ב-Workspace שישמש ליצירת אסימון גישה. בשלב הזה אנחנו משתמשים בו רק להטמעת נתונים ממחבר Google Drive המקורי. |
superAdminEmailAddress |
זה שינוי אופציונלי. כתובת האימייל של סופר-אדמין בסביבת העבודה שתשמש ליצירת אסימון גישה. בשלב הזה אנחנו משתמשים בו רק להטמעת נתונים ממחבר Google Drive המקורי. |
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. |
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 |
זה שינוי אופציונלי. הגדרות של תכונות ה-Magic. |
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, מופעלת תכונת ה-PSV ב-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 ובחשבונות אחרים שבהם אי אפשר להגדיר את שיטת החיוב. |
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE |
משתמשים במינוי הבסיסי + חיוב על חריגה לצורך חיוב על ליבת האינדקס לאחסון שאינו הטמעה. |
CONFIGURABLE_CONSUMPTION_EMBEDDING |
משתמשים בחיוב תשלום לפי שימוש עבור תוסף אחסון להטמעה. |
Methods |
|
|---|---|
|
הוספת קבוצה של מזהי מטופלים כמסנן מטופלים למאגר הנתונים. |
|
משלים את קלט של משתמשים שצוין בעזרת הצעות למילות מפתח. |
|
יצירת DataStore. |
|
מחיקת DataStore. |
|
מוחק את כל המסנן של המטופל במאגר הנתונים. |
|
הפונקציה מחזירה DataStore. |
|
מקבלים CompletionConfig |
|
הפונקציה מחזירה DocumentProcessingConfig. |
|
הפונקציה מחזירה את ה-SiteSearchEngine. |
|
רשימה של כל DataStore שמשויכים לפרויקט. |
|
עדכון של DataStore |
|
הסרת קבוצה של מזהי מטופלים ממסנן המטופלים של מאגר הנתונים. |
|
מחליף את מסנן המטופלים עבור מאגר הנתונים. |
|
מאמנת מודל בהתאמה אישית. |
|
מעדכן את CompletionConfig. |
|
עדכון של DocumentProcessingConfig. |