RFC Cleanup Configuration and naming

[Flux159]

RFC Cleanup Configuration and naming

The initialization code is really verbose - configuration can just be an object & be initialized directly with LastMile

Currently:

import { Configuration, LastMileAIApi} from "lastmileai";

const configuration = new Configuration({
  apiKey: process.env.LASTMILEAI_API_KEY ?? "",
});
const lastmile = new LastMileAIApi(configuration);

const completion = await lastmile.createOpenAICompletion({
  completionParams: {
    model: "text-davinci-003",
    prompt: "Your prompt here",
  },
  embeddingCollectionId: "clfpqyvpp004npmzgp1d4j4fw",
});

Can become:

import { LastMile } from "lastmileai";

const lastmile = new LastMile({apiKey: process.env.LASTMILEAI_API_KEY ?? ""});

const completion = await lastmile.createOpenAICompletion({
  completionParams: {
    model: "text-davinci-003",
    prompt: "Your prompt here",
  },
  embeddingCollectionId: "clfpqyvpp004npmzgp1d4j4fw",
});

---

Stack created with Sapling. Best reviewed with ReviewStack.

• -> RFC Cleanup Configuration and naming #2
• Use javascript for code syntax highlighting in README #1

[rholinshead]

I think this is fine. We can revisit the class later if additional configuration setup is needed instead of pushing more into the api class.

After removing the unused interface can you run the doc generation (npx typedoc index.ts) to keep it in sync?

[rholinshead]

Can remove ConfigurationParameters as unused

[Flux159]

Updated docs & tests, but I'm having trouble running the tests successfully, don't know if it's because of jest or something else:

Node.js v20.0.0
node:internal/child_process/serialization:159
    const string = JSONStringify(message) + '\n';
                   ^

TypeError: Converting circular structure to JSON
    --> starting at object with constructor 'Object'
    |     property 'res' -> object with constructor 'Object'
    --- property 'req' closes the circle
    at stringify (<anonymous>)
    at writeChannelMessage (node:internal/child_process/serialization:159:20)
    at process.target._send (node:internal/child_process:845:17)
    at process.target.send (node:internal/child_process:745:19)
    at reportSuccess (/Users/suyogsonwalkar/Projects/company/lastmileai-node/node_modules/jest-worker/build/workers/processChild.js:82:11)

Did you see that before?

[rholinshead]

Updated docs & tests, but I'm having trouble running the tests successfully, don't know if it's because of jest or something else:

Node.js v20.0.0
node:internal/child_process/serialization:159
    const string = JSONStringify(message) + '\n';
                   ^

TypeError: Converting circular structure to JSON
    --> starting at object with constructor 'Object'
    |     property 'res' -> object with constructor 'Object'
    --- property 'req' closes the circle
    at stringify (<anonymous>)
    at writeChannelMessage (node:internal/child_process/serialization:159:20)
    at process.target._send (node:internal/child_process:845:17)
    at process.target.send (node:internal/child_process:745:19)
    at reportSuccess (/Users/suyogsonwalkar/Projects/company/lastmileai-node/node_modules/jest-worker/build/workers/processChild.js:82:11)

Did you see that before?

I haven't seen that before, no. I don't have jest globally, just do npm run test (or npx jest) -- does that work?

[rholinshead]

In any case, I pulled this and ran the tests successfully on my end

[Flux159]

In any case, I pulled this and ran the tests successfully on my end

I'm running vianpm run test, was able to get around the circular dep thing by using "--runInBand" (found here: jestjs/jest#10577 (comment)) ; the really weird thing is that I can't get the API key passed, so the tests at trials & embeddings are failing because Authorization Bearer is empty. For some reason jest isn't taking environment vars from my shell and can't figure out why

[Flux159]

Okay, got it working weirdly:

LASTMILEAI_API_KEY=$LASTMILEAI_API_KEY npm run test

Essentially forcing npm test to also have the api key passed in... also using jest --runInBand

Edit: Feel like I should've done the docs changes on a diff on top lol - sorry