Debian Codegraph @

docs/dyn/ces_v1beta.projects.locations.apps.tools.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="ces_v1beta.html">Gemini Enterprise for Customer Experience API</a> . <a href="ces_v1beta.projects.html">projects</a> . <a href="ces_v1beta.projects.locations.html">locations</a> . <a href="ces_v1beta.projects.locations.apps.html">apps</a> . <a href="ces_v1beta.projects.locations.apps.tools.html">tools</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, toolId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new tool in the given app.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, etag=None, force=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes the specified tool.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets details of the specified tool.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists tools in the given app.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates the specified tool.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(parent, body=None, toolId=None, x__xgafv=None)</code>
106 <pre>Creates a new tool in the given app.
107
108 Args:
109 parent: string, Required. The resource name of the app to create a tool in. (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A tool represents an action that the CES agent can take to achieve certain goals.
114 &quot;agentTool&quot;: { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
115 &quot;agent&quot;: &quot;A String&quot;, # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
116 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
117 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the agent tool.
118 &quot;rootAgent&quot;: &quot;A String&quot;, # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
119 },
120 &quot;clientFunction&quot;: { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
121 &quot;description&quot;: &quot;A String&quot;, # Optional. The function description.
122 &quot;name&quot;: &quot;A String&quot;, # Required. The function name.
123 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
124 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
125 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
126 # Object with schema name: Schema
127 ],
128 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
129 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
130 &quot;a_key&quot;: # Object with schema name: Schema
131 },
132 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
133 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
134 &quot;A String&quot;,
135 ],
136 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
137 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
138 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
139 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
140 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
141 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
142 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
143 # Object with schema name: Schema
144 ],
145 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
146 &quot;a_key&quot;: # Object with schema name: Schema
147 },
148 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
149 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
150 &quot;A String&quot;,
151 ],
152 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
153 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
154 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
155 },
156 &quot;response&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
157 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
158 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
159 # Object with schema name: Schema
160 ],
161 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
162 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
163 &quot;a_key&quot;: # Object with schema name: Schema
164 },
165 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
166 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
167 &quot;A String&quot;,
168 ],
169 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
170 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
171 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
172 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
173 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
174 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
175 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
176 # Object with schema name: Schema
177 ],
178 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
179 &quot;a_key&quot;: # Object with schema name: Schema
180 },
181 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
182 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
183 &quot;A String&quot;,
184 ],
185 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
186 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
187 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
188 },
189 },
190 &quot;connectorTool&quot;: { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
191 &quot;action&quot;: { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
192 &quot;connectionActionId&quot;: &quot;A String&quot;, # ID of a Connection action for the tool to use.
193 &quot;entityOperation&quot;: { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
194 &quot;entityId&quot;: &quot;A String&quot;, # Required. ID of the entity.
195 &quot;operation&quot;: &quot;A String&quot;, # Required. Operation to perform on the entity.
196 },
197 &quot;inputFields&quot;: [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
198 &quot;A String&quot;,
199 ],
200 &quot;outputFields&quot;: [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
201 &quot;A String&quot;,
202 ],
203 },
204 &quot;authConfig&quot;: { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
205 &quot;oauth2AuthCodeConfig&quot;: { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
206 &quot;oauthToken&quot;: &quot;A String&quot;, # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
207 },
208 &quot;oauth2JwtBearerConfig&quot;: { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
209 &quot;clientKey&quot;: &quot;A String&quot;, # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
210 &quot;issuer&quot;: &quot;A String&quot;, # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
211 &quot;subject&quot;: &quot;A String&quot;, # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
212 },
213 },
214 &quot;connection&quot;: &quot;A String&quot;, # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
215 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
216 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
217 },
218 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was created.
219 &quot;dataStoreTool&quot;: { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
220 &quot;boostSpecs&quot;: [ # Optional. Boost specification to boost certain documents.
221 { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
222 &quot;dataStores&quot;: [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
223 &quot;A String&quot;,
224 ],
225 &quot;spec&quot;: [ # Required. A list of boosting specifications.
226 { # Boost specification to boost certain documents.
227 &quot;conditionBoostSpecs&quot;: [ # Required. A list of boosting specifications.
228 { # Boost specification for a condition.
229 &quot;boost&quot;: 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
230 &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
231 &quot;attributeType&quot;: &quot;A String&quot;, # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
232 &quot;controlPoints&quot;: [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
233 { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
234 &quot;attributeValue&quot;: &quot;A String&quot;, # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
235 &quot;boostAmount&quot;: 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
236 },
237 ],
238 &quot;fieldName&quot;: &quot;A String&quot;, # Optional. The name of the field whose value will be used to determine the boost amount.
239 &quot;interpolationType&quot;: &quot;A String&quot;, # Optional. The interpolation type to be applied to connect the control points listed below.
240 },
241 &quot;condition&quot;: &quot;A String&quot;, # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(&quot;en&quot;, &quot;fr&quot;))
242 },
243 ],
244 },
245 ],
246 },
247 ],
248 &quot;dataStoreSource&quot;: { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
249 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
250 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
251 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
252 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
253 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
254 },
255 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
256 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
257 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
258 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
259 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
260 },
261 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
262 },
263 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
264 &quot;engineSource&quot;: { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
265 &quot;dataStoreSources&quot;: [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
266 { # Configuration for searching within a specific DataStore.
267 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
268 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
269 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
270 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
271 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
272 },
273 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
274 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
275 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
276 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
277 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
278 },
279 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
280 },
281 ],
282 &quot;engine&quot;: &quot;A String&quot;, # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
283 &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter applied to the search across the Engine. Not relevant and not used if &#x27;data_store_sources&#x27; is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
284 },
285 &quot;filterParameterBehavior&quot;: &quot;A String&quot;, # Optional. The filter parameter behavior.
286 &quot;modalityConfigs&quot;: [ # Optional. The modality configs for the data store.
287 { # If specified, will apply the given configuration for the specified modality.
288 &quot;groundingConfig&quot;: { # Grounding configuration. # Optional. The grounding configuration.
289 &quot;disabled&quot;: True or False, # Optional. Whether grounding is disabled.
290 &quot;groundingLevel&quot;: 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
291 },
292 &quot;modalityType&quot;: &quot;A String&quot;, # Required. The modality type.
293 &quot;rewriterConfig&quot;: { # Rewriter configuration. # Optional. The rewriter config.
294 &quot;disabled&quot;: True or False, # Optional. Whether the rewriter is disabled.
295 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
296 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
297 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
298 },
299 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
300 },
301 &quot;summarizationConfig&quot;: { # Summarization configuration. # Optional. The summarization config.
302 &quot;disabled&quot;: True or False, # Optional. Whether summarization is disabled.
303 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
304 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
305 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
306 },
307 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
308 },
309 },
310 ],
311 &quot;name&quot;: &quot;A String&quot;, # Required. The data store tool name.
312 },
313 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool, derived based on the tool&#x27;s type. For example, display name of a ClientFunction is derived from its `name` property.
314 &quot;etag&quot;: &quot;A String&quot;, # Etag used to ensure the object hasn&#x27;t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
315 &quot;executionType&quot;: &quot;A String&quot;, # Optional. The execution type of the tool.
316 &quot;fileSearchTool&quot;: { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
317 &quot;corpusType&quot;: &quot;A String&quot;, # Optional. The type of the corpus. Default is FULLY_MANAGED.
318 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
319 &quot;fileCorpus&quot;: &quot;A String&quot;, # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
320 &quot;name&quot;: &quot;A String&quot;, # Required. The tool name.
321 },
322 &quot;generatedSummary&quot;: &quot;A String&quot;, # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
323 &quot;googleSearchTool&quot;: { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
324 &quot;contextUrls&quot;: [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: &quot;https://example.com/path.html&quot;. A maximum of 20 URLs are allowed.
325 &quot;A String&quot;,
326 ],
327 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
328 &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. Example: &quot;example.com&quot;. A maximum of 2000 domains can be excluded.
329 &quot;A String&quot;,
330 ],
331 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
332 &quot;preferredDomains&quot;: [ # Optional. Specifies domains to restrict search results to. Example: &quot;example.com&quot;, &quot;another.site&quot;. A maximum of 20 domains can be specified.
333 &quot;A String&quot;,
334 ],
335 &quot;promptConfig&quot;: { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
336 &quot;textPrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
337 &quot;voicePrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
338 },
339 },
340 &quot;mcpTool&quot;: { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
341 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
342 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
343 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
344 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
345 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
346 },
347 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
348 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
349 },
350 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
351 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
352 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
353 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
354 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
355 &quot;A String&quot;,
356 ],
357 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
358 },
359 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
360 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
361 &quot;A String&quot;,
362 ],
363 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
364 },
365 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
366 },
367 },
368 &quot;customHeaders&quot;: { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
369 &quot;a_key&quot;: &quot;A String&quot;,
370 },
371 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the MCP tool.
372 &quot;inputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
373 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
374 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
375 # Object with schema name: Schema
376 ],
377 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
378 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
379 &quot;a_key&quot;: # Object with schema name: Schema
380 },
381 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
382 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
383 &quot;A String&quot;,
384 ],
385 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
386 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
387 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
388 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
389 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
390 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
391 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
392 # Object with schema name: Schema
393 ],
394 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
395 &quot;a_key&quot;: # Object with schema name: Schema
396 },
397 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
398 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
399 &quot;A String&quot;,
400 ],
401 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
402 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
403 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
404 },
405 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the MCP tool.
406 &quot;nameOverride&quot;: &quot;A String&quot;, # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
407 &quot;outputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
408 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
409 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
410 # Object with schema name: Schema
411 ],
412 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
413 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
414 &quot;a_key&quot;: # Object with schema name: Schema
415 },
416 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
417 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
418 &quot;A String&quot;,
419 ],
420 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
421 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
422 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
423 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
424 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
425 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
426 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
427 # Object with schema name: Schema
428 ],
429 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
430 &quot;a_key&quot;: # Object with schema name: Schema
431 },
432 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
433 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
434 &quot;A String&quot;,
435 ],
436 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
437 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
438 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
439 },
440 &quot;serverAddress&quot;: &quot;A String&quot;, # Required. The server address of the MCP server, e.g., &quot;https://example.com/mcp/&quot;. If the server is built with the MCP SDK, the url should be suffixed with &quot;/mcp/&quot;. Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
441 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
442 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
443 },
444 &quot;state&quot;: &quot;A String&quot;, # Output only. The dynamic availability state of the tool on the external server.
445 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
446 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
447 { # The CA certificate.
448 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
449 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
450 },
451 ],
452 },
453 },
454 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
455 &quot;openApiTool&quot;: { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
456 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required by the API.
457 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
458 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
459 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
460 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
461 },
462 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
463 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
464 },
465 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
466 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
467 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
468 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
469 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
470 &quot;A String&quot;,
471 ],
472 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
473 },
474 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
475 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
476 &quot;A String&quot;,
477 ],
478 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
479 },
480 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
481 },
482 },
483 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
484 &quot;ignoreUnknownFields&quot;: True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
485 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
486 &quot;openApiSchema&quot;: &quot;A String&quot;, # Required. The OpenAPI schema in JSON or YAML format.
487 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
488 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
489 },
490 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
491 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
492 { # The CA certificate.
493 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
494 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
495 },
496 ],
497 },
498 &quot;url&quot;: &quot;A String&quot;, # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
499 },
500 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. The python function tool.
501 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
502 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
503 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
504 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
505 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
506 },
507 },
508 &quot;remoteAgentTool&quot;: { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
509 &quot;agentCard&quot;: { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
510 &quot;description&quot;: &quot;A String&quot;, # Required. A description of the agent&#x27;s domain of action/solution space.
511 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the agent.
512 &quot;skills&quot;: [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
513 { # Represents a distinct capability or function that an agent can perform.
514 &quot;description&quot;: &quot;A String&quot;, # Required. A detailed description of the skill.
515 &quot;examples&quot;: [ # Example prompts or scenarios that this skill can handle.
516 &quot;A String&quot;,
517 ],
518 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for the agent&#x27;s skill.
519 &quot;inputModes&quot;: [ # The set of supported input media types for this skill, overriding the agent&#x27;s defaults.
520 &quot;A String&quot;,
521 ],
522 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the skill.
523 &quot;outputModes&quot;: [ # The set of supported output media types for this skill, overriding the agent&#x27;s defaults.
524 &quot;A String&quot;,
525 ],
526 &quot;tags&quot;: [ # Required. A set of keywords describing the skill&#x27;s capabilities.
527 &quot;A String&quot;,
528 ],
529 },
530 ],
531 &quot;supportedInterfaces&quot;: [ # Required. Ordered list of supported interfaces. The first entry is preferred.
532 { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
533 &quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
534 &quot;protocolVersion&quot;: &quot;A String&quot;, # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: &quot;0.3&quot;, &quot;1.0&quot;
535 &quot;tenant&quot;: &quot;A String&quot;, # Tenant ID to be used in the request when calling the agent.
536 &quot;url&quot;: &quot;A String&quot;, # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: &quot;https://api.example.com/a2a/v1&quot;, &quot;https://grpc.example.com/a2a&quot;
537 },
538 ],
539 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the agent.
540 },
541 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the tool.
542 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
543 },
544 &quot;systemTool&quot;: { # Pre-defined system tool. # Optional. The system tool.
545 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the system tool.
546 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the system tool.
547 },
548 &quot;timeout&quot;: &quot;A String&quot;, # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
549 &quot;toolFakeConfig&quot;: { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
550 &quot;codeBlock&quot;: { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
551 &quot;pythonCode&quot;: &quot;A String&quot;, # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
552 },
553 &quot;enableFakeMode&quot;: True or False, # Optional. Whether the tool is using fake mode.
554 },
555 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was last updated.
556 &quot;widgetTool&quot;: { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
557 &quot;dataMapping&quot;: { # Configuration for mapping data from a source tool to the widget&#x27;s input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget&#x27;s input parameters.
558 &quot;fieldMappings&quot;: { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
559 &quot;a_key&quot;: &quot;A String&quot;,
560 },
561 &quot;mode&quot;: &quot;A String&quot;, # Optional. The mode of the data mapping.
562 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool&#x27;s output into the widget&#x27;s input format.
563 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
564 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
565 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
566 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
567 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
568 },
569 },
570 &quot;pythonScript&quot;: &quot;A String&quot;, # Deprecated: Use `python_function` instead.
571 &quot;sourceToolName&quot;: &quot;A String&quot;, # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
572 },
573 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the widget tool.
574 &quot;name&quot;: &quot;A String&quot;, # Required. The display name of the widget tool.
575 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
576 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
577 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
578 # Object with schema name: Schema
579 ],
580 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
581 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
582 &quot;a_key&quot;: # Object with schema name: Schema
583 },
584 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
585 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
586 &quot;A String&quot;,
587 ],
588 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
589 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
590 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
591 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
592 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
593 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
594 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
595 # Object with schema name: Schema
596 ],
597 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
598 &quot;a_key&quot;: # Object with schema name: Schema
599 },
600 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
601 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
602 &quot;A String&quot;,
603 ],
604 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
605 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
606 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
607 },
608 &quot;textResponseConfig&quot;: { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
609 &quot;staticText&quot;: &quot;A String&quot;, # Optional. The static text response to return when type is STATIC.
610 &quot;textResponseInstruction&quot;: &quot;A String&quot;, # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
611 &quot;type&quot;: &quot;A String&quot;, # Optional. The strategy for providing the text response.
612 },
613 &quot;uiConfig&quot;: { # Optional. Configuration for rendering the widget.
614 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
615 },
616 &quot;widgetType&quot;: &quot;A String&quot;, # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
617 },
618 }
619
620 toolId: string, Optional. The ID to use for the tool, which will become the final component of the tool&#x27;s resource name. If not provided, a unique ID will be automatically assigned for the tool.
621 x__xgafv: string, V1 error format.
622 Allowed values
623 1 - v1 error format
624 2 - v2 error format
625
626 Returns:
627 An object of the form:
628
629 { # A tool represents an action that the CES agent can take to achieve certain goals.
630 &quot;agentTool&quot;: { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
631 &quot;agent&quot;: &quot;A String&quot;, # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
632 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
633 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the agent tool.
634 &quot;rootAgent&quot;: &quot;A String&quot;, # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
635 },
636 &quot;clientFunction&quot;: { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
637 &quot;description&quot;: &quot;A String&quot;, # Optional. The function description.
638 &quot;name&quot;: &quot;A String&quot;, # Required. The function name.
639 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
640 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
641 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
642 # Object with schema name: Schema
643 ],
644 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
645 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
646 &quot;a_key&quot;: # Object with schema name: Schema
647 },
648 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
649 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
650 &quot;A String&quot;,
651 ],
652 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
653 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
654 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
655 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
656 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
657 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
658 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
659 # Object with schema name: Schema
660 ],
661 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
662 &quot;a_key&quot;: # Object with schema name: Schema
663 },
664 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
665 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
666 &quot;A String&quot;,
667 ],
668 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
669 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
670 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
671 },
672 &quot;response&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
673 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
674 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
675 # Object with schema name: Schema
676 ],
677 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
678 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
679 &quot;a_key&quot;: # Object with schema name: Schema
680 },
681 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
682 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
683 &quot;A String&quot;,
684 ],
685 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
686 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
687 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
688 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
689 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
690 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
691 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
692 # Object with schema name: Schema
693 ],
694 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
695 &quot;a_key&quot;: # Object with schema name: Schema
696 },
697 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
698 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
699 &quot;A String&quot;,
700 ],
701 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
702 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
703 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
704 },
705 },
706 &quot;connectorTool&quot;: { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
707 &quot;action&quot;: { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
708 &quot;connectionActionId&quot;: &quot;A String&quot;, # ID of a Connection action for the tool to use.
709 &quot;entityOperation&quot;: { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
710 &quot;entityId&quot;: &quot;A String&quot;, # Required. ID of the entity.
711 &quot;operation&quot;: &quot;A String&quot;, # Required. Operation to perform on the entity.
712 },
713 &quot;inputFields&quot;: [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
714 &quot;A String&quot;,
715 ],
716 &quot;outputFields&quot;: [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
717 &quot;A String&quot;,
718 ],
719 },
720 &quot;authConfig&quot;: { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
721 &quot;oauth2AuthCodeConfig&quot;: { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
722 &quot;oauthToken&quot;: &quot;A String&quot;, # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
723 },
724 &quot;oauth2JwtBearerConfig&quot;: { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
725 &quot;clientKey&quot;: &quot;A String&quot;, # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
726 &quot;issuer&quot;: &quot;A String&quot;, # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
727 &quot;subject&quot;: &quot;A String&quot;, # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
728 },
729 },
730 &quot;connection&quot;: &quot;A String&quot;, # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
731 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
732 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
733 },
734 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was created.
735 &quot;dataStoreTool&quot;: { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
736 &quot;boostSpecs&quot;: [ # Optional. Boost specification to boost certain documents.
737 { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
738 &quot;dataStores&quot;: [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
739 &quot;A String&quot;,
740 ],
741 &quot;spec&quot;: [ # Required. A list of boosting specifications.
742 { # Boost specification to boost certain documents.
743 &quot;conditionBoostSpecs&quot;: [ # Required. A list of boosting specifications.
744 { # Boost specification for a condition.
745 &quot;boost&quot;: 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
746 &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
747 &quot;attributeType&quot;: &quot;A String&quot;, # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
748 &quot;controlPoints&quot;: [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
749 { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
750 &quot;attributeValue&quot;: &quot;A String&quot;, # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
751 &quot;boostAmount&quot;: 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
752 },
753 ],
754 &quot;fieldName&quot;: &quot;A String&quot;, # Optional. The name of the field whose value will be used to determine the boost amount.
755 &quot;interpolationType&quot;: &quot;A String&quot;, # Optional. The interpolation type to be applied to connect the control points listed below.
756 },
757 &quot;condition&quot;: &quot;A String&quot;, # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(&quot;en&quot;, &quot;fr&quot;))
758 },
759 ],
760 },
761 ],
762 },
763 ],
764 &quot;dataStoreSource&quot;: { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
765 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
766 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
767 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
768 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
769 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
770 },
771 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
772 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
773 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
774 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
775 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
776 },
777 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
778 },
779 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
780 &quot;engineSource&quot;: { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
781 &quot;dataStoreSources&quot;: [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
782 { # Configuration for searching within a specific DataStore.
783 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
784 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
785 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
786 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
787 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
788 },
789 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
790 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
791 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
792 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
793 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
794 },
795 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
796 },
797 ],
798 &quot;engine&quot;: &quot;A String&quot;, # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
799 &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter applied to the search across the Engine. Not relevant and not used if &#x27;data_store_sources&#x27; is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
800 },
801 &quot;filterParameterBehavior&quot;: &quot;A String&quot;, # Optional. The filter parameter behavior.
802 &quot;modalityConfigs&quot;: [ # Optional. The modality configs for the data store.
803 { # If specified, will apply the given configuration for the specified modality.
804 &quot;groundingConfig&quot;: { # Grounding configuration. # Optional. The grounding configuration.
805 &quot;disabled&quot;: True or False, # Optional. Whether grounding is disabled.
806 &quot;groundingLevel&quot;: 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
807 },
808 &quot;modalityType&quot;: &quot;A String&quot;, # Required. The modality type.
809 &quot;rewriterConfig&quot;: { # Rewriter configuration. # Optional. The rewriter config.
810 &quot;disabled&quot;: True or False, # Optional. Whether the rewriter is disabled.
811 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
812 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
813 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
814 },
815 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
816 },
817 &quot;summarizationConfig&quot;: { # Summarization configuration. # Optional. The summarization config.
818 &quot;disabled&quot;: True or False, # Optional. Whether summarization is disabled.
819 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
820 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
821 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
822 },
823 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
824 },
825 },
826 ],
827 &quot;name&quot;: &quot;A String&quot;, # Required. The data store tool name.
828 },
829 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool, derived based on the tool&#x27;s type. For example, display name of a ClientFunction is derived from its `name` property.
830 &quot;etag&quot;: &quot;A String&quot;, # Etag used to ensure the object hasn&#x27;t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
831 &quot;executionType&quot;: &quot;A String&quot;, # Optional. The execution type of the tool.
832 &quot;fileSearchTool&quot;: { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
833 &quot;corpusType&quot;: &quot;A String&quot;, # Optional. The type of the corpus. Default is FULLY_MANAGED.
834 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
835 &quot;fileCorpus&quot;: &quot;A String&quot;, # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
836 &quot;name&quot;: &quot;A String&quot;, # Required. The tool name.
837 },
838 &quot;generatedSummary&quot;: &quot;A String&quot;, # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
839 &quot;googleSearchTool&quot;: { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
840 &quot;contextUrls&quot;: [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: &quot;https://example.com/path.html&quot;. A maximum of 20 URLs are allowed.
841 &quot;A String&quot;,
842 ],
843 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
844 &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. Example: &quot;example.com&quot;. A maximum of 2000 domains can be excluded.
845 &quot;A String&quot;,
846 ],
847 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
848 &quot;preferredDomains&quot;: [ # Optional. Specifies domains to restrict search results to. Example: &quot;example.com&quot;, &quot;another.site&quot;. A maximum of 20 domains can be specified.
849 &quot;A String&quot;,
850 ],
851 &quot;promptConfig&quot;: { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
852 &quot;textPrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
853 &quot;voicePrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
854 },
855 },
856 &quot;mcpTool&quot;: { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
857 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
858 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
859 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
860 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
861 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
862 },
863 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
864 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
865 },
866 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
867 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
868 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
869 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
870 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
871 &quot;A String&quot;,
872 ],
873 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
874 },
875 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
876 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
877 &quot;A String&quot;,
878 ],
879 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
880 },
881 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
882 },
883 },
884 &quot;customHeaders&quot;: { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
885 &quot;a_key&quot;: &quot;A String&quot;,
886 },
887 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the MCP tool.
888 &quot;inputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
889 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
890 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
891 # Object with schema name: Schema
892 ],
893 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
894 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
895 &quot;a_key&quot;: # Object with schema name: Schema
896 },
897 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
898 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
899 &quot;A String&quot;,
900 ],
901 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
902 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
903 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
904 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
905 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
906 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
907 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
908 # Object with schema name: Schema
909 ],
910 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
911 &quot;a_key&quot;: # Object with schema name: Schema
912 },
913 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
914 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
915 &quot;A String&quot;,
916 ],
917 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
918 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
919 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
920 },
921 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the MCP tool.
922 &quot;nameOverride&quot;: &quot;A String&quot;, # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
923 &quot;outputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
924 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
925 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
926 # Object with schema name: Schema
927 ],
928 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
929 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
930 &quot;a_key&quot;: # Object with schema name: Schema
931 },
932 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
933 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
934 &quot;A String&quot;,
935 ],
936 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
937 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
938 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
939 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
940 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
941 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
942 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
943 # Object with schema name: Schema
944 ],
945 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
946 &quot;a_key&quot;: # Object with schema name: Schema
947 },
948 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
949 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
950 &quot;A String&quot;,
951 ],
952 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
953 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
954 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
955 },
956 &quot;serverAddress&quot;: &quot;A String&quot;, # Required. The server address of the MCP server, e.g., &quot;https://example.com/mcp/&quot;. If the server is built with the MCP SDK, the url should be suffixed with &quot;/mcp/&quot;. Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
957 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
958 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
959 },
960 &quot;state&quot;: &quot;A String&quot;, # Output only. The dynamic availability state of the tool on the external server.
961 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
962 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
963 { # The CA certificate.
964 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
965 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
966 },
967 ],
968 },
969 },
970 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
971 &quot;openApiTool&quot;: { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
972 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required by the API.
973 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
974 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
975 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
976 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
977 },
978 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
979 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
980 },
981 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
982 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
983 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
984 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
985 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
986 &quot;A String&quot;,
987 ],
988 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
989 },
990 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
991 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
992 &quot;A String&quot;,
993 ],
994 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
995 },
996 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
997 },
998 },
999 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
1000 &quot;ignoreUnknownFields&quot;: True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
1001 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
1002 &quot;openApiSchema&quot;: &quot;A String&quot;, # Required. The OpenAPI schema in JSON or YAML format.
1003 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
1004 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1005 },
1006 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
1007 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
1008 { # The CA certificate.
1009 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
1010 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
1011 },
1012 ],
1013 },
1014 &quot;url&quot;: &quot;A String&quot;, # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
1015 },
1016 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. The python function tool.
1017 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
1018 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
1019 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
1020 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
1021 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1022 },
1023 },
1024 &quot;remoteAgentTool&quot;: { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
1025 &quot;agentCard&quot;: { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
1026 &quot;description&quot;: &quot;A String&quot;, # Required. A description of the agent&#x27;s domain of action/solution space.
1027 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the agent.
1028 &quot;skills&quot;: [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
1029 { # Represents a distinct capability or function that an agent can perform.
1030 &quot;description&quot;: &quot;A String&quot;, # Required. A detailed description of the skill.
1031 &quot;examples&quot;: [ # Example prompts or scenarios that this skill can handle.
1032 &quot;A String&quot;,
1033 ],
1034 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for the agent&#x27;s skill.
1035 &quot;inputModes&quot;: [ # The set of supported input media types for this skill, overriding the agent&#x27;s defaults.
1036 &quot;A String&quot;,
1037 ],
1038 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the skill.
1039 &quot;outputModes&quot;: [ # The set of supported output media types for this skill, overriding the agent&#x27;s defaults.
1040 &quot;A String&quot;,
1041 ],
1042 &quot;tags&quot;: [ # Required. A set of keywords describing the skill&#x27;s capabilities.
1043 &quot;A String&quot;,
1044 ],
1045 },
1046 ],
1047 &quot;supportedInterfaces&quot;: [ # Required. Ordered list of supported interfaces. The first entry is preferred.
1048 { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
1049 &quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
1050 &quot;protocolVersion&quot;: &quot;A String&quot;, # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: &quot;0.3&quot;, &quot;1.0&quot;
1051 &quot;tenant&quot;: &quot;A String&quot;, # Tenant ID to be used in the request when calling the agent.
1052 &quot;url&quot;: &quot;A String&quot;, # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: &quot;https://api.example.com/a2a/v1&quot;, &quot;https://grpc.example.com/a2a&quot;
1053 },
1054 ],
1055 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the agent.
1056 },
1057 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the tool.
1058 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
1059 },
1060 &quot;systemTool&quot;: { # Pre-defined system tool. # Optional. The system tool.
1061 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the system tool.
1062 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the system tool.
1063 },
1064 &quot;timeout&quot;: &quot;A String&quot;, # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
1065 &quot;toolFakeConfig&quot;: { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
1066 &quot;codeBlock&quot;: { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
1067 &quot;pythonCode&quot;: &quot;A String&quot;, # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
1068 },
1069 &quot;enableFakeMode&quot;: True or False, # Optional. Whether the tool is using fake mode.
1070 },
1071 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was last updated.
1072 &quot;widgetTool&quot;: { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
1073 &quot;dataMapping&quot;: { # Configuration for mapping data from a source tool to the widget&#x27;s input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget&#x27;s input parameters.
1074 &quot;fieldMappings&quot;: { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
1075 &quot;a_key&quot;: &quot;A String&quot;,
1076 },
1077 &quot;mode&quot;: &quot;A String&quot;, # Optional. The mode of the data mapping.
1078 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool&#x27;s output into the widget&#x27;s input format.
1079 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
1080 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
1081 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
1082 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
1083 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1084 },
1085 },
1086 &quot;pythonScript&quot;: &quot;A String&quot;, # Deprecated: Use `python_function` instead.
1087 &quot;sourceToolName&quot;: &quot;A String&quot;, # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
1088 },
1089 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the widget tool.
1090 &quot;name&quot;: &quot;A String&quot;, # Required. The display name of the widget tool.
1091 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
1092 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1093 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1094 # Object with schema name: Schema
1095 ],
1096 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1097 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1098 &quot;a_key&quot;: # Object with schema name: Schema
1099 },
1100 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1101 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1102 &quot;A String&quot;,
1103 ],
1104 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1105 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1106 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1107 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1108 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1109 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1110 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1111 # Object with schema name: Schema
1112 ],
1113 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1114 &quot;a_key&quot;: # Object with schema name: Schema
1115 },
1116 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1117 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1118 &quot;A String&quot;,
1119 ],
1120 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1121 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1122 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1123 },
1124 &quot;textResponseConfig&quot;: { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
1125 &quot;staticText&quot;: &quot;A String&quot;, # Optional. The static text response to return when type is STATIC.
1126 &quot;textResponseInstruction&quot;: &quot;A String&quot;, # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
1127 &quot;type&quot;: &quot;A String&quot;, # Optional. The strategy for providing the text response.
1128 },
1129 &quot;uiConfig&quot;: { # Optional. Configuration for rendering the widget.
1130 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1131 },
1132 &quot;widgetType&quot;: &quot;A String&quot;, # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
1133 },
1134 }</pre>
1135 </div>
1136
1137 <div class="method">
1138 <code class="details" id="delete">delete(name, etag=None, force=None, x__xgafv=None)</code>
1139 <pre>Deletes the specified tool.
1140
1141 Args:
1142 name: string, Required. The resource name of the tool to delete. (required)
1143 etag: string, Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.
1144 force: boolean, Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted.
1145 x__xgafv: string, V1 error format.
1146 Allowed values
1147 1 - v1 error format
1148 2 - v2 error format
1149
1150 Returns:
1151 An object of the form:
1152
1153 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
1154 }</pre>
1155 </div>
1156
1157 <div class="method">
1158 <code class="details" id="get">get(name, x__xgafv=None)</code>
1159 <pre>Gets details of the specified tool.
1160
1161 Args:
1162 name: string, Required. The resource name of the tool to retrieve. (required)
1163 x__xgafv: string, V1 error format.
1164 Allowed values
1165 1 - v1 error format
1166 2 - v2 error format
1167
1168 Returns:
1169 An object of the form:
1170
1171 { # A tool represents an action that the CES agent can take to achieve certain goals.
1172 &quot;agentTool&quot;: { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
1173 &quot;agent&quot;: &quot;A String&quot;, # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
1174 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
1175 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the agent tool.
1176 &quot;rootAgent&quot;: &quot;A String&quot;, # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
1177 },
1178 &quot;clientFunction&quot;: { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
1179 &quot;description&quot;: &quot;A String&quot;, # Optional. The function description.
1180 &quot;name&quot;: &quot;A String&quot;, # Required. The function name.
1181 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
1182 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1183 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1184 # Object with schema name: Schema
1185 ],
1186 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1187 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1188 &quot;a_key&quot;: # Object with schema name: Schema
1189 },
1190 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1191 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1192 &quot;A String&quot;,
1193 ],
1194 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1195 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1196 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1197 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1198 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1199 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1200 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1201 # Object with schema name: Schema
1202 ],
1203 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1204 &quot;a_key&quot;: # Object with schema name: Schema
1205 },
1206 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1207 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1208 &quot;A String&quot;,
1209 ],
1210 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1211 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1212 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1213 },
1214 &quot;response&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
1215 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1216 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1217 # Object with schema name: Schema
1218 ],
1219 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1220 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1221 &quot;a_key&quot;: # Object with schema name: Schema
1222 },
1223 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1224 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1225 &quot;A String&quot;,
1226 ],
1227 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1228 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1229 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1230 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1231 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1232 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1233 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1234 # Object with schema name: Schema
1235 ],
1236 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1237 &quot;a_key&quot;: # Object with schema name: Schema
1238 },
1239 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1240 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1241 &quot;A String&quot;,
1242 ],
1243 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1244 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1245 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1246 },
1247 },
1248 &quot;connectorTool&quot;: { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
1249 &quot;action&quot;: { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
1250 &quot;connectionActionId&quot;: &quot;A String&quot;, # ID of a Connection action for the tool to use.
1251 &quot;entityOperation&quot;: { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
1252 &quot;entityId&quot;: &quot;A String&quot;, # Required. ID of the entity.
1253 &quot;operation&quot;: &quot;A String&quot;, # Required. Operation to perform on the entity.
1254 },
1255 &quot;inputFields&quot;: [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
1256 &quot;A String&quot;,
1257 ],
1258 &quot;outputFields&quot;: [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
1259 &quot;A String&quot;,
1260 ],
1261 },
1262 &quot;authConfig&quot;: { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
1263 &quot;oauth2AuthCodeConfig&quot;: { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
1264 &quot;oauthToken&quot;: &quot;A String&quot;, # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
1265 },
1266 &quot;oauth2JwtBearerConfig&quot;: { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
1267 &quot;clientKey&quot;: &quot;A String&quot;, # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
1268 &quot;issuer&quot;: &quot;A String&quot;, # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
1269 &quot;subject&quot;: &quot;A String&quot;, # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
1270 },
1271 },
1272 &quot;connection&quot;: &quot;A String&quot;, # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
1273 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
1274 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
1275 },
1276 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was created.
1277 &quot;dataStoreTool&quot;: { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
1278 &quot;boostSpecs&quot;: [ # Optional. Boost specification to boost certain documents.
1279 { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
1280 &quot;dataStores&quot;: [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
1281 &quot;A String&quot;,
1282 ],
1283 &quot;spec&quot;: [ # Required. A list of boosting specifications.
1284 { # Boost specification to boost certain documents.
1285 &quot;conditionBoostSpecs&quot;: [ # Required. A list of boosting specifications.
1286 { # Boost specification for a condition.
1287 &quot;boost&quot;: 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
1288 &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
1289 &quot;attributeType&quot;: &quot;A String&quot;, # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
1290 &quot;controlPoints&quot;: [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
1291 { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
1292 &quot;attributeValue&quot;: &quot;A String&quot;, # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
1293 &quot;boostAmount&quot;: 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
1294 },
1295 ],
1296 &quot;fieldName&quot;: &quot;A String&quot;, # Optional. The name of the field whose value will be used to determine the boost amount.
1297 &quot;interpolationType&quot;: &quot;A String&quot;, # Optional. The interpolation type to be applied to connect the control points listed below.
1298 },
1299 &quot;condition&quot;: &quot;A String&quot;, # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(&quot;en&quot;, &quot;fr&quot;))
1300 },
1301 ],
1302 },
1303 ],
1304 },
1305 ],
1306 &quot;dataStoreSource&quot;: { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
1307 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
1308 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
1309 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
1310 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
1311 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
1312 },
1313 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
1314 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
1315 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
1316 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
1317 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
1318 },
1319 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
1320 },
1321 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
1322 &quot;engineSource&quot;: { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
1323 &quot;dataStoreSources&quot;: [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
1324 { # Configuration for searching within a specific DataStore.
1325 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
1326 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
1327 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
1328 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
1329 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
1330 },
1331 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
1332 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
1333 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
1334 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
1335 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
1336 },
1337 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
1338 },
1339 ],
1340 &quot;engine&quot;: &quot;A String&quot;, # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
1341 &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter applied to the search across the Engine. Not relevant and not used if &#x27;data_store_sources&#x27; is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
1342 },
1343 &quot;filterParameterBehavior&quot;: &quot;A String&quot;, # Optional. The filter parameter behavior.
1344 &quot;modalityConfigs&quot;: [ # Optional. The modality configs for the data store.
1345 { # If specified, will apply the given configuration for the specified modality.
1346 &quot;groundingConfig&quot;: { # Grounding configuration. # Optional. The grounding configuration.
1347 &quot;disabled&quot;: True or False, # Optional. Whether grounding is disabled.
1348 &quot;groundingLevel&quot;: 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
1349 },
1350 &quot;modalityType&quot;: &quot;A String&quot;, # Required. The modality type.
1351 &quot;rewriterConfig&quot;: { # Rewriter configuration. # Optional. The rewriter config.
1352 &quot;disabled&quot;: True or False, # Optional. Whether the rewriter is disabled.
1353 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
1354 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
1355 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
1356 },
1357 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
1358 },
1359 &quot;summarizationConfig&quot;: { # Summarization configuration. # Optional. The summarization config.
1360 &quot;disabled&quot;: True or False, # Optional. Whether summarization is disabled.
1361 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
1362 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
1363 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
1364 },
1365 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
1366 },
1367 },
1368 ],
1369 &quot;name&quot;: &quot;A String&quot;, # Required. The data store tool name.
1370 },
1371 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool, derived based on the tool&#x27;s type. For example, display name of a ClientFunction is derived from its `name` property.
1372 &quot;etag&quot;: &quot;A String&quot;, # Etag used to ensure the object hasn&#x27;t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
1373 &quot;executionType&quot;: &quot;A String&quot;, # Optional. The execution type of the tool.
1374 &quot;fileSearchTool&quot;: { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
1375 &quot;corpusType&quot;: &quot;A String&quot;, # Optional. The type of the corpus. Default is FULLY_MANAGED.
1376 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
1377 &quot;fileCorpus&quot;: &quot;A String&quot;, # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
1378 &quot;name&quot;: &quot;A String&quot;, # Required. The tool name.
1379 },
1380 &quot;generatedSummary&quot;: &quot;A String&quot;, # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
1381 &quot;googleSearchTool&quot;: { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
1382 &quot;contextUrls&quot;: [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: &quot;https://example.com/path.html&quot;. A maximum of 20 URLs are allowed.
1383 &quot;A String&quot;,
1384 ],
1385 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
1386 &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. Example: &quot;example.com&quot;. A maximum of 2000 domains can be excluded.
1387 &quot;A String&quot;,
1388 ],
1389 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
1390 &quot;preferredDomains&quot;: [ # Optional. Specifies domains to restrict search results to. Example: &quot;example.com&quot;, &quot;another.site&quot;. A maximum of 20 domains can be specified.
1391 &quot;A String&quot;,
1392 ],
1393 &quot;promptConfig&quot;: { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
1394 &quot;textPrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
1395 &quot;voicePrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
1396 },
1397 },
1398 &quot;mcpTool&quot;: { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
1399 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
1400 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
1401 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
1402 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
1403 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
1404 },
1405 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
1406 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
1407 },
1408 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
1409 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
1410 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
1411 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
1412 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
1413 &quot;A String&quot;,
1414 ],
1415 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
1416 },
1417 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
1418 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
1419 &quot;A String&quot;,
1420 ],
1421 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
1422 },
1423 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
1424 },
1425 },
1426 &quot;customHeaders&quot;: { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
1427 &quot;a_key&quot;: &quot;A String&quot;,
1428 },
1429 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the MCP tool.
1430 &quot;inputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
1431 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1432 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1433 # Object with schema name: Schema
1434 ],
1435 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1436 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1437 &quot;a_key&quot;: # Object with schema name: Schema
1438 },
1439 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1440 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1441 &quot;A String&quot;,
1442 ],
1443 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1444 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1445 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1446 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1447 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1448 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1449 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1450 # Object with schema name: Schema
1451 ],
1452 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1453 &quot;a_key&quot;: # Object with schema name: Schema
1454 },
1455 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1456 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1457 &quot;A String&quot;,
1458 ],
1459 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1460 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1461 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1462 },
1463 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the MCP tool.
1464 &quot;nameOverride&quot;: &quot;A String&quot;, # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
1465 &quot;outputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
1466 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1467 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1468 # Object with schema name: Schema
1469 ],
1470 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1471 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1472 &quot;a_key&quot;: # Object with schema name: Schema
1473 },
1474 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1475 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1476 &quot;A String&quot;,
1477 ],
1478 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1479 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1480 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1481 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1482 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1483 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1484 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1485 # Object with schema name: Schema
1486 ],
1487 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1488 &quot;a_key&quot;: # Object with schema name: Schema
1489 },
1490 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1491 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1492 &quot;A String&quot;,
1493 ],
1494 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1495 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1496 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1497 },
1498 &quot;serverAddress&quot;: &quot;A String&quot;, # Required. The server address of the MCP server, e.g., &quot;https://example.com/mcp/&quot;. If the server is built with the MCP SDK, the url should be suffixed with &quot;/mcp/&quot;. Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
1499 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
1500 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1501 },
1502 &quot;state&quot;: &quot;A String&quot;, # Output only. The dynamic availability state of the tool on the external server.
1503 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
1504 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
1505 { # The CA certificate.
1506 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
1507 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
1508 },
1509 ],
1510 },
1511 },
1512 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
1513 &quot;openApiTool&quot;: { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
1514 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required by the API.
1515 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
1516 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
1517 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
1518 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
1519 },
1520 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
1521 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
1522 },
1523 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
1524 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
1525 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
1526 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
1527 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
1528 &quot;A String&quot;,
1529 ],
1530 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
1531 },
1532 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
1533 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
1534 &quot;A String&quot;,
1535 ],
1536 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
1537 },
1538 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
1539 },
1540 },
1541 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
1542 &quot;ignoreUnknownFields&quot;: True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
1543 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
1544 &quot;openApiSchema&quot;: &quot;A String&quot;, # Required. The OpenAPI schema in JSON or YAML format.
1545 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
1546 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1547 },
1548 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
1549 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
1550 { # The CA certificate.
1551 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
1552 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
1553 },
1554 ],
1555 },
1556 &quot;url&quot;: &quot;A String&quot;, # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
1557 },
1558 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. The python function tool.
1559 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
1560 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
1561 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
1562 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
1563 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1564 },
1565 },
1566 &quot;remoteAgentTool&quot;: { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
1567 &quot;agentCard&quot;: { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
1568 &quot;description&quot;: &quot;A String&quot;, # Required. A description of the agent&#x27;s domain of action/solution space.
1569 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the agent.
1570 &quot;skills&quot;: [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
1571 { # Represents a distinct capability or function that an agent can perform.
1572 &quot;description&quot;: &quot;A String&quot;, # Required. A detailed description of the skill.
1573 &quot;examples&quot;: [ # Example prompts or scenarios that this skill can handle.
1574 &quot;A String&quot;,
1575 ],
1576 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for the agent&#x27;s skill.
1577 &quot;inputModes&quot;: [ # The set of supported input media types for this skill, overriding the agent&#x27;s defaults.
1578 &quot;A String&quot;,
1579 ],
1580 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the skill.
1581 &quot;outputModes&quot;: [ # The set of supported output media types for this skill, overriding the agent&#x27;s defaults.
1582 &quot;A String&quot;,
1583 ],
1584 &quot;tags&quot;: [ # Required. A set of keywords describing the skill&#x27;s capabilities.
1585 &quot;A String&quot;,
1586 ],
1587 },
1588 ],
1589 &quot;supportedInterfaces&quot;: [ # Required. Ordered list of supported interfaces. The first entry is preferred.
1590 { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
1591 &quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
1592 &quot;protocolVersion&quot;: &quot;A String&quot;, # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: &quot;0.3&quot;, &quot;1.0&quot;
1593 &quot;tenant&quot;: &quot;A String&quot;, # Tenant ID to be used in the request when calling the agent.
1594 &quot;url&quot;: &quot;A String&quot;, # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: &quot;https://api.example.com/a2a/v1&quot;, &quot;https://grpc.example.com/a2a&quot;
1595 },
1596 ],
1597 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the agent.
1598 },
1599 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the tool.
1600 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
1601 },
1602 &quot;systemTool&quot;: { # Pre-defined system tool. # Optional. The system tool.
1603 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the system tool.
1604 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the system tool.
1605 },
1606 &quot;timeout&quot;: &quot;A String&quot;, # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
1607 &quot;toolFakeConfig&quot;: { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
1608 &quot;codeBlock&quot;: { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
1609 &quot;pythonCode&quot;: &quot;A String&quot;, # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
1610 },
1611 &quot;enableFakeMode&quot;: True or False, # Optional. Whether the tool is using fake mode.
1612 },
1613 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was last updated.
1614 &quot;widgetTool&quot;: { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
1615 &quot;dataMapping&quot;: { # Configuration for mapping data from a source tool to the widget&#x27;s input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget&#x27;s input parameters.
1616 &quot;fieldMappings&quot;: { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
1617 &quot;a_key&quot;: &quot;A String&quot;,
1618 },
1619 &quot;mode&quot;: &quot;A String&quot;, # Optional. The mode of the data mapping.
1620 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool&#x27;s output into the widget&#x27;s input format.
1621 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
1622 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
1623 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
1624 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
1625 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
1626 },
1627 },
1628 &quot;pythonScript&quot;: &quot;A String&quot;, # Deprecated: Use `python_function` instead.
1629 &quot;sourceToolName&quot;: &quot;A String&quot;, # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
1630 },
1631 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the widget tool.
1632 &quot;name&quot;: &quot;A String&quot;, # Required. The display name of the widget tool.
1633 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
1634 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1635 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1636 # Object with schema name: Schema
1637 ],
1638 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1639 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1640 &quot;a_key&quot;: # Object with schema name: Schema
1641 },
1642 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1643 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1644 &quot;A String&quot;,
1645 ],
1646 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1647 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1648 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1649 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1650 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1651 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1652 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1653 # Object with schema name: Schema
1654 ],
1655 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1656 &quot;a_key&quot;: # Object with schema name: Schema
1657 },
1658 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1659 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1660 &quot;A String&quot;,
1661 ],
1662 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1663 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1664 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1665 },
1666 &quot;textResponseConfig&quot;: { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
1667 &quot;staticText&quot;: &quot;A String&quot;, # Optional. The static text response to return when type is STATIC.
1668 &quot;textResponseInstruction&quot;: &quot;A String&quot;, # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
1669 &quot;type&quot;: &quot;A String&quot;, # Optional. The strategy for providing the text response.
1670 },
1671 &quot;uiConfig&quot;: { # Optional. Configuration for rendering the widget.
1672 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1673 },
1674 &quot;widgetType&quot;: &quot;A String&quot;, # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
1675 },
1676 }</pre>
1677 </div>
1678
1679 <div class="method">
1680 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
1681 <pre>Lists tools in the given app.
1682
1683 Args:
1684 parent: string, Required. The resource name of the app to list tools from. (required)
1685 filter: string, Optional. Filter to be applied when listing the tools. Use &quot;include_system_tools=true&quot; to include system tools in the response. See https://google.aip.dev/160 for more details.
1686 orderBy: string, Optional. Field to sort by. Only &quot;name&quot; and &quot;create_time&quot; is supported. See https://google.aip.dev/132#ordering for more details.
1687 pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
1688 pageToken: string, Optional. The next_page_token value returned from a previous list AgentService.ListTools call.
1689 x__xgafv: string, V1 error format.
1690 Allowed values
1691 1 - v1 error format
1692 2 - v2 error format
1693
1694 Returns:
1695 An object of the form:
1696
1697 { # Response message for AgentService.ListTools.
1698 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as ListToolsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
1699 &quot;tools&quot;: [ # The list of tools.
1700 { # A tool represents an action that the CES agent can take to achieve certain goals.
1701 &quot;agentTool&quot;: { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
1702 &quot;agent&quot;: &quot;A String&quot;, # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
1703 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
1704 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the agent tool.
1705 &quot;rootAgent&quot;: &quot;A String&quot;, # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
1706 },
1707 &quot;clientFunction&quot;: { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
1708 &quot;description&quot;: &quot;A String&quot;, # Optional. The function description.
1709 &quot;name&quot;: &quot;A String&quot;, # Required. The function name.
1710 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
1711 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1712 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1713 # Object with schema name: Schema
1714 ],
1715 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1716 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1717 &quot;a_key&quot;: # Object with schema name: Schema
1718 },
1719 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1720 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1721 &quot;A String&quot;,
1722 ],
1723 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1724 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1725 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1726 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1727 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1728 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1729 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1730 # Object with schema name: Schema
1731 ],
1732 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1733 &quot;a_key&quot;: # Object with schema name: Schema
1734 },
1735 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1736 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1737 &quot;A String&quot;,
1738 ],
1739 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1740 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1741 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1742 },
1743 &quot;response&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
1744 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1745 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1746 # Object with schema name: Schema
1747 ],
1748 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1749 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1750 &quot;a_key&quot;: # Object with schema name: Schema
1751 },
1752 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1753 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1754 &quot;A String&quot;,
1755 ],
1756 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1757 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1758 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1759 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1760 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1761 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1762 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1763 # Object with schema name: Schema
1764 ],
1765 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1766 &quot;a_key&quot;: # Object with schema name: Schema
1767 },
1768 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1769 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1770 &quot;A String&quot;,
1771 ],
1772 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1773 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1774 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1775 },
1776 },
1777 &quot;connectorTool&quot;: { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
1778 &quot;action&quot;: { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
1779 &quot;connectionActionId&quot;: &quot;A String&quot;, # ID of a Connection action for the tool to use.
1780 &quot;entityOperation&quot;: { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
1781 &quot;entityId&quot;: &quot;A String&quot;, # Required. ID of the entity.
1782 &quot;operation&quot;: &quot;A String&quot;, # Required. Operation to perform on the entity.
1783 },
1784 &quot;inputFields&quot;: [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
1785 &quot;A String&quot;,
1786 ],
1787 &quot;outputFields&quot;: [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
1788 &quot;A String&quot;,
1789 ],
1790 },
1791 &quot;authConfig&quot;: { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
1792 &quot;oauth2AuthCodeConfig&quot;: { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
1793 &quot;oauthToken&quot;: &quot;A String&quot;, # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
1794 },
1795 &quot;oauth2JwtBearerConfig&quot;: { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
1796 &quot;clientKey&quot;: &quot;A String&quot;, # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
1797 &quot;issuer&quot;: &quot;A String&quot;, # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
1798 &quot;subject&quot;: &quot;A String&quot;, # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
1799 },
1800 },
1801 &quot;connection&quot;: &quot;A String&quot;, # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
1802 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
1803 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
1804 },
1805 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was created.
1806 &quot;dataStoreTool&quot;: { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
1807 &quot;boostSpecs&quot;: [ # Optional. Boost specification to boost certain documents.
1808 { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
1809 &quot;dataStores&quot;: [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
1810 &quot;A String&quot;,
1811 ],
1812 &quot;spec&quot;: [ # Required. A list of boosting specifications.
1813 { # Boost specification to boost certain documents.
1814 &quot;conditionBoostSpecs&quot;: [ # Required. A list of boosting specifications.
1815 { # Boost specification for a condition.
1816 &quot;boost&quot;: 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
1817 &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
1818 &quot;attributeType&quot;: &quot;A String&quot;, # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
1819 &quot;controlPoints&quot;: [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
1820 { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
1821 &quot;attributeValue&quot;: &quot;A String&quot;, # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
1822 &quot;boostAmount&quot;: 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
1823 },
1824 ],
1825 &quot;fieldName&quot;: &quot;A String&quot;, # Optional. The name of the field whose value will be used to determine the boost amount.
1826 &quot;interpolationType&quot;: &quot;A String&quot;, # Optional. The interpolation type to be applied to connect the control points listed below.
1827 },
1828 &quot;condition&quot;: &quot;A String&quot;, # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(&quot;en&quot;, &quot;fr&quot;))
1829 },
1830 ],
1831 },
1832 ],
1833 },
1834 ],
1835 &quot;dataStoreSource&quot;: { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
1836 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
1837 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
1838 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
1839 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
1840 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
1841 },
1842 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
1843 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
1844 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
1845 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
1846 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
1847 },
1848 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
1849 },
1850 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
1851 &quot;engineSource&quot;: { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
1852 &quot;dataStoreSources&quot;: [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
1853 { # Configuration for searching within a specific DataStore.
1854 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
1855 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
1856 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
1857 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
1858 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
1859 },
1860 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
1861 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
1862 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
1863 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
1864 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
1865 },
1866 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
1867 },
1868 ],
1869 &quot;engine&quot;: &quot;A String&quot;, # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
1870 &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter applied to the search across the Engine. Not relevant and not used if &#x27;data_store_sources&#x27; is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
1871 },
1872 &quot;filterParameterBehavior&quot;: &quot;A String&quot;, # Optional. The filter parameter behavior.
1873 &quot;modalityConfigs&quot;: [ # Optional. The modality configs for the data store.
1874 { # If specified, will apply the given configuration for the specified modality.
1875 &quot;groundingConfig&quot;: { # Grounding configuration. # Optional. The grounding configuration.
1876 &quot;disabled&quot;: True or False, # Optional. Whether grounding is disabled.
1877 &quot;groundingLevel&quot;: 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
1878 },
1879 &quot;modalityType&quot;: &quot;A String&quot;, # Required. The modality type.
1880 &quot;rewriterConfig&quot;: { # Rewriter configuration. # Optional. The rewriter config.
1881 &quot;disabled&quot;: True or False, # Optional. Whether the rewriter is disabled.
1882 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
1883 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
1884 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
1885 },
1886 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
1887 },
1888 &quot;summarizationConfig&quot;: { # Summarization configuration. # Optional. The summarization config.
1889 &quot;disabled&quot;: True or False, # Optional. Whether summarization is disabled.
1890 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
1891 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
1892 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
1893 },
1894 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
1895 },
1896 },
1897 ],
1898 &quot;name&quot;: &quot;A String&quot;, # Required. The data store tool name.
1899 },
1900 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool, derived based on the tool&#x27;s type. For example, display name of a ClientFunction is derived from its `name` property.
1901 &quot;etag&quot;: &quot;A String&quot;, # Etag used to ensure the object hasn&#x27;t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
1902 &quot;executionType&quot;: &quot;A String&quot;, # Optional. The execution type of the tool.
1903 &quot;fileSearchTool&quot;: { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
1904 &quot;corpusType&quot;: &quot;A String&quot;, # Optional. The type of the corpus. Default is FULLY_MANAGED.
1905 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
1906 &quot;fileCorpus&quot;: &quot;A String&quot;, # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
1907 &quot;name&quot;: &quot;A String&quot;, # Required. The tool name.
1908 },
1909 &quot;generatedSummary&quot;: &quot;A String&quot;, # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
1910 &quot;googleSearchTool&quot;: { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
1911 &quot;contextUrls&quot;: [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: &quot;https://example.com/path.html&quot;. A maximum of 20 URLs are allowed.
1912 &quot;A String&quot;,
1913 ],
1914 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
1915 &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. Example: &quot;example.com&quot;. A maximum of 2000 domains can be excluded.
1916 &quot;A String&quot;,
1917 ],
1918 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
1919 &quot;preferredDomains&quot;: [ # Optional. Specifies domains to restrict search results to. Example: &quot;example.com&quot;, &quot;another.site&quot;. A maximum of 20 domains can be specified.
1920 &quot;A String&quot;,
1921 ],
1922 &quot;promptConfig&quot;: { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
1923 &quot;textPrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
1924 &quot;voicePrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
1925 },
1926 },
1927 &quot;mcpTool&quot;: { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
1928 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
1929 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
1930 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
1931 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
1932 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
1933 },
1934 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
1935 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
1936 },
1937 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
1938 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
1939 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
1940 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
1941 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
1942 &quot;A String&quot;,
1943 ],
1944 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
1945 },
1946 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
1947 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
1948 &quot;A String&quot;,
1949 ],
1950 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
1951 },
1952 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
1953 },
1954 },
1955 &quot;customHeaders&quot;: { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
1956 &quot;a_key&quot;: &quot;A String&quot;,
1957 },
1958 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the MCP tool.
1959 &quot;inputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
1960 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1961 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1962 # Object with schema name: Schema
1963 ],
1964 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
1965 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
1966 &quot;a_key&quot;: # Object with schema name: Schema
1967 },
1968 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
1969 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
1970 &quot;A String&quot;,
1971 ],
1972 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
1973 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
1974 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
1975 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
1976 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
1977 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
1978 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
1979 # Object with schema name: Schema
1980 ],
1981 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
1982 &quot;a_key&quot;: # Object with schema name: Schema
1983 },
1984 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
1985 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
1986 &quot;A String&quot;,
1987 ],
1988 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
1989 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
1990 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
1991 },
1992 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the MCP tool.
1993 &quot;nameOverride&quot;: &quot;A String&quot;, # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
1994 &quot;outputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
1995 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
1996 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
1997 # Object with schema name: Schema
1998 ],
1999 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2000 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2001 &quot;a_key&quot;: # Object with schema name: Schema
2002 },
2003 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2004 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2005 &quot;A String&quot;,
2006 ],
2007 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2008 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2009 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2010 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2011 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2012 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2013 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2014 # Object with schema name: Schema
2015 ],
2016 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2017 &quot;a_key&quot;: # Object with schema name: Schema
2018 },
2019 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2020 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2021 &quot;A String&quot;,
2022 ],
2023 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2024 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2025 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2026 },
2027 &quot;serverAddress&quot;: &quot;A String&quot;, # Required. The server address of the MCP server, e.g., &quot;https://example.com/mcp/&quot;. If the server is built with the MCP SDK, the url should be suffixed with &quot;/mcp/&quot;. Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
2028 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
2029 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2030 },
2031 &quot;state&quot;: &quot;A String&quot;, # Output only. The dynamic availability state of the tool on the external server.
2032 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
2033 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
2034 { # The CA certificate.
2035 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
2036 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
2037 },
2038 ],
2039 },
2040 },
2041 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
2042 &quot;openApiTool&quot;: { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
2043 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required by the API.
2044 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
2045 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2046 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
2047 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
2048 },
2049 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
2050 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
2051 },
2052 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
2053 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
2054 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2055 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
2056 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
2057 &quot;A String&quot;,
2058 ],
2059 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
2060 },
2061 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
2062 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
2063 &quot;A String&quot;,
2064 ],
2065 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
2066 },
2067 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
2068 },
2069 },
2070 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
2071 &quot;ignoreUnknownFields&quot;: True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
2072 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
2073 &quot;openApiSchema&quot;: &quot;A String&quot;, # Required. The OpenAPI schema in JSON or YAML format.
2074 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
2075 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2076 },
2077 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
2078 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
2079 { # The CA certificate.
2080 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
2081 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
2082 },
2083 ],
2084 },
2085 &quot;url&quot;: &quot;A String&quot;, # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
2086 },
2087 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. The python function tool.
2088 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
2089 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
2090 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
2091 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
2092 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2093 },
2094 },
2095 &quot;remoteAgentTool&quot;: { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
2096 &quot;agentCard&quot;: { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
2097 &quot;description&quot;: &quot;A String&quot;, # Required. A description of the agent&#x27;s domain of action/solution space.
2098 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the agent.
2099 &quot;skills&quot;: [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
2100 { # Represents a distinct capability or function that an agent can perform.
2101 &quot;description&quot;: &quot;A String&quot;, # Required. A detailed description of the skill.
2102 &quot;examples&quot;: [ # Example prompts or scenarios that this skill can handle.
2103 &quot;A String&quot;,
2104 ],
2105 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for the agent&#x27;s skill.
2106 &quot;inputModes&quot;: [ # The set of supported input media types for this skill, overriding the agent&#x27;s defaults.
2107 &quot;A String&quot;,
2108 ],
2109 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the skill.
2110 &quot;outputModes&quot;: [ # The set of supported output media types for this skill, overriding the agent&#x27;s defaults.
2111 &quot;A String&quot;,
2112 ],
2113 &quot;tags&quot;: [ # Required. A set of keywords describing the skill&#x27;s capabilities.
2114 &quot;A String&quot;,
2115 ],
2116 },
2117 ],
2118 &quot;supportedInterfaces&quot;: [ # Required. Ordered list of supported interfaces. The first entry is preferred.
2119 { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
2120 &quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
2121 &quot;protocolVersion&quot;: &quot;A String&quot;, # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: &quot;0.3&quot;, &quot;1.0&quot;
2122 &quot;tenant&quot;: &quot;A String&quot;, # Tenant ID to be used in the request when calling the agent.
2123 &quot;url&quot;: &quot;A String&quot;, # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: &quot;https://api.example.com/a2a/v1&quot;, &quot;https://grpc.example.com/a2a&quot;
2124 },
2125 ],
2126 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the agent.
2127 },
2128 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the tool.
2129 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
2130 },
2131 &quot;systemTool&quot;: { # Pre-defined system tool. # Optional. The system tool.
2132 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the system tool.
2133 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the system tool.
2134 },
2135 &quot;timeout&quot;: &quot;A String&quot;, # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
2136 &quot;toolFakeConfig&quot;: { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
2137 &quot;codeBlock&quot;: { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
2138 &quot;pythonCode&quot;: &quot;A String&quot;, # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
2139 },
2140 &quot;enableFakeMode&quot;: True or False, # Optional. Whether the tool is using fake mode.
2141 },
2142 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was last updated.
2143 &quot;widgetTool&quot;: { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
2144 &quot;dataMapping&quot;: { # Configuration for mapping data from a source tool to the widget&#x27;s input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget&#x27;s input parameters.
2145 &quot;fieldMappings&quot;: { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
2146 &quot;a_key&quot;: &quot;A String&quot;,
2147 },
2148 &quot;mode&quot;: &quot;A String&quot;, # Optional. The mode of the data mapping.
2149 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool&#x27;s output into the widget&#x27;s input format.
2150 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
2151 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
2152 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
2153 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
2154 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2155 },
2156 },
2157 &quot;pythonScript&quot;: &quot;A String&quot;, # Deprecated: Use `python_function` instead.
2158 &quot;sourceToolName&quot;: &quot;A String&quot;, # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
2159 },
2160 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the widget tool.
2161 &quot;name&quot;: &quot;A String&quot;, # Required. The display name of the widget tool.
2162 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
2163 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2164 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2165 # Object with schema name: Schema
2166 ],
2167 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2168 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2169 &quot;a_key&quot;: # Object with schema name: Schema
2170 },
2171 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2172 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2173 &quot;A String&quot;,
2174 ],
2175 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2176 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2177 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2178 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2179 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2180 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2181 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2182 # Object with schema name: Schema
2183 ],
2184 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2185 &quot;a_key&quot;: # Object with schema name: Schema
2186 },
2187 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2188 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2189 &quot;A String&quot;,
2190 ],
2191 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2192 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2193 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2194 },
2195 &quot;textResponseConfig&quot;: { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
2196 &quot;staticText&quot;: &quot;A String&quot;, # Optional. The static text response to return when type is STATIC.
2197 &quot;textResponseInstruction&quot;: &quot;A String&quot;, # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
2198 &quot;type&quot;: &quot;A String&quot;, # Optional. The strategy for providing the text response.
2199 },
2200 &quot;uiConfig&quot;: { # Optional. Configuration for rendering the widget.
2201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
2202 },
2203 &quot;widgetType&quot;: &quot;A String&quot;, # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
2204 },
2205 },
2206 ],
2207 }</pre>
2208 </div>
2209
2210 <div class="method">
2211 <code class="details" id="list_next">list_next()</code>
2212 <pre>Retrieves the next page of results.
2213
2214 Args:
2215 previous_request: The request for the previous page. (required)
2216 previous_response: The response from the request for the previous page. (required)
2217
2218 Returns:
2219 A request object that you can call &#x27;execute()&#x27; on to request the next
2220 page. Returns None if there are no more items in the collection.
2221 </pre>
2222 </div>
2223
2224 <div class="method">
2225 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
2226 <pre>Updates the specified tool.
2227
2228 Args:
2229 name: string, Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. (required)
2230 body: object, The request body.
2231 The object takes the form of:
2232
2233 { # A tool represents an action that the CES agent can take to achieve certain goals.
2234 &quot;agentTool&quot;: { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
2235 &quot;agent&quot;: &quot;A String&quot;, # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
2236 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
2237 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the agent tool.
2238 &quot;rootAgent&quot;: &quot;A String&quot;, # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
2239 },
2240 &quot;clientFunction&quot;: { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
2241 &quot;description&quot;: &quot;A String&quot;, # Optional. The function description.
2242 &quot;name&quot;: &quot;A String&quot;, # Required. The function name.
2243 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
2244 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2245 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2246 # Object with schema name: Schema
2247 ],
2248 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2249 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2250 &quot;a_key&quot;: # Object with schema name: Schema
2251 },
2252 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2253 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2254 &quot;A String&quot;,
2255 ],
2256 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2257 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2258 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2259 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2260 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2261 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2262 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2263 # Object with schema name: Schema
2264 ],
2265 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2266 &quot;a_key&quot;: # Object with schema name: Schema
2267 },
2268 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2269 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2270 &quot;A String&quot;,
2271 ],
2272 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2273 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2274 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2275 },
2276 &quot;response&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
2277 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2278 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2279 # Object with schema name: Schema
2280 ],
2281 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2282 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2283 &quot;a_key&quot;: # Object with schema name: Schema
2284 },
2285 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2286 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2287 &quot;A String&quot;,
2288 ],
2289 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2290 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2291 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2292 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2293 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2294 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2295 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2296 # Object with schema name: Schema
2297 ],
2298 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2299 &quot;a_key&quot;: # Object with schema name: Schema
2300 },
2301 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2302 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2303 &quot;A String&quot;,
2304 ],
2305 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2306 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2307 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2308 },
2309 },
2310 &quot;connectorTool&quot;: { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
2311 &quot;action&quot;: { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
2312 &quot;connectionActionId&quot;: &quot;A String&quot;, # ID of a Connection action for the tool to use.
2313 &quot;entityOperation&quot;: { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
2314 &quot;entityId&quot;: &quot;A String&quot;, # Required. ID of the entity.
2315 &quot;operation&quot;: &quot;A String&quot;, # Required. Operation to perform on the entity.
2316 },
2317 &quot;inputFields&quot;: [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
2318 &quot;A String&quot;,
2319 ],
2320 &quot;outputFields&quot;: [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
2321 &quot;A String&quot;,
2322 ],
2323 },
2324 &quot;authConfig&quot;: { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
2325 &quot;oauth2AuthCodeConfig&quot;: { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
2326 &quot;oauthToken&quot;: &quot;A String&quot;, # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
2327 },
2328 &quot;oauth2JwtBearerConfig&quot;: { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
2329 &quot;clientKey&quot;: &quot;A String&quot;, # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
2330 &quot;issuer&quot;: &quot;A String&quot;, # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
2331 &quot;subject&quot;: &quot;A String&quot;, # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
2332 },
2333 },
2334 &quot;connection&quot;: &quot;A String&quot;, # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
2335 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
2336 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
2337 },
2338 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was created.
2339 &quot;dataStoreTool&quot;: { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
2340 &quot;boostSpecs&quot;: [ # Optional. Boost specification to boost certain documents.
2341 { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
2342 &quot;dataStores&quot;: [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
2343 &quot;A String&quot;,
2344 ],
2345 &quot;spec&quot;: [ # Required. A list of boosting specifications.
2346 { # Boost specification to boost certain documents.
2347 &quot;conditionBoostSpecs&quot;: [ # Required. A list of boosting specifications.
2348 { # Boost specification for a condition.
2349 &quot;boost&quot;: 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
2350 &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
2351 &quot;attributeType&quot;: &quot;A String&quot;, # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
2352 &quot;controlPoints&quot;: [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
2353 { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
2354 &quot;attributeValue&quot;: &quot;A String&quot;, # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
2355 &quot;boostAmount&quot;: 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
2356 },
2357 ],
2358 &quot;fieldName&quot;: &quot;A String&quot;, # Optional. The name of the field whose value will be used to determine the boost amount.
2359 &quot;interpolationType&quot;: &quot;A String&quot;, # Optional. The interpolation type to be applied to connect the control points listed below.
2360 },
2361 &quot;condition&quot;: &quot;A String&quot;, # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(&quot;en&quot;, &quot;fr&quot;))
2362 },
2363 ],
2364 },
2365 ],
2366 },
2367 ],
2368 &quot;dataStoreSource&quot;: { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
2369 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
2370 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
2371 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
2372 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
2373 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
2374 },
2375 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
2376 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
2377 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
2378 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
2379 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
2380 },
2381 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
2382 },
2383 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
2384 &quot;engineSource&quot;: { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
2385 &quot;dataStoreSources&quot;: [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
2386 { # Configuration for searching within a specific DataStore.
2387 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
2388 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
2389 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
2390 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
2391 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
2392 },
2393 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
2394 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
2395 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
2396 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
2397 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
2398 },
2399 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
2400 },
2401 ],
2402 &quot;engine&quot;: &quot;A String&quot;, # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
2403 &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter applied to the search across the Engine. Not relevant and not used if &#x27;data_store_sources&#x27; is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
2404 },
2405 &quot;filterParameterBehavior&quot;: &quot;A String&quot;, # Optional. The filter parameter behavior.
2406 &quot;modalityConfigs&quot;: [ # Optional. The modality configs for the data store.
2407 { # If specified, will apply the given configuration for the specified modality.
2408 &quot;groundingConfig&quot;: { # Grounding configuration. # Optional. The grounding configuration.
2409 &quot;disabled&quot;: True or False, # Optional. Whether grounding is disabled.
2410 &quot;groundingLevel&quot;: 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
2411 },
2412 &quot;modalityType&quot;: &quot;A String&quot;, # Required. The modality type.
2413 &quot;rewriterConfig&quot;: { # Rewriter configuration. # Optional. The rewriter config.
2414 &quot;disabled&quot;: True or False, # Optional. Whether the rewriter is disabled.
2415 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
2416 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
2417 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
2418 },
2419 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
2420 },
2421 &quot;summarizationConfig&quot;: { # Summarization configuration. # Optional. The summarization config.
2422 &quot;disabled&quot;: True or False, # Optional. Whether summarization is disabled.
2423 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
2424 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
2425 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
2426 },
2427 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
2428 },
2429 },
2430 ],
2431 &quot;name&quot;: &quot;A String&quot;, # Required. The data store tool name.
2432 },
2433 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool, derived based on the tool&#x27;s type. For example, display name of a ClientFunction is derived from its `name` property.
2434 &quot;etag&quot;: &quot;A String&quot;, # Etag used to ensure the object hasn&#x27;t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
2435 &quot;executionType&quot;: &quot;A String&quot;, # Optional. The execution type of the tool.
2436 &quot;fileSearchTool&quot;: { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
2437 &quot;corpusType&quot;: &quot;A String&quot;, # Optional. The type of the corpus. Default is FULLY_MANAGED.
2438 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
2439 &quot;fileCorpus&quot;: &quot;A String&quot;, # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
2440 &quot;name&quot;: &quot;A String&quot;, # Required. The tool name.
2441 },
2442 &quot;generatedSummary&quot;: &quot;A String&quot;, # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
2443 &quot;googleSearchTool&quot;: { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
2444 &quot;contextUrls&quot;: [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: &quot;https://example.com/path.html&quot;. A maximum of 20 URLs are allowed.
2445 &quot;A String&quot;,
2446 ],
2447 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
2448 &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. Example: &quot;example.com&quot;. A maximum of 2000 domains can be excluded.
2449 &quot;A String&quot;,
2450 ],
2451 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
2452 &quot;preferredDomains&quot;: [ # Optional. Specifies domains to restrict search results to. Example: &quot;example.com&quot;, &quot;another.site&quot;. A maximum of 20 domains can be specified.
2453 &quot;A String&quot;,
2454 ],
2455 &quot;promptConfig&quot;: { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
2456 &quot;textPrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
2457 &quot;voicePrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
2458 },
2459 },
2460 &quot;mcpTool&quot;: { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
2461 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
2462 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
2463 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2464 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
2465 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
2466 },
2467 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
2468 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
2469 },
2470 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
2471 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
2472 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2473 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
2474 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
2475 &quot;A String&quot;,
2476 ],
2477 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
2478 },
2479 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
2480 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
2481 &quot;A String&quot;,
2482 ],
2483 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
2484 },
2485 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
2486 },
2487 },
2488 &quot;customHeaders&quot;: { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
2489 &quot;a_key&quot;: &quot;A String&quot;,
2490 },
2491 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the MCP tool.
2492 &quot;inputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
2493 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2494 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2495 # Object with schema name: Schema
2496 ],
2497 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2498 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2499 &quot;a_key&quot;: # Object with schema name: Schema
2500 },
2501 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2502 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2503 &quot;A String&quot;,
2504 ],
2505 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2506 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2507 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2508 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2509 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2510 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2511 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2512 # Object with schema name: Schema
2513 ],
2514 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2515 &quot;a_key&quot;: # Object with schema name: Schema
2516 },
2517 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2518 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2519 &quot;A String&quot;,
2520 ],
2521 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2522 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2523 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2524 },
2525 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the MCP tool.
2526 &quot;nameOverride&quot;: &quot;A String&quot;, # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
2527 &quot;outputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
2528 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2529 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2530 # Object with schema name: Schema
2531 ],
2532 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2533 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2534 &quot;a_key&quot;: # Object with schema name: Schema
2535 },
2536 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2537 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2538 &quot;A String&quot;,
2539 ],
2540 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2541 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2542 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2543 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2544 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2545 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2546 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2547 # Object with schema name: Schema
2548 ],
2549 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2550 &quot;a_key&quot;: # Object with schema name: Schema
2551 },
2552 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2553 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2554 &quot;A String&quot;,
2555 ],
2556 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2557 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2558 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2559 },
2560 &quot;serverAddress&quot;: &quot;A String&quot;, # Required. The server address of the MCP server, e.g., &quot;https://example.com/mcp/&quot;. If the server is built with the MCP SDK, the url should be suffixed with &quot;/mcp/&quot;. Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
2561 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
2562 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2563 },
2564 &quot;state&quot;: &quot;A String&quot;, # Output only. The dynamic availability state of the tool on the external server.
2565 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
2566 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
2567 { # The CA certificate.
2568 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
2569 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
2570 },
2571 ],
2572 },
2573 },
2574 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
2575 &quot;openApiTool&quot;: { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
2576 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required by the API.
2577 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
2578 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2579 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
2580 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
2581 },
2582 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
2583 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
2584 },
2585 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
2586 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
2587 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2588 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
2589 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
2590 &quot;A String&quot;,
2591 ],
2592 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
2593 },
2594 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
2595 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
2596 &quot;A String&quot;,
2597 ],
2598 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
2599 },
2600 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
2601 },
2602 },
2603 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
2604 &quot;ignoreUnknownFields&quot;: True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
2605 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
2606 &quot;openApiSchema&quot;: &quot;A String&quot;, # Required. The OpenAPI schema in JSON or YAML format.
2607 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
2608 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2609 },
2610 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
2611 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
2612 { # The CA certificate.
2613 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
2614 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
2615 },
2616 ],
2617 },
2618 &quot;url&quot;: &quot;A String&quot;, # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
2619 },
2620 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. The python function tool.
2621 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
2622 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
2623 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
2624 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
2625 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2626 },
2627 },
2628 &quot;remoteAgentTool&quot;: { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
2629 &quot;agentCard&quot;: { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
2630 &quot;description&quot;: &quot;A String&quot;, # Required. A description of the agent&#x27;s domain of action/solution space.
2631 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the agent.
2632 &quot;skills&quot;: [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
2633 { # Represents a distinct capability or function that an agent can perform.
2634 &quot;description&quot;: &quot;A String&quot;, # Required. A detailed description of the skill.
2635 &quot;examples&quot;: [ # Example prompts or scenarios that this skill can handle.
2636 &quot;A String&quot;,
2637 ],
2638 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for the agent&#x27;s skill.
2639 &quot;inputModes&quot;: [ # The set of supported input media types for this skill, overriding the agent&#x27;s defaults.
2640 &quot;A String&quot;,
2641 ],
2642 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the skill.
2643 &quot;outputModes&quot;: [ # The set of supported output media types for this skill, overriding the agent&#x27;s defaults.
2644 &quot;A String&quot;,
2645 ],
2646 &quot;tags&quot;: [ # Required. A set of keywords describing the skill&#x27;s capabilities.
2647 &quot;A String&quot;,
2648 ],
2649 },
2650 ],
2651 &quot;supportedInterfaces&quot;: [ # Required. Ordered list of supported interfaces. The first entry is preferred.
2652 { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
2653 &quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
2654 &quot;protocolVersion&quot;: &quot;A String&quot;, # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: &quot;0.3&quot;, &quot;1.0&quot;
2655 &quot;tenant&quot;: &quot;A String&quot;, # Tenant ID to be used in the request when calling the agent.
2656 &quot;url&quot;: &quot;A String&quot;, # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: &quot;https://api.example.com/a2a/v1&quot;, &quot;https://grpc.example.com/a2a&quot;
2657 },
2658 ],
2659 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the agent.
2660 },
2661 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the tool.
2662 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
2663 },
2664 &quot;systemTool&quot;: { # Pre-defined system tool. # Optional. The system tool.
2665 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the system tool.
2666 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the system tool.
2667 },
2668 &quot;timeout&quot;: &quot;A String&quot;, # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
2669 &quot;toolFakeConfig&quot;: { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
2670 &quot;codeBlock&quot;: { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
2671 &quot;pythonCode&quot;: &quot;A String&quot;, # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
2672 },
2673 &quot;enableFakeMode&quot;: True or False, # Optional. Whether the tool is using fake mode.
2674 },
2675 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was last updated.
2676 &quot;widgetTool&quot;: { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
2677 &quot;dataMapping&quot;: { # Configuration for mapping data from a source tool to the widget&#x27;s input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget&#x27;s input parameters.
2678 &quot;fieldMappings&quot;: { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
2679 &quot;a_key&quot;: &quot;A String&quot;,
2680 },
2681 &quot;mode&quot;: &quot;A String&quot;, # Optional. The mode of the data mapping.
2682 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool&#x27;s output into the widget&#x27;s input format.
2683 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
2684 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
2685 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
2686 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
2687 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
2688 },
2689 },
2690 &quot;pythonScript&quot;: &quot;A String&quot;, # Deprecated: Use `python_function` instead.
2691 &quot;sourceToolName&quot;: &quot;A String&quot;, # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
2692 },
2693 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the widget tool.
2694 &quot;name&quot;: &quot;A String&quot;, # Required. The display name of the widget tool.
2695 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
2696 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2697 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2698 # Object with schema name: Schema
2699 ],
2700 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2701 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2702 &quot;a_key&quot;: # Object with schema name: Schema
2703 },
2704 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2705 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2706 &quot;A String&quot;,
2707 ],
2708 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2709 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2710 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2711 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2712 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2713 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2714 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2715 # Object with schema name: Schema
2716 ],
2717 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2718 &quot;a_key&quot;: # Object with schema name: Schema
2719 },
2720 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2721 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2722 &quot;A String&quot;,
2723 ],
2724 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2725 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2726 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2727 },
2728 &quot;textResponseConfig&quot;: { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
2729 &quot;staticText&quot;: &quot;A String&quot;, # Optional. The static text response to return when type is STATIC.
2730 &quot;textResponseInstruction&quot;: &quot;A String&quot;, # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
2731 &quot;type&quot;: &quot;A String&quot;, # Optional. The strategy for providing the text response.
2732 },
2733 &quot;uiConfig&quot;: { # Optional. Configuration for rendering the widget.
2734 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
2735 },
2736 &quot;widgetType&quot;: &quot;A String&quot;, # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
2737 },
2738 }
2739
2740 updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
2741 x__xgafv: string, V1 error format.
2742 Allowed values
2743 1 - v1 error format
2744 2 - v2 error format
2745
2746 Returns:
2747 An object of the form:
2748
2749 { # A tool represents an action that the CES agent can take to achieve certain goals.
2750 &quot;agentTool&quot;: { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
2751 &quot;agent&quot;: &quot;A String&quot;, # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
2752 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
2753 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the agent tool.
2754 &quot;rootAgent&quot;: &quot;A String&quot;, # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
2755 },
2756 &quot;clientFunction&quot;: { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
2757 &quot;description&quot;: &quot;A String&quot;, # Optional. The function description.
2758 &quot;name&quot;: &quot;A String&quot;, # Required. The function name.
2759 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
2760 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2761 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2762 # Object with schema name: Schema
2763 ],
2764 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2765 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2766 &quot;a_key&quot;: # Object with schema name: Schema
2767 },
2768 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2769 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2770 &quot;A String&quot;,
2771 ],
2772 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2773 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2774 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2775 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2776 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2777 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2778 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2779 # Object with schema name: Schema
2780 ],
2781 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2782 &quot;a_key&quot;: # Object with schema name: Schema
2783 },
2784 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2785 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2786 &quot;A String&quot;,
2787 ],
2788 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2789 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2790 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2791 },
2792 &quot;response&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
2793 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
2794 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
2795 # Object with schema name: Schema
2796 ],
2797 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
2798 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
2799 &quot;a_key&quot;: # Object with schema name: Schema
2800 },
2801 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
2802 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
2803 &quot;A String&quot;,
2804 ],
2805 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
2806 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
2807 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
2808 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
2809 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
2810 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
2811 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
2812 # Object with schema name: Schema
2813 ],
2814 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
2815 &quot;a_key&quot;: # Object with schema name: Schema
2816 },
2817 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
2818 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
2819 &quot;A String&quot;,
2820 ],
2821 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
2822 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
2823 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
2824 },
2825 },
2826 &quot;connectorTool&quot;: { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
2827 &quot;action&quot;: { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
2828 &quot;connectionActionId&quot;: &quot;A String&quot;, # ID of a Connection action for the tool to use.
2829 &quot;entityOperation&quot;: { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
2830 &quot;entityId&quot;: &quot;A String&quot;, # Required. ID of the entity.
2831 &quot;operation&quot;: &quot;A String&quot;, # Required. Operation to perform on the entity.
2832 },
2833 &quot;inputFields&quot;: [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
2834 &quot;A String&quot;,
2835 ],
2836 &quot;outputFields&quot;: [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
2837 &quot;A String&quot;,
2838 ],
2839 },
2840 &quot;authConfig&quot;: { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
2841 &quot;oauth2AuthCodeConfig&quot;: { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
2842 &quot;oauthToken&quot;: &quot;A String&quot;, # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
2843 },
2844 &quot;oauth2JwtBearerConfig&quot;: { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
2845 &quot;clientKey&quot;: &quot;A String&quot;, # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
2846 &quot;issuer&quot;: &quot;A String&quot;, # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
2847 &quot;subject&quot;: &quot;A String&quot;, # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
2848 },
2849 },
2850 &quot;connection&quot;: &quot;A String&quot;, # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
2851 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
2852 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
2853 },
2854 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was created.
2855 &quot;dataStoreTool&quot;: { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
2856 &quot;boostSpecs&quot;: [ # Optional. Boost specification to boost certain documents.
2857 { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
2858 &quot;dataStores&quot;: [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
2859 &quot;A String&quot;,
2860 ],
2861 &quot;spec&quot;: [ # Required. A list of boosting specifications.
2862 { # Boost specification to boost certain documents.
2863 &quot;conditionBoostSpecs&quot;: [ # Required. A list of boosting specifications.
2864 { # Boost specification for a condition.
2865 &quot;boost&quot;: 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
2866 &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
2867 &quot;attributeType&quot;: &quot;A String&quot;, # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
2868 &quot;controlPoints&quot;: [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
2869 { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
2870 &quot;attributeValue&quot;: &quot;A String&quot;, # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
2871 &quot;boostAmount&quot;: 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
2872 },
2873 ],
2874 &quot;fieldName&quot;: &quot;A String&quot;, # Optional. The name of the field whose value will be used to determine the boost amount.
2875 &quot;interpolationType&quot;: &quot;A String&quot;, # Optional. The interpolation type to be applied to connect the control points listed below.
2876 },
2877 &quot;condition&quot;: &quot;A String&quot;, # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY(&quot;en&quot;, &quot;fr&quot;))
2878 },
2879 ],
2880 },
2881 ],
2882 },
2883 ],
2884 &quot;dataStoreSource&quot;: { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
2885 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
2886 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
2887 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
2888 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
2889 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
2890 },
2891 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
2892 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
2893 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
2894 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
2895 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
2896 },
2897 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
2898 },
2899 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
2900 &quot;engineSource&quot;: { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
2901 &quot;dataStoreSources&quot;: [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
2902 { # Configuration for searching within a specific DataStore.
2903 &quot;dataStore&quot;: { # A DataStore resource in Vertex AI Search. # Optional. The data store.
2904 &quot;connectorConfig&quot;: { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
2905 &quot;collection&quot;: &quot;A String&quot;, # Resource name of the collection the data store belongs to.
2906 &quot;collectionDisplayName&quot;: &quot;A String&quot;, # Display name of the collection the data store belongs to.
2907 &quot;dataSource&quot;: &quot;A String&quot;, # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
2908 },
2909 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the data store was created.
2910 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the data store.
2911 &quot;documentProcessingMode&quot;: &quot;A String&quot;, # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
2912 &quot;name&quot;: &quot;A String&quot;, # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
2913 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the data store. This field is readonly and populated by the server.
2914 },
2915 &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
2916 },
2917 ],
2918 &quot;engine&quot;: &quot;A String&quot;, # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
2919 &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter applied to the search across the Engine. Not relevant and not used if &#x27;data_store_sources&#x27; is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
2920 },
2921 &quot;filterParameterBehavior&quot;: &quot;A String&quot;, # Optional. The filter parameter behavior.
2922 &quot;modalityConfigs&quot;: [ # Optional. The modality configs for the data store.
2923 { # If specified, will apply the given configuration for the specified modality.
2924 &quot;groundingConfig&quot;: { # Grounding configuration. # Optional. The grounding configuration.
2925 &quot;disabled&quot;: True or False, # Optional. Whether grounding is disabled.
2926 &quot;groundingLevel&quot;: 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
2927 },
2928 &quot;modalityType&quot;: &quot;A String&quot;, # Required. The modality type.
2929 &quot;rewriterConfig&quot;: { # Rewriter configuration. # Optional. The rewriter config.
2930 &quot;disabled&quot;: True or False, # Optional. Whether the rewriter is disabled.
2931 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
2932 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
2933 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
2934 },
2935 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
2936 },
2937 &quot;summarizationConfig&quot;: { # Summarization configuration. # Optional. The summarization config.
2938 &quot;disabled&quot;: True or False, # Optional. Whether summarization is disabled.
2939 &quot;modelSettings&quot;: { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
2940 &quot;model&quot;: &quot;A String&quot;, # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
2941 &quot;temperature&quot;: 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model&#x27;s responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
2942 },
2943 &quot;prompt&quot;: &quot;A String&quot;, # Optional. The prompt definition. If not set, default prompt will be used.
2944 },
2945 },
2946 ],
2947 &quot;name&quot;: &quot;A String&quot;, # Required. The data store tool name.
2948 },
2949 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool, derived based on the tool&#x27;s type. For example, display name of a ClientFunction is derived from its `name` property.
2950 &quot;etag&quot;: &quot;A String&quot;, # Etag used to ensure the object hasn&#x27;t changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
2951 &quot;executionType&quot;: &quot;A String&quot;, # Optional. The execution type of the tool.
2952 &quot;fileSearchTool&quot;: { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
2953 &quot;corpusType&quot;: &quot;A String&quot;, # Optional. The type of the corpus. Default is FULLY_MANAGED.
2954 &quot;description&quot;: &quot;A String&quot;, # Optional. The tool description.
2955 &quot;fileCorpus&quot;: &quot;A String&quot;, # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
2956 &quot;name&quot;: &quot;A String&quot;, # Required. The tool name.
2957 },
2958 &quot;generatedSummary&quot;: &quot;A String&quot;, # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
2959 &quot;googleSearchTool&quot;: { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
2960 &quot;contextUrls&quot;: [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: &quot;https://example.com/path.html&quot;. A maximum of 20 URLs are allowed.
2961 &quot;A String&quot;,
2962 ],
2963 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the tool&#x27;s purpose.
2964 &quot;excludeDomains&quot;: [ # Optional. List of domains to be excluded from the search results. Example: &quot;example.com&quot;. A maximum of 2000 domains can be excluded.
2965 &quot;A String&quot;,
2966 ],
2967 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
2968 &quot;preferredDomains&quot;: [ # Optional. Specifies domains to restrict search results to. Example: &quot;example.com&quot;, &quot;another.site&quot;. A maximum of 20 domains can be specified.
2969 &quot;A String&quot;,
2970 ],
2971 &quot;promptConfig&quot;: { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
2972 &quot;textPrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
2973 &quot;voicePrompt&quot;: &quot;A String&quot;, # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
2974 },
2975 },
2976 &quot;mcpTool&quot;: { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
2977 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
2978 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
2979 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2980 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
2981 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
2982 },
2983 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
2984 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
2985 },
2986 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
2987 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
2988 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
2989 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
2990 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
2991 &quot;A String&quot;,
2992 ],
2993 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
2994 },
2995 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
2996 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
2997 &quot;A String&quot;,
2998 ],
2999 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
3000 },
3001 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
3002 },
3003 },
3004 &quot;customHeaders&quot;: { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
3005 &quot;a_key&quot;: &quot;A String&quot;,
3006 },
3007 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the MCP tool.
3008 &quot;inputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
3009 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
3010 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
3011 # Object with schema name: Schema
3012 ],
3013 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
3014 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
3015 &quot;a_key&quot;: # Object with schema name: Schema
3016 },
3017 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
3018 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
3019 &quot;A String&quot;,
3020 ],
3021 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
3022 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
3023 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
3024 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
3025 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
3026 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
3027 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
3028 # Object with schema name: Schema
3029 ],
3030 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
3031 &quot;a_key&quot;: # Object with schema name: Schema
3032 },
3033 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
3034 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
3035 &quot;A String&quot;,
3036 ],
3037 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
3038 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
3039 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
3040 },
3041 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the MCP tool.
3042 &quot;nameOverride&quot;: &quot;A String&quot;, # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
3043 &quot;outputSchema&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
3044 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
3045 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
3046 # Object with schema name: Schema
3047 ],
3048 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
3049 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
3050 &quot;a_key&quot;: # Object with schema name: Schema
3051 },
3052 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
3053 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
3054 &quot;A String&quot;,
3055 ],
3056 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
3057 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
3058 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
3059 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
3060 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
3061 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
3062 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
3063 # Object with schema name: Schema
3064 ],
3065 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
3066 &quot;a_key&quot;: # Object with schema name: Schema
3067 },
3068 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
3069 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
3070 &quot;A String&quot;,
3071 ],
3072 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
3073 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
3074 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
3075 },
3076 &quot;serverAddress&quot;: &quot;A String&quot;, # Required. The server address of the MCP server, e.g., &quot;https://example.com/mcp/&quot;. If the server is built with the MCP SDK, the url should be suffixed with &quot;/mcp/&quot;. Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
3077 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
3078 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
3079 },
3080 &quot;state&quot;: &quot;A String&quot;, # Output only. The dynamic availability state of the tool on the external server.
3081 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
3082 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
3083 { # The CA certificate.
3084 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
3085 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
3086 },
3087 ],
3088 },
3089 },
3090 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
3091 &quot;openApiTool&quot;: { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
3092 &quot;apiAuthentication&quot;: { # Authentication information required for API calls. # Optional. Authentication information required by the API.
3093 &quot;apiKeyConfig&quot;: { # Configurations for authentication with API key. # Optional. Config for API key auth.
3094 &quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
3095 &quot;keyName&quot;: &quot;A String&quot;, # Required. The parameter name or the header name of the API key. E.g., If the API request is &quot;https://example.com/act?X-Api-Key=&quot;, &quot;X-Api-Key&quot; would be the parameter name.
3096 &quot;requestLocation&quot;: &quot;A String&quot;, # Required. Key location in the request.
3097 },
3098 &quot;bearerTokenConfig&quot;: { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
3099 &quot;token&quot;: &quot;A String&quot;, # Required. The bearer token. Must be in the format `$context.variables.`.
3100 },
3101 &quot;oauthConfig&quot;: { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
3102 &quot;clientId&quot;: &quot;A String&quot;, # Required. The client ID from the OAuth provider.
3103 &quot;clientSecretVersion&quot;: &quot;A String&quot;, # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `[email protected]`.
3104 &quot;oauthGrantType&quot;: &quot;A String&quot;, # Required. OAuth grant types.
3105 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant.
3106 &quot;A String&quot;,
3107 ],
3108 &quot;tokenEndpoint&quot;: &quot;A String&quot;, # Required. The token endpoint in the OAuth provider to exchange for an access token.
3109 },
3110 &quot;serviceAccountAuthConfig&quot;: { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
3111 &quot;scopes&quot;: [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
3112 &quot;A String&quot;,
3113 ],
3114 &quot;serviceAccount&quot;: &quot;A String&quot;, # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `[email protected]`.
3115 },
3116 &quot;serviceAgentIdTokenAuthConfig&quot;: { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
3117 },
3118 },
3119 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
3120 &quot;ignoreUnknownFields&quot;: True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
3121 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
3122 &quot;openApiSchema&quot;: &quot;A String&quot;, # Required. The OpenAPI schema in JSON or YAML format.
3123 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
3124 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
3125 },
3126 &quot;tlsConfig&quot;: { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
3127 &quot;caCerts&quot;: [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
3128 { # The CA certificate.
3129 &quot;cert&quot;: &quot;A String&quot;, # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google&#x27;s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with &quot;subject alt name&quot;. For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile &lt;(printf &quot;\nsubjectAltName=&#x27;DNS:www.example.com&#x27;&quot;) ```
3130 &quot;displayName&quot;: &quot;A String&quot;, # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
3131 },
3132 ],
3133 },
3134 &quot;url&quot;: &quot;A String&quot;, # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
3135 },
3136 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. The python function tool.
3137 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
3138 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
3139 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
3140 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
3141 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
3142 },
3143 },
3144 &quot;remoteAgentTool&quot;: { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
3145 &quot;agentCard&quot;: { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
3146 &quot;description&quot;: &quot;A String&quot;, # Required. A description of the agent&#x27;s domain of action/solution space.
3147 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the agent.
3148 &quot;skills&quot;: [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
3149 { # Represents a distinct capability or function that an agent can perform.
3150 &quot;description&quot;: &quot;A String&quot;, # Required. A detailed description of the skill.
3151 &quot;examples&quot;: [ # Example prompts or scenarios that this skill can handle.
3152 &quot;A String&quot;,
3153 ],
3154 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for the agent&#x27;s skill.
3155 &quot;inputModes&quot;: [ # The set of supported input media types for this skill, overriding the agent&#x27;s defaults.
3156 &quot;A String&quot;,
3157 ],
3158 &quot;name&quot;: &quot;A String&quot;, # Required. A human-readable name for the skill.
3159 &quot;outputModes&quot;: [ # The set of supported output media types for this skill, overriding the agent&#x27;s defaults.
3160 &quot;A String&quot;,
3161 ],
3162 &quot;tags&quot;: [ # Required. A set of keywords describing the skill&#x27;s capabilities.
3163 &quot;A String&quot;,
3164 ],
3165 },
3166 ],
3167 &quot;supportedInterfaces&quot;: [ # Required. Ordered list of supported interfaces. The first entry is preferred.
3168 { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
3169 &quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
3170 &quot;protocolVersion&quot;: &quot;A String&quot;, # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: &quot;0.3&quot;, &quot;1.0&quot;
3171 &quot;tenant&quot;: &quot;A String&quot;, # Tenant ID to be used in the request when calling the agent.
3172 &quot;url&quot;: &quot;A String&quot;, # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: &quot;https://api.example.com/a2a/v1&quot;, &quot;https://grpc.example.com/a2a&quot;
3173 },
3174 ],
3175 &quot;version&quot;: &quot;A String&quot;, # Required. The version of the agent.
3176 },
3177 &quot;description&quot;: &quot;A String&quot;, # Required. The description of the tool.
3178 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the tool.
3179 },
3180 &quot;systemTool&quot;: { # Pre-defined system tool. # Optional. The system tool.
3181 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the system tool.
3182 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the system tool.
3183 },
3184 &quot;timeout&quot;: &quot;A String&quot;, # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
3185 &quot;toolFakeConfig&quot;: { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
3186 &quot;codeBlock&quot;: { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
3187 &quot;pythonCode&quot;: &quot;A String&quot;, # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -&gt; Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
3188 },
3189 &quot;enableFakeMode&quot;: True or False, # Optional. Whether the tool is using fake mode.
3190 },
3191 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the tool was last updated.
3192 &quot;widgetTool&quot;: { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
3193 &quot;dataMapping&quot;: { # Configuration for mapping data from a source tool to the widget&#x27;s input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget&#x27;s input parameters.
3194 &quot;fieldMappings&quot;: { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
3195 &quot;a_key&quot;: &quot;A String&quot;,
3196 },
3197 &quot;mode&quot;: &quot;A String&quot;, # Optional. The mode of the data mapping.
3198 &quot;pythonFunction&quot;: { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool&#x27;s output into the widget&#x27;s input format.
3199 &quot;description&quot;: &quot;A String&quot;, # Output only. The description of the Python function, parsed from the python code&#x27;s docstring.
3200 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
3201 &quot;pythonCode&quot;: &quot;A String&quot;, # Optional. The Python code to execute for the tool.
3202 &quot;serviceDirectoryConfig&quot;: { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
3203 &quot;service&quot;: &quot;A String&quot;, # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
3204 },
3205 },
3206 &quot;pythonScript&quot;: &quot;A String&quot;, # Deprecated: Use `python_function` instead.
3207 &quot;sourceToolName&quot;: &quot;A String&quot;, # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
3208 },
3209 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the widget tool.
3210 &quot;name&quot;: &quot;A String&quot;, # Required. The display name of the widget tool.
3211 &quot;parameters&quot;: { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
3212 &quot;additionalProperties&quot;: # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
3213 &quot;anyOf&quot;: [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
3214 # Object with schema name: Schema
3215 ],
3216 &quot;default&quot;: &quot;&quot;, # Optional. Default value of the data.
3217 &quot;defs&quot;: { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema.
3218 &quot;a_key&quot;: # Object with schema name: Schema
3219 },
3220 &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the data.
3221 &quot;enum&quot;: [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[&quot;EAST&quot;, NORTH&quot;, &quot;SOUTH&quot;, &quot;WEST&quot;]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[&quot;101&quot;, &quot;201&quot;, &quot;301&quot;]}
3222 &quot;A String&quot;,
3223 ],
3224 &quot;items&quot;: # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
3225 &quot;maxItems&quot;: &quot;A String&quot;, # Optional. Maximum number of the elements for Type.ARRAY.
3226 &quot;maximum&quot;: 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
3227 &quot;minItems&quot;: &quot;A String&quot;, # Optional. Minimum number of the elements for Type.ARRAY.
3228 &quot;minimum&quot;: 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
3229 &quot;nullable&quot;: True or False, # Optional. Indicates if the value may be null.
3230 &quot;prefixItems&quot;: [ # Optional. Schemas of initial elements of Type.ARRAY.
3231 # Object with schema name: Schema
3232 ],
3233 &quot;properties&quot;: { # Optional. Properties of Type.OBJECT.
3234 &quot;a_key&quot;: # Object with schema name: Schema
3235 },
3236 &quot;ref&quot;: &quot;A String&quot;, # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named &quot;Pet&quot;: ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the &quot;pet&quot; property is a reference to the schema node named &quot;Pet&quot;. See details in https://json-schema.org/understanding-json-schema/structuring.
3237 &quot;required&quot;: [ # Optional. Required properties of Type.OBJECT.
3238 &quot;A String&quot;,
3239 ],
3240 &quot;title&quot;: &quot;A String&quot;, # Optional. The title of the schema.
3241 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the data.
3242 &quot;uniqueItems&quot;: True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
3243 },
3244 &quot;textResponseConfig&quot;: { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
3245 &quot;staticText&quot;: &quot;A String&quot;, # Optional. The static text response to return when type is STATIC.
3246 &quot;textResponseInstruction&quot;: &quot;A String&quot;, # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
3247 &quot;type&quot;: &quot;A String&quot;, # Optional. The strategy for providing the text response.
3248 },
3249 &quot;uiConfig&quot;: { # Optional. Configuration for rendering the widget.
3250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
3251 },
3252 &quot;widgetType&quot;: &quot;A String&quot;, # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
3253 },
3254 }</pre>
3255 </div>
3256
3257 </body></html>