MCP Tools Reference: ces.googleapis.com

כלי: create_tool

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

בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP‏ create_tool.

בקשת Curl 
                  
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "create_tool",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

בקשת הודעה עבור AgentService.CreateTool.

CreateToolRequest

ייצוג ב-JSON 
{
  "parent": string,
  "toolId": string,
  "tool": {
    object (Tool)
  }
}
שדות
parent

string

חובה. שם המשאב של האפליקציה שבה רוצים ליצור כלי.
toolId

string

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

object (Tool)

חובה. הכלי ליצירה.

כלי

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

  // Union field tool_type can be only one of the following:
  "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 list of possible types for union field tool_type.
}
שדות
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)

זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלי במצב מזויף.
שדה איחוד tool_type. סוג הכלי. הערך tool_type יכול להיות רק אחד מהבאים:
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

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

string

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

string

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

object (Schema)

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

object (Schema)

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

סכימה

ייצוג ב-JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
שדות
type

enum (Type)

חובה. סוג הנתונים.
properties

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

זה שינוי אופציונלי. מאפיינים של Type.OBJECT.

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

string

זה שינוי אופציונלי. מאפייני חובה של Type.OBJECT.
description

string

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

object (Schema)

זה שינוי אופציונלי. סכימה של רכיבים מסוג ARRAY.
nullable

boolean

זה שינוי אופציונלי. מציין אם הערך יכול להיות null.
uniqueItems

boolean

זה שינוי אופציונלי. מציינים שהפריטים במערך צריכים להיות ייחודיים. ההגדרה רלוונטית רק ל-TYPE.ARRAY.
prefixItems[]

object (Schema)

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

object (Schema)

זה שינוי אופציונלי. יכול להיות ערך בוליאני או אובייקט, שקובע את הנוכחות של מאפיינים נוספים.
anyOf[]

object (Schema)

זה שינוי אופציונלי. הערך צריך להיות מאומת מול כל אחת (אחת או יותר) מסכימות המשנה ברשימה.
enum[]

string

זה שינוי אופציונלי. ערכים אפשריים של רכיב מסוג פרימיטיבי עם פורמט enum. דוגמאות: 1. אפשר להגדיר כיוון כך : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. אפשר להגדיר את מספר הדירה כך : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

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

string

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

לדוגמה, הסכימה הבאה מגדירה הפניה לצומת סכימה בשם Pet:

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

הערך של המאפיין pet הוא הפניה לצומת הסכימה שנקרא Pet. פרטים נוספים זמינים בכתובת https://json-schema.org/understanding-json-schema/structuring.
defs

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

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

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

string

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

string (int64 format)

זה שינוי אופציונלי. מספר המינימום של הרכיבים עבור Type.ARRAY.
maxItems

string (int64 format)

זה שינוי אופציונלי. המספר המקסימלי של הרכיבים עבור Type.ARRAY.

שדה איחוד _minimum.

הערך _minimum יכול להיות רק אחד מהבאים:
minimum

number

זה שינוי אופציונלי. הערך המינימלי של Type.INTEGER ו-Type.NUMBER.

שדה איחוד _maximum.

הערך _maximum יכול להיות רק אחד מהבאים:
maximum

number

זה שינוי אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER.

PropertiesEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
שדות
key

string
value

object (Schema)

ערך

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג null JSON.
numberValue

number

מייצג מספר JSON. הערך לא יכול להיות NaN, Infinity או -Infinity, כי אין תמיכה בערכים האלה ב-JSON. בנוסף, אי אפשר לייצג ערכי Int64 גדולים, כי פורמט JSON בדרך כלל לא תומך בהם בסוג המספר שלו.
stringValue

string

מייצג מחרוזת JSON.
boolValue

boolean

מייצג ערך בוליאני ב-JSON (הערך המילולי true או false ב-JSON).
structValue

object (Struct format)

מייצג אובייקט JSON.
listValue

array (ListValue format)

מייצג מערך JSON.

Struct

ייצוג ב-JSON 
{
  "fields": {
    string: value,
    ...
  }
}
שדות
fields

map (key: string, value: value (Value format))

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

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

FieldsEntry

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

string
value

value (Value format)

ListValue

ייצוג ב-JSON 
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

שדה חוזר של ערכים עם הקלדה דינמית.

DefsEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
שדות
key

string
value

object (Schema)

OpenApiTool

ייצוג ב-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, הפלייסהולדר יוחלף בסכימה.

ApiAuthentication

ייצוג ב-JSON 
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
שדות
שדה איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
apiKeyConfig

object (ApiKeyConfig)

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

object (OAuthConfig)

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

object (ServiceAgentIdTokenAuthConfig)

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

object (ServiceAccountAuthConfig)

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

object (BearerTokenConfig)

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

ApiKeyConfig

ייצוג ב-JSON 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
שדות
keyName

string

חובה. שם הפרמטר או שם הכותרת של מפתח ה-API. למשל, אם בקשת ה-API היא ‎https://example.com/act?X-Api-Key=‎, ‏X-Api-Key הוא שם הפרמטר.
apiKeySecretVersion

string

חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן מפתח ה-API. פורמט: projects/{project}/secrets/{secret}/versions/{version}

הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation

enum (RequestLocation)

חובה. מיקום המפתח בבקשה.

OAuthConfig

ייצוג ב-JSON 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
שדות
oauthGrantType

enum (OauthGrantType)

חובה. סוגי הרשאות OAuth.
clientId

string

חובה. מזהה הלקוח מספק OAuth.
clientSecretVersion

string

חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן סוד הלקוח. פורמט: projects/{project}/secrets/{secret}/versions/{version}

הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint

string

חובה. נקודת הקצה של הטוקן אצל ספק ה-OAuth להחלפה באסימון גישה.
scopes[]

string

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

ServiceAccountAuthConfig

ייצוג ב-JSON 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
שדות
serviceAccount

string

חובה. כתובת האימייל של חשבון השירות שמשמש לאימות. מערכת CES משתמשת בחשבון השירות הזה כדי להחליף טוקן גישה, ואז טוקן הגישה נשלח בכותרת Authorization של הבקשה.

לחשבון השירות צריך להיות מוקצה התפקיד roles/iam.serviceAccountTokenCreator לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק. אם לא מציינים היקף, המערכת משתמשת בהיקף ברירת המחדל https://www.googleapis.com/auth/cloud-platform.

BearerTokenConfig

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

string

חובה. טוקן למוכ"ז. חייב להיות בפורמט $context.variables.<name_of_variable>.

TlsConfig

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

object (CaCert)

חובה. מציינת רשימה של אישורי CA מותאמים אישית שמותרים לאימות HTTPS.

CaCert

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

string

חובה. השם של אישורי ה-CA המותאמים אישית שמותרים. אפשר להשתמש בזה כדי להבחין בין אישורי CA מותאמים אישית.
cert

string (bytes format)

חובה. אישורי CA מותאמים אישית שמותרים (בפורמט DER) לאימות HTTPS. ההגדרה הזו מבטלת את ברירת המחדל של מאגר האישורים של SSL. אם הרשימה ריקה או לא צוינה, CES ישתמש במאגר האישורים של Google כדי לאמת אישורים. הערה: חשוב לוודא שאישורי השרת של HTTPS חתומים עם 'שם חלופי לנושא'. לדוגמה, אפשר להשתמש בפקודה הבאה כדי ליצור אישור בחתימה עצמית:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

מחרוזת בקידוד Base64.

ServiceDirectoryConfig

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

string

חובה. השם של שירות Service Directory. פורמט: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} המיקום של ספריית השירותים צריך להיות זהה למיקום של האפליקציה.

GoogleSearchTool

ייצוג ב-JSON 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (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 (PromptConfig)

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

PromptConfig

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

string

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

string

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

ConnectorTool

ייצוג ב-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 הזה.

פעולה

ייצוג ב-JSON 
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
שדות
inputFields[]

string

זה שינוי אופציונלי. שדות של הישות שמשמשים כקלט לפעולה. אם לא מציינים שדות, המערכת משתמשת בכל השדות של הישות.
outputFields[]

string

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

string

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

object (EntityOperation)

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

EntityOperation

ייצוג ב-JSON 
{
  "entityId": string,
  "operation": enum (OperationType)
}
שדות
entityId

string

חובה. המזהה של הישות.
operation

enum (OperationType)

חובה. הפעולה שצריך לבצע בישות.

EndUserAuthConfig

ייצוג ב-JSON 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
שדות
שדה איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

אימות באמצעות קוד הרשאה ל-Oauth 2.0.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

אימות של הרשאת גישה מסוג OAuth 2.0 בפרופיל JWT.

Oauth2AuthCodeConfig

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

string

חובה. שם הפרמטר של טוקן OAuth להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

ייצוג ב-JSON 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
שדות
issuer

string

חובה. שם הפרמטר של המנפיק להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.
subject

string

חובה. שם הפרמטר של הנושא להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.
clientKey

string

חובה. שם פרמטר של לקוח להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.

DataStoreTool

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

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
שדות
name

string

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

string

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

object (BoostSpecs)

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

object (ModalityConfig)

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

enum (FilterParameterBehavior)

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

object (DataStoreSource)

זה שינוי אופציונלי. חיפוש ב-DataStore ספציפי.
engineSource

object (EngineSource)

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

DataStoreSource

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

string

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

object (DataStore)

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

DataStore

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

string

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

enum (DataStoreType)

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

enum (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 (ConnectorConfig)

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

חותמת הזמן

ייצוג ב-JSON 
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ב-1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).
nanos

integer

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

ConnectorConfig

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

string

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

string

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

string

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

EngineSource

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

string

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

object (DataStoreSource)

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

string

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

BoostSpecs

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

string

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

object (BoostSpec)

חובה. רשימה של מפרטי קידום.

BoostSpec

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

object (ConditionBoostSpec)

חובה. רשימה של מפרטי קידום.

ConditionBoostSpec

ייצוג ב-JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (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 (BoostControlSpec)

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

BoostControlSpec

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

string

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

enum (AttributeType)

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

enum (InterpolationType)

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

object (ControlPoint)

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

ControlPoint

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

string

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

number

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

ModalityConfig

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

enum (ModalityType)

חובה. סוג השיטה.
rewriterConfig

object (RewriterConfig)

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

object (SummarizationConfig)

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

object (GroundingConfig)

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

object (SnippetsConfig)

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

RewriterConfig

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

object (ModelSettings)

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

string

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

boolean

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

ModelSettings

ייצוג ב-JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
שדות
model

string

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

שדה איחוד _temperature.

הערך _temperature יכול להיות רק אחד מהבאים:
temperature

number

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

SummarizationConfig

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

object (ModelSettings)

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

string

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

boolean

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

GroundingConfig

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

number

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

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

boolean

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

SnippetsConfig

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

boolean

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

PythonFunction

ייצוג ב-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

ייצוג ב-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 (State)
}
שדות
name

string

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

string

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

string

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

object (Schema)

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

object (Schema)

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

string

חובה. כתובת השרת של שרת ה-MCP, למשל, https://example.com/mcp/. אם השרת בנוי באמצעות MCP SDK, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. זהה ל-server_address ב-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 (State)

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

CustomHeadersEntry

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

string
value

string

FileSearchTool

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

enum (CorpusType)

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

string

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

string

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

string

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

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 (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
שדות
name

string

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

string

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

enum (WidgetType)

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

object (Struct format)

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

object (DataMapping)

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

object (TextResponseConfig)

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

object (Schema)

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

DataMapping

ייצוג ב-JSON 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (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 (Mode)

זה שינוי אופציונלי. מצב מיפוי הנתונים.
pythonScript
(deprecated)

string

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

FieldMappingsEntry

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

string
value

string

TextResponseConfig

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

enum (Type)

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

string

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

string

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

RemoteAgentTool

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

string

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

string

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

object (AgentCard)

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

AgentCard

ייצוג ב-JSON 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
שדות
name

string

חובה. שם של הסוכן שקריא לאנשים.
description

string

חובה. תיאור של תחום הפעולה או מרחב הפתרונות של הסוכן.
supportedInterfaces[]

object (AgentInterface)

חובה. רשימה מסודרת של ממשקים נתמכים. עדיף להשתמש ברשומה הראשונה.
version

string

חובה. גרסת הסוכן.
skills[]

object (AgentSkill)

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

AgentInterface

ייצוג ב-JSON 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
שדות
url

string

חובה. כתובת ה-URL שבה הממשק הזה זמין. כתובת ה-URL חייבת להיות כתובת HTTPS מוחלטת ותקינה בסביבת הייצור. דוגמה: "https://api.example.com/a2a/v1",‏ "https://grpc.example.com/a2a"
protocolBinding

string

חובה. הקישור לפרוטוקול שנתמך בכתובת ה-URL הזו. זו מחרוזת של טופס פתוח, שאפשר להרחיב אותה בקלות לקישורי פרוטוקולים אחרים. הפורמטים העיקריים שנתמכים באופן רשמי הם JSONRPC, ‏ GRPC ו-HTTP+JSON.
tenant

string

מזהה הדייר שבו יש להשתמש בבקשה כשמתקשרים לסוכן.
protocolVersion

string

חובה. הגרסה של פרוטוקול A2A שהממשק הזה חושף. שימוש בגרסה המשנית הנתמכת האחרונה לכל גרסה ראשית. דוגמאות: ‎0.3,‏ ‎1.0

AgentSkill

ייצוג ב-JSON 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
שדות
id

string

חובה. מזהה ייחודי של מיומנות הסוכן.
name

string

חובה. שם של המיומנות שקריא לאנשים.
description

string

חובה. תיאור מפורט של המיומנות.
tags[]

string

חובה. קבוצה של מילות מפתח שמתארות את היכולות של המיומנות.
examples[]

string

הנחיות או תרחישים לדוגמה שהמיומנות הזו יכולה לטפל בהם.
inputModes[]

string

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

string

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

משך

ייצוג ב-JSON 
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

שניות חתומות של טווח הזמן. הערך חייב להיות בין ‎-315,576,000,000 לבין ‎+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות בדקה * 60 דקות בשעה * 24 שעות ביממה * 365.25 ימים בשנה * 10,000 שנים
nanos

integer

שברים חתומים של שנייה ברזולוציית ננו-שנייה של טווח הזמן. משכי זמן של פחות משנייה מיוצגים באמצעות שדה seconds עם הערך 0 ושדה nanos עם ערך חיובי או שלילי. למשכי זמן של שנייה אחת או יותר, הערך בשדה nanos צריך להיות שונה מאפס ובעל אותו סימן כמו הערך בשדה seconds. הערך צריך להיות בין ‎-999,999,999 לבין ‎+999,999,999, כולל.

ToolFakeConfig

ייצוג ב-JSON 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
שדות
enableFakeMode

boolean

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

object (CodeBlock)

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

CodeBlock

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

string

חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python הצפויה – כדי לתפוס את כל קריאות הכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאה ספציפית לכלי: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: אם הפונקציה מחזירה None, הכלי האמיתי יופעל במקום זאת.

סוג

סוגי נתונים של OpenAPI.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הסוג לא צוין.
STRING סוג המחרוזת.
INTEGER סוג Integer.
NUMBER סוג המספר.
BOOLEAN סוג בוליאני.
OBJECT סוג האובייקט.
ARRAY סוג המערך.

NullValue

מייצג null JSON.

‫NullValue הוא ערך שמירה, שמשתמש בערך מספרי עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב כלי הסריאליזציה של ProtoJSON יפלטו Value עם null_value שמוגדר כ-null JSON בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך null.

RequestLocation

המיקום של מפתח ה-API בבקשה.

טיפוסים בני מנייה (enum)
REQUEST_LOCATION_UNSPECIFIED לא צוין. אין להשתמש בערך הזה.
HEADER מייצג את המפתח בכותרת ה-HTTP.
QUERY_STRING מייצג את המפתח במחרוזת של שאילתה.

OauthGrantType

סוגי הרשאות OAuth. יש תמיכה רק ב-client credential grant.

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

OperationType

הפעולה שצריך לבצע על היישות.

טיפוסים בני מנייה (enum)
OPERATION_TYPE_UNSPECIFIED לא צוין סוג הפעולה. לא תקין, יצירה או עדכון של ConnectorTool ייכשלו.
LIST פעולה ברשימה.
GET קבלת פעולה.
CREATE פעולת יצירה.
UPDATE פעולת עדכון.
DELETE פעולת מחיקה.

DataStoreType

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

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

DocumentProcessingMode

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

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

AttributeType

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

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

InterpolationType

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

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

ModalityType

סוג השיטה.

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

FilterParameterBehavior

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

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

מדינה

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

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

CorpusType

סוג הקורפוס של Vertex RAG.

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

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 ווידג'ט של טופס ליצירת קשר.

מצב

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

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

סוג

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

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

ExecutionType

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

טיפוסים בני מנייה (enum)
EXECUTION_TYPE_UNSPECIFIED לא צוין סוג ההפעלה. אם לא מציינים ערך, ברירת המחדל היא SYNCHRONOUS.
SYNCHRONOUS הכלי מופעל באופן סינכרוני. הסשן ייחסם עד שהכלי יחזור.
ASYNCHRONOUS הכלי מופעל באופן אסינכרוני. הסשן ימשיך בזמן שהכלי פועל.

סכימת הפלט

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

כלי

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

  // Union field tool_type can be only one of the following:
  "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 list of possible types for union field tool_type.
}
שדות
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)

זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלי במצב מזויף.
שדה איחוד tool_type. סוג הכלי. הערך tool_type יכול להיות רק אחד מהבאים:
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

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

string

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

string

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

object (Schema)

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

object (Schema)

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

סכימה

ייצוג ב-JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
שדות
type

enum (Type)

חובה. סוג הנתונים.
properties

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

זה שינוי אופציונלי. מאפיינים של Type.OBJECT.

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

string

זה שינוי אופציונלי. מאפייני חובה של Type.OBJECT.
description

string

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

object (Schema)

זה שינוי אופציונלי. סכימה של רכיבים מסוג ARRAY.
nullable

boolean

זה שינוי אופציונלי. מציין אם הערך יכול להיות null.
uniqueItems

boolean

זה שינוי אופציונלי. מציינים שהפריטים במערך צריכים להיות ייחודיים. ההגדרה רלוונטית רק ל-TYPE.ARRAY.
prefixItems[]

object (Schema)

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

object (Schema)

זה שינוי אופציונלי. יכול להיות ערך בוליאני או אובייקט, שקובע את הנוכחות של מאפיינים נוספים.
anyOf[]

object (Schema)

זה שינוי אופציונלי. הערך צריך להיות מאומת מול כל אחת (אחת או יותר) מסכימות המשנה ברשימה.
enum[]

string

זה שינוי אופציונלי. ערכים אפשריים של רכיב מסוג פרימיטיבי עם פורמט enum. דוגמאות: 1. אפשר להגדיר כיוון כך : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. אפשר להגדיר את מספר הדירה כך : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

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

string

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

לדוגמה, הסכימה הבאה מגדירה הפניה לצומת סכימה בשם Pet:

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

הערך של המאפיין pet הוא הפניה לצומת הסכימה שנקרא Pet. פרטים נוספים זמינים בכתובת https://json-schema.org/understanding-json-schema/structuring.
defs

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

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

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

string

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

string (int64 format)

זה שינוי אופציונלי. מספר המינימום של הרכיבים עבור Type.ARRAY.
maxItems

string (int64 format)

זה שינוי אופציונלי. המספר המקסימלי של הרכיבים עבור Type.ARRAY.

שדה איחוד _minimum.

הערך _minimum יכול להיות רק אחד מהבאים:
minimum

number

זה שינוי אופציונלי. הערך המינימלי של Type.INTEGER ו-Type.NUMBER.

שדה איחוד _maximum.

הערך _maximum יכול להיות רק אחד מהבאים:
maximum

number

זה שינוי אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER.

PropertiesEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
שדות
key

string
value

object (Schema)

ערך

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג null JSON.
numberValue

number

מייצג מספר JSON. הערך לא יכול להיות NaN, Infinity או -Infinity, כי אין תמיכה בערכים האלה ב-JSON. בנוסף, אי אפשר לייצג ערכי Int64 גדולים, כי פורמט JSON בדרך כלל לא תומך בהם בסוג המספר שלו.
stringValue

string

מייצג מחרוזת JSON.
boolValue

boolean

מייצג ערך בוליאני ב-JSON (הערך המילולי true או false ב-JSON).
structValue

object (Struct format)

מייצג אובייקט JSON.
listValue

array (ListValue format)

מייצג מערך JSON.

Struct

ייצוג ב-JSON 
{
  "fields": {
    string: value,
    ...
  }
}
שדות
fields

map (key: string, value: value (Value format))

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

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

FieldsEntry

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

string
value

value (Value format)

ListValue

ייצוג ב-JSON 
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

שדה חוזר של ערכים עם הקלדה דינמית.

DefsEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
שדות
key

string
value

object (Schema)

OpenApiTool

ייצוג ב-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, הפלייסהולדר יוחלף בסכימה.

ApiAuthentication

ייצוג ב-JSON 
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
שדות
שדה איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
apiKeyConfig

object (ApiKeyConfig)

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

object (OAuthConfig)

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

object (ServiceAgentIdTokenAuthConfig)

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

object (ServiceAccountAuthConfig)

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

object (BearerTokenConfig)

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

ApiKeyConfig

ייצוג ב-JSON 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
שדות
keyName

string

חובה. שם הפרמטר או שם הכותרת של מפתח ה-API. למשל, אם בקשת ה-API היא ‎https://example.com/act?X-Api-Key=‎, ‏X-Api-Key הוא שם הפרמטר.
apiKeySecretVersion

string

חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן מפתח ה-API. פורמט: projects/{project}/secrets/{secret}/versions/{version}

הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation

enum (RequestLocation)

חובה. מיקום המפתח בבקשה.

OAuthConfig

ייצוג ב-JSON 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
שדות
oauthGrantType

enum (OauthGrantType)

חובה. סוגי הרשאות OAuth.
clientId

string

חובה. מזהה הלקוח מספק OAuth.
clientSecretVersion

string

חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן סוד הלקוח. פורמט: projects/{project}/secrets/{secret}/versions/{version}

הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint

string

חובה. נקודת הקצה של הטוקן אצל ספק ה-OAuth להחלפה באסימון גישה.
scopes[]

string

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

ServiceAccountAuthConfig

ייצוג ב-JSON 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
שדות
serviceAccount

string

חובה. כתובת האימייל של חשבון השירות שמשמש לאימות. מערכת CES משתמשת בחשבון השירות הזה כדי להחליף טוקן גישה, ואז טוקן הגישה נשלח בכותרת Authorization של הבקשה.

לחשבון השירות צריך להיות מוקצה התפקיד roles/iam.serviceAccountTokenCreator לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק. אם לא מציינים היקף, המערכת משתמשת בהיקף ברירת המחדל https://www.googleapis.com/auth/cloud-platform.

BearerTokenConfig

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

string

חובה. טוקן למוכ"ז. חייב להיות בפורמט $context.variables.<name_of_variable>.

TlsConfig

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

object (CaCert)

חובה. מציינת רשימה של אישורי CA מותאמים אישית שמותרים לאימות HTTPS.

CaCert

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

string

חובה. השם של אישורי ה-CA המותאמים אישית שמותרים. אפשר להשתמש בזה כדי להבחין בין אישורי CA מותאמים אישית.
cert

string (bytes format)

חובה. אישורי CA מותאמים אישית שמותרים (בפורמט DER) לאימות HTTPS. ההגדרה הזו מבטלת את ברירת המחדל של מאגר האישורים של SSL. אם הרשימה ריקה או לא צוינה, CES ישתמש במאגר האישורים של Google כדי לאמת אישורים. הערה: חשוב לוודא שאישורי השרת של HTTPS חתומים עם 'שם חלופי לנושא'. לדוגמה, אפשר להשתמש בפקודה הבאה כדי ליצור אישור בחתימה עצמית:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

מחרוזת בקידוד Base64.

ServiceDirectoryConfig

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

string

חובה. השם של שירות Service Directory. פורמט: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} המיקום של ספריית השירותים צריך להיות זהה למיקום של האפליקציה.

GoogleSearchTool

ייצוג ב-JSON 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (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 (PromptConfig)

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

PromptConfig

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

string

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

string

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

ConnectorTool

ייצוג ב-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 הזה.

פעולה

ייצוג ב-JSON 
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
שדות
inputFields[]

string

זה שינוי אופציונלי. שדות של הישות שמשמשים כקלט לפעולה. אם לא מציינים שדות, המערכת משתמשת בכל השדות של הישות.
outputFields[]

string

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

string

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

object (EntityOperation)

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

EntityOperation

ייצוג ב-JSON 
{
  "entityId": string,
  "operation": enum (OperationType)
}
שדות
entityId

string

חובה. המזהה של הישות.
operation

enum (OperationType)

חובה. הפעולה שצריך לבצע בישות.

EndUserAuthConfig

ייצוג ב-JSON 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
שדות
שדה איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

אימות באמצעות קוד הרשאה ל-Oauth 2.0.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

אימות של הרשאת גישה מסוג OAuth 2.0 בפרופיל JWT.

Oauth2AuthCodeConfig

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

string

חובה. שם הפרמטר של טוקן OAuth להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

ייצוג ב-JSON 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
שדות
issuer

string

חובה. שם הפרמטר של המנפיק להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.
subject

string

חובה. שם הפרמטר של הנושא להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.
clientKey

string

חובה. שם פרמטר של לקוח להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.

DataStoreTool

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

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
שדות
name

string

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

string

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

object (BoostSpecs)

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

object (ModalityConfig)

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

enum (FilterParameterBehavior)

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

object (DataStoreSource)

זה שינוי אופציונלי. חיפוש ב-DataStore ספציפי.
engineSource

object (EngineSource)

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

DataStoreSource

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

string

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

object (DataStore)

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

DataStore

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

string

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

enum (DataStoreType)

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

enum (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 (ConnectorConfig)

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

חותמת הזמן

ייצוג ב-JSON 
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ב-1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).
nanos

integer

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

ConnectorConfig

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

string

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

string

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

string

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

EngineSource

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

string

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

object (DataStoreSource)

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

string

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

BoostSpecs

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

string

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

object (BoostSpec)

חובה. רשימה של מפרטי קידום.

BoostSpec

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

object (ConditionBoostSpec)

חובה. רשימה של מפרטי קידום.

ConditionBoostSpec

ייצוג ב-JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (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 (BoostControlSpec)

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

BoostControlSpec

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

string

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

enum (AttributeType)

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

enum (InterpolationType)

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

object (ControlPoint)

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

ControlPoint

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

string

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

number

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

ModalityConfig

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

enum (ModalityType)

חובה. סוג השיטה.
rewriterConfig

object (RewriterConfig)

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

object (SummarizationConfig)

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

object (GroundingConfig)

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

object (SnippetsConfig)

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

RewriterConfig

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

object (ModelSettings)

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

string

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

boolean

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

ModelSettings

ייצוג ב-JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
שדות
model

string

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

שדה איחוד _temperature.

הערך _temperature יכול להיות רק אחד מהבאים:
temperature

number

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

SummarizationConfig

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

object (ModelSettings)

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

string

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

boolean

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

GroundingConfig

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

number

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

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

boolean

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

SnippetsConfig

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

boolean

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

PythonFunction

ייצוג ב-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

ייצוג ב-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 (State)
}
שדות
name

string

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

string

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

string

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

object (Schema)

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

object (Schema)

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

string

חובה. כתובת השרת של שרת ה-MCP, למשל, https://example.com/mcp/. אם השרת בנוי באמצעות MCP SDK, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. זהה ל-server_address ב-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 (State)

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

CustomHeadersEntry

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

string
value

string

FileSearchTool

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

enum (CorpusType)

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

string

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

string

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

string

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

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 (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
שדות
name

string

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

string

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

enum (WidgetType)

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

object (Struct format)

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

object (DataMapping)

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

object (TextResponseConfig)

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

object (Schema)

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

DataMapping

ייצוג ב-JSON 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (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 (Mode)

זה שינוי אופציונלי. מצב מיפוי הנתונים.
pythonScript
(deprecated)

string

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

FieldMappingsEntry

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

string
value

string

TextResponseConfig

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

enum (Type)

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

string

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

string

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

RemoteAgentTool

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

string

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

string

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

object (AgentCard)

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

AgentCard

ייצוג ב-JSON 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
שדות
name

string

חובה. שם של הסוכן שקריא לאנשים.
description

string

חובה. תיאור של תחום הפעולה או מרחב הפתרונות של הסוכן.
supportedInterfaces[]

object (AgentInterface)

חובה. רשימה מסודרת של ממשקים נתמכים. עדיף להשתמש ברשומה הראשונה.
version

string

חובה. גרסת הסוכן.
skills[]

object (AgentSkill)

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

AgentInterface

ייצוג ב-JSON 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
שדות
url

string

חובה. כתובת ה-URL שבה הממשק הזה זמין. כתובת ה-URL חייבת להיות כתובת HTTPS מוחלטת ותקינה בסביבת הייצור. דוגמה: "https://api.example.com/a2a/v1",‏ "https://grpc.example.com/a2a"
protocolBinding

string

חובה. הקישור לפרוטוקול שנתמך בכתובת ה-URL הזו. זו מחרוזת של טופס פתוח, שאפשר להרחיב אותה בקלות לקישורי פרוטוקולים אחרים. הפורמטים העיקריים שנתמכים באופן רשמי הם JSONRPC, ‏ GRPC ו-HTTP+JSON.
tenant

string

מזהה הדייר שבו יש להשתמש בבקשה כשמתקשרים לסוכן.
protocolVersion

string

חובה. הגרסה של פרוטוקול A2A שהממשק הזה חושף. שימוש בגרסה המשנית הנתמכת האחרונה לכל גרסה ראשית. דוגמאות: ‎0.3,‏ ‎1.0

AgentSkill

ייצוג ב-JSON 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
שדות
id

string

חובה. מזהה ייחודי של מיומנות הסוכן.
name

string

חובה. שם של המיומנות שקריא לאנשים.
description

string

חובה. תיאור מפורט של המיומנות.
tags[]

string

חובה. קבוצה של מילות מפתח שמתארות את היכולות של המיומנות.
examples[]

string

הנחיות או תרחישים לדוגמה שהמיומנות הזו יכולה לטפל בהם.
inputModes[]

string

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

string

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

משך

ייצוג ב-JSON 
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

שניות חתומות של טווח הזמן. הערך חייב להיות בין ‎-315,576,000,000 לבין ‎+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות בדקה * 60 דקות בשעה * 24 שעות ביממה * 365.25 ימים בשנה * 10,000 שנים
nanos

integer

שברים חתומים של שנייה ברזולוציית ננו-שנייה של טווח הזמן. משכי זמן של פחות משנייה מיוצגים באמצעות שדה seconds עם הערך 0 ושדה nanos עם ערך חיובי או שלילי. למשכי זמן של שנייה אחת או יותר, הערך בשדה nanos צריך להיות שונה מאפס ובעל אותו סימן כמו הערך בשדה seconds. הערך צריך להיות בין ‎-999,999,999 לבין ‎+999,999,999, כולל.

ToolFakeConfig

ייצוג ב-JSON 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
שדות
enableFakeMode

boolean

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

object (CodeBlock)

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

CodeBlock

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

string

חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python הצפויה – כדי לתפוס את כל קריאות הכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאה ספציפית לכלי: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: אם הפונקציה מחזירה None, הכלי האמיתי יופעל במקום זאת.

סוג

סוגי נתונים של OpenAPI.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הסוג לא צוין.
STRING סוג המחרוזת.
INTEGER סוג Integer.
NUMBER סוג המספר.
BOOLEAN סוג בוליאני.
OBJECT סוג האובייקט.
ARRAY סוג המערך.

NullValue

מייצג null JSON.

‫NullValue הוא ערך שמירה, שמשתמש בערך מספרי עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב כלי הסריאליזציה של ProtoJSON יפלטו Value עם null_value שמוגדר כ-null JSON בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך null.

RequestLocation

המיקום של מפתח ה-API בבקשה.

טיפוסים בני מנייה (enum)
REQUEST_LOCATION_UNSPECIFIED לא צוין. אין להשתמש בערך הזה.
HEADER מייצג את המפתח בכותרת ה-HTTP.
QUERY_STRING מייצג את המפתח במחרוזת של שאילתה.

OauthGrantType

סוגי הרשאות OAuth. יש תמיכה רק ב-client credential grant.

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

OperationType

הפעולה שצריך לבצע על היישות.

טיפוסים בני מנייה (enum)
OPERATION_TYPE_UNSPECIFIED לא צוין סוג הפעולה. לא תקין, יצירה או עדכון של ConnectorTool ייכשלו.
LIST פעולה ברשימה.
GET קבלת פעולה.
CREATE פעולת יצירה.
UPDATE פעולת עדכון.
DELETE פעולת מחיקה.

DataStoreType

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

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

DocumentProcessingMode

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

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

AttributeType

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

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

InterpolationType

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

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

ModalityType

סוג השיטה.

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

FilterParameterBehavior

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

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

מדינה

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

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

CorpusType

סוג הקורפוס של Vertex RAG.

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

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 ווידג'ט של טופס ליצירת קשר.

מצב

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

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

סוג

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

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

ExecutionType

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

טיפוסים בני מנייה (enum)
EXECUTION_TYPE_UNSPECIFIED לא צוין סוג ההפעלה. אם לא מציינים ערך, ברירת המחדל היא SYNCHRONOUS.
SYNCHRONOUS הכלי מופעל באופן סינכרוני. הסשן ייחסם עד שהכלי יחזור.
ASYNCHRONOUS הכלי מופעל באופן אסינכרוני. הסשן ימשיך בזמן שהכלי פועל.

הערות על כלים

רמז הרסני: ✅ | רמז אידמפוטנטי: ❌ | רמז לקריאה בלבד: ❌ | רמז לעולם פתוח: ❌