Skip to content
This repository was archived by the owner on Jul 16, 2024. It is now read-only.

Commit bcd2678

Browse files
committed
README fixed - Version 0.0.1
1 parent e8632ab commit bcd2678

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Pinecone + OpenAI Scala Client - Demo/Seed Project
22
[![version](https://img.shields.io/badge/version-0.0.1-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
33

4-
This is a ready-to-fork, example/demo project demonstrating how to use [Pinecone](https://github.com/cequence-io/pinecone-scala) with [OpenAI Scala Client](https://github.com/cequence-io/openai-scala-client) embeddings in Scala using two clients: [Pinecone](https://github.com/cequence-io/pinecone-scala) and [OpenAI Scala Client](https://github.com/cequence-io/openai-scala-client).
4+
This is a ready-to-fork, example/demo project demonstrating how to use [Pinecone](https://pinecone.io) vector database with [OpenAI](https://openai.com) embeddings in Scala using [Pinecone Scala Client](https://github.com/cequence-io/pinecone-scala) and [OpenAI Scala Client](https://github.com/cequence-io/openai-scala-client).
55

66
The demo app can be found in [PineconeOpenAIDemo](./src/main/scala/io/cequence/pineconeopenai/demo/PineconeOpenAIDemo.scala).
77
The following env. variables are expected:
@@ -10,7 +10,7 @@ The following env. variables are expected:
1010
- `OPENAI_SCALA_CLIENT_API_KEY`
1111
- `OPENAI_SCALA_CLIENT_ORG_ID` (optional)
1212

13-
**✔️ Important**: The demo uses data from [Trec dataset](https://cogcomp.seas.upenn.edu/Data/QA/QC/) created by Cognitive Computation Group at University of Pennsylvania, which we hereby acknowledge. Its training part is included in this project at [trec-train.json](./src/main/resources/trec-train.json) (downloaded using [this script](./src/main/resources/download-trec.sh)).
13+
**✔️ Important**: The demo uses data from [Trec dataset](https://cogcomp.seas.upenn.edu/Data/QA/QC/) created by Cognitive Computation Group at University of Pennsylvania, which we hereby acknowledge. Its training part is included in this project at [trec-train.json](./src/main/resources/trec-train.json) (downloaded using [this script](./src/main/resources/trec-dump.py)).
1414

1515
## License ⚖️
1616

0 commit comments

Comments
 (0)