REST Resource: projects.locations.collections.engines.assistants

משאב: Assistant

משאב בנושא Discovery Engine Assistant.

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
שדות
name

string

אי אפשר לשנות. שם המשאב של העוזר הדיגיטלי. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

הוא חייב להיות מחרוזת מקודדת ב-UTF-8, עם מגבלת אורך של 1,024 תווים.

displayName

string

חובה. השם המוצג של העוזר הדיגיטלי.

הוא חייב להיות מחרוזת מקודדת ב-UTF-8 באורך של עד 128 תווים.

description

string

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

generationConfig

object (GenerationConfig)

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

googleSearchGroundingEnabled
(deprecated)

boolean

זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ב-webGroundingType.

webGroundingType

enum (WebGroundingType)

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

defaultWebGroundingToggleOff

boolean

זה שינוי אופציונלי. השדה הזה קובע את מצב ברירת המחדל של המתג להארקה באינטרנט עבור משתמשי קצה, אם webGroundingType מוגדר ל-WEB_GROUNDING_TYPE_GOOGLE_SEARCH או ל-WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. כברירת מחדל, הערך שמוגדר בשדה הזה הוא False. אם webGroundingType הוא WEB_GROUNDING_TYPE_GOOGLE_SEARCH או WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, משתמשי הקצה יקבלו כברירת מחדל את האפשרות להשתמש בנתוני אינטרנט בממשק המשתמש. אם הערך הוא True, מתג ההארקה מושבת כברירת מחדל בממשק המשתמש. משתמשי קצה עדיין יכולים להפעיל את העיגון בנתונים מהאינטרנט בממשק המשתמש אם העיגון בנתונים מהאינטרנט מופעל.

enabledActions
(deprecated)

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

זה שינוי אופציונלי. המאפיין הזה יצא משימוש. במקומו צריך להשתמש במאפיין enabledTools. הפעולות המופעלות באסיסטנט הזה. המפתחות הם שם המחבר, לדוגמה: projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. הערכים מורכבים מפעולות שהאדמין הפעיל כלפי מופע המחבר. האדמין יכול להפעיל באופן סלקטיבי כמה פעולות בכל אחד מהמופעים של המחבר שהוא יצר בפרויקט. לדוגמה: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }

enabledTools

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

זה שינוי אופציונלי. הערה: עדיין לא יושם. במקום זאת, אתם צריכים להשתמש ב-enabledActions. הכלים שמופעלים בעוזר הדיגיטלי הזה. המפתחות הם שם המחבר, לדוגמה: projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. הערכים כוללים כלים שאדמינים יכולים להפעיל עבור מופע המחבר. האדמין יכול להפעיל באופן סלקטיבי כמה כלים בכל אחד מהמופעים של המחבר שהוא יצר בפרויקט. לדוגמה: {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }

customerPolicy

object (CustomerPolicy)

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

GenerationConfig

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

ייצוג ב-JSON
{
  "defaultModelId": string,
  "allowedModelIds": [
    string
  ],
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
שדות
defaultModelId

string

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

allowedModelIds[]

string

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

systemInstruction

object (SystemInstruction)

הוראת מערכת, שנקראת גם מבוא להנחיה לקריאות ל-LLM. אפשר גם לעיין במאמר https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

defaultLanguage

string

שפת ברירת המחדל שבה ישתמשו ליצירת התשובה של העוזר הדיגיטלי. צריך להשתמש בקוד שפה לפי תקן ISO 639-1, כמו en. אם לא מציינים שפה, המערכת תזהה אותה באופן אוטומטי.

SystemInstruction

הוראת מערכת, שנקראת גם מבוא להנחיה לקריאות ל-LLM.

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

string

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

WebGroundingType

סוג ההצמדה לאתר שבה רוצים להשתמש.

טיפוסים בני מנייה (enum)
WEB_GROUNDING_TYPE_UNSPECIFIED הגדרה לא מוגדרת, ברירת מחדל. ההגדרה הזו זהה להגדרה 'מושבת'.
WEB_GROUNDING_TYPE_DISABLED העיגון בנתונים מהאינטרנט מושבת.

ActionList

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

ייצוג ב-JSON
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
שדות
actionInfo[]

object (ActionInfo)

רשימת הפעולות עם פרטי הפעולה המתאימים.

ActionInfo

המאפיין הזה יצא משימוש. במקומו צריך להשתמש במאפיין ToolInfo. מידע לזיהוי פעולה.

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

string

השם של הפעולה כפי שמוגדר על ידי DataConnectorService.QueryAvailableActions.

actionDisplayName

string

השם המוצג של הפעולה.

ToolList

הכלים המופעלים במחבר

ייצוג ב-JSON
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
שדות
toolInfo[]

object (ToolInfo)

רשימת הכלים עם פרטי הכלים המתאימים.

ToolInfo

מידע לזיהוי כלי.

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

string

השם של הכלי כפי שמוגדר ב-DataConnectorService.QueryAvailableActions. הערה: נעשה שימוש ב-action בממשקי ה-API של DataConnectorService, אבל הם זהים ל-tool שמופיעים כאן.

toolDisplayName

string

השם המוצג של הכלי.

CustomerPolicy

מדיניות שהלקוח מגדיר לגבי העוזר הדיגיטלי.

ייצוג ב-JSON
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
שדות
bannedPhrases[]

object (BannedPhrase)

זה שינוי אופציונלי. רשימה של ביטויים אסורים.

modelArmorConfig

object (ModelArmorConfig)

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

BannedPhrase

הגדרה של ביטוי אסור שהוגדר על ידי הלקוח. אסור שביטוי אסור יופיע בשאילתת המשתמש או בתשובת ה-LLM, אחרת התשובה תידחה.

ייצוג ב-JSON
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
שדות
phrase

string

חובה. תוכן המחרוזת הגולמית שרוצים לאסור.

matchType

enum (BannedPhraseMatchType)

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

ignoreDiacritics

boolean

זה שינוי אופציונלי. אם הערך הוא True, המערכת מתעלמת מסימנים דיאקריטיים (למשל, סימני הטעמה, אומלאוט) כשמתאימה בין ביטויים אסורים. לדוגמה, המחרוזת 'cafe' תתאים למחרוזת 'café'.

BannedPhraseMatchType

שיטת ההתאמה של הביטוי האסור.

טיפוסים בני מנייה (enum)
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED ברירת המחדל היא SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH הביטוי האסור תואם אם הוא נמצא במקום כלשהו בטקסט כמחרוזת משנה מדויקת.
WORD_BOUNDARY_STRING_MATCH התאמה של ביטוי אסור מתרחשת רק אם התבנית שנמצאה בטקסט מוקפת בתווים להפרדת מילים. הביטוי עצמו עדיין יכול להכיל מפרידי מילים.

ModelArmorConfig

הגדרות לתבניות הגנה מוגברת על המודל שהוגדרו על ידי הלקוח, שישמשו לניקוי הנחיות למשתמשים ותשובות של העוזר הדיגיטלי.

ייצוג ב-JSON
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
שדות
userPromptTemplate

string

זה שינוי אופציונלי. שם המשאב של תבנית הגנה מוגברת על המודל לניקוי הנחיות למשתמשים. פורמט: projects/{project}/locations/{location}/templates/{templateId}

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

responseTemplate

string

זה שינוי אופציונלי. שם המשאב של תבנית הגנה מוגברת על המודל לניקוי תשובות של העוזר הדיגיטלי. פורמט: projects/{project}/locations/{location}/templates/{templateId}

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

failureMode

enum (FailureMode)

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

FailureMode

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

טיפוסים בני מנייה (enum)
FAILURE_MODE_UNSPECIFIED מצב כשל לא מוגדר, התנהגות ברירת המחדל היא FAIL_CLOSED.
FAIL_OPEN במקרה של כשל בעיבוד של הגנה מוגברת על המודל, הבקשה תמשיך להתבצע ללא שינויים.
FAIL_CLOSED אם העיבוד של הגנה מוגברת על המודל נכשל, הבקשה נדחית.

Methods

assist

עוזר למשתמש בשאילתה.

create

יוצר Assistant.

delete

מוחקת Assistant.

get

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

list

רשימה של כל הAssistants בדומיין Engine.

patch

עדכון של Assistant

streamAssist

מסייע למשתמש בשאילתה בשיטת סטרימינג.