SqlDatabaseRetriever

SQL Database content retriever using LangChain4j experimental SqlDatabaseContentRetriever. ⚠ IMPORTANT: the database user should have READ-ONLY permissions.

yaml
type: "io.kestra.plugin.ai.retriever.SqlDatabaseRetriever"

Examples

RAG chat with a SQL Database content retriever (answers grounded in database data)

yaml
id: rag
namespace: company.ai

tasks:
  - id: chat_with_rag_and_sql_retriever
    type: io.kestra.plugin.ai.rag.ChatCompletion
    chatProvider:
      type: io.kestra.plugin.ai.provider.GoogleGemini
      modelName: gemini-2.0-flash
      apiKey: "{{ kv('GOOGLE_API_KEY') }}"
    contentRetrievers:
      - type: io.kestra.plugin.ai.retriever.SqlDatabaseRetriever
        databaseType: POSTGRESQL
        jdbcUrl: "jdbc:postgresql://localhost:5432/mydb"
        username: "{{ kv('DB_USER') }}"
        password: "{{ kv('DB_PASSWORD') }}"
    prompt: "What are the top 5 customers by revenue?"

Properties

databaseType *string

Possible Values

POSTGRESQLMYSQLH2

Type of database to connect to (PostgreSQL, MySQL, or H2)

Determines the default JDBC driver and connection format.

password *string

Database password

provider *AmazonBedrock Anthropic AzureOpenAI DashScope DeepSeek GoogleGemini GoogleVertexAI HuggingFace LocalAI MistralAI OciGenAI Ollama OpenAI OpenRouter WorkersAI ZhiPuAI

Language model provider

username *string

Database username

configuration ChatConfiguration

Default {}

Language model configuration

driver string

Optional JDBC driver class name – automatically resolved if not provided.

jdbcUrl string

JDBC connection URL to the target database

maxPoolSize integerstring

Default 2

Maximum number of database connections in the pool

Definitions

Azure OpenAI Model Provider

endpoint *string

API endpoint

The Azure OpenAI endpoint in the format: https://{resource}.openai.azure.com/

modelName *string

Model name

apiKey string

API Key

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientId string

Client ID

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

clientSecret string

Client secret

serviceVersion string

API version

tenantId string

Tenant ID

type object

Google VertexAI Model Provider

endpoint *string

Endpoint URL

location *string

Project location

modelName *string

Model name

project *string

Project ID

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

Google Gemini Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

Mistral AI Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

ZhiPu AI Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Default https://open.bigmodel.cn/

API base URL

The base URL for ZhiPu API (defaults to https://open.bigmodel.cn/)

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

maxRetries integerstring

The maximum retry times to request

maxToken integerstring

The maximum number of tokens returned by this request

stops array

SubType string

With the stop parameter, the model will automatically stop generating text when it is about to contain the specified string or token_id

type object

OciGenAI Model Provider

compartmentId *string

OCID of OCI Compartment with the model

modelName *string

Model name

region *string

OCI Region to connect the client to

authProvider string

OCI SDK Authentication provider

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

Deepseek Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Default https://api.deepseek.com/v1

API base URL

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

io.kestra.plugin.ai.domain.ChatConfiguration-ResponseFormat

jsonSchema object

JSON Schema (used when type = JSON)

Provide a JSON Schema describing the expected structure of the response. In Kestra flows, define the schema in YAML (it is still a JSON Schema object). Example (YAML):

text

responseFormat: 
    type: JSON
    jsonSchema: 
      type: object
      required: ["category", "priority"]
      properties: 
        category: 
          type: string
          enum: ["ACCOUNT", "BILLING", "TECHNICAL", "GENERAL"]
        priority: 
          type: string
          enum: ["LOW", "MEDIUM", "HIGH"]

Note: Provider support for strict schema enforcement varies. If unsupported, guide the model about the expected output structure via the prompt and validate downstream.

jsonSchemaDescription string

Schema description (optional)

Natural-language description of the schema to help the model produce the right fields. Example: "Classify a customer ticket into category and priority."

type string

Default TEXT

Possible Values

TEXTJSON

Response format type

Specifies how the LLM should return output. Allowed values:

TEXT (default): free-form natural language.
JSON: structured output validated against a JSON Schema.

Anthropic AI Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

maxTokens integerstring

Maximum Tokens

Specifies the maximum number of tokens that the model is allowed to generate in its response.

type object

OpenRouter Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

Ollama Model Provider

endpoint *string

Model endpoint

modelName *string

Model name

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

OpenAI Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Default https://api.openai.com/v1

API base URL

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

io.kestra.plugin.ai.domain.ChatConfiguration

logRequests booleanstring

Log LLM requests

If true, prompts and configuration sent to the LLM will be logged at INFO level.

logResponses booleanstring

Log LLM responses

If true, raw responses from the LLM will be logged at INFO level.

maxToken integerstring

Maximum number of tokens the model can generate in the completion (response). This limits the length of the output.

responseFormat ChatConfiguration-ResponseFormat

Response format

Defines the expected output format. Default is plain text. Some providers allow requesting JSON or schema-constrained outputs, but support varies and may be incompatible with tool use. When using a JSON schema, the output will be returned under the key jsonOutput.

returnThinking booleanstring

Return Thinking

Controls whether to return the model's internal reasoning or 'thinking' text, if available. When enabled, the reasoning content is extracted from the response and made available in the AiMessage object. It Does not trigger the thinking process itself—only affects whether the output is parsed and returned.

seed integerstring

Seed

Optional random seed for reproducibility. Provide a positive integer (e.g., 42, 1234). Using the same seed with identical settings produces repeatable outputs.

temperature numberstring

Temperature

Controls randomness in generation. Typical range is 0.0–1.0. Lower values (e.g., 0.2) make outputs more focused and deterministic, while higher values (e.g., 0.7–1.0) increase creativity and variability.

thinkingBudgetTokens integerstring

Thinking Token Budget

Specifies the maximum number of tokens allocated as a budget for internal reasoning processes, such as generating intermediate thoughts or chain-of-thought sequences, allowing the model to perform multi-step reasoning before producing the final output.

thinkingEnabled booleanstring

Enable Thinking

Enables internal reasoning ('thinking') in supported language models, allowing the model to perform intermediate reasoning steps before producing a final output; this is useful for complex tasks like multi-step problem solving or decision making, but may increase token usage and response time, and is only applicable to compatible models.

topK integerstring

Top-K

Limits sampling to the top K most likely tokens at each step. Typical values are between 20 and 100. Smaller values reduce randomness; larger values allow more diverse outputs.

topP numberstring

Top-P (nucleus sampling)

Selects from the smallest set of tokens whose cumulative probability is ≤ topP. Typical values are 0.8–0.95. Lower values make the output more focused, higher values increase diversity.

DashScope (Qwen) Model Provider from Alibaba Cloud

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Default https://dashscope-intl.aliyuncs.com/api/v1

API base URL

text

If you use a model in the China (Beijing) region, you need to replace the URL with: https://dashscope.aliyuncs.com/api/v1,
otherwise use the Singapore region of: "https://dashscope-intl.aliyuncs.com/api/v1.
The default value is computed based on the system timezone.

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

enableSearch booleanstring

Whether the model uses Internet search results for reference when generating text or not

maxTokens integerstring

The maximum number of tokens returned by this request

repetitionPenalty numberstring

Repetition in a continuous sequence during model generation

text

Increasing repetition_penalty reduces the repetition in model generation,
1.0 means no penalty. Value range: (0, +inf)

type object

LocalAI Model Provider

baseUrl *string

API base URL

modelName *string

Model name

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

Amazon Bedrock Model Provider

accessKeyId *string

AWS Access Key ID

modelName *string

Model name

secretAccessKey *string

AWS Secret Access Key

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

modelType string

Default COHERE

Possible Values

COHERETITAN

Amazon Bedrock Embedding Model Type

type object

HuggingFace Model Provider

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Default https://router.huggingface.co/v1

API base URL

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

WorkersAI Model Provider

accountId *string

Account Identifier

Unique identifier assigned to an account

apiKey *string

API Key

modelName *string

Model name

baseUrl string

Base URL

Custom base URL to override the default endpoint (useful for local tests, WireMock, or enterprise gateways).

caPem string

CA PEM certificate content

CA certificate as text, used to verify SSL/TLS connections when using custom endpoints.

clientPem string

Client PEM certificate content

PEM client certificate as text, used to authenticate the connection to enterprise AI endpoints.

type object

​Sql​Database​Retriever

SqlDatabaseRetriever