SqlDatabaseRetriever
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 *Requiredstring
Possible Values
POSTGRESQLMYSQLH2password *Requiredstring
provider *RequiredNon-dynamic
Definitions
Amazon Bedrock Model Provider
accessKeyId*Requiredstring
modelName*Requiredstring
secretAccessKey*Requiredstring
baseUrlstring
caPemstring
clientPemstring
modelTypestring
Default
COHEREPossible Values
COHERETITANtypeobject
Anthropic AI Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
maxTokensintegerstring
typeobject
Azure OpenAI Model Provider
endpoint*Requiredstring
modelName*Requiredstring
apiKeystring
baseUrlstring
caPemstring
clientIdstring
clientPemstring
clientSecretstring
serviceVersionstring
tenantIdstring
typeobject
DashScope (Qwen) Model Provider from Alibaba Cloud
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Default
https://dashscope-intl.aliyuncs.com/api/v1caPemstring
clientPemstring
enableSearchbooleanstring
maxTokensintegerstring
repetitionPenaltynumberstring
typeobject
Deepseek Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Default
https://api.deepseek.com/v1caPemstring
clientPemstring
typeobject
GitHub Models AI Model Provider
gitHubToken*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
Google Gemini Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
embeddingModelConfiguration
io.kestra.plugin.ai.provider.GoogleGemini-EmbeddingModelConfiguration
maxRetriesintegerstring
outputDimensionalityintegerstring
taskTypestring
Possible Values
RETRIEVAL_QUERYRETRIEVAL_DOCUMENTSEMANTIC_SIMILARITYCLASSIFICATIONCLUSTERINGQUESTION_ANSWERINGFACT_VERIFICATIONtimeoutstring
Format
durationtitleMetadataKeystring
typeobject
Google VertexAI Model Provider
endpoint*Requiredstring
location*Requiredstring
modelName*Requiredstring
project*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
HuggingFace Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Default
https://router.huggingface.co/v1caPemstring
clientPemstring
typeobject
LocalAI Model Provider
baseUrl*Requiredstring
modelName*Requiredstring
caPemstring
clientPemstring
typeobject
Mistral AI Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
OciGenAI Model Provider
compartmentId*Requiredstring
modelName*Requiredstring
region*Requiredstring
authProviderstring
baseUrlstring
caPemstring
clientPemstring
typeobject
Ollama Model Provider
endpoint*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
OpenAI Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Default
https://api.openai.com/v1caPemstring
clientPemstring
typeobject
OpenRouter Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
Watsonx AI Model Provider
apiKey*Requiredstring
modelName*Requiredstring
projectId*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
WorkersAI Model Provider
accountId*Requiredstring
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
ZhiPu AI Model Provider
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Default
https://open.bigmodel.cn/caPemstring
clientPemstring
maxRetriesintegerstring
maxTokenintegerstring
stopsarray
SubTypestring
typeobject
username *Requiredstring
configuration Non-dynamic
Default
{} Definitions
io.kestra.plugin.ai.domain.ChatConfiguration
logRequestsbooleanstring
logResponsesbooleanstring
maxTokenintegerstring
responseFormat
io.kestra.plugin.ai.domain.ChatConfiguration-ResponseFormat
jsonSchemaobject
jsonSchemaDescriptionstring
typestring
Default
TEXTPossible Values
TEXTJSONreturnThinkingbooleanstring
seedintegerstring
temperaturenumberstring
thinkingBudgetTokensintegerstring
thinkingEnabledbooleanstring
topKintegerstring
topPnumberstring
driver string
jdbcUrl string
maxPoolSize integerstring
Default
2