Skip to main content

Refiner CLI allows you to store text as vectors in Pinecone and then search for similar text. It uses OpenAI to generate embeddings and then uses Pinecone to store and search for similar text.

Project description

refiner-cli

CLI for the Refiner python package convert and store text and metadata as vector embeddings. Embeddings are generated using OpenAI and stored as vectors in Pinecone. Stored embeddings can then be "queried" using the search command. Matched embeddings contain contextually relavant metadata that can be used for AI chatbots, semnatic search APIs, and can also be used for training and tuning large language models.

Installation

pip install refiner-cli

OpenAI and Pinecone API Keys.

You'll need API keys for OpenAI and Pinecone.

Once you have your API keys, you can either set local ENV variables in a shell:

export PINECONE_API_KEY="API_KEY"
export PINECONE_ENVIRONMENT_NAME="ENV_NAME"
export OPENAI_API_KEY="API_KEY"

or you can create a .env (dotenv) config file and pass it in with the --config-file option.

Your .env file should follow key/value format:

PINECONE_API_KEY="API_KEY"
PINECONE_ENVIRONMENT_NAME="ENV_NAME"
OPENAI_API_KEY="API_KEY"

Help

The --help option can be used to learn about the create and search commands.

refiner --help
refiner create --help
refiner search --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

refiner-cli-0.0.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

refiner_cli-0.0.2-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file refiner-cli-0.0.2.tar.gz.

File metadata

  • Download URL: refiner-cli-0.0.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for refiner-cli-0.0.2.tar.gz
Algorithm Hash digest
SHA256 1be2ca66e128cd9f1b2baa52dc7f76b7c158b5dc3fd98094ff0f6e925584fd98
MD5 d29592f6b530f58858af4a825f06c044
BLAKE2b-256 9fd31ae234c5ce58331f8681ddf4f4cc3ca8b765aaddc2254a03b30177d29b92

See more details on using hashes here.

File details

Details for the file refiner_cli-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: refiner_cli-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for refiner_cli-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2e8b453f004a16cf7f8e331f5fea96af584ce2ffbf1bee7432fa0251f0604fb7
MD5 fa93694adb0df19bbae7dc6f2c33bfec
BLAKE2b-256 ebd418843ba2e1494ece042f4d3bd16618b63f60d22d557cb9e6318117ff43ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page