New endpoint - listVectorIds with a response holder and JSON format

Author: peterbanda

pinecone-client/src/main/scala/io/cequence/pineconescala/JsonFormats.scala

@@ -15,6 +15,10 @@ object JsonFormats {
   implicit val matchFormat: Format[Match] = Json.format[Match]
   implicit val queryResultFormat: Format[QueryResponse] = Json.format[QueryResponse]
   implicit val fetchResponseFormat: Format[FetchResponse] = Json.format[FetchResponse]
+  implicit val vectorIdFormat: Format[VectorId] = Json.format[VectorId]
+  implicit val listVectorIdsPaginationFormat: Format[ListVectorIdsPagination] = Json.format[ListVectorIdsPagination]
+  implicit val listVectorIdsResponseFormat: Format[ListVectorIdsResponse] = Json.format[ListVectorIdsResponse]
+
 
   // index/collection formats
   implicit val collectionInfoFormat: Format[CollectionInfo] = Json.format[CollectionInfo]

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

@@ -9,6 +9,7 @@ object EndPoint {
   case object query extends EndPoint
   case object vectors_delete extends EndPoint("vectors/delete")
   case object vectors_fetch extends EndPoint("vectors/fetch")
+  case object vectors_list extends EndPoint("vectors/list")
   case object vectors_update extends EndPoint("vectors/update")
   case object vectors_upsert extends EndPoint("vectors/upsert")
   case object collections extends EndPoint
@@ -42,4 +43,7 @@ object Tag {
   case object metadata_config extends Tag
   case object source_collection extends Tag
   case object indexName extends Tag
+  case object limit extends Tag
+  case object paginationToken extends Tag
+  case object prefix extends Tag
 }

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

@@ -91,6 +91,24 @@ private class PineconeVectorServiceImpl(
       _.asSafe[QueryResponse]
     )
 
+  override def listVectorIDs(
+    namespace: String,
+    limit: Option[Int],
+    paginationToken: Option[String],
+    prefix: Option[String],
+  ): Future[ListVectorIdsResponse] =
+    execGET(
+      EndPoint.vectors_list,
+      params = Seq(
+        Tag.namespace -> Some(namespace),
+        Tag.limit -> limit,
+        Tag.paginationToken -> paginationToken,
+        Tag.prefix -> prefix
+      )
+    ).map(
+      _.asSafe[ListVectorIdsResponse]
+    )
+
   override def delete(
     ids: Seq[String],
     namespace: String

pinecone-core/src/main/scala/io/cequence/pineconescala/domain/response/ListVectorIdsResponse.scala

@@ -0,0 +1,14 @@
+package io.cequence.pineconescala.domain.response
+
+case class ListVectorIdsResponse(
+  vectors: Seq[VectorId],
+  pagination: ListVectorIdsPagination,
+  namespace: String
+)
+
+case class VectorId(id: String)
+
+case class ListVectorIdsPagination(
+  next: Option[String],
+  previous: Option[String]
+)

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

@@ -62,6 +62,30 @@ trait PineconeVectorService extends PineconeServiceConsts {
     settings: QuerySettings = DefaultSettings.Query
   ): Future[QueryResponse]
 
+  /**
+   * The list operation lists the IDs of vectors in a single namespace.
+   * An optional prefix can be passed to limit the results to IDs with a common prefix.
+   *
+   * It returns up to 100 IDs at a time by default in sorted order (bitwise/"C" collation).
+   * If the limit parameter is set, list returns up to that number of IDs instead.
+   * Whenever there are additional IDs to return, the response also includes a pagination_token that you can use to get the next batch of IDs.
+   * When the response does not includes a pagination_token, there are no more IDs to return.
+   *
+   * @param namespace
+   * @param limit
+   * @param paginationToken
+   * @param prefix
+   *
+   * @return List of vector IDs wrapped in a ListVectorIdsResponse
+   * @see <a href="https://docs.pinecone.io/reference/list">Pinecone Doc</a>
+   */
+  def listVectorIDs(
+    namespace: String,
+    limit: Option[Int] = None,
+    paginationToken: Option[String] = None,
+    prefix: Option[String] = None,
+  ): Future[ListVectorIdsResponse]
+
   /**
    * The Delete operation deletes vectors, by id, from a single namespace.
    *