- משאב: Assistant
- GenerationConfig
- SystemInstruction
- WebGroundingType
- ActionList
- ActionInfo
- ToolList
- ToolInfo
- CustomerPolicy
- BannedPhrase
- BannedPhraseMatchType
- ModelArmorConfig
- FailureMode
- Methods
משאב: Assistant
משאב בנושא Discovery Engine Assistant.
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "generationConfig": { object ( |
| שדות | |
|---|---|
name |
אי אפשר לשנות. שם המשאב של העוזר הדיגיטלי. פורמט: הוא חייב להיות מחרוזת מקודדת ב-UTF-8, עם מגבלת אורך של 1,024 תווים. |
displayName |
חובה. השם המוצג של העוזר הדיגיטלי. הוא חייב להיות מחרוזת מקודדת ב-UTF-8 באורך של עד 128 תווים. |
description |
זה שינוי אופציונלי. תיאור למידע נוסף. ההודעה אמורה להופיע בממשק המשתמש של ההגדרה, ולא למשתמשים של העוזר הדיגיטלי. |
generationConfig |
זה שינוי אופציונלי. הגדרות ליצירת התשובה של העוזר הדיגיטלי. |
googleSearchGroundingEnabled |
זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ב- |
webGroundingType |
זה שינוי אופציונלי. סוג ההצמדה לאתר שבה רוצים להשתמש. |
defaultWebGroundingToggleOff |
זה שינוי אופציונלי. השדה הזה קובע את מצב ברירת המחדל של המתג להארקה באינטרנט עבור משתמשי קצה, אם |
enabledActions |
זה שינוי אופציונלי. המאפיין הזה יצא משימוש. במקומו צריך להשתמש במאפיין |
enabledTools |
זה שינוי אופציונלי. הערה: עדיין לא יושם. במקום זאת, אתם צריכים להשתמש ב- |
customerPolicy |
זה שינוי אופציונלי. מדיניות הלקוח לגבי העוזר הדיגיטלי. |
GenerationConfig
הגדרות ליצירת התשובה של העוזר הדיגיטלי.
| ייצוג ב-JSON |
|---|
{
"defaultModelId": string,
"allowedModelIds": [
string
],
"systemInstruction": {
object ( |
| שדות | |
|---|---|
defaultModelId |
זה שינוי אופציונלי. מודל ברירת המחדל שבו צריך להשתמש בשביל העוזר הדיגיטלי. |
allowedModelIds[] |
זה שינוי אופציונלי. רשימת המודלים שמותר להשתמש בהם לצורך העזרה. |
systemInstruction |
הוראת מערכת, שנקראת גם מבוא להנחיה לקריאות ל-LLM. אפשר גם לעיין במאמר https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions |
defaultLanguage |
שפת ברירת המחדל שבה ישתמשו ליצירת התשובה של העוזר הדיגיטלי. צריך להשתמש בקוד שפה לפי תקן ISO 639-1, כמו |
SystemInstruction
הוראת מערכת, שנקראת גם מבוא להנחיה לקריאות ל-LLM.
| ייצוג ב-JSON |
|---|
{ "additionalSystemInstruction": string } |
| שדות | |
|---|---|
additionalSystemInstruction |
זה שינוי אופציונלי. הוראת מערכת נוספת שתתווסף להוראת המערכת שמוגדרת כברירת מחדל. |
WebGroundingType
סוג ההצמדה לאתר שבה רוצים להשתמש.
| טיפוסים בני מנייה (enum) | |
|---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
הגדרה לא מוגדרת, ברירת מחדל. ההגדרה הזו זהה להגדרה 'מושבת'. |
WEB_GROUNDING_TYPE_DISABLED |
העיגון בנתונים מהאינטרנט מושבת. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
העיגון באמצעות חיפוש Google מופעל. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
העיגון באמצעות חיפוש אינטרנט ארגוני מופעל. |
ActionList
המאפיין הזה יצא משימוש. במקומו צריך להשתמש במאפיין ToolList. הפעולות המופעלות במחבר
| ייצוג ב-JSON |
|---|
{
"actionInfo": [
{
object ( |
| שדות | |
|---|---|
actionInfo[] |
רשימת הפעולות עם פרטי הפעולה המתאימים. |
ActionInfo
המאפיין הזה יצא משימוש. במקומו צריך להשתמש במאפיין ToolInfo. מידע לזיהוי פעולה.
| ייצוג ב-JSON |
|---|
{ "actionName": string, "actionDisplayName": string } |
| שדות | |
|---|---|
actionName |
השם של הפעולה כפי שמוגדר על ידי DataConnectorService.QueryAvailableActions. |
actionDisplayName |
השם המוצג של הפעולה. |
ToolList
הכלים המופעלים במחבר
| ייצוג ב-JSON |
|---|
{
"toolInfo": [
{
object ( |
| שדות | |
|---|---|
toolInfo[] |
רשימת הכלים עם פרטי הכלים המתאימים. |
ToolInfo
מידע לזיהוי כלי.
| ייצוג ב-JSON |
|---|
{ "toolName": string, "toolDisplayName": string } |
| שדות | |
|---|---|
toolName |
השם של הכלי כפי שמוגדר ב-DataConnectorService.QueryAvailableActions. הערה: נעשה שימוש ב- |
toolDisplayName |
השם המוצג של הכלי. |
CustomerPolicy
מדיניות שהלקוח מגדיר לגבי העוזר הדיגיטלי.
| ייצוג ב-JSON |
|---|
{ "bannedPhrases": [ { object ( |
| שדות | |
|---|---|
bannedPhrases[] |
זה שינוי אופציונלי. רשימה של ביטויים אסורים. |
modelArmorConfig |
זה שינוי אופציונלי. הגדרת הגנה מוגברת על המודל לשימוש בסניטציה של הנחיות למשתמשים ותשובות של העוזר הדיגיטלי. |
BannedPhrase
הגדרה של ביטוי אסור שהוגדר על ידי הלקוח. אסור שביטוי אסור יופיע בשאילתת המשתמש או בתשובת ה-LLM, אחרת התשובה תידחה.
| ייצוג ב-JSON |
|---|
{
"phrase": string,
"matchType": enum ( |
| שדות | |
|---|---|
phrase |
חובה. תוכן המחרוזת הגולמית שרוצים לאסור. |
matchType |
זה שינוי אופציונלי. סוג ההתאמה של הביטוי האסור. |
ignoreDiacritics |
זה שינוי אופציונלי. אם הערך הוא 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 ( |
| שדות | |
|---|---|
userPromptTemplate |
זה שינוי אופציונלי. שם המשאב של תבנית הגנה מוגברת על המודל לניקוי הנחיות למשתמשים. פורמט: אם לא מציינים את ההגדרה הזו, לא יבוצע ניקוי של ההנחיה למשתמש. |
responseTemplate |
זה שינוי אופציונלי. שם המשאב של תבנית הגנה מוגברת על המודל לניקוי תשובות של העוזר הדיגיטלי. פורמט: אם לא מציינים, לא יתבצע ניקוי של התשובה של העוזר הדיגיטלי. |
failureMode |
זה שינוי אופציונלי. הגדרה של מצב הכשל לניקוי של הגנה מוגברת על המודל. |
FailureMode
קובעת את ההתנהגות כש-הגנה מוגברת על המודל לא מצליח לעבד בקשה.
| טיפוסים בני מנייה (enum) | |
|---|---|
FAILURE_MODE_UNSPECIFIED |
מצב כשל לא מוגדר, התנהגות ברירת המחדל היא FAIL_CLOSED. |
FAIL_OPEN |
במקרה של כשל בעיבוד של הגנה מוגברת על המודל, הבקשה תמשיך להתבצע ללא שינויים. |
FAIL_CLOSED |
אם העיבוד של הגנה מוגברת על המודל נכשל, הבקשה נדחית. |
Methods |
|
|---|---|
|
עוזר למשתמש בשאילתה. |
|
יוצר Assistant. |
|
מוחקת Assistant. |
|
הפונקציה מחזירה Assistant. |
|
רשימה של כל הAssistants בדומיין Engine. |
|
עדכון של Assistant |
|
מסייע למשתמש בשאילתה בשיטת סטרימינג. |