Package com.hw.pinecone.service

Interface IndexService

public interface IndexService
Index Operations
Author:
HamaWhite

  • Method Summary

    Modifier and Type
    Method
    Description
    io.reactivex.Single<okhttp3.ResponseBody>
    createIndex(CreateIndexRequest request)
    This operation creates a Pinecone index.
    io.reactivex.Single<okhttp3.ResponseBody>
    deleteIndex(String name)
    This operation deletes an existing index.
    io.reactivex.Single<IndexDescription>
    describeIndex(String name)
    Get a description of an index.
    io.reactivex.Single<List<String>>
    listIndexes()
    This operation returns a list of your Pinecone indexes.

  • Method Details

    • listIndexes

      @GET("/databases") io.reactivex.Single<List<String>> listIndexes()
      This operation returns a list of your Pinecone indexes.
      Returns:
      A Single that emits a list of strings representing the Pinecone indexes.

    • createIndex

      @POST("/databases") io.reactivex.Single<okhttp3.ResponseBody> createIndex(@Body CreateIndexRequest request)
      This operation creates a Pinecone index.
      Parameters:
      request - create index request
      Returns:
      a Single wrapping the response body

    • describeIndex

      @GET("/databases/{indexName}") io.reactivex.Single<IndexDescription> describeIndex(@Path("indexName") String name)
      Get a description of an index.
      Parameters:
      name - the name of the index
      Returns:
      A Single that emits a description of the index

    • deleteIndex

      @DELETE("/databases/{indexName}") io.reactivex.Single<okhttp3.ResponseBody> deleteIndex(@Path("indexName") String name)
      This operation deletes an existing index.
      Parameters:
      name - the name of the index
      Returns:
      a Single wrapping the response body