Links updated + some comments/documentation

Author: peterbanda

README.md

@@ -3,11 +3,11 @@
 
 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: 
 
-* **Vector Operations**: [describeIndexStats](https://docs.pinecone.io/reference/describe_index_stats_post), [query](https://docs.pinecone.io/reference/query), [delete](https://docs.pinecone.io/reference/delete_post), [fetch](https://docs.pinecone.io/reference/fetch), [update](https://docs.pinecone.io/reference/update), and [upsert](https://docs.pinecone.io/reference/upsert)
-* **Collection Operations**: [listCollections](https://docs.pinecone.io/reference/list_collections), [createCollection](https://docs.pinecone.io/reference/create_collection), [describeCollection](https://docs.pinecone.io/reference/describe_collection), and [deleteCollection](https://docs.pinecone.io/reference/delete_collection)
-* **Index Operations**: [listIndexes](https://docs.pinecone.io/reference/list_indexes), [creatIndex](https://docs.pinecone.io/reference/create_index), [describeIndex](https://docs.pinecone.io/reference/describe_index), [deleteIndex](https://docs.pinecone.io/reference/delete_index), and [configureIndex](https://docs.pinecone.io/reference/configure_index)
-* **Inference Operations**: [embedData](https://docs.pinecone.io/reference/api/inference/generate-embeddings)
-* **Assistant Operations**:  [listAssistants](https://docs.pinecone.io/reference/api/assistant/list-assistants), [createAssistant](https://docs.pinecone.io/reference/api/assistant/create-assistant), [describeAssistant](https://docs.pinecone.io/reference/api/assistant/describe-assistant), [deleteAssistant](https://docs.pinecone.io/reference/api/assistant/delete-assistant), [listFiles](https://https://docs.pinecone.io/reference/api/assistant/list-files), [uploadFile](https://docs.pinecone.io/reference/api/assistant/create-file), [describeFile](https://docs.pinecone.io/reference/api/assistant/describe-file), [deleteFile](https://docs.pinecone.io/reference/api/assistant/delete-file), [chatWithAnAssistant](https://docs.pinecone.io/reference/api/assistant/chat-completion-assistant)
+* **Vector Operations**: [describeIndexStats](https://docs.pinecone.io/reference/api/2024-07/data-plane/describeindexstats), [query](https://docs.pinecone.io/reference/api/2024-07/data-plane/query), [delete](https://docs.pinecone.io/reference/api/2024-07/data-plane/delete), [fetch](https://docs.pinecone.io/reference/api/2024-07/data-plane/fetch), [update](https://docs.pinecone.io/reference/api/2024-07/data-plane/update), and [upsert](https://docs.pinecone.io/reference/api/2024-07/data-plane/upsert)
+* **Collection Operations**: [listCollections](https://docs.pinecone.io/reference/api/2024-07/control-plane/list_collections), [createCollection](https://docs.pinecone.io/reference/api/2024-07/control-plane/create_collection), [describeCollection](https://docs.pinecone.io/reference/api/2024-07/control-plane/describe_collection), and [deleteCollection](https://docs.pinecone.io/reference/api/2024-07/control-plane/delete_collection)
+* **Index Operations**: [listIndexes](https://docs.pinecone.io/reference/api/2024-07/control-plane/list_indexes), [creatIndex](https://docs.pinecone.io/reference/api/2024-07/control-plane/create_index), [describeIndex](https://docs.pinecone.io/reference/api/2024-07/control-plane/describe_index), [deleteIndex](https://docs.pinecone.io/reference/api/2024-07/control-plane/delete_index), and [configureIndex](https://docs.pinecone.io/reference/api/2024-07/control-plane/configure_index)
+* **Inference Operations**: [embedData](https://docs.pinecone.io/reference/api/2024-07/inference/generate-embeddings)
+* **Assistant Operations**:  [listAssistants](https://docs.pinecone.io/reference/api/2024-07/assistant/list-assistants), [createAssistant](https://docs.pinecone.io/reference/api/2024-07/assistant/create-assistant), [describeAssistant](https://docs.pinecone.io/reference/api/2024-07/assistant/describe-assistant), [deleteAssistant](https://docs.pinecone.io/reference/api/2024-07/assistant/delete-assistant), [listFiles](https://docs.pinecone.io/reference/api/2024-07/assistant/list-files), [uploadFile](https://docs.pinecone.io/reference/api/2024-07/assistant/create-file), [describeFile](https://docs.pinecone.io/reference/api/2024-07/assistant/describe-file), [deleteFile](https://docs.pinecone.io/reference/api/2024-07/assistant/delete-file), [chatWithAssistant](https://docs.pinecone.io/reference/api/2024-07/assistant/chat-completion-assistant)
   - these operations are provided by two services: `PineconeAssistantService` and `PineconeAssistantFileService`
 
 Note that in order to be consistent with the Pinecone API naming, the service function names match exactly the API endpoint titles/descriptions with camelcase.

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

@@ -6,6 +6,21 @@ import java.io.File
 import java.util.UUID
 import scala.concurrent.Future
 
+/**
+ * Pinecone assistant file operations as defined at <a
+ * href="https://docs.pinecone.io/reference/api/2024-07/assistant">the API ref. page</a>
+ *
+ * The following services are supported:
+ *
+ * - listFiles
+ * - uploadFile
+ * - describeFile
+ * - deleteFile
+ * - chatWithAssistant
+ *
+ * @since July
+ *   2024
+ */
 trait PineconeAssistantFileService {
 
   /**

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

@@ -5,6 +5,20 @@ import io.cequence.wsclient.service.CloseableService
 
 import scala.concurrent.Future
 
+/**
+ * Pinecone assistant operations as defined at <a
+ * href="https://docs.pinecone.io/reference/api/2024-07/assistant">the API ref. page</a>
+ *
+ * The following services are supported:
+ *
+ * - listAssistants
+ * - createAssistant
+ * - describeAssistant
+ * - deleteAssistant
+ *
+ * @since July
+ *   2024
+ */
 trait PineconeAssistantService extends CloseableService with PineconeServiceConsts {
 
   /**

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

@@ -6,6 +6,17 @@ import io.cequence.wsclient.service.CloseableService
 
 import scala.concurrent.Future
 
+/**
+ * Pinecone inference operations as defined at <a
+ * href="https://docs.pinecone.io/reference/api/2024-07/inference">the API ref. page</a>
+ *
+ * The following services are supported:
+ *
+ *   - createEmbeddings
+ *
+ * @since May
+ *   2024
+ */
 trait PineconeInferenceService extends CloseableService with PineconeServiceConsts {
 
   /**

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

@@ -18,6 +18,7 @@ import scala.concurrent.Future
  *  - fetch
  *  - update
  *  - upsert
+ *  - listVectorIDs
  *
  * @since Apr 2023
  */