Agent
Class: metadata
Platform Veeva AI allows Admins to configure custom agents with direct, secure access to Vault object and document data. Agents leverage a Large Language Model (LLM) to allow them to perform a set of agent actions. Learn more about Veeva AI.
| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault's base language. |
active | Type: Boolean | Indicates whether this Agent is active. |
agent_user | Type: String Max length: 255 | The Agent User assigned to this agent, allowing agent actions to execute without a user at the keyboard, such as through a job or email processor. |
class | Type: ComponentReference Required | Determines a orchestration pattern for an agent. Implemented in Vault Java SDK. |
description | Type: String Required Max length: 500 | A natural language description of this Agent, displayed to Admins in the Vault UI and used for Chat routing. |
document_type | Type: Component | The document type upon which this Agent can perform agent actions. |
model_level | Type: Enum Allowed values:
| Indicates whether this Agent uses the Basic or Advanced LLM connection. |
object | Type: Component | The name of the object to which this Agent is scoped. |
object_type | Type: Component | The name of the object type to which this Agent is scoped. |
objective | Type: LongString Max length: 32000 | A description of what this Agent is intended to do. Used as a system prompt when this Agent runs. |
supplemental_objective | Type: LongString Max length: 10000 | This field adds supporting information to this Agent's objective. Only available on standard and system-managed Agents based on application family availability. |
Agentcontext
Section link for Agentcontext| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault's base language. |
active | Type: Boolean | Indicates whether the component is active. |
always_include | Type: Boolean Required | Indicates whether to automatically include this agent context with each agent action configured in this Agent. |
context_configuration | Type: XMLString Max length: 32000 | Defines this agent context's configuration using XML. |
context_type | Type: ComponentReference Required | The standard context type for this agent context. |
description | Type: String Max length: 500 | A natural language description of this agent context. Vault sends this information to your LLM to help it understand and execute the agent context. |
Agentactioncontext
Section link for Agentactioncontext| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault's base language. |
active | Type: Boolean | Indicates whether the component is active. |
action | Type: SubcomponentReference Required | The agent action for which this context is configured. |
agent | Type: ComponentReference Required | The assigned agent that can execute this agent action. |
context | Type: SubcomponentReference Required | The assigned agent context for this agent action. |
Agentactiontool
Section link for Agentactiontool| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault's base language. |
active | Type: Boolean | Indicates whether the component is active. |
action | Type: SubcomponentReference Required | The agent action for which this tool is configured. |
agent | Type: ComponentReference Required | The assigned agent that can execute this agent tool. |
tool | Type: ComponentReference Required | The assigned agent tool for this agent action. |
Agentaction
Section link for Agentaction| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault's base language. |
active | Type: Boolean | Indicates whether the component is active. |
api_access | Type: Boolean | Indicates whether this agent action is visible to the MCP server and Vault API. If false, no call to Vault API or MCP server can be made to the agent action. |
description | Type: String Required Max length: 500 | A natural language description of this agent action. Vault sends this information to your LLM to help it understand this agent action. |
hide_in_chat | Type: Boolean | If support_chat is set to true, this indicates whether to hide this agent action from the Veeva AI Chat window. |
instructions | Type: LongString Max length: 32000 | This agent action's instructions. Your LLM uses these instructions to understand how to execute and respond to this agent action. |
supplemental_instructions | Type: LongString Max length: 10000 | This field adds supporting information to this agent action's instructions. Only available on standard and system-managed Agents based on application family availability. |
support_chat | Type: Boolean Required | Indicates whether to display this agent action in the Veeva AI Chat window. If false, it is hidden in the Veeva AI Chat window. If omitted, this agent action is hidden from the chat window. |
tool_evaluation | Type: Enum Required Allowed values:
| Indicates whether your LLM is allowed to decide when to execute the agent tool or will use the agent tool each time this agent action is executed. |
tool_evaluation_required_tool | Type: ComponentReference | If tool_evaluation is set to REQUIRED, this indicates the agent tool for this agent action to execute. |
Supported Operations
Section link for Supported Operations| Operation | Support |
|---|---|
| Create | |
| Recreate | |
| Alter | |
| Drop | |
| Rename | |
| Describe | |
| Generate Recreate | |
| Queryable |