SDK for interacting with the AI Services API's such as Text Generation and Text to SQL

Example Text Generation Usage

import { AIClient } from '@domoinc/toolkit';

interface PromptTemplate {
template: string;
}

interface Context {
input: string;
promptTemplate?: PromptTemplate;
parameters?: Record<string, string>;
model?: string;
modelConfiguration?: Record<string, Object>;
}
const aiClient = new AIClient<Context>();

const generateText = async (input: string, promptTemplate?: PromptTemplate, parameters?: Record<string, string>, model?: string, modelConfiguration?: Record<string, Object>) =>
aiClient.generate_text(input, promptTemplate, parameters, model, modelConfiguration);

Example Text To SQL Usage

import { AIClient } from '@domoinc/toolkit';

interface PromptTemplate {
template: string;
}

interface DataSourceSchema {
dataSourceName: string;
description: string;
columns: Column[];
}


const aiClient = new AIClient<aiClient>();

const textToSQL = async (input: string, dataSourceSchemas: DataSourceSchema[], promptTemplate?: PromptTemplate, parameters?: Record<string, string>, model?: string, modelConfiguration?: Record<string, Object>) =>
aiClient.text_to_sql(input, dataSourceSchemas, promptTemplate, parameters, model, modelConfiguration);

Hierarchy

  • AIClient

Constructors

Properties

headers: {
    Content-type: any;
    accept: any;
} = ...

Type declaration

  • Content-type: any
  • accept: any

Methods

  • Parameters

    • input: string
    • Optional promptTemplate: any
    • Optional parameters: Record<string, string>
    • Optional model: string
    • Optional modelConfiguration: Record<string, Object>

    Returns Promise<Response<TextAIResponse>>

  • Parameters

    • input: string
    • Optional promptTemplate: any
    • Optional parameters: Record<string, string>
    • Optional model: string
    • Optional modelConfiguration: Record<string, Object>
    • Optional system: string
    • Optional chatContext: any
    • Optional chunkingConfiguration: any
    • Optional outputStyle: any
    • Optional outputWordLength: any

    Returns Promise<Response<TextAIResponse>>

  • Parameters

    • input: string
    • Optional dataSourceSchema: any
    • Optional promptTemplate: any
    • Optional parameters: Record<string, string>
    • Optional model: string
    • Optional modelConfiguration: Record<string, Object>
    • Optional system: string
    • Optional chatContext: any

    Returns Promise<Response<TextAIResponse>>

  • Parameters

    • input: string
    • Optional dataSourceSchemas: DataSourceSchema[]
    • Optional promptTemplate: any
    • Optional parameters: Record<string, string>
    • Optional model: string
    • Optional modelConfiguration: Record<string, Object>

    Returns Promise<Response<TextAIResponse>>

Generated using TypeDoc