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

Commit 315fc9d

Browse files
committed
OpenAI scala version added to build + README completed
1 parent 3c6c307 commit 315fc9d

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
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 Scala](https://github.com/cequence-io/pinecone-scala) with embeddings from [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://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).
55

6-
Follwing examples are available::
6+
The demo app can be found in [PineconeOpenAIDemo](./src/main/scala/io/cequence/pineconeopenai/demo/PineconeOpenAIDemo.scala).
7+
The following env. variables are expected:
8+
- `PINECONE_SCALA_CLIENT_API_KEY`
9+
- `PINECONE_SCALA_CLIENT_ENV`
10+
- `OPENAI_SCALA_CLIENT_API_KEY`
11+
- `OPENAI_SCALA_CLIENT_ORG_ID` (optional)
712

8-
TODO
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)).
914

1015
## License ⚖️
1116

build.sbt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ val scala3 = "3.2.2"
1111

1212
scalaVersion := scala212
1313

14+
val openAIScalaVersion = "0.3.2"
15+
1416
libraryDependencies ++= Seq(
1517
"io.cequence" %% "pinecone-scala-client" % version.value,
16-
"io.cequence" %% "openai-scala-client" % "0.3.2"
18+
"io.cequence" %% "openai-scala-client" % openAIScalaVersion
1719
)

0 commit comments

Comments
 (0)