SqlAgent
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - implementation | No | const | No | - | SqlAgent |
| - client | No | Reference[SqlClient] | No | In SqlClient | Overview of SqlClient components |
| - apu | No | Reference[APU] | No | In APU | The APU is the main interface for the Agent to interact with the LLM. The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation. To learn more, check out our blog article APU: What is it and how does it work?. |
| - description | No | string | No | - | Description |
| - system_prompt | No | string | No | - | System Prompt |
| - user_prompt | No | string | No | - | User Prompt |
| - clarification_prompt | No | string | No | - | Clarification Prompt |
| - response_prompt | No | string | No | - | Response Prompt |
| - error_prompt | No | string | No | - | Error Prompt |
| - num_retries | No | integer | No | - | Num Retries |
1. Property implementation
| Type | const |
| Required | No |
Description: SqlAgent
Specific value: "SqlAgent"
2. Property client
| Type | Reference[SqlClient] |
| Required | No |
| Default | {"implementation": "SqlClient"} |
| Defined in | SqlClient |
Description: Overview of SqlClient components
3. Property apu
| Type | Reference[APU] |
| Required | No |
| Default | {"implementation": "APU"} |
| Defined in | APU |
Description: The APU is the main interface for the Agent to interact with the LLM. The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation.
To learn more, check out our blog article APU: What is it and how does it work?.
4. Property description
Title: Description
| Type | string |
| Required | No |
| Default | "An agent for interacting with data. Can respond to queries provided in natural language." |
5. Property system_prompt
Title: System Prompt
| Type | string |
| Required | No |
| Default | "\n You are a helpful assistant that is a sql expert and helps a user query a {{ protocol }} database and analyse the response.\n \n Here is the database schema:\n {{ metadata }}\n \n Use your as needed tools to investigate the database with the goal of providing the user with the query that they need.\n \n Think carefully.\n " |
6. Property user_prompt
Title: User Prompt
| Type | string |
| Required | No |
| Default | "{{ message }}" |
7. Property clarification_prompt
Title: Clarification Prompt
| Type | string |
| Required | No |
| Default | "What clarifying information do you need? Phrase your response as an explicit question or several questions." |
8. Property response_prompt
Title: Response Prompt
| Type | string |
| Required | No |
| Default | "What is your response? Be explicit and concise." |
9. Property error_prompt
Title: Error Prompt
| Type | string |
| Required | No |
| Default | "An error occurred executing the query \"{{ query }}\": {{ error }}" |
10. Property num_retries
Title: Num Retries
| Type | integer |
| Required | No |
| Default | 3 |