OpenFn / OpenFn/apollo

vocab mapper: allow all keys to be passed by the client

Open
#152 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

The vocab mapper currently expects an anthropic API key to be passed by the client request.

We should also enable the pinecone and openai keys to be passed in the request object too. It sort of looks like this is supposed to work in the vocab_mapper main function, but while the keys are tested they aren't fed through to the vectorstore.

Now, in the long run, it makes sense for client to send their anthropic and openai keys directly, because that basically let them pay for themselves.

Pinecone is a bit harder to justify, because the pinecone API key needs to give access to the embeddings database which loaded the datasets. In the short-medium term WE own this an WE control the embeddings, so this has to come from the Apollo server.

But enabling the pinecone key to be passed would let us work around #151 and get the demo working

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the vocab_mapper main function and trace how request keys reach the vectorstore; the issue says the keys are tested but are not passed through. Review the existing key tests and the Apollo server path. Done means Anthropic and OpenAI client keys, plus the appropriately sourced Pinecone key, reach their intended consumers and the demo workaround for #151 works.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
api, backend, databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.