Improving documentation of PineconeIndexService and PineconeVectorService + refactoring params to camel case

Author: peterbanda

pinecone-client/src/main/scala/io/cequence/pineconescala/service/PineconeIndexServiceImpl.scala

@@ -114,9 +114,9 @@ private class PineconeIndexServiceImpl(
         Tag.metric -> Some(settings.metric.toString),
         Tag.pods -> Some(settings.pods),
         Tag.replicas -> Some(settings.replicas),
-        Tag.pod_type -> Some(settings.pod_type.toString),
-        Tag.metadata_config -> (if (settings.metadata_config.nonEmpty) Some(settings.metadata_config) else None),
-        Tag.source_collection -> settings.source_collection
+        Tag.pod_type -> Some(settings.podType.toString),
+        Tag.metadata_config -> (if (settings.metadataConfig.nonEmpty) Some(settings.metadataConfig) else None),
+        Tag.source_collection -> settings.sourceCollection
       ),
       acceptableStatusCodes = Nil // don't parse response at all
     ).map { response =>
@@ -162,14 +162,14 @@ private class PineconeIndexServiceImpl(
   override def configureIndex(
     indexName: String,
     replicas: Option[Int],
-    pod_type: Option[PodType.Value]
+    podType: Option[PodType.Value]
   ): Future[ConfigureIndexResponse] =
     execPATCHWithStatus(
       EndPoint.databases,
       endPointParam = Some(indexName),
       bodyParams = jsonBodyParams(
         Tag.replicas -> replicas,
-        Tag.pod_type -> pod_type.map(_.toString)
+        Tag.pod_type -> podType.map(_.toString)
       )
     ).map { response =>
       val (statusCode, message) = statusCodeAndMessage(response)

pinecone-client/src/main/scala/io/cequence/pineconescala/service/examples/PineconeIndexExample.scala

@@ -2,6 +2,7 @@ package io.cequence.pineconescala.service.examples
 
 import akka.actor.ActorSystem
 import akka.stream.Materializer
+import io.cequence.pineconescala.domain.PodType
 import io.cequence.pineconescala.service.PineconeIndexServiceFactory
 
 import scala.concurrent.ExecutionContext
@@ -20,7 +21,17 @@ object PineconeIndexExample extends App {
 
       _ = println(indexes.mkString(", "))
 
-      _ <- service.describeIndex(indexes(0)).map(println(_))
+      indexInfo <- service.describeIndex(indexes(0))
+
+      _ = println(indexInfo)
+
+      deleteResponse <- service.deleteIndex(indexes(0))
+
+      _ = println(deleteResponse)
+
+      indexInfo <- service.describeIndex(indexes(0))
+
+      _ = println(indexInfo)
 
       createResponse <- service.createIndex(
         name = "auto-gpt-test",
@@ -29,6 +40,20 @@ object PineconeIndexExample extends App {
 
       _ = println(createResponse)
 
+      configureIndexResponse <- service.configureIndex(
+        "auto-gpt-test",
+        replicas = Some(0),
+        podType = Some(PodType.p1_x1)
+      )
+
+      _ = println(configureIndexResponse)
+
+      _ = Thread.sleep(5000)
+
+      indexInfo <- service.describeIndex("auto-gpt-test")
+
+      _ = println(indexInfo)
+
       createResponse2 <- service.createIndex(
         name = "auto-gpt-test",
         dimension = 1536
@@ -38,7 +63,27 @@ object PineconeIndexExample extends App {
 
       indexes2 <- service.listIndexes
 
-      _ = println(indexes2.mkString(" "))
+      _ = println(indexes2.mkString(", "))
+
+      createResponse3 <- service.createCollection("auto-gpt-test-collection", "auto-gpt-test")
+
+      _ = println(createResponse3)
+
+      collections <- service.listCollections
+
+      _ = println(collections.mkString(", "))
+
+      collectionInfo <- service.describeCollection("auto-gpt-test-collection")
+
+      _ = println(collectionInfo)
+
+      deleteResponse2 <- service.deleteCollection("auto-gpt-test-collection")
+
+      _ = println(deleteResponse2)
+
+      collections2 <- service.listCollections
+
+      _ = println(collections2.mkString(", "))
     } yield {
       System.exit(0)
     }
@@ -47,4 +92,4 @@ object PineconeIndexExample extends App {
       println(e)
       System.exit(1)
   }
-}
+}

pinecone-client/src/main/scala/io/cequence/pineconescala/service/examples/PineconeVectorExample.scala

@@ -25,7 +25,7 @@ object PineconeVectorExample extends App {
 
       stats <- service.describeIndexStats
 
-      upsertResponse <- service.upsert(
+      vectorUpsertedCount <- service.upsert(
         vectors = Seq(
           PVector(
             id = testIds(0),
@@ -103,7 +103,7 @@ object PineconeVectorExample extends App {
     } yield {
       println(stats)
       println()
-      println(upsertResponse)
+      println(vectorUpsertedCount)
       println()
       println("Before update:")
       println(fetchResponse)

pinecone-core/src/main/scala/io/cequence/pineconescala/domain/settings/CreateIndexSettings.scala

@@ -14,12 +14,12 @@ case class CreateIndexSettings(
   replicas: Int,
 
   // The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
-  pod_type: PodType.Value,
+  podType: PodType.Value,
 
   // Configuration for the behavior of Pinecone's internal metadata index.
   // By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed.
-  metadata_config: Map[String, String] = Map(),
+  metadataConfig: Map[String, String] = Map(),
 
   // The name of the collection to create an index from
-  source_collection: Option[String] = None
+  sourceCollection: Option[String] = None
 )

pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala

@@ -11,9 +11,9 @@ import scala.concurrent.Future
  *
  * The following services are supported:
  *
- * - Collection Operations: listCollections, createCollection, describeCollection, and deleteCollection
+ *  - '''Collection Operations''': listCollections, createCollection, describeCollection, and deleteCollection
  *
- * - Index Operations: listIndexes, creatIndex, describeIndex, deleteIndex, and configureIndex
+ *  - '''Index Operations''': listIndexes, creatIndex, describeIndex, deleteIndex, and configureIndex
  *
  * @since Apr 2023
  */
@@ -113,13 +113,13 @@ trait PineconeIndexService extends PineconeServiceConsts {
    *
    * @param indexName The name of the index
    * @param replicas The desired number of replicas for the index.
-   * @param pod_type The new pod type for the index.
+   * @param podType The new pod type for the index.
    * @return Whether the index was updated successfully or not found.
    * @see <a href="https://docs.pinecone.io/reference/configure_index">Pinecone Doc</a>
    */
   def configureIndex(
     indexName: String,
     replicas: Option[Int],
-    pod_type: Option[PodType.Value]
+    podType: Option[PodType.Value]
   ): Future[ConfigureIndexResponse]
 }

pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeServiceConsts.scala

@@ -28,9 +28,9 @@ trait PineconeServiceConsts {
       metric = Metric.cosine,
       pods = 1,
       replicas = 1,
-      pod_type = PodType.p1_x1,
-      metadata_config = Map(),
-      source_collection = None
+      podType = PodType.p1_x1,
+      metadataConfig = Map(),
+      sourceCollection = None
     )
   }
 }

pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala

@@ -12,7 +12,12 @@ import scala.concurrent.Future
  *
  * The following services are supported:
  *
- * - describeIndexStats, query, delete, fetch, update, and upsert
+ *  - describeIndexStats
+ *  - query - by vector or by id
+ *  - delete - by filter or ids, or delete all
+ *  - fetch
+ *  - update
+ *  - upsert
  *
  * @since Apr 2023
  */