SqlDatabaseRetriever

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

Examples

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

password *string

provider *

Definitions

Use Amazon Bedrock models

accessKeyId*string

modelName*string

secretAccessKey*string

baseUrlstring

caPemstring

clientPemstring

modelTypestring

DefaultCOHERE

Possible Values

COHERETITAN

typeobject

Possible Values

io.kestra.plugin.ai.provider.AmazonBedrockio.kestra.plugin.langchain4j.provider.AmazonBedrock

Use Anthropic Claude models

apiKey*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

maxTokensintegerstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.Anthropicio.kestra.plugin.langchain4j.provider.Anthropic

Use Azure OpenAI deployments

endpoint*string

modelName*string

apiKeystring

baseUrlstring

caPemstring

clientIdstring

clientPemstring

clientSecretstring

serviceVersionstring

tenantIdstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.AzureOpenAIio.kestra.plugin.langchain4j.provider.AzureOpenAI

Use DashScope (Qwen) models

apiKey*string

modelName*string

baseUrlstring

Defaulthttps://dashscope-intl.aliyuncs.com/api/v1

caPemstring

clientPemstring

enableSearchbooleanstring

maxTokensintegerstring

repetitionPenaltynumberstring

typeobject

Use DeepSeek models

apiKey*string

modelName*string

baseUrlstring

Defaulthttps://api.deepseek.com/v1

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.DeepSeekio.kestra.plugin.langchain4j.provider.DeepSeek

Use GitHub Models via Azure AI Inference

gitHubToken*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Use Google Gemini models

apiKey*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

embeddingModelConfiguration

io.kestra.plugin.ai.provider.GoogleGemini-EmbeddingModelConfiguration

maxRetriesintegerstring

outputDimensionalityintegerstring

taskTypestring

Possible Values

RETRIEVAL_QUERYRETRIEVAL_DOCUMENTSEMANTIC_SIMILARITYCLASSIFICATIONCLUSTERINGQUESTION_ANSWERINGFACT_VERIFICATION

timeoutstring

titleMetadataKeystring

typeobject

Possible Values

io.kestra.plugin.ai.provider.GoogleGeminiio.kestra.plugin.langchain4j.provider.GoogleGemini

Use Google Vertex AI models

endpoint*string

location*string

modelName*string

project*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.GoogleVertexAIio.kestra.plugin.langchain4j.provider.GoogleVertexAI

Use Hugging Face Inference endpoints

apiKey*string

modelName*string

baseUrlstring

Defaulthttps://router.huggingface.co/v1

caPemstring

clientPemstring

typeobject

Use LocalAI OpenAI-compatible server

baseUrl*string

modelName*string

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.LocalAIio.kestra.plugin.langchain4j.provider.LocalAI

Use Mistral models

apiKey*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.MistralAIio.kestra.plugin.langchain4j.provider.MistralAI

Use OCI Generative AI models

compartmentId*string

modelName*string

region*string

authProviderstring

baseUrlstring

caPemstring

clientPemstring

typeobject

Use local Ollama models

endpoint*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.Ollamaio.kestra.plugin.langchain4j.provider.Ollama

Use OpenAI models

apiKey*string

modelName*string

baseUrlstring

Defaulthttps://api.openai.com/v1

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.OpenAIio.kestra.plugin.langchain4j.provider.OpenAI

Use OpenRouter models

apiKey*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.OpenRouterio.kestra.plugin.langchain4j.provider.OpenRouter

Use IBM watsonx.ai models

apiKey*string

modelName*string

projectId*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Use Cloudflare Workers AI models

accountId*string

apiKey*string

modelName*string

baseUrlstring

caPemstring

clientPemstring

typeobject

Possible Values

io.kestra.plugin.ai.provider.WorkersAIio.kestra.plugin.langchain4j.provider.WorkersAI

Use ZhiPu AI models

apiKey*string

modelName*string

baseUrlstring

Defaulthttps://open.bigmodel.cn/

caPemstring

clientPemstring

maxRetriesintegerstring

maxTokenintegerstring

stopsarray

SubTypestring

typeobject

username *string

configuration

Default{}

Definitions

io.kestra.plugin.ai.domain.ChatConfiguration

logRequestsbooleanstring

logResponsesbooleanstring

maxTokenintegerstring

responseFormat

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

jsonSchemaobject

jsonSchemaDescriptionstring

typestring

DefaultTEXT

Possible Values

TEXTJSON

returnThinkingbooleanstring

seedintegerstring

temperaturenumberstring

thinkingBudgetTokensintegerstring

thinkingEnabledbooleanstring

topKintegerstring

topPnumberstring

driver string

jdbcUrl string

maxPoolSize integerstring

Default2

Run DeepSeek chat and JSON completions

Tasks that call DeepSeek chat models for conversational or schema-guided JSON responses.

Perplexity

Tasks that request chat completions from Perplexity models.

Google Cloud

Execute tasks and orchestrate workflows across Google Cloud Platform services. Centralize authentication and resource management for seamless GCP integration.

CloudDataInfrastructureAI

SqlDatabaseRetriever

More Plugins in this Category

Run DeepSeek chat and JSON completions

Perplexity

Google Cloud

1.6.0