Returns the files Resource.
Returns the operations Resource.
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an Agent.
Deletes an Agent.
disableAgent(name, x__xgafv=None)
Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.
enableAgent(name, x__xgafv=None)
Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
Gets an Agent.
getAgentView(name, adminView=None, languageCode=None, maxSuggestedPrompts=None, x__xgafv=None)
Returns a AgentView for a given Agent, which contains additional information about the Agent.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Agents under an Assistant which were created by the caller.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an Agent
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.
suspendAgent(name, suspensionReason=None, x__xgafv=None)
Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an Agent.
Args:
parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
body: object, The request body.
The object takes the form of:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
delete(name, x__xgafv=None)
Deletes an Agent.
Args:
name: string, Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
disableAgent(name, x__xgafv=None)
Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.
Args:
name: string, Required. The name of the Agent to disable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
enableAgent(name, x__xgafv=None)
Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
Args:
name: string, Required. The name of the Agent to enable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
get(name, x__xgafv=None)
Gets an Agent.
Args:
name: string, Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
getAgentView(name, adminView=None, languageCode=None, maxSuggestedPrompts=None, x__xgafv=None)
Returns a AgentView for a given Agent, which contains additional information about the Agent.
Args:
name: string, Required. The name of the Agent to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
adminView: boolean, Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.
languageCode: string, Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
maxSuggestedPrompts: integer, Optional. The maximum number of suggested prompts to return per agent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the AgentService.GetAgentView method.
"agentView": { # The data for displaying an Agent. # The data for displaying an Agent.
"agentOrigin": "A String", # Immutable. The origin of the Agent.
"agentSharingState": "A String", # Output only. The sharing state of the agent.
"agentType": "A String", # Output only. The type of the agent.
"customPlaceholderText": "A String", # The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
"displayName": "A String", # Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"name": "A String", # Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"state": "A String", # Output only. The state of the Agent.
"suggestedPrompts": [ # Optional. The suggested prompts for the agent, to be shown on the agent landing page.
{ # A suggested prompt for the agent, to be shown on the agent landing page.
"text": "A String", # Required. The text of the suggested prompt. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
},
],
"suspensionReason": "A String", # The reason why the agent was suspended. Only set if the state is SUSPENDED.
"userAnnotations": { # Per-user annotations for an Agent, based on UserAnnotation. # Optional. Per-user annotations of the current caller for the agent.
"pinned": True or False, # Optional. Whether the agent is pinned, pinned agent will be displayed on the top of the agent list.
"viewed": True or False, # Optional. Whether the agent has been viewed by the user.
},
"userPermissions": { # The permissions of the user on an Agent. # The permissions of the user for this Agent.
"canDelete": True or False, # If the user can delete this Agent.
"canEdit": True or False, # If the user can edit this Agent.
"canProposeUsers": True or False, # If the user can propose other users to share the Agent with.
"canRequestReview": True or False, # If the user can request a review for this Agent.
"canRun": True or False, # If the user can run this Agent.
"canView": True or False, # If the user can view the source of this Agent.
"canWithdraw": True or False, # If the user can withdraw this Agent.
},
},
}
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Agents under an Assistant which were created by the caller.
Args:
parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.
pageSize: integer, Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken: string, Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the AgentService.ListAgents method.
"agents": [ # The agents visible to the caller under the parent Assistant.
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
},
],
"nextPageToken": "A String", # A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
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 an Agent
Args:
name: string, Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
body: object, The request body.
The object takes the form of:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
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:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
suspendAgent(name, suspensionReason=None, x__xgafv=None)
Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.
Args:
name: string, Required. The name of the Agent to suspend. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
suspensionReason: string, Required. The reason for suspending the Agent. This will be shown to the users of the Agent.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Performs a predefined, specific task.
"a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
"cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
"entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
"order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
},
"jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
},
"adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
"provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
"reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
},
},
"authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
"agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
"toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
"A String",
],
},
"createTime": "A String", # Output only. Timestamp when this Agent was created.
"customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
"deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
"description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
"dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
},
"displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
"icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
"content": "A String", # Base64-encoded image file contents.
"uri": "A String", # Image URI.
},
"languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
"managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
},
"name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
"rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
"sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
"scope": "A String", # Optional. The sharing scope of the agent.
},
"starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
{ # The starter prompt suggestion to show the user on the landing page of the agent.
"text": "A String", # Required. The text of the starter prompt.
},
],
"state": "A String", # Output only. The lifecycle state of the agent.
"suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
"updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
}