pinecone-scala-core
API
Generated with
pinecone-scala-core/io.cequence.pineconescala.service/PineconeAssistantService

PineconeAssistantService

io.cequence.pineconescala.service.PineconeAssistantService
trait PineconeAssistantService extends CloseableService with PineconeServiceConsts

Pinecone assistant operations as defined at the API ref. page

The following services are supported:

  • listAssistants
  • createAssistant
  • describeAssistant
  • deleteAssistant

Attributes

Since:

July 2024

Graph
Supertypes
trait CloseableService
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Inherited classlikes

object DefaultSettings

Attributes

Inherited from:
PineconeServiceConsts
Graph
Supertypes
class Object
trait Matchable
class Any

Value members

Abstract methods

def createAssistant(name: String, metadata: Map[String, String]): Future[Assistant]

This operation deploys a Pinecone Assistant. This is where you specify the underlying training model, which cloud provider you would like to deploy with, and more.

This operation deploys a Pinecone Assistant. This is where you specify the underlying training model, which cloud provider you would like to deploy with, and more.

Attributes

metadata

A dictionary containing metadata for the assistant.

name

The name of the assistant. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

def deleteAssistant(name: String): Future[DeleteResponse]

This operation deletes an existing assistant.

This operation deletes an existing assistant.

Attributes

name

The name of the base to delete.

def describeAssistant(name: String): Future[Option[Assistant]]

This operation describes an assistant and its metadata.

This operation describes an assistant and its metadata.

Attributes

name

The name of the assistant to poll.

def listAssistants(): Future[Seq[Assistant]]

This operation returns a list of all assistants in a project.

This operation returns a list of all assistants in a project.

Attributes

Inherited methods

def close(): Unit

Closes the underlying ws client, and releases all its resources.

Closes the underlying ws client, and releases all its resources.

Attributes

Inherited from:
CloseableService

Inherited fields

protected val configFileName: String

Attributes

Inherited from:
PineconeServiceConsts
protected val configPrefix: String

Attributes

Inherited from:
PineconeServiceConsts
Generated with