Loading...
Loading...
Toolkit-first AIClient patterns for generation, text-to-sql, and response parsing.
npx skill4agent add stahura/domo-ai-vibe-rules cap-apps-ai-service-layerAIClient@domoinc/toolkitLegacy endpoint-first guidance has been archived to.archive/legacy-rules/domo-ai-endpoints.md
yarn add @domoinc/toolkitimport { AIClient } from '@domoinc/toolkit';AIClientconst ai = new AIClient();
await ai.text_to_sql('...');await AIClient.text_to_sql('...');const response = await AIClient.generate_text(
'Explain this sales trend in simple terms',
{ template: 'You are a business analyst. ${input}' },
{ tone: 'professional' },
undefined,
{ temperature: 0.7 }
);
const body = response.data || response.body || response;
const text = body.output || body.choices?.[0]?.output;text_to_sqlawait AIClient.text_to_sql('Show top vendors by spend', {
dataSourceName: 'vendorPayments',
columns: [{ name: 'amount', type: 'number' }]
});await AIClient.text_to_sql('Show top vendors by spend', [
{
dataSourceName: 'vendorPayments',
description: 'Vendor payment invoices',
columns: [
{ name: 'vendor', type: 'string' },
{ name: 'amount', type: 'number' },
{ name: 'date', type: 'date' }
]
}
]);AIClient.text_to_sql(
input: string,
dataSourceSchemas?: DataSourceSchema[], // array
promptTemplate?: any,
parameters?: Record<string, string>,
model?: string,
modelConfiguration?: Record<string, Object>
): Promise<Response<TextAIResponse>>;text_to_sql/sql/v1/data/v1@domoinc/queryconst sqlResult = await AIClient.text_to_sql('Show total sales by region', [
{
dataSourceName: 'Sales',
description: 'Sales transactions',
columns: [{ name: 'region', type: 'string' }, { name: 'amount', type: 'number' }]
}
]);
const beastModeResult = await AIClient.text_to_beastmode(
'Calculate year over year growth percentage',
{ dataSourceName: 'Revenue', columns: [{ name: 'revenue', type: 'number' }, { name: 'date', type: 'date' }] }
);AIClientresponse.dataoutputchoicesconst body = response?.data ?? response?.body ?? response;
const outputCandidate = body?.output ?? body?.choices?.[0]?.output;
const output = typeof outputCandidate === 'string' ? outputCandidate.trim() : '';
if (!output) throw new Error('AI returned no usable output');.cursor/rules/04-toolkit.mdc.cursor/rules/09-gotchas.mdcAIClientgenerate_texttext_to_sqlAIClientAIClient.text_to_sql(...)AIClient.text_to_sqlDataSourceSchema[]databody