SqlDatabaseRetriever SqlDatabaseRetriever
SqlDatabaseRetriever Certified

yaml
type: "io.kestra.plugin.ai.retriever.SqlDatabaseRetriever"
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
Possible Values
POSTGRESQLMYSQLH2
Definitions
accessKeyId*Requiredstring
modelName*Requiredstring
secretAccessKey*Requiredstring
baseUrlstring
caPemstring
clientPemstring
modelTypestring
DefaultCOHERE
Possible Values
COHERETITAN
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
maxTokensintegerstring
typeobject
endpoint*Requiredstring
modelName*Requiredstring
apiKeystring
baseUrlstring
caPemstring
clientIdstring
clientPemstring
clientSecretstring
serviceVersionstring
tenantIdstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Defaulthttps://dashscope-intl.aliyuncs.com/api/v1
caPemstring
clientPemstring
enableSearchbooleanstring
maxTokensintegerstring
repetitionPenaltynumberstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Defaulthttps://api.deepseek.com/v1
caPemstring
clientPemstring
typeobject
gitHubToken*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
embeddingModelConfiguration
maxRetriesintegerstring
outputDimensionalityintegerstring
taskTypestring
Possible Values
RETRIEVAL_QUERYRETRIEVAL_DOCUMENTSEMANTIC_SIMILARITYCLASSIFICATIONCLUSTERINGQUESTION_ANSWERINGFACT_VERIFICATION
timeoutstring
Formatduration
titleMetadataKeystring
typeobject
endpoint*Requiredstring
location*Requiredstring
modelName*Requiredstring
project*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Defaulthttps://router.huggingface.co/v1
caPemstring
clientPemstring
typeobject
baseUrl*Requiredstring
modelName*Requiredstring
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
compartmentId*Requiredstring
modelName*Requiredstring
region*Requiredstring
authProviderstring
baseUrlstring
caPemstring
clientPemstring
typeobject
endpoint*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Defaulthttps://api.openai.com/v1
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
projectId*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
accountId*Requiredstring
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
caPemstring
clientPemstring
typeobject
apiKey*Requiredstring
modelName*Requiredstring
baseUrlstring
Defaulthttps://open.bigmodel.cn/
caPemstring
clientPemstring
maxRetriesintegerstring
maxTokenintegerstring
stopsarray
SubTypestring
typeobject
Default{}
Definitions
logRequestsbooleanstring
logResponsesbooleanstring
maxTokenintegerstring
responseFormat
jsonSchemaobject
jsonSchemaDescriptionstring
typestring
DefaultTEXT
Possible Values
TEXTJSON
returnThinkingbooleanstring
seedintegerstring
temperaturenumberstring
thinkingBudgetTokensintegerstring
thinkingEnabledbooleanstring
topKintegerstring
topPnumberstring
Default2