Skip to content

RelevanceAI/relevance-chain-sdk

Repository files navigation

Relevance AI Chain SDK

Relevance AI stack

npm GitHub commit activity Discord Twitter Follow

The managed, developer-first SDK for building LLM chains.

🔨 Installation

Get started with the SDK and CLI by installing it with the following line:

npm i -g @relevanceai/chain

🏃‍♀️ Quickstart

Authenticate into your Relevance AI account

relevance login

Create a /chains folder with a file for each chain

/chains
- pdf-qa.ts
- generate-sql.ts
- generate-configs.ts

Represent the chain in code exporting defineChain and configure the chain. The first argument is a config of the chain and the input schema. The second argument is the setup function which is used to define the chain with each step.

import { defineChain } from '@relevanceai/chain';

export default defineChain(
    {
        title: 'PDF Q&A',
        params: {
            question: { type: 'string' },
            file_url: { type: 'string' }
        }
    },
    setup(({ params, step }) => {
        const { question, file_url } = params;

        const { text } = step('pdf_to_text', { file_url });
        const { answer } = step('prompt_completion', { 
            prompt: `${text}\n Based on the above context, answer the question ${question}` 
        });

        return {
            answer
        };
    })
});

Deploy the chains

relevance deploy

Documentation

See our full documentation here.

Re-generating & publishing transformation types

Run scripts/update-codegen.sh and publish the draft release that gets created.