PineconeAssistantFileService

io.cequence.pineconescala.service.PineconeAssistantFileService

Pinecone assistant file operations as defined at the API ref. page

The following services are supported:

  • listFiles
  • uploadFile
  • describeFile
  • deleteFile
  • chatWithAssistant

Attributes

Since:

July 2024

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

def chatWithAssistant(assistantName: String, messages: Seq[String]): Future[ChatCompletionResponse]

This operation queries the completions endpoint of a Pinecone Assistant. For guidance and examples, see the chat with assistant guide.

This operation queries the completions endpoint of a Pinecone Assistant. For guidance and examples, see the chat with assistant guide.

Attributes

assistantName

The name of the assistant to be described.

messages

An array of objects that represent the messages in a conversation.

Returns:

The ChatCompletionModel describes the response format of a chat request

def deleteFile(assistantName: String, fileId: UUID): Future[DeleteResponse]

Attributes

fileId

The UUID of the file to be described.

def describeFile(assistantName: String, fileId: UUID): Future[Option[FileResponse]]

Attributes

assistantName

The name of the assistant to get file from.

fileId

The UUID of the file to be described.

def listFiles(assistantName: String): Future[Seq[FileResponse]]

This operation returns a list of all files in an assistant.

This operation returns a list of all files in an assistant.

Attributes

assistantName

The name of the assistant to get files of.

def uploadFile(assistantName: String, file: File, displayFileName: Option[String]): Future[FileResponse]

This operation uploads a file to a specified assistant.

This operation uploads a file to a specified assistant.

Attributes

assistantName

The name of the assistant to upload file to.

displayFileName

The name of the file to be displayed.

file

A file to upload.