Close httplib2 connections.
create(parent, body=None, toolId=None, x__xgafv=None)
Creates a tool.
Deletes a tool.
Retrieves a tool.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists tools.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a tool.
close()
Close httplib2 connections.
create(parent, body=None, toolId=None, x__xgafv=None)
Creates a tool.
Args:
parent: string, Required. The project/location to create tool for. Format: `projects//locations/` (required)
body: object, The request body.
The object takes the form of:
{ # Represents a tool.
"actionConfirmationRequirement": { # Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
"a_key": "A String",
},
"connectorSpec": { # A ConnectorTool enabling using Integration Connectors Connections as tools. # Integration connectors tool specification.
"actions": [ # Required. Actions for the tool to use.
{ # Configuration of a Connection operation for the tool to use.
"connectionActionId": "A String", # ID of a Connection action for the tool to use.
"entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
"entityId": "A String", # Required. ID of the entity.
"operation": "A String", # Required. Operation to perform on the entity.
},
"inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
"A String",
],
"outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
"A String",
],
},
],
"name": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects/*/locations/*/connections/*'
},
"createTime": "A String", # Output only. Creation time of this tool.
"description": "A String", # Optional. A human readable description of the tool.
"displayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI.
"extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
"name": "A String", # Required. The full name of the referenced vertex extension. Format: `projects/{project}/locations/{location}/extensions/{extension}`
},
"functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
"inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
"methodType": "A String", # Optional. The method type of the function. If not specified, the default value is GET.
"outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
},
"name": "A String", # Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.
"openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI tool.
"authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
"apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
"apiKey": "A String", # Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
"requestLocation": "A String", # Required. Key location in the request.
"secretVersionForApiKey": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
},
"bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth.
"secretVersionForToken": "A String", # Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"token": "A String", # Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.
},
"oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
"clientId": "A String", # Required. The client ID from the OAuth provider.
"clientSecret": "A String", # Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.
"oauthGrantType": "A String", # Required. OAuth grant types.
"scopes": [ # Optional. The OAuth scopes to grant.
"A String",
],
"secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
},
"serviceAgentAuthConfig": { # Config for auth using [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
"serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
},
},
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
"service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the tool.
},
"textSchema": "A String", # Required. The OpenAPI schema specified as a text.
"tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
"caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
{ # The CA certificate.
"cert": "A String", # 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, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 <(printf "\nsubjectAltName='DNS:www.example.com'")
"displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
},
],
},
},
"satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.
"satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.
"toolKey": "A String", # Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
"updateTime": "A String", # Output only. Update time of this tool.
}
toolId: string, Optional. The ID to use for the tool, which will become the final component of the tool's resource name. The tool ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provide, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a tool.
"actionConfirmationRequirement": { # Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
"a_key": "A String",
},
"connectorSpec": { # A ConnectorTool enabling using Integration Connectors Connections as tools. # Integration connectors tool specification.
"actions": [ # Required. Actions for the tool to use.
{ # Configuration of a Connection operation for the tool to use.
"connectionActionId": "A String", # ID of a Connection action for the tool to use.
"entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
"entityId": "A String", # Required. ID of the entity.
"operation": "A String", # Required. Operation to perform on the entity.
},
"inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
"A String",
],
"outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
"A String",
],
},
],
"name": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects/*/locations/*/connections/*'
},
"createTime": "A String", # Output only. Creation time of this tool.
"description": "A String", # Optional. A human readable description of the tool.
"displayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI.
"extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
"name": "A String", # Required. The full name of the referenced vertex extension. Format: `projects/{project}/locations/{location}/extensions/{extension}`
},
"functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
"inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
"methodType": "A String", # Optional. The method type of the function. If not specified, the default value is GET.
"outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
},
"name": "A String", # Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.
"openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI tool.
"authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
"apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
"apiKey": "A String", # Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
"requestLocation": "A String", # Required. Key location in the request.
"secretVersionForApiKey": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
},
"bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth.
"secretVersionForToken": "A String", # Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"token": "A String", # Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.
},
"oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
"clientId": "A String", # Required. The client ID from the OAuth provider.
"clientSecret": "A String", # Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.
"oauthGrantType": "A String", # Required. OAuth grant types.
"scopes": [ # Optional. The OAuth scopes to grant.
"A String",
],
"secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
},
"serviceAgentAuthConfig": { # Config for auth using [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
"serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
},
},
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
"service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the tool.
},
"textSchema": "A String", # Required. The OpenAPI schema specified as a text.
"tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
"caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
{ # The CA certificate.
"cert": "A String", # 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, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 <(printf "\nsubjectAltName='DNS:www.example.com'")
"displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
},
],
},
},
"satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.
"satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.
"toolKey": "A String", # Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
"updateTime": "A String", # Output only. Update time of this tool.
}
delete(name, x__xgafv=None)
Deletes a tool.
Args:
name: string, Required. The tool resource name to delete. Format: `projects//locations//tools/` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}
get(name, x__xgafv=None)
Retrieves a tool.
Args:
name: string, Required. The tool resource name to retrieve. Format: `projects//locations//tools/` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a tool.
"actionConfirmationRequirement": { # Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
"a_key": "A String",
},
"connectorSpec": { # A ConnectorTool enabling using Integration Connectors Connections as tools. # Integration connectors tool specification.
"actions": [ # Required. Actions for the tool to use.
{ # Configuration of a Connection operation for the tool to use.
"connectionActionId": "A String", # ID of a Connection action for the tool to use.
"entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
"entityId": "A String", # Required. ID of the entity.
"operation": "A String", # Required. Operation to perform on the entity.
},
"inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
"A String",
],
"outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
"A String",
],
},
],
"name": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects/*/locations/*/connections/*'
},
"createTime": "A String", # Output only. Creation time of this tool.
"description": "A String", # Optional. A human readable description of the tool.
"displayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI.
"extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
"name": "A String", # Required. The full name of the referenced vertex extension. Format: `projects/{project}/locations/{location}/extensions/{extension}`
},
"functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
"inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
"methodType": "A String", # Optional. The method type of the function. If not specified, the default value is GET.
"outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
},
"name": "A String", # Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.
"openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI tool.
"authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
"apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
"apiKey": "A String", # Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
"requestLocation": "A String", # Required. Key location in the request.
"secretVersionForApiKey": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
},
"bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth.
"secretVersionForToken": "A String", # Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"token": "A String", # Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.
},
"oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
"clientId": "A String", # Required. The client ID from the OAuth provider.
"clientSecret": "A String", # Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.
"oauthGrantType": "A String", # Required. OAuth grant types.
"scopes": [ # Optional. The OAuth scopes to grant.
"A String",
],
"secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
},
"serviceAgentAuthConfig": { # Config for auth using [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
"serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
},
},
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
"service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the tool.
},
"textSchema": "A String", # Required. The OpenAPI schema specified as a text.
"tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
"caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
{ # The CA certificate.
"cert": "A String", # 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, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 <(printf "\nsubjectAltName='DNS:www.example.com'")
"displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
},
],
},
},
"satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.
"satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.
"toolKey": "A String", # Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
"updateTime": "A String", # Output only. Update time of this tool.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists tools.
Args:
parent: string, Required. The project/location to list tools for. Format: `projects//locations/` (required)
pageSize: integer, Optional. Maximum number of conversation models to return in a single page. Default to 10.
pageToken: string, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response of ListTools.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"tools": [ # List of tools retrieved.
{ # Represents a tool.
"actionConfirmationRequirement": { # Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
"a_key": "A String",
},
"connectorSpec": { # A ConnectorTool enabling using Integration Connectors Connections as tools. # Integration connectors tool specification.
"actions": [ # Required. Actions for the tool to use.
{ # Configuration of a Connection operation for the tool to use.
"connectionActionId": "A String", # ID of a Connection action for the tool to use.
"entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
"entityId": "A String", # Required. ID of the entity.
"operation": "A String", # Required. Operation to perform on the entity.
},
"inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
"A String",
],
"outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
"A String",
],
},
],
"name": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects/*/locations/*/connections/*'
},
"createTime": "A String", # Output only. Creation time of this tool.
"description": "A String", # Optional. A human readable description of the tool.
"displayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI.
"extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
"name": "A String", # Required. The full name of the referenced vertex extension. Format: `projects/{project}/locations/{location}/extensions/{extension}`
},
"functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
"inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
"methodType": "A String", # Optional. The method type of the function. If not specified, the default value is GET.
"outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
},
"name": "A String", # Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.
"openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI tool.
"authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
"apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
"apiKey": "A String", # Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
"requestLocation": "A String", # Required. Key location in the request.
"secretVersionForApiKey": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
},
"bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth.
"secretVersionForToken": "A String", # Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"token": "A String", # Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.
},
"oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
"clientId": "A String", # Required. The client ID from the OAuth provider.
"clientSecret": "A String", # Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.
"oauthGrantType": "A String", # Required. OAuth grant types.
"scopes": [ # Optional. The OAuth scopes to grant.
"A String",
],
"secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
},
"serviceAgentAuthConfig": { # Config for auth using [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
"serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
},
},
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
"service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the tool.
},
"textSchema": "A String", # Required. The OpenAPI schema specified as a text.
"tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
"caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
{ # The CA certificate.
"cert": "A String", # 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, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 <(printf "\nsubjectAltName='DNS:www.example.com'")
"displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
},
],
},
},
"satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.
"satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.
"toolKey": "A String", # Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
"updateTime": "A String", # Output only. Update time of this tool.
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a tool.
Args:
name: string, Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a tool.
"actionConfirmationRequirement": { # Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
"a_key": "A String",
},
"connectorSpec": { # A ConnectorTool enabling using Integration Connectors Connections as tools. # Integration connectors tool specification.
"actions": [ # Required. Actions for the tool to use.
{ # Configuration of a Connection operation for the tool to use.
"connectionActionId": "A String", # ID of a Connection action for the tool to use.
"entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
"entityId": "A String", # Required. ID of the entity.
"operation": "A String", # Required. Operation to perform on the entity.
},
"inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
"A String",
],
"outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
"A String",
],
},
],
"name": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects/*/locations/*/connections/*'
},
"createTime": "A String", # Output only. Creation time of this tool.
"description": "A String", # Optional. A human readable description of the tool.
"displayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI.
"extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
"name": "A String", # Required. The full name of the referenced vertex extension. Format: `projects/{project}/locations/{location}/extensions/{extension}`
},
"functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
"inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
"methodType": "A String", # Optional. The method type of the function. If not specified, the default value is GET.
"outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
},
"name": "A String", # Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.
"openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI tool.
"authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
"apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
"apiKey": "A String", # Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
"requestLocation": "A String", # Required. Key location in the request.
"secretVersionForApiKey": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
},
"bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth.
"secretVersionForToken": "A String", # Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"token": "A String", # Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.
},
"oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
"clientId": "A String", # Required. The client ID from the OAuth provider.
"clientSecret": "A String", # Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.
"oauthGrantType": "A String", # Required. OAuth grant types.
"scopes": [ # Optional. The OAuth scopes to grant.
"A String",
],
"secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
},
"serviceAgentAuthConfig": { # Config for auth using [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
"serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
},
},
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
"service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the tool.
},
"textSchema": "A String", # Required. The OpenAPI schema specified as a text.
"tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
"caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
{ # The CA certificate.
"cert": "A String", # 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, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 <(printf "\nsubjectAltName='DNS:www.example.com'")
"displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
},
],
},
},
"satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.
"satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.
"toolKey": "A String", # Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
"updateTime": "A String", # Output only. Update time of this tool.
}
updateMask: string, Optional. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a tool.
"actionConfirmationRequirement": { # Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified (either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET.
"a_key": "A String",
},
"connectorSpec": { # A ConnectorTool enabling using Integration Connectors Connections as tools. # Integration connectors tool specification.
"actions": [ # Required. Actions for the tool to use.
{ # Configuration of a Connection operation for the tool to use.
"connectionActionId": "A String", # ID of a Connection action for the tool to use.
"entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
"entityId": "A String", # Required. ID of the entity.
"operation": "A String", # Required. Operation to perform on the entity.
},
"inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
"A String",
],
"outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
"A String",
],
},
],
"name": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects/*/locations/*/connections/*'
},
"createTime": "A String", # Output only. Creation time of this tool.
"description": "A String", # Optional. A human readable description of the tool.
"displayName": "A String", # Optional. A human readable short name of the tool, to be shown on the UI.
"extensionSpec": { # An ExtensionTool is a way to use Vertex Extensions as a tool. # Vertex extension tool specification.
"name": "A String", # Required. The full name of the referenced vertex extension. Format: `projects/{project}/locations/{location}/extensions/{extension}`
},
"functionSpec": { # A Function tool describes the functions to be invoked on the client side. # Client side executed function specification.
"inputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the input of the function. This input is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
"methodType": "A String", # Optional. The method type of the function. If not specified, the default value is GET.
"outputSchema": { # Optional. The JSON schema is encapsulated in a google.protobuf.Struct to describe the output of the function. This output is a JSON object that contains the function's parameters as properties of the object.
"a_key": "", # Properties of the object.
},
},
"name": "A String", # Output only. Identifier. The resource name of the tool. Format: `projects//locations//tools/`.
"openApiSpec": { # An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. # OpenAPI tool.
"authentication": { # Authentication information required for API calls # Optional. Authentication information required by the API.
"apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
"apiKey": "A String", # Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
"requestLocation": "A String", # Required. Key location in the request.
"secretVersionForApiKey": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the `api_key` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
},
"bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth.
"secretVersionForToken": "A String", # Optional. The name of the SecretManager secret version resource storing the Bearer token. If this field is set, the `token` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"token": "A String", # Optional. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.
},
"oauthConfig": { # Config for authentication with OAuth. # Config for OAuth.
"clientId": "A String", # Required. The client ID from the OAuth provider.
"clientSecret": "A String", # Optional. The client secret from the OAuth provider. If the `secret_version_for_client_secret` field is set, this field will be ignored.
"oauthGrantType": "A String", # Required. OAuth grant types.
"scopes": [ # Optional. The OAuth scopes to grant.
"A String",
],
"secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
},
"serviceAgentAuthConfig": { # Config for auth using [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
"serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
},
},
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
"service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the tool.
},
"textSchema": "A String", # Required. The OpenAPI schema specified as a text.
"tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
"caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
{ # The CA certificate.
"cert": "A String", # 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, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". 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 <(printf "\nsubjectAltName='DNS:www.example.com'")
"displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
},
],
},
},
"satisfiesPzi": True or False, # Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown.
"satisfiesPzs": True or False, # Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown.
"toolKey": "A String", # Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool.
"updateTime": "A String", # Output only. Update time of this tool.
}