Skip to content

Commit

Permalink
Version 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
peterbanda committed May 16, 2023
1 parent c2b2e8c commit 7fd5f43
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Pinecone Scala Client 🗄
[![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) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
# Pinecone Scala Client 🗂
[![version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)

This is an intuitive async Scala client for Pinecone API supporting all the available vector and index/collection operations/endpoints, provided in two convenient services called [PineconeVectorService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala) and [PineconeIndexService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala). The supported calls are:

Expand All @@ -21,7 +21,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
To pull the library you have to add the following dependency to your *build.sbt*

```
"io.cequence" %% "pinecone-scala-client" % "0.0.1"
"io.cequence" %% "pinecone-scala-client" % "0.1.0"
```

or to *pom.xml* (if you use maven)
Expand All @@ -30,7 +30,7 @@ or to *pom.xml* (if you use maven)
<dependency>
<groupId>io.cequence</groupId>
<artifactId>pinecone-scala-client_2.12</artifactId>
<version>0.0.1</version>
<version>0.1.0</version>
</dependency>
```

Expand Down Expand Up @@ -390,7 +390,7 @@ pinecone-scala-client {
}
```

2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.0.1/pinecone-scala-client_2.13-0.0.1.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_
2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.1.0/pinecone-scala-client_2.13-0.1.0.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_

Set the env. variable `PINECONE_SCALA_CLIENT_API_KEY`. If you don't have one register [here](https://app.pinecone.io/?sessionType=signup).

Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ val scala3 = "3.2.2"

ThisBuild / organization := "io.cequence"
ThisBuild / scalaVersion := scala212
ThisBuild / version := "0.0.1"
ThisBuild / version := "0.1.0"
ThisBuild / isSnapshot := false

lazy val core = (project in file("pinecone-core"))
Expand Down
6 changes: 3 additions & 3 deletions pinecone-client/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pinecone Scala - Client [![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)
# Pinecone Scala - Client [![version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)

This module provides the actual meat, i.e. WS client implementation ([PineconeVectorService impl and factory](./src/main/scala/io/cequence/pineconescala/service/PineconeVectorServiceImpl.scala) and [PineconeIndexService impl and factory](./src/main/scala/io/cequence/pineconescala/service/PineconeIndexServiceImpl.scala)).
Note that the full project documentation can be found [here](../README.md).
Expand All @@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
To pull the library you have to add the following dependency to your *build.sbt*

```
"io.cequence" %% "pinecone-scala-client" % "0.0.1"
"io.cequence" %% "pinecone-scala-client" % "0.1.0"
```

or to *pom.xml* (if you use maven)
Expand All @@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven)
<dependency>
<groupId>io.cequence</groupId>
<artifactId>pinecone-scala-client_2.12</artifactId>
<version>0.0.1</version>
<version>0.1.0</version>
</dependency>
```
6 changes: 3 additions & 3 deletions pinecone-core/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pinecone Scala - Core [![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)
# Pinecone Scala - Core [![version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)

This is the core module, which contains mostly domain classes and the definition of services: [PineconeVectorService](./src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala) and [PineconeIndexService](./src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala).
Note that the full project documentation can be found [here](../README.md).
Expand All @@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
To pull the library you have to add the following dependency to your *build.sbt*

```
"io.cequence" %% "pinecone-scala-core" % "0.0.1"
"io.cequence" %% "pinecone-scala-core" % "0.1.0"
```

or to *pom.xml* (if you use maven)
Expand All @@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven)
<dependency>
<groupId>io.cequence</groupId>
<artifactId>pinecone-scala-core_2.12</artifactId>
<version>0.0.1</version>
<version>0.1.0</version>
</dependency>
```

0 comments on commit 7fd5f43

Please sign in to comment.