Copyright IBM Corp. 2023, 2024

wxflows SDK

The wxflows sofware development kit (SDK) enables you to set up a client to query an endpoint from wxflows AI with Retrieval-Augmented Generation (RAG) and Generative AI (GenAI) models.

Installing

npm install wxflows

Import into Project

import wxflows from 'wxflows' // const wxflows = require('wxflows')

async function getData() {
  const model = new wxflows({
    endpoint: process.env.ENDPOINT,
    apikey: process.env.APIKEY,
  })

  console.log('model', model)
}

getData()

Test the SDK Locally

Clone the repository

Build

Install the modules, build the typescript files

npm install
npm run build

Test

To execute the script.js file, test the module.

npm install dotenv node-fetch
cp .env.sample .env
npm run test

Export

To pack the sdk for export

npm pack

Import the wxflows-<version>.tgz file into your package.json

"dependencies": {
    "wxflows": "file:wxflows-<version>.tgz"
},