REST Resource: projects.locations.apps.tools

מקור מידע: כלי

כלי מייצג פעולה שאגנט ה-CES יכול לבצע כדי להשיג יעדים מסוימים.

ייצוג ב-JSON
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },
  "readOnly": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

מזהה. שם המשאב של הכלי. פורמט:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} לכלים עצמאיים.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} לכלים שאוחזרו מתוך ערכת כלים.

הכלים האלה הם דינמיים ומוציאים פלט בלבד. אי אפשר להפנות אליהם ישירות במקום שבו נדרש כלי.

displayName

string

פלט בלבד. השם המוצג של הכלי, שנגזר מסוג הכלי. לדוגמה, השם המוצג של [ClientFunction][Tool.ClientFunction] נגזר מהמאפיין name שלו.

executionType

enum (ExecutionType)

זה שינוי אופציונלי. סוג הביצוע של הכלי.

timeout

string (Duration format)

זה שינוי אופציונלי. הזמן הקצוב לתפוגה של הרצת הכלי. אם לא מגדירים את משך הזמן הקצוב לתפוגה, ברירת המחדל היא 30 שניות לכלים של SYNCHRONOUS ו-60 שניות לכלים של ASYNCHRONOUS.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".

createTime

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".

updateTime

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".

etag

string

תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.

generatedSummary

string

פלט בלבד. אם הכלי נוצר על ידי עוזר ה-LLM, השדה הזה מכיל סיכום תיאורי של היצירה.

toolFakeConfig

object (ToolFakeConfig)

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

readOnly

boolean

פלט בלבד. מציין אם הכלי הוא לקריאה בלבד. אם הערך הוא True, המשתמש לא יכול לשנות את הכלי.

סוג הכלי. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
clientFunction

object (ClientFunction)

זה שינוי אופציונלי. פונקציית הלקוח.

openApiTool

object (OpenApiTool)

זה שינוי אופציונלי. כלי ה-API הפתוח.

googleSearchTool

object (GoogleSearchTool)

זה שינוי אופציונלי. כלי חיפוש Google.

connectorTool

object (ConnectorTool)

זה שינוי אופציונלי. הכלי Integration Connector.

dataStoreTool

object (DataStoreTool)

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

pythonFunction

object (PythonFunction)

זה שינוי אופציונלי. כלי הפונקציה של Python.

mcpTool

object (McpTool)

זה שינוי אופציונלי. כלי ה-MCP. אי אפשר ליצור או לעדכן כלי MCP ישירות, והוא מנוהל על ידי ערכת הכלים של MCP.

fileSearchTool

object (FileSearchTool)

זה שינוי אופציונלי. כלי לחיפוש קבצים.

systemTool

object (SystemTool)

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

agentTool

object (AgentTool)

זה שינוי אופציונלי. כלי הסוכן.

widgetTool

object (WidgetTool)

זה שינוי אופציונלי. כלי הווידג'טים.

remoteAgentTool

object (RemoteAgentTool)

זה שינוי אופציונלי. כלי הסוכן המרוחק.

סוף השדות הבלעדיים.

ClientFunction

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

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
שדות
name

string

חובה. שם הפונקציה.

description

string

זה שינוי אופציונלי. תיאור הפונקציה.

parameters

object (Schema)

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

response

object (Schema)

זה שינוי אופציונלי. הסכימה של תשובת הפונקציה.

OpenApiTool

כלי API מרחוק שמוגדר על ידי סכימת OpenAPI.

ייצוג ב-JSON
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
שדות
openApiSchema

string

חובה. סכימת OpenAPI בפורמט JSON או YAML.

name

string

זה שינוי אופציונלי. שם הכלי. אם לא תציינו שם, השם של הכלי ייגזר מסכימת OpenAPI, מ-operation.operationId.

description

string

זה שינוי אופציונלי. תיאור הכלי. אם לא תספקו תיאור, הוא יחולץ מסכמת OpenAPI, מ-operation.description או מ-operation.summary.

apiAuthentication

object (ApiAuthentication)

זה שינוי אופציונלי. פרטי האימות שנדרשים על ידי ה-API.

tlsConfig

object (TlsConfig)

זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת המותאמים אישית שהלקוח ייתן בהם אמון.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

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

ignoreUnknownFields

boolean

זה שינוי אופציונלי. אם הערך הוא true, הסוכן יתעלם משדות לא מוכרים בתגובת ה-API.

url

string

זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת Open API. השדה הזה מוגדר רק בכלים בתלות הסביבתית במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו מופיעה בתלות בסביבה ולסכימה יש פלייסהולדר מסוג ‎ $env_var, הפלייסהולדר יוחלף בסכימה.

GoogleSearchTool

מייצג כלי לביצוע חיפושים באינטרנט של Google לצורך עיגון. מידע נוסף מופיע כאן: https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (GoogleSearchTool.PromptConfig)
  }
}
שדות
name

string

חובה. שם הכלי.

description

string

זה שינוי אופציונלי. תיאור של מטרת הכלי.

contextUrls[]

string

זה שינוי אופציונלי. התוכן יאוחזר ישירות מכתובות ה-URL האלה כדי לספק הקשר וביסוס. דוגמה: "https://example.com/path.html". אפשר להוסיף עד 20 כתובות URL.

preferredDomains[]

string

זה שינוי אופציונלי. מציינים דומיינים להגבלת תוצאות החיפוש. לדוגמה: example.com,‏ another.site. אפשר לציין עד 20 דומיינים.

excludeDomains[]

string

זה שינוי אופציונלי. רשימת דומיינים שיוחרגו מתוצאות החיפוש. לדוגמה: example.com. אפשר להחריג עד 2,000 דומיינים.

promptConfig

object (GoogleSearchTool.PromptConfig)

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

GoogleSearchTool.PromptConfig

הגדרות ההנחיה שבהן נעשה שימוש על ידי המודל כשמעבדים או מסכמים את תוצאות החיפוש ב-Google.

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

string

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

voicePrompt

string

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

ConnectorTool

כלי ConnectorTool מאפשר חיבורים לשילובים שונים. מידע נוסף זמין בכתובת: https://cloud.google.com/integration-connectors/docs/overview.

ייצוג ב-JSON
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
שדות
connection

string

חובה. השם המלא של המשאב של חיבור Integration Connectors שאליו מתייחסים. פורמט: projects/{project}/locations/{location}/connections/{connection}

action

object (Action)

חובה. הפעולה שבה הכלי ישתמש.

authConfig

object (EndUserAuthConfig)

זה שינוי אופציונלי. ההגדרה הזו קובעת איך מתבצע אימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל את האפשרות 'ביטול ברירת המחדל של האימות' בחיבור – אחרת, יצירת הכלי ConnectorTool תיכשל. פרטים נוספים זמינים במאמר https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.

name

string

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

description

string

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

DataStoreTool

כלי לאחזור נתונים ממאגר נתונים או ממנוע של חיפוש מבוסס-Vertex AI לצורך ביסוס. אפשר להזין מאגר נתונים או מנוע, אבל לא את שניהם. מידע נוסף על חיפוש מבוסס-Vertex AI: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (DataStoreTool.BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (DataStoreTool.ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (DataStoreTool.FilterParameterBehavior),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dataStoreSource": {
    object (DataStoreTool.DataStoreSource)
  },
  "engineSource": {
    object (DataStoreTool.EngineSource)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

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

description

string

זה שינוי אופציונלי. תיאור הכלי.

boostSpecs[]

object (DataStoreTool.BoostSpecs)

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

modalityConfigs[]

object (DataStoreTool.ModalityConfig)

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

filterParameterBehavior

enum (DataStoreTool.FilterParameterBehavior)

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

הגדרה של מקור החיפוש, יכול להיות מאגר נתונים יחיד או מנוע. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
dataStoreSource

object (DataStoreTool.DataStoreSource)

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

engineSource

object (DataStoreTool.EngineSource)

זה שינוי אופציונלי. חיפוש בתוך מנוע (יכול להיות בכמה מאגרי נתונים).

סוף השדות הבלעדיים.

DataStoreTool.DataStoreSource

הגדרה של חיפוש ב-DataStore ספציפי.

ייצוג ב-JSON
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
שדות
filter

string

זה שינוי אופציונלי. מפרט הסינון של מאגר הנתונים. מידע נוסף מופיע כאן: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

dataStore

object (DataStore)

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

DataStore

משאב DataStore בחיפוש מבוסס-Vertex AI.

ייצוג ב-JSON
{
  "name": string,
  "type": enum (DataStore.DataStoreType),
  "documentProcessingMode": enum (DataStore.DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (DataStore.ConnectorConfig)
  }
}
שדות
name

string

חובה. השם המלא של המשאב DataStore. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

type

enum (DataStore.DataStoreType)

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

documentProcessingMode

enum (DataStore.DocumentProcessingMode)

פלט בלבד. מצב עיבוד המסמכים לחיבור למאגר הנתונים. ההגדרה הזו רלוונטית רק למאגרי נתונים מסוג PUBLIC_WEB ו-UNSTRUCTURED.

displayName

string

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

createTime

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".

connectorConfig

object (DataStore.ConnectorConfig)

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

DataStore.DataStoreType

סוג מאגר הנתונים.

טיפוסים בני מנייה (enum)
DATA_STORE_TYPE_UNSPECIFIED לא צוין. הערך הזה מציין שסוג מאגר הנתונים לא צוין, ולכן המערכת לא תשתמש בו במהלך החיפוש.
PUBLIC_WEB מאגר נתונים שמכיל תוכן אינטרנטי שזמין לכולם.
UNSTRUCTURED מאגר נתונים שמכיל נתונים פרטיים לא מובנים.
FAQ מאגר נתונים שמכיל נתונים מובְנים שמשמשים כשאלות נפוצות.
CONNECTOR מאגר נתונים שהוא מחבר לשירות צד ראשון או צד שלישי.

DataStore.DocumentProcessingMode

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

טיפוסים בני מנייה (enum)
DOCUMENT_PROCESSING_MODE_UNSPECIFIED לא צוין.
DOCUMENTS המסמכים מעובדים כמסמכים.
CHUNKS המסמכים מומרים לחלקים.

DataStore.ConnectorConfig

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

ייצוג ב-JSON
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
שדות
collection

string

שם המשאב של האוסף שאליו שייך מאגר הנתונים.

collectionDisplayName

string

השם המוצג של האוסף שאליו שייך מאגר הנתונים.

dataSource

string

השם של מקור הנתונים. דוגמה: salesforce, jira, confluence, bigquery.

DataStoreTool.EngineSource

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

ייצוג ב-JSON
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreTool.DataStoreSource)
    }
  ],
  "filter": string
}
שדות
engine

string

חובה. השם המלא של המשאב של המנוע. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

dataStoreSources[]

object (DataStoreTool.DataStoreSource)

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

filter

string

זה שינוי אופציונלי. מסנן שמוחל על החיפוש במנוע. לא רלוונטי ולא בשימוש אם מצוין הערך dataStoreSources. מידע נוסף מופיע כאן: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

DataStoreTool.BoostSpecs

מגדירים מפרטים לחיזוק כדי לחזק מסמכים מסוימים. מידע נוסף זמין בכתובת https://cloud.google.com/generative-ai-app-builder/docs/boosting.

ייצוג ב-JSON
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (DataStoreTool.BoostSpec)
    }
  ]
}
שדות
dataStores[]

string

חובה. מאגר הנתונים שבו מוחלת הגדרת ההגברה. השם המלא של משאב DataStore, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

spec[]

object (DataStoreTool.BoostSpec)

חובה. רשימה של מפרטי הגברה.

DataStoreTool.BoostSpec

הגדרת חיזוק כדי לחזק מסמכים מסוימים.

ייצוג ב-JSON
{
  "conditionBoostSpecs": [
    {
      object (DataStoreTool.BoostSpec.ConditionBoostSpec)
    }
  ]
}
שדות
conditionBoostSpecs[]

object (DataStoreTool.BoostSpec.ConditionBoostSpec)

חובה. רשימה של מפרטי הגברה.

DataStoreTool.BoostSpec.ConditionBoostSpec

הגדרת חיזוק לתנאי.

ייצוג ב-JSON
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec)
  }
}
שדות
condition

string

חובה. ביטוי שמציין תנאי להגברת החשיפה. התחביר זהה לתחביר של ביטויי סינון. בשלב הזה, התנאי היחיד שנתמך הוא רשימה של קודי שפה לפי BCP-47. דוגמה: כדי לשפר את ההצעות בשפות en או fr: ‏(lang_code: ANY("en", "fr"))

boost

number

זה שינוי אופציונלי. עוצמת ההגברה, שצריכה להיות בטווח [‎-1, 1]. הגברה שלילית פירושה הורדה בדרגה. ברירת המחדל היא 0.0.

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

הגדרה של ‎-1.0 גורמת להורדה משמעותית של ההצעות. עם זאת, יכול להיות שעדיין יוצגו הצעות רלוונטיות אחרות.

הגדרה של 0.0 פירושה שלא מוחל שיפור. המערכת מתעלמת מתנאי ההדגשה.

boostControlSpec

object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec)

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

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

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

ייצוג ב-JSON
{
  "fieldName": string,
  "attributeType": enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType),
  "interpolationType": enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType),
  "controlPoints": [
    {
      object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint)
    }
  ]
}
שדות
fieldName

string

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

attributeType

enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType)

זה שינוי אופציונלי. סוג המאפיין שמשמש לקביעת סכום ההגדלה. אפשר לגזור את ערך המאפיין מערך השדה של fieldName שצוין. במקרה של ערך מספרי, זה פשוט: attributeValue = numerical_field_value. במקרה של טריות, attributeValue = (time.now() - datetime_field_value).

interpolationType

enum (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType)

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

controlPoints[]

object (DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint)

זה שינוי אופציונלי. נקודות הבקרה שמשמשות להגדרת העקומה. הפונקציה המונוטונית (מוגדרת באמצעות interpolationType שלמעלה) עוברת דרך נקודות הבקרה שמפורטות כאן.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

המאפיין(או הפונקציה) שעליו יחול הדירוג המותאם אישית.

טיפוסים בני מנייה (enum)
ATTRIBUTE_TYPE_UNSPECIFIED סוג מאפיין לא צוין.
NUMERICAL הערך של השדה המספרי ישמש לעדכון דינמי של סכום ההגדלה. במקרה כזה, הערך של attributeValue (הערך x) של נקודת הבקרה יהיה הערך בפועל של השדה המספרי שצוין עבורו boostAmount.
FRESHNESS במקרה השימוש של רעננות, ערך המאפיין יהיה משך הזמן שעבר בין השעה הנוכחית לבין התאריך בשדה התאריך והשעה שצוין. הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן לפי ISO 8601). הדפוס של זה הוא: [nD][T[nH][nM][nS]]. לדוגמה: 5D, ‏ 3DT12H30M, ‏ T24H.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType

סוג האינטרפולציה שרוצים להחיל. ברירת המחדל תהיה לינארית (Piecewise Linear).

טיפוסים בני מנייה (enum)
INTERPOLATION_TYPE_UNSPECIFIED לא צוין סוג האינטרפולציה. במקרה כזה, ברירת המחדל היא לינארית.
LINEAR תופעל אינטרפולציה ליניארית מקטע לקטע.

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

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

ייצוג ב-JSON
{
  "attributeValue": string,
  "boostAmount": number
}
שדות
attributeValue

string

זה שינוי אופציונלי. יכול להיות אחד מהערכים הבאים: 1. הערך המספרי של השדה. 2. מפרט משך הזמן של הטריות: הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן בפורמט ISO 8601). הדפוס של זה הוא: [nD][T[nH][nM][nS]].

boostAmount

number

זה שינוי אופציונלי. הערך בין ‎-1 ל-1 שבו יש להגדיל את הניקוד אם הערך של attributeValue הוא הערך שצוין למעלה.

DataStoreTool.ModalityConfig

אם מציינים ערך, המערכת תחיל את ההגדרה שצוינה על האופן שצוין.

ייצוג ב-JSON
{
  "modalityType": enum (DataStoreTool.ModalityConfig.ModalityType),
  "rewriterConfig": {
    object (DataStoreTool.RewriterConfig)
  },
  "summarizationConfig": {
    object (DataStoreTool.SummarizationConfig)
  },
  "groundingConfig": {
    object (DataStoreTool.GroundingConfig)
  },
  "snippetsConfig": {
    object (DataStoreTool.SnippetsConfig)
  }
}
שדות
modalityType

enum (DataStoreTool.ModalityConfig.ModalityType)

חובה. סוג האמצעי.

rewriterConfig

object (DataStoreTool.RewriterConfig)

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

summarizationConfig

object (DataStoreTool.SummarizationConfig)

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

groundingConfig

object (DataStoreTool.GroundingConfig)

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

snippetsConfig

object (DataStoreTool.SnippetsConfig)

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

DataStoreTool.ModalityConfig.ModalityType

סוג האמצעי.

טיפוסים בני מנייה (enum)
MODALITY_TYPE_UNSPECIFIED סוג המודאליות לא צוין.
TEXT אופן הצגת הטקסט.
AUDIO שיטת אודיו.

DataStoreTool.RewriterConfig

הגדרות של כלי השכתוב.

ייצוג ב-JSON
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
שדות
modelSettings

object (ModelSettings)

חובה. הגדרות למודל ה-LLM.

prompt

string

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

disabled

boolean

זה שינוי אופציונלי. האם הכתיבה מחדש מושבתת.

DataStoreTool.SummarizationConfig

הגדרת סיכומים.

ייצוג ב-JSON
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
שדות
modelSettings

object (ModelSettings)

זה שינוי אופציונלי. הגדרות למודל ה-LLM.

prompt

string

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

disabled

boolean

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

DataStoreTool.GroundingConfig

הגדרת ההארקה.

ייצוג ב-JSON
{
  "groundingLevel": number,
  "disabled": boolean
}
שדות
groundingLevel

number

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

לדוגמה, רמה 3 אומרת שציון ההתבססות על מקורות צריך להיות 3 ומעלה כדי שהתשובה תוחזר.

disabled

boolean

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

DataStoreTool.SnippetsConfig

הגדרת קטעי קוד.

ייצוג ב-JSON
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
שדות
enableSnippets

boolean

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

maxSnippets

integer

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

DataStoreTool.FilterParameterBehavior

התנהגות של פרמטר סינון.

טיפוסים בני מנייה (enum)
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED התנהגות ברירת המחדל של המסנן. כוללים פרמטר של מסנן במאגרי נתונים של מחברים. בשאר סוגי מאגרי הנתונים, פרמטר הקלט של המסנן מושמט.
ALWAYS_INCLUDE תמיד צריך לכלול פרמטר של מסנן לכל סוגי מאגרי הנתונים.
NEVER_INCLUDE פרמטר הסינון אף פעם לא נכלל ברשימת הפרמטרים של הכלי, ללא קשר לסוג מאגר הנתונים.

PythonFunction

כלי פונקציית Python.

ייצוג ב-JSON
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
שדות
name

string

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

pythonCode

string

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

description

string

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

serviceDirectoryConfig

object (ServiceDirectoryConfig)

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

McpTool

כלי MCP. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-06-18/server/tools.

ייצוג ב-JSON
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (McpTool.State)
}
שדות
name

string

חובה. השם של כלי ה-MCP.

nameOverride

string

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

description

string

זה שינוי אופציונלי. תיאור הכלי MCP.

inputSchema

object (Schema)

זה שינוי אופציונלי. הסכימה של ארגומנטי הקלט של כלי ה-MCP.

outputSchema

object (Schema)

זה שינוי אופציונלי. הסכימה של ארגומנטי הפלט של כלי ה-MCP.

serverAddress

string

חובה. כתובת השרת של שרת ה-MCP, למשל, https://example.com/mcp/. אם השרת נבנה באמצעות ה-SDK של MCP, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. זהה ל-serverAddress ב-McpToolset. מידע נוסף זמין בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.

apiAuthentication

object (ApiAuthentication)

זה שינוי אופציונלי. פרטי האימות שנדרשים להרצת הכלי מול שרת ה-MCP. באימות באמצעות טוקן bearer, הטוקן חל רק על הפעלת הכלי, ולא על כלי הרישום. לכן, צריך לוודא שאפשר לראות את רשימת הכלים בלי אימות.

tlsConfig

object (TlsConfig)

זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת המותאמים אישית שהלקוח צריך לסמוך עליהם.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.

customHeaders

map (key: string, value: string)

זה שינוי אופציונלי. הכותרות המותאמות אישית שיישלחו בבקשה לשרת ה-MCP. הערכים צריכים להיות בפורמט $context.variables.<name_of_variable> ואפשר להגדיר אותם במשתני הסשן. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (McpTool.State)

פלט בלבד. מצב הזמינות הדינמי של הכלי בשרת החיצוני.

McpTool.State

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

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב ברירת מחדל.
ACTIVE הכלי זמין והשרת מציע אותו באופן פעיל.
INACTIVE הכלי מוגדר או מוצמד, אבל השרת לא מציע אותו כרגע.
STALE הכלי קיים בשרת, אבל הוא לא תואם לגרסה בשרת.

FileSearchTool

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

ייצוג ב-JSON
{
  "corpusType": enum (FileSearchTool.CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
שדות
corpusType

enum (FileSearchTool.CorpusType)

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

name

string

חובה. שם הכלי.

description

string

זה שינוי אופציונלי. תיאור הכלי.

fileCorpus

string

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

FileSearchTool.CorpusType

סוג המאגר של Vertex RAG.

טיפוסים בני מנייה (enum)
CORPUS_TYPE_UNSPECIFIED סוג הקורפוס לא צוין.
USER_OWNED המאגר נוצר על ידי המשתמש והוא הבעלים שלו.
FULLY_MANAGED המאגר נוצר על ידי הסוכן.

SystemTool

כלי מערכת מוגדר מראש.

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

string

חובה. השם של כלי המערכת.

description

string

פלט בלבד. תיאור כלי המערכת.

AgentTool

מייצג כלי שמאפשר לסוכן להתקשר לסוכן אחר.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "agent": string
}
שדות
name

string

חובה. השם של כלי הסוכן.

description

string

זה שינוי אופציונלי. תיאור של מטרת הכלי.

agent

string

זה שינוי אופציונלי. שם המשאב של הסוכן שמשמש כנקודת הכניסה לכלי. פורמט: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

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

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetTool.WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (WidgetTool.DataMapping)
  },
  "textResponseConfig": {
    object (WidgetTool.TextResponseConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parameters": {
    object (Schema)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

חובה. השם המוצג של כלי הווידג'ט.

description

string

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

widgetType

enum (WidgetTool.WidgetType)

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

uiConfig

object (Struct format)

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

dataMapping

object (WidgetTool.DataMapping)

זה שינוי אופציונלי. המיפוי שמגדיר איך נתונים מכלי מקור ממופים לפרמטרים של הקלט בווידג'ט.

textResponseConfig

object (WidgetTool.TextResponseConfig)

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

הקלט של כלי הווידג'ט. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
parameters

object (Schema)

זה שינוי אופציונלי. פרמטרי הקלט של כלי הווידג'ט.

סוף השדות הבלעדיים.

WidgetTool.WidgetType

כל סוגי הווידג'טים שזמינים. יכול להיות שבעתיד נוסיף ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
WIDGET_TYPE_UNSPECIFIED סוג הווידג'ט לא צוין.
CUSTOM סוג הווידג'ט המותאם אישית.
PRODUCT_DETAILS ווידג'ט של פרטי מוצר.
QUICK_ACTIONS ווידג'ט של פעולות מהירות.
PRODUCT_COMPARISON ווידג'ט להשוואת מוצרים.
ADVANCED_PRODUCT_DETAILS ווידג'ט מתקדם של פרטי מוצר.
SHORT_FORM ווידג'ט של סרטון קצר.
OVERALL_SATISFACTION ווידג'ט של שביעות רצון כללית.
ORDER_SUMMARY ווידג'ט של סיכום ההזמנה.
APPOINTMENT_DETAILS ווידג'ט של פרטי הפגישה.
APPOINTMENT_SCHEDULER ווידג'ט לקביעת פגישות.
CONTACT_FORM ווידג'ט של טופס ליצירת קשר.

WidgetTool.DataMapping

הגדרות למיפוי נתונים מכלי מקור לפרמטרים של קלט בווידג'ט.

ייצוג ב-JSON
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (WidgetTool.DataMapping.Mode),
  "pythonScript": string
}
שדות
sourceToolName

string

זה שינוי אופציונלי. שם המשאב של הכלי שמספק את הנתונים לווידג'ט (למשל, כלי חיפוש או פונקציה בהתאמה אישית). פורמט: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}

fieldMappings

map (key: string, value: string)

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

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

pythonFunction

object (PythonFunction)

זה שינוי אופציונלי. הגדרות לפונקציית Python שמשמשת להמרת הפלט של כלי המקור לפורמט הקלט של הווידג'ט.

mode

enum (WidgetTool.DataMapping.Mode)

זה שינוי אופציונלי. מצב מיפוי הנתונים.

pythonScript
(deprecated)

string

הוצא משימוש: במקומו צריך להשתמש ב-pythonFunction.

WidgetTool.DataMapping.Mode

האסטרטגיה שמשמשת למיפוי נתונים מכלי המקור לווידג'ט.

טיפוסים בני מנייה (enum)
MODE_UNSPECIFIED מצב לא מוגדר.
FIELD_MAPPING משתמשים במפה fieldMappings כדי לבצע טרנספורמציה של נתונים.
PYTHON_SCRIPT משתמשים ב-pythonScript לטרנספורמציה של נתונים.

WidgetTool.TextResponseConfig

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

ייצוג ב-JSON
{
  "type": enum (WidgetTool.TextResponseConfig.Type),
  "staticText": string,
  "textResponseInstruction": string
}
שדות
type

enum (WidgetTool.TextResponseConfig.Type)

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

staticText

string

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

textResponseInstruction

string

זה שינוי אופציונלי. הוראה למודל השפה הגדול (LLM) לגבי אופן יצירת תשובת הטקסט. הערך הזה משמש כתיאור של פרמטר התגובה הטקסטואלית אם הסוג הוא LLM_GENERATED.

WidgetTool.TextResponseConfig.Type

מגדיר איך נוצרת תשובה שהיא טקסט.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא מוגדר.
NONE מודל ה-LLM מחליט באופן דינמי אם ליצור תשובה טקסטואלית לצד הווידג'ט, על סמך הקשר של השיחה.
LLM_GENERATED המודל הגדול של השפה נדרש במפורש ליצור תשובה שהיא טקסט.
STATIC תמיד נעשה שימוש בתגובה סטטית מוגדרת מראש.

RemoteAgentTool

מייצג כלי שמאפשר לסוכן להתקשר לסוכן מרוחק אחר.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "statefulAgent": boolean,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  }
}
שדות
name

string

חובה. שם הכלי.

description

string

חובה. תיאור הכלי.

agentCard

object (AgentCard)

חובה. כרטיס הסוכן של הסוכן המרוחק שהכלי הזה מפעיל.

apiAuthentication

object (ApiAuthentication)

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

statefulAgent

boolean

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

inputVariableMapping

map (key: string, value: string)

זה שינוי אופציונלי. מיפוי של שמות משתני הקלט של סוכן מרוחק לשמות משתנים של GECX.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

outputVariableMapping

map (key: string, value: string)

זה שינוי אופציונלי. מיפוי של שמות משתני הפלט של הסוכן המרוחק לשמות משתנים של GECX.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

create

הפונקציה יוצרת כלי חדש באפליקציה הנתונה.

delete

מחיקת הכלי שצוין.

get

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

list

רשימת הכלים באפליקציה הנתונה.

patch

מעדכן את הכלי שצוין.