public sealed class OpenApiTool : IMessage<OpenApiTool>, IEquatable<OpenApiTool>, IDeepCloneable<OpenApiTool>, IBufferMessage, IMessageReference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class OpenApiTool.
A remote API tool defined by an OpenAPI schema.
Implements
IMessageOpenApiTool, IEquatableOpenApiTool, IDeepCloneableOpenApiTool, IBufferMessage, IMessageNamespace
Google.Cloud.Ces.V1Assembly
Google.Cloud.Ces.V1.dll
Constructors
OpenApiTool()
public OpenApiTool()OpenApiTool(OpenApiTool)
public OpenApiTool(OpenApiTool other)| Parameter | |
|---|---|
| Name | Description |
other |
OpenApiTool |
Properties
ApiAuthentication
public ApiAuthentication ApiAuthentication { get; set; }Optional. Authentication information required by the API.
| Property Value | |
|---|---|
| Type | Description |
ApiAuthentication |
|
Description
public string Description { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
IgnoreUnknownFields
public bool IgnoreUnknownFields { get; set; }Optional. If true, the agent will ignore unknown fields in the API response.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Name
public string Name { get; set; }Optional. The name of the tool. If not provided, the name of the tool will
be derived from the OpenAPI schema, from operation.operationId.
| Property Value | |
|---|---|
| Type | Description |
string |
|
OpenApiSchema
public string OpenApiSchema { get; set; }Required. The OpenAPI schema in JSON or YAML format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ServiceDirectoryConfig
public ServiceDirectoryConfig ServiceDirectoryConfig { get; set; }Optional. Service Directory configuration.
| Property Value | |
|---|---|
| Type | Description |
ServiceDirectoryConfig |
|
TlsConfig
public TlsConfig TlsConfig { get; set; }Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
| Property Value | |
|---|---|
| Type | Description |
TlsConfig |
|
Url
public string Url { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|