Ax Framework

Building intelligent agents is a breeze with the Ax framework, inspired by the power of “Agentic workflows” and the Stanford DSPy paper. It seamlessly integrates with multiple LLMs and VectorDBs to build RAG pipelines or collaborative agents that can solve complex problems. Plus, it offers advanced features like streaming validation, multi-modal DSPy, etc.

Large language models (LLMs) are becoming really powerful and have reached a point where they can work as the backend for your entire product. However, there’s still a lot of complexity to manage from using the correct prompts, models, streaming, function calls, error correction, and much more. We aim help manage this complexity via this easy-to-use library that can work with all state-of-the-art LLMs. Additionally, we are using the latest research to add new capabilities like DSPy to the library.

Install

With NPM

npm install @ax-llm/ax

With Yarn

yarn add @ax-llm/ax

Features

• Support for various LLMs and Vector DBs
• Prompts auto-generated from simple signatures
• Build Agents that can call other agents
• Convert docs of any format to text
• RAG, smart chunking, embedding, querying
• Works with Vercel AI SDK
• Output validation while streaming
• Multi-modal DSPy supported
• Automatic prompt tuning using optimizers
• OpenTelemetry tracing / observability
• Production ready Typescript code
• Lite weight, zero-dependencies

Quick Start

1. Pick an AI to work with

// Pick a LLM
const ai = new AxOpenAI({ apiKey: process.env.OPENAI_APIKEY } as AxOpenAIArgs);

2. Create a prompt signature based on your usecase

// Signature defines the inputs and outputs of your prompt program
const cot = new AxGen(ai, `question:string -> answer:string`, { mem });

3. Execute this new prompt program

// Pass in the input fields defined in the above signature
const res = await cot.forward({ question: 'Are we in a simulation?' });

4. Or if you just want to directly use the LLM

const res = await ai.chat([
  { role: "system", content: "Help the customer with his questions" }
  { role: "user", content: "I'm looking for a Macbook Pro M2 With 96GB RAM?" }
]);

Reach out

https://twitter.com/dosco

Efficient type-safe prompts are auto-generated from a simple signature. A prompt signature is made up of a "task description" inputField:type "field description" -> "outputField:type. The idea behind prompt signatures is based on work done in the “Demonstrate-Search-Predict” paper.

You can have multiple input and output fields, and each field can be of the types string, number, boolean, date, datetime, class "class1, class2", JSON, or an array of any of these, e.g., string[]. When a type is not defined, it defaults to string. The underlying AI is encouraged to generate the correct JSON when the JSON type is used.

Output Field Types

Type	Description	Usage	Example Output
string	A sequence of characters.	fullName:string	"example"
number	A numerical value.	price:number	42
boolean	A true or false value.	isEvent:boolean	true, false
date	A date value.	startDate:date	"2023-10-01"
datetime	A date and time value.	createdAt:datetime	"2023-10-01T12:00:00Z"
class "class1,class2"	A classification of items.	category:class	["class1", "class2", "class3"]
string[]	An array of strings.	tags:string[]	["example1", "example2"]
number[]	An array of numbers.	scores:number[]	[1, 2, 3]
boolean[]	An array of boolean values.	permissions:boolean[]	[true, false, true]
date[]	An array of dates.	holidayDates:date[]	["2023-10-01", "2023-10-02"]
datetime[]	An array of date and time values.	logTimestamps:datetime[]	["2023-10-01T12:00:00Z", "2023-10-02T12:00:00Z"]
class[] "class1,class2"	Multiple classes	categories:class[]	["class1", "class2", "class3"]

Ax supports all the top LLM providers and models, along with their advanced capabilities, such as function calling, multi-modal, streaming, and JSON.

Our defaults, including default models, are selected to ensure solid agent performance.

OpenAI

const ai = new AxAI({
  name: 'openai',
  apiKey: process.env.OPENAI_APIKEY as string
});

const ai = new AxAI({
 name: 'openai',
 apiKey: process.env.OPENAI_APIKEY as string
 config: {
    model: AxAIOpenAIModel.GPT4Turbo,
    embedModel: AxAIOpenAIEmbedModel.TextEmbedding3Small
    temperature: 0.1,
 }
});

Azure OpenAI

Azure requires you to set a resource name and a deployment name

https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal

const ai = new AxAI({
  name: 'azure-openai',
  apiKey: process.env.AZURE_OPENAI_APIKEY as string,
  resourceName: 'test-resource',
  deploymentName: 'test-deployment'
});

Together

Together runs a diverse array of open-source models, each designed for a specific use case. This variety ensures that you can find the perfect model for your needs.

https://docs.together.ai/docs/inference-models

const ai = new AxAI({
  name: 'together',
  apiKey: process.env.TOGETHER_APIKEY as string,
  config: {
    model: 'Qwen/Qwen1.5-0.5B-Chat'
  }
});

Anthropic

const ai = new AxAI({
  name: 'anthropic',
  apiKey: process.env.ANTHROPIC_APIKEY as string
});

Groq

Groq uses specialized hardware to serve open-source models with the lowest latency. It supports a small number of good models.

const ai = new AxAI({
  name: 'groq',
  apiKey: process.env.GROQ_APIKEY as string
});

Google Gemini

An excellent model family with very long context lengths at the lowest price points. Gemini has built-in support for compute (code execution); their models can write and run code in the backend if needed.

const ai = new AxAI({
  name: 'google-gemini',
  apiKey: process.env.GOOGLE_GEMINI_APIKEY as string
  options: { codeExecution: true }
});

Cohere

const ai = new AxAI({
  name: 'cohere',
  apiKey: process.env.COHERE_APIKEY as string
});

Mistral

const ai = new AxAI({
  name: 'mistral',
  apiKey: process.env.MISTRAL_APIKEY as string
});

Deepseek

Deepseek is an LLM provider from China that has excellent models.

const ai = new AxAI({
  name: 'deepseek',
  apiKey: process.env.DEEPSEEK_APIKEY as string
});

Ollama

Ollama is an engine for running open-source models locally on your laptop. We default to nous-hermes21 for inference and all-minilm for embedding.

const ai = new AxAI({
  name: 'ollama',
  apiKey: process.env.DEEPSEEK_APIKEY as string,
  url: 'http://localhost:11434'
  config: { model: 'nous-hermes2', embedModel: 'all-minilm' }
});

Huggingface

const ai = new AxAI({
  name: 'huggingface',
  apiKey: process.env.HF_APIKEY as string
});

Pick an LLM

Ax is a zero-dependency framework. Every LLM API integration we build is solid, works well with Ax, and supports all required features, such as function calling, multi-modal, JSON, streaming, etc.

Currently we support "openai" | "azure-openai" | "together" | "anthropic" | "groq" | "google-gemini" | "cohere" | "huggingface" | "mistral" | "deepseek" | "ollama"

const ai = new AxAI({
  name: 'openai',
  apiKey: process.env.OPENAI_APIKEY as string
});

The LLMs are pre-configured with sensible defaults such as models and other conifgurations such as topK, temperature, etc

Prompting

Prompts are usually stressful and complex. You never know what the right prompt is, and blobs of text in your code are hard to deal with. We fix this by adopting the prompt signatures from the popular Stanford DSPy paper.

A prompt signature is a list of typed input and output fields along with a task description prefix. the following fields are supported 'string' | 'number' | 'boolean' | 'json' | 'image' | 'audio' add a [] to convert a field into an array field eg. string[], number[], etc. Additionally a ? marks the field as an optional field context?:string.

Summarize some text

textToSummarize -> shortSummary "summarize in 5 to 10 words"

Answer questions using a multi-modal prompt that takes a question and an image

"answer biology questions about animals"
question:string, animalImage:image -> answer:string

A prompt that ensures the response is a numeric list

"Rate the quality of each answer on a scale of 1 to 10 against the question"
question:string, answers:string[] -> rating:number[]

Putting it all together

Use the above AI and a prompt to build an LLM-powered program to summarize the text.

// example.ts
import { AxAI, AxChainOfThought } from '@ax-llm/ax';

const textToSummarize = `
The technological singularity—or simply the singularity[1]—is a hypothetical 
future point in time at which technological growth becomes uncontrollable 
and irreversible, resulting in unforeseeable changes to human 
civilization.[2][3] ...`;

const ai = new AxAI({
  name: 'openai',
  apiKey: process.env.OPENAI_APIKEY as string
});

const gen = new AxChainOfThought(`textToSummarize -> shortSummary "summarize in 5 to 10 words"`);
const res = await gen.forward(ai, { textToSummarize });

console.log(res);

tsx example.ts

{
    shortSummary: "The technological singularity refers to a
    hypothetical future scenario where technological..."
}

Build your first agent

Ax makes it really simple to build agents. An agent requires a name, description and signature. it can optionally use functions and other agents.

Example Stock Analyst Agent The Stock Analyst Agent is an advanced AI-powered tool that provides comprehensive stock analysis and financial insights. It combines multiple specialized sub-agents and functions to deliver in-depth evaluations of stocks, market trends, and related financial data.

This is only an example, but it highlights the power of agentic workflows, where you can build agents who work with agents to handle complex tasks.

const agent = new AxAgent({
  name: 'Stock Analyst',
  description:
    'An AI agent specialized in analyzing stocks, market trends, and providing financial insights.',
  signature: `
    stockSymbol:string, 
    analysisType:string "fundamental, technical or sentiment" -> analysisReport`,
  functions: [
    getStockData,
    calculateFinancialRatios,
    analyzeTechnicalIndicators,
    performSentimentAnalysis
  ],
  agents: [
    financialDataCollector,
    marketTrendAnalyzer,
    newsAnalyzer,
    sectorAnalyst,
    competitorAnalyzer,
    riskAssessor,
    valuationExpert,
    economicIndicatorAnalyzer,
    insiderTradingMonitor,
    esgAnalyst
  ]
});

Example of agents working with other agents

// ./src/examples/agent.ts

const researcher = new AxAgent({
  name: 'researcher',
  description: 'Researcher agent',
  signature: `physicsQuestion "physics questions" -> answer "reply in bullet points"`
});

const summarizer = new AxAgent({
  name: 'summarizer',
  description: 'Summarizer agent',
  signature: `text "text so summarize" -> shortSummary "summarize in 5 to 10 words"`
});

const agent = new AxAgent({
  name: 'agent',
  description: 'A an agent to research complex topics',
  signature: `question -> answer`,
  agents: [researcher, summarizer]
});

agent.forward({ questions: 'How many atoms are there in the universe' });

Vector databases are critical to building LLM workflows. We have clean abstractions over popular vector databases and our own quick in-memory vector database.

Provider	Tested
In Memory	🟢 100%
Weaviate	🟢 100%
Cloudflare	🟡 50%
Pinecone	🟡 50%

// Create embeddings from text using an LLM
const ret = await this.ai.embed({ texts: 'hello world' });

// Create an in memory vector db
const db = new axDB('memory');

// Insert into vector db
await this.db.upsert({
  id: 'abc',
  table: 'products',
  values: ret.embeddings[0]
});

// Query for similar entries using embeddings
const matches = await this.db.query({
  table: 'products',
  values: embeddings[0]
});

Alternatively you can use the AxDBManager which handles smart chunking, embedding and querying everything for you, it makes things almost too easy.

const manager = new AxDBManager({ ai, db });
await manager.insert(text);

const matches = await manager.query(
  'John von Neumann on human intelligence and singularity.'
);
console.log(matches);

RAG Documents

Using documents like PDF, DOCX, PPT, XLS, etc., with LLMs is a huge pain. We make it easy with Apache Tika, an open-source document processing engine.

Launch Apache Tika

docker run -p 9998:9998 apache/tika

Convert documents to text and embed them for retrieval using the AxDBManager, which also supports a reranker and query rewriter. Two default implementations, AxDefaultResultReranker and AxDefaultQueryRewriter, are available.

const tika = new AxApacheTika();
const text = await tika.convert('/path/to/document.pdf');

const manager = new AxDBManager({ ai, db });
await manager.insert(text);

const matches = await manager.query('Find some text');
console.log(matches);

When using models like GPT-4o and Gemini that support multi-modal prompts, we support using image fields, and this works with the whole DSP pipeline.

const image = fs
  .readFileSync('./src/examples/assets/kitten.jpeg')
  .toString('base64');

const gen = new AxChainOfThought(`question, animalImage:image -> answer`);

const res = await gen.forward(ai, {
  question: 'What family does this animal belong to?',
  animalImage: { mimeType: 'image/jpeg', data: image }
});

When using models like gpt-4o-audio-preview that support multi-modal prompts with audio support, we support using audio fields, and this works with the whole DSP pipeline.

const audio = fs
  .readFileSync('./src/examples/assets/comment.wav')
  .toString('base64');

const gen = new AxGen(`question, commentAudio:audio -> answer`);

const res = await gen.forward(ai, {
  question: 'What family does this animal belong to?',
  commentAudio: { format: 'wav', data: audio }
});

We support parsing output fields and function execution while streaming. This allows for fail-fast and error correction without waiting for the whole output, saving tokens and costs and reducing latency. Assertions are a powerful way to ensure the output matches your requirements; they also work with streaming.

// setup the prompt program
const gen = new AxChainOfThought(
  ai,
  `startNumber:number -> next10Numbers:number[]`
);

// add a assertion to ensure that the number 5 is not in an output field
gen.addAssert(({ next10Numbers }: Readonly<{ next10Numbers: number[] }>) => {
  return next10Numbers ? !next10Numbers.includes(5) : undefined;
}, 'Numbers 5 is not allowed');

// run the program with streaming enabled
const res = await gen.forward({ startNumber: 1 }, { stream: true });

The above example allows you to validate entire output fields as they are streamed in. This validation works with streaming and when not streaming and is triggered when the whole field value is available. For true validation while streaming, check out the example below. This will massively improve performance and save tokens at scale in production.

// add a assertion to ensure all lines start with a number and a dot.
gen.addStreamingAssert(
  'answerInPoints',
  (value: string) => {
    const re = /^\d+\./;

    // split the value by lines, trim each line,
    // filter out empty lines and check if all lines match the regex
    return value
      .split('\n')
      .map((x) => x.trim())
      .filter((x) => x.length > 0)
      .every((x) => re.test(x));
  },
  'Lines must start with a number and a dot. Eg: 1. This is a line.'
);

// run the program with streaming enabled
const res = await gen.forward(
  {
    question: 'Provide a list of optimizations to speedup LLM inference.'
  },
  { stream: true, debug: true }
);

npm i @ax-llm/ax-ai-sdk-provider

Then use it with the AI SDK, you can either use the AI provider or the Agent Provider

const ai = new AxAI({
    name: 'openai',
    apiKey: process.env['OPENAI_APIKEY'] ?? "",
});

// Create a model using the provider
const model = new AxAIProvider(ai);

export const foodAgent = new AxAgent({
  name: 'food-search',
  description:
    'Use this agent to find restaurants based on what the customer wants',
  signature,
  functions
})

// Get vercel ai sdk state
const aiState = getMutableAIState()

// Create an agent for a specific task
const foodAgent = new AxAgentProvider(ai, {
    agent: foodAgent,
    updateState: (state) => {
         aiState.done({ ...aiState.get(), state })
    },
    generate: async ({ restaurant, priceRange }) => {
        return (
            <BotCard>
                <h1>{restaurant as string} {priceRange as string}</h1>
            </BotCard>
        )
    }
})

// Use with streamUI a critical part of building chat UIs in the AI SDK
const result = await streamUI({
    model,
    initial: <SpinnerMessage />,
    messages: [
        // ...
    ],
    text: ({ content, done, delta }) => {
        // ...
    },
    tools: {
        // @ts-ignore
        'find-food': foodAgent,
    }
})

Demonstrate, search, predict, or DSPy is a now-famous Stanford paper focused on optimizing the prompting of LLMs. The basic idea is to provide examples instead of instructions.

Ax supports DSPy and allows you to set examples on each prompt. It also allows you to run an optimizer, which runs the prompt using inputs from a test set and validates the outputs against the same test set. In short, the optimizer helps you capture good examples across the entire tree of prompts your workflow is built with.

Pick a prompt strategy

There are various prompts available in Ax, pick one based on your needs.

1. Generate - Generic prompt that all other prompts inherit from.
2. ChainOfThough - Increasing performance by reasoning before providing the answer
3. RAG - Uses a vector database to add context and improve performance and accuracy.
4. Agent - For agentic workflows

Create a signature

A signature defines the task you want to do, the inputs you’ll provide, and the outputs you expect the LLM to generate.

const prompt = new AxGen(
`"Extract customer query details" customerMessage:string -> customerName, customerIssue, ,productName:string, troubleshootingAttempted?:string`)

The next optional but most important thing you can do to improve the performance of your prompts is to set examples. When we say “performance,” we mean the number of times the LLM does exactly what you expect correctly over the number of times it fails.

Examples are the best way to communicate to the LLM what you want it to do. The patterns you define in high-quality examples help the LLM much better than the instructions.

prompt.setExample([
    {
        customerMessage: "Hello, I'm Jane Smith. I'm having trouble with my UltraPhone X. The screen remains black even after restarting multiple times. I have tried charging it overnight and using a different charger.",
        customerName: "Jane Smith",
        productName: "UltraPhone X",
        troubleshootingAttempted: "Charging it overnight and using a different charger.",
    },
    {
        customerMessage: "Hi, my name is Michael Johnson. My EcoPrinter Pro isn't connecting to Wi-Fi. I've restarted the printer and my router, and also tried connecting via Ethernet cable.",
        customerName: "Michael Johnson",
        productName: "EcoPrinter Pro",
        troubleshootingAttempted: "Restarted the printer and router, and tried connecting via Ethernet cable.",
    },
    {
        customerMessage: "Greetings, I'm Sarah Lee. I'm experiencing issues with my SmartHome Hub. It keeps losing connection with my smart devices. I have reset the hub, checked my internet connection, and re-paired the devices.",
        customerName: "Sarah Lee",
        productName: "SmartHome Hub",
        troubleshootingAttempted: "Reset the hub, checked the internet connection, and re-paired the devices.",
    }
])

Use this prompt

You are now ready to use this prompt in your workflows.

# Setup the ai
const ai = new AxAI("openai", { apiKey: process.env.OPENAI_APIKEY })

# Execute the prompt
const { customerName, productName, troubleshootingAttempted } = prompt.forward(ai, { customerMessage })

Easy enough! this is all you need

DAP prompt tuning

What if I want more performance, or do I want to run this with a smaller model? I was told you can tune your prompts with DSPy. Yes, this is true. You can do this. In short, you can use a big LLM to generate better examples for every prompt you use in your entire flow of prompts.

// Use the HuggingFace data loader or create one for your own data
const hf = new AxHFDataLoader({
  dataset: 'yixuantt/MultiHopRAG',
  split: 'train',
  config: 'MultiHopRAG',
  options: { length: 5 }
});

await hf.loadData();

// Fetch some rows, map the data columns to your prompts inputs
const examples = await hf.getRows<{ question: string; answer: string }>({
  count: 20,
  fields: ['query', 'answer'],
  renameMap: { query: 'question', answer: 'answer' }
});

// Create your prompt
const prompt = new AxGen(`question -> answer`)

// Setup a Bootstrap Few Shot optimizer to tune the above prompt
const optimize = new AxBootstrapFewShot<
  { question: string },
  { answer: string }
>({
  prompt,
  examples
});

// Setup a evaluation metric em, f1 scores are a popular way measure retrieval performance.
const metricFn: AxMetricFn = ({ prediction, example }) => {
  return axEvalUtil.emScore(
    prediction.answer as string,
    example.answer as string
  );
};

// Run the optimizer
const result = await optimize.compile(metricFn);

// Save the results to use later
await fs.promises.writeFile('./qna-tune-demos.json', values);

// Use this tuning data in your workflow
const values = await fs.promises.readFile('./qna-tune-demos.json', 'utf8');
const demos = JSON.parse(values);

// Your done now, use this prompt
prompt.setDemos(demos);

In this guide, we’ll explain how to create functions, function classes, etc. that can be used in Ax. Creation focused functions with clear names and descriptions are critical to a solid workflow. Do not use too many functions on a prompt or make the function itself do too much. Focused functions are better. If you need to use several functions, then look into breaking down the task into multiple prompts or using agents.

Function definition simple

A function is an object with a name, and description along with a JSON schema of the function arguments and the function itself

// The function
const googleSearchAPI = async (query: string) => {
    const res = await axios.get("http://google.com/?q=" + query)
    return res.json()
}

// The function definition
const googleSearch AxFunction = {
    name: 'googleSearch',
    description: 'Use this function to search google for links related to the query',
    func: googleSearchAPI,
    parameters: {
        type: 'object',
         properties: {
             query: {
                description: `The query to search for`,
                type: 'string'
            },
        }
    }
}

Function definition as a class

Another way to define functions is as a class with a toFunction method.

class GoogleSearch {
    private apiKey: string;

    constructor(apiKey: string) {
        this.apiLey = apiKey;
    }


    async query(query: string) {
        const res = await axios.get("http://google.com/?q=" + query)
        return res.json()
    }

    async toFunction() {
        return {
            name: 'googleSearch',
            description: 'Use this function to search google for links related to the query',
            parameters: {
                type: 'object',
                properties: {
                    query: {
                        description: `The query to search for`,
                        type: 'string'
                    },
                }
            },
            func: (query: string) => this.query(query)
        }
    }
}

How to use these functions

Just set the function on the prompt

const prompt = new AxGen('inputs -> output', { functions: [ googleSearch ] })

Or in the case of function classes

const prompt = new AxGen('inputs -> output', { functions: [ new GoogleSearch(apiKey) ] })

Restaurant finding agent

Let’s create an agent to help find a restaurant based on the diner’s preferences. To do this, we’ll start by creating some dummy APIs specifically for this example. We’ll need a function to get the weather, and another one to look up places to eat at.

const choice = Math.round(Math.random());

const goodDay = {
  temperature: '27C',
  description: 'Clear Sky',
  wind_speed: 5.1,
  humidity: 56
};

const badDay = {
  temperature: '10C',
  description: 'Cloudy',
  wind_speed: 10.6,
  humidity: 70
};

// dummy weather lookup function
const weatherAPI = ({ location }: Readonly<{ location: string }>) => {
  const data = [
    {
      city: 'san francisco',
      weather: choice === 1 ? goodDay : badDay
    },
    {
      city: 'tokyo',
      weather: choice === 1 ? goodDay : badDay
    }
  ];

  return data
    .filter((v) => v.city === location.toLowerCase())
    .map((v) => v.weather);
};

// dummy opentable api
const opentableAPI = ({
  location
}: Readonly<{
  location: string;
  outdoor: string;
  cuisine: string;
  priceRange: string;
}>) => {
  const data = [
    {
      name: "Gordon Ramsay's",
      city: 'san francisco',
      cuisine: 'indian',
      rating: 4.8,
      price_range: '$$$$$$',
      outdoor_seating: true
    },
    {
      name: 'Sukiyabashi Jiro',
      city: 'san francisco',
      cuisine: 'sushi',
      rating: 4.7,
      price_range: '$$',
      outdoor_seating: true
    },
    {
      name: 'Oyster Bar',
      city: 'san francisco',
      cuisine: 'seafood',
      rating: 4.5,
      price_range: '$$',
      outdoor_seating: true
    },
    {
      name: 'Quay',
      city: 'tokyo',
      cuisine: 'sushi',
      rating: 4.6,
      price_range: '$$$$',
      outdoor_seating: true
    },
    {
      name: 'White Rabbit',
      city: 'tokyo',
      cuisine: 'indian',
      rating: 4.7,
      price_range: '$$$',
      outdoor_seating: true
    }
  ];

  return data
    .filter((v) => v.city === location?.toLowerCase())
    .sort((a, b) => {
      return a.price_range.length - b.price_range.length;
    });
};

The function parameters must be defined in JSON schema for the AI to read and understand.

// List of functions available to the AI
const functions: AxFunction[] = [
  {
    name: 'getCurrentWeather',
    description: 'get the current weather for a location',
    func: weatherAPI,
    parameters: {
      type: 'object',
      properties: {
        location: {
          description: 'location to get weather for',
          type: 'string'
        },
        units: {
          type: 'string',
          enum: ['imperial', 'metric'],
          description: 'units to use'
        }
      },
      required: ['location']
    }
  },
  {
    name: 'findRestaurants',
    description: 'find restaurants in a location',
    func: opentableAPI,
    parameters: {
      type: 'object',
      properties: {
        location: {
          description: 'location to find restaurants in',
          type: 'string'
        },
        outdoor: {
          type: 'boolean',
          description: 'outdoor seating'
        },
        cuisine: { type: 'string', description: 'cuisine type' },
        priceRange: {
          type: 'string',
          enum: ['$', '$$', '$$$', '$$$$'],
          description: 'price range'
        }
      },
      required: ['location', 'outdoor', 'cuisine', 'priceRange']
    }
  }
];

Let’s use this agent.

const customerQuery =
  "Give me an ideas for lunch today in San Francisco. I like sushi but I don't want to spend too much or other options are fine as well. Also if its a nice day I'd rather sit outside.";

const ai = new Ax({
  name: 'openai',
  apiKey: process.env.OPENAI_APIKEY as string
});

const agent = new AxAgent({
  name: 'Restaurant search agent'
  description:
    'Search for restaurants to dine at based on the weather and food preferences',
  signature:
    `customerQuery:string  -> restaurant:string, priceRange:string "use $ signs to indicate price range"`
    functions,
});

const res = await agent.forward(ai, { customerQuery });
console.log(res);

npm run tsx src/examples/food-search.ts

{
  restaurant: 'Sukiyabashi Jiro',
  priceRange: '$$'
}

Defined in: src/ax/ai/wrap.ts:80

Implements

• AxAIService

Constructors

new AxAI()

new AxAI(options): AxAI

Defined in: src/ax/ai/wrap.ts:83

Parameters

Parameter	Type
options	Readonly<AxAIArgs>

Returns

AxAI

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/wrap.ts:150

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Implementation of

AxAIService.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/wrap.ts:157

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Implementation of

AxAIService.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/wrap.ts:134

Returns

undefined | Readonly<AxModelInfoWithProvider>

Implementation of

AxAIService.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): object

Defined in: src/ax/ai/wrap.ts:138

Parameters

Parameter	Type
model?	string

Returns

object

functions

functions: boolean

streaming

streaming: boolean

Implementation of

AxAIService.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/wrap.ts:146

Returns

AxAIServiceMetrics

Implementation of

AxAIService.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/wrap.ts:130

Returns

Readonly<AxModelInfoWithProvider>

Implementation of

AxAIService.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/wrap.ts:142

Returns

undefined | AxAIModelMap

Implementation of

AxAIService.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/wrap.ts:126

Returns

string

Implementation of

AxAIService.getName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/wrap.ts:164

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Implementation of

AxAIService.setOptions

Defined in: src/ax/ai/anthropic/api.ts:287

Extends

• AxBaseAI<AxAIAnthropicChatRequest, unknown, AxAIAnthropicChatResponse, AxAIAnthropicChatResponseDelta, unknown>

Constructors

new AxAIAnthropic()

new AxAIAnthropic(__namedParameters): AxAIAnthropic

Defined in: src/ax/ai/anthropic/api.ts:294

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIAnthropicArgs, "name">>

Returns

AxAIAnthropic

Overrides

AxBaseAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxBaseAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxBaseAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxBaseAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxBaseAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxBaseAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxBaseAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxBaseAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxBaseAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxBaseAI.setOptions

Defined in: src/ax/ai/azure-openai/api.ts:34

Extends

• AxAIOpenAI

Constructors

new AxAIAzureOpenAI()

new AxAIAzureOpenAI(__namedParameters): AxAIAzureOpenAI

Defined in: src/ax/ai/azure-openai/api.ts:35

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIAzureOpenAIArgs, "name">>

Returns

AxAIAzureOpenAI

Overrides

AxAIOpenAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxAIOpenAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxAIOpenAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxAIOpenAI.setOptions

Defined in: src/ax/ai/cohere/api.ts:286

Extends

• AxBaseAI<AxAICohereChatRequest, AxAICohereEmbedRequest, AxAICohereChatResponse, AxAICohereChatResponseDelta, AxAICohereEmbedResponse>

Constructors

new AxAICohere()

new AxAICohere(__namedParameters): AxAICohere

Defined in: src/ax/ai/cohere/api.ts:293

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAICohereArgs, "name">>

Returns

AxAICohere

Overrides

AxBaseAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxBaseAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxBaseAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxBaseAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxBaseAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxBaseAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxBaseAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxBaseAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxBaseAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxBaseAI.setOptions

Defined in: src/ax/ai/google-gemini/api.ts:439

AxAIGoogleGemini: AI Service

Extends

• AxBaseAI<AxAIGoogleGeminiChatRequest, AxAIGoogleGeminiBatchEmbedRequest, AxAIGoogleGeminiChatResponse, AxAIGoogleGeminiChatResponseDelta, AxAIGoogleGeminiBatchEmbedResponse>

Constructors

new AxAIGoogleGemini()

new AxAIGoogleGemini(__namedParameters): AxAIGoogleGemini

Defined in: src/ax/ai/google-gemini/api.ts:446

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIGoogleGeminiArgs, "name">>

Returns

AxAIGoogleGemini

Overrides

AxBaseAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxBaseAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxBaseAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxBaseAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxBaseAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxBaseAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxBaseAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxBaseAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxBaseAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxBaseAI.setOptions

Defined in: src/ax/ai/deepseek/api.ts:34

Extends

• AxAIOpenAI

Constructors

new AxAIDeepSeek()

new AxAIDeepSeek(__namedParameters): AxAIDeepSeek

Defined in: src/ax/ai/deepseek/api.ts:35

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIDeepSeekArgs, "name">>

Returns

AxAIDeepSeek

Overrides

AxAIOpenAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxAIOpenAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxAIOpenAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxAIOpenAI.setOptions

Defined in: src/ax/ai/groq/api.ts:26

Extends

• AxAIOpenAI

Constructors

new AxAIGroq()

new AxAIGroq(__namedParameters): AxAIGroq

Defined in: src/ax/ai/groq/api.ts:27

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIGroqArgs, "groq">>

Returns

AxAIGroq

Overrides

AxAIOpenAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxAIOpenAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxAIOpenAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/groq/api.ts:59

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Overrides

AxAIOpenAI.setOptions

Defined in: src/ax/ai/huggingface/api.ts:155

Extends

• AxBaseAI<AxAIHuggingFaceRequest, unknown, AxAIHuggingFaceResponse, unknown, unknown>

Constructors

new AxAIHuggingFace()

new AxAIHuggingFace(__namedParameters): AxAIHuggingFace

Defined in: src/ax/ai/huggingface/api.ts:162

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIHuggingFaceArgs, "name">>

Returns

AxAIHuggingFace

Overrides

AxBaseAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxBaseAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxBaseAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxBaseAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxBaseAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxBaseAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxBaseAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxBaseAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxBaseAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxBaseAI.setOptions

Defined in: src/ax/ai/mistral/api.ts:31

Extends

• AxAIOpenAI

Constructors

new AxAIMistral()

new AxAIMistral(__namedParameters): AxAIMistral

Defined in: src/ax/ai/mistral/api.ts:32

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIMistralArgs, "name">>

Returns

AxAIMistral

Overrides

AxAIOpenAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxAIOpenAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxAIOpenAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxAIOpenAI.setOptions

Defined in: src/ax/ai/openai/api.ts:408

Extends

• AxBaseAI<AxAIOpenAIChatRequest, AxAIOpenAIEmbedRequest, AxAIOpenAIChatResponse, AxAIOpenAIChatResponseDelta, AxAIOpenAIEmbedResponse>

Extended by

• AxAIAzureOpenAI
• AxAIDeepSeek
• AxAIGroq
• AxAIMistral
• AxAIOllama
• AxAITogether

Constructors

new AxAIOpenAI()

new AxAIOpenAI(__namedParameters): AxAIOpenAI

Defined in: src/ax/ai/openai/api.ts:415

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIOpenAIArgs, "name">>

Returns

AxAIOpenAI

Overrides

AxBaseAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxBaseAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxBaseAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxBaseAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxBaseAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxBaseAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxBaseAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxBaseAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxBaseAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxBaseAI.setOptions

Defined in: src/ax/ai/ollama/api.ts:39

OllamaAI: AI Service

Extends

• AxAIOpenAI

Constructors

new AxAIOllama()

new AxAIOllama(__namedParameters): AxAIOllama

Defined in: src/ax/ai/ollama/api.ts:40

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIOllamaArgs, "name">>

Returns

AxAIOllama

Overrides

AxAIOpenAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxAIOpenAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxAIOpenAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxAIOpenAI.setOptions

Defined in: src/ax/ai/reka/api.ts:263

Extends

• AxBaseAI<AxAIRekaChatRequest, unknown, AxAIRekaChatResponse, AxAIRekaChatResponseDelta, unknown>

Constructors

new AxAIReka()

new AxAIReka(__namedParameters): AxAIReka

Defined in: src/ax/ai/reka/api.ts:270

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAIRekaArgs, "name">>

Returns

AxAIReka

Overrides

AxBaseAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxBaseAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxBaseAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxBaseAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxBaseAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxBaseAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxBaseAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxBaseAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxBaseAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxBaseAI.setOptions

Defined in: src/ax/ai/together/api.ts:25

Extends

• AxAIOpenAI

Constructors

new AxAITogether()

new AxAITogether(__namedParameters): AxAITogether

Defined in: src/ax/ai/together/api.ts:26

Parameters

Parameter	Type
__namedParameters	Readonly<Omit<AxAITogetherArgs, "name">>

Returns

AxAITogether

Overrides

AxAIOpenAI.constructor

Methods

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Defined in: src/ax/ai/base.ts:278

Parameters

Parameter	Type
req	Readonly<AxChatRequest>
options?	Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

---

embed()

embed(req, options?): Promise<AxEmbedResponse>

Defined in: src/ax/ai/base.ts:468

Parameters

Parameter	Type
req	Readonly<AxEmbedRequest>
options?	Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

---

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Defined in: src/ax/ai/base.ts:205

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

---

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Defined in: src/ax/ai/base.ts:229

Parameters

Parameter	Type
model?	string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

---

getMetrics()

getMetrics(): AxAIServiceMetrics

Defined in: src/ax/ai/base.ts:274

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAI.getMetrics

---

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Defined in: src/ax/ai/base.ts:193

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

---

getModelMap()

getModelMap(): undefined | AxAIModelMap

Defined in: src/ax/ai/base.ts:221

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

---

getName()

getName(): string

Defined in: src/ax/ai/base.ts:225

Returns

string

Inherited from

AxAIOpenAI.getName

---

setAPIURL()

setAPIURL(apiURL): void

Defined in: src/ax/ai/base.ts:167

Parameters

Parameter	Type
apiURL	string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

---

setHeaders()

setHeaders(headers): void

Defined in: src/ax/ai/base.ts:171

Parameters

Parameter	Type
headers	Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

---

setName()

setName(name): void

Defined in: src/ax/ai/base.ts:163

Parameters

Parameter	Type
name	string

Returns

void

Inherited from

AxAIOpenAI.setName

---

setOptions()

setOptions(options): void

Defined in: src/ax/ai/base.ts:175

Parameters

Parameter	Type
options	Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxAIOpenAI.setOptions