Download pinecone scala - pinecone scala download do código fonte

Pinecone Scala Client

Este é um cliente Scala de pleno direito de pleno direito da API de Pinecone, que suporta todo o índice, vetor, coleta, inferência e operações assistentes disponíveis, fornecido em dois serviços convenientes chamados PineconeVectorService e PineconeIndexService. As chamadas suportadas são:

Operações vetoriais : descreva os estatísticas, consulta, exclua, busque, atualize e upsert
Operações de coleta : ListCollections, CreateCollection, Desceconlection e DeleteCollection
Operações de índice : ListIndexes, CreateIndex, Descrevendex, DeleteIndex e Configurindex
Operações de inferência : incorpeddata, re -marcado e avaliar
Operações Assistentes : ListAssistants, CreateAssistant, descrevensistente, DeleteasSistant, ListFiles, UploadFile, Descruiofile, DeleteFile, ChatWithassistant
- Essas operações são fornecidas por dois serviços: PineconeAssistantService e PineconeAssistantFileService

Observe que, para ser consistente com a nomeação da API do Pinecone, os nomes da função de serviço correspondem exatamente aos títulos/descrições do API Endpoint com camelcase. Além disso, pretendemos que o LIB fosse independente, com o menor número de dependências possíveis, portanto, acabamos usando apenas dois Libs play-ahc-ws-standalone e play-ws-standalone-json (no nível superior).

✔️ Importante : esta é uma biblioteca "comunitária" e, como tal, não tem relação com a Pinecone Company.

Confira um artigo sobre o LIB/cliente no Medium. Além disso, se você quiser ver exemplos práticos imediatamente, vá para os exemplos de pinecone ou os módulos de exemplos do OpenAI + Pinecone.

Instalação

As versões Scala atualmente suportadas são 2,12, 2.13 e 3 .

Para puxar a biblioteca, você deve adicionar a seguinte dependência à sua construção.sbt

 "io.cequence" %% "pinecone-scala-client" % "1.2.2"

ou para pom.xml (se você usar o Maven)

 <dependency>
    <groupId>io.cequence</groupId>
    <artifactId>pinecone-scala-client_2.12</artifactId>
    <version>1.2.2</version>
</dependency>

Config

Env. Variáveis: PINECONE_SCALA_CLIENT_API_KEY e PINECONE_SCALA_CLIENT_ENV Se o serviço baseado em POD for usado
Config do arquivo (padrão): Pinecone-scala-client.conf

Uso? ‍?

IA. Obtendo PineconeIndexService

Primeiro você precisa fornecer um contexto de execução implícito, bem como o materializador de Akka, por exemplo, como

  implicit val ec = ExecutionContext .global
  implicit val materializer = Materializer ( ActorSystem ())

Em seguida, você pode obter um serviço (POD ou baseado em servidor) de uma das seguintes maneiras.

Config padrão Config espera

  import io . cequence . pineconescala . service . PineconeIndexServiceFactory . FactoryImplicits

  val service = PineconeIndexServiceFactory ().asOne

Config personalizado

  val config = ConfigFactory .load( " path_to_my_custom_config " )
  val service = PineconeIndexServiceFactory (config).asOne

Sem configuração para o serviço baseado em pod (com Env) - cria uma instância de PineconePodBasedIndexService

  val service  = PineconeIndexServiceFactory (
    apiKey = " your_api_key " ,
    environment = " your_env " // e.g. "northamerica-northeast1-gcp
  )

Sem configuração para serviço sem servidor - cria uma instância de PineconeServerlessIndexService

  val service = PineconeIndexServiceFactory (
    apiKey = " your_api_key "
  )

Ib. Obtendo PineconeVectorService

O mesmo que no PineconeIndexService , você precisa primeiro fornecer contexto de execução implícito e materializador de Akka. Então você pode obter um serviço de uma das seguintes maneiras.

Config padrão (espera que a (s) variável (s) Env. Seja definida conforme definido na seção Config ). Observe que, se o índice com um determinado nome não estiver disponível, a fábrica retornará None .

  PineconeVectorServiceFactory ( " index_name " ).map { serviceOption =>
    val service = serviceOption.getOrElse(
      throw new Exception ( s " Index with a given name does not exist. " )
    )
    // do something with the service
  }

Ic. Obtendo PineconeInferenceService Service

O mesmo que no PineconeIndexService , você precisa primeiro fornecer contexto de execução implícito e materializador de Akka. Então você pode obter um serviço de uma das seguintes maneiras.

Config padrão

  val service = PineconeInferenceServiceFactory ()

Config personalizado

  val config = ConfigFactory .load( " path_to_my_custom_config " )
  val service = PineconeInferenceServiceFactory (config)

Diretamente com a tecla API

  val service = PineconeInferenceServiceFactory (
    apiKey = " your_api_key "
  )

Eu ia. Obtendo PineconeAssistantService

Config padrão

  val service = PineconeAssistantServiceFactory ()

Config personalizado

  val config = ConfigFactory .load( " path_to_my_custom_config " )
  val service = PineconeAssistantServiceFactory (config)

Diretamente com a tecla API

  val service = PineconeAssistantServiceFactory (
    apiKey = " your_api "
  )

Ou seja. Obtendo PineconeAssistantFileService

Config padrão

  val service = PineconeAssistantFileServiceFactory ()

Config personalizado

  val config = ConfigFactory .load( " path_to_my_custom_config " )
  val service = PineconeAssistantFileServiceFactory (config)

Diretamente com a tecla API

  val service = PineconeAssistantFileServiceFactory (
    apiKey = " your_api "
  )

Ii. Chamando funções

A documentação completa de cada chamada com suas respectivas entradas e configurações é fornecida no PineconeVectorService e PineconeIndexService. Como todas as chamadas são assíncronas, eles retornam respostas embrulhadas no Future .

Exemplos:

Operações de índice

Índices de lista

  pineconeIndexService.listIndexes.map(indexes =>
    indexes.foreach(println)
  )

Crie índice (com configurações padrão)

  import io . cequence . pineconescala . domain . response . CreateResponse

  pineconeIndexService.createIndex(
    name = " auto-gpt-test " ,
    dimension = 1536
  ).map {
    case CreateResponse . Created => println( " Index successfully created. " )
    case CreateResponse . BadRequest => println( " Index creation failed. Request exceeds quota or an invalid index name. " )
    case CreateResponse . AlreadyExists => println( " Index with a given name already exists. " )
  }

Descrever o índice

  pineconeIndexService.describeIndex( " index_name " ).map(indexInfo =>
    // if not found, indexInfo will be None    
    println(indexInfo)
  )

Excluir índice

  import io . cequence . pineconescala . domain . response . DeleteResponse

  pineconeIndexService.deleteIndex( " index_name " ).map {
    case DeleteResponse . Deleted => println( " Index successfully deleted. " )
    case DeleteResponse . NotFound => println( " Index with a given name not found. " )
  }

Configurar índice

  import io . cequence . pineconescala . domain . response . ConfigureIndexResponse

  pineconeIndexService.configureIndex(
    name = " index_name " ,
    replicas = Some ( 2 ),
    pod_type = Some ( PodType .p1_x2)
  ).map { 
    case ConfigureIndexResponse . Updated => println( " Index successfully updated. " )
    case ConfigureIndexResponse . BadRequestNotEnoughQuota => println( " Index update failed. Not enough quota. " )
    case ConfigureIndexResponse . NotFound => println( " Index with a given name not found. " )
  }

Operações de coleta

Coleções de lista

  pineconeIndexService.listCollections.map(collectionNames =>
    println(collectionNames.mkString( " , " ))
  )

Criar coleção

  import io . cequence . pineconescala . domain . response . CreateResponse

  pineconeIndexService.createCollection(
    name = " collection_name " ,
    source = " index_name "
  ).map {
    case CreateResponse . Created => println( " Collection successfully created. " )
    case CreateResponse . BadRequest => println( " Collection creation failed. Request exceeds quota or an invalid collection name. " )
    case CreateResponse . AlreadyExists => println( " Collection with a given name already exists. " )
  }

Descrever a coleção

  pineconeIndexService.describeCollection( " collection_name " ).map(collectionInfo =>
    // if not found, collectionInfo will be None
    println(collectionInfo)
  )

Excluir coleção

  import io . cequence . pineconescala . domain . response . DeleteResponse

  pineconeIndexService.deleteCollection( " collection_name " ).map {
    case DeleteResponse . Deleted => println( " Collection successfully deleted. " )
    case DeleteResponse . NotFound => println( " Collection with a given name not found. " )
  }

Operações vetoriais

Upsert

  val dimension = 1536

  pineconeVectorService.upsert(
    vectors = Seq (
      PVector (
        id = " 666 " ,
        values = Seq .fill(dimension)( Random .nextDouble),
        metadata = Map (
          " is_relevant " -> " not really but for testing it's ok, you know " ,
          " food_quality " -> " brunches are perfect but don't go there before closing time "
        )
      ),
      PVector (
        id = " 777 " ,
        values = Seq .fill(dimension)( Random .nextDouble),
        metadata = Map (
          " is_relevant " -> " very much so " ,
          " food_quality " -> " burritos are the best! "
        )
      )
    ),
    namespace = " my_namespace " ,
  ).map(vectorUpsertedCount =>
    println( s " Upserted $vectorUpsertedCount vectors. " )
  )

Atualizar

  val fetchedValues = ... // vectors fetched from somewhere 

  pineconeVectorService.update(
    id = " 777 " ,
    namespace = " my_namespace " ,
    values = fetchedValues.map(_ / 100 ), // divide fetched values by 100
    sparseValues = Some ( SparseVector (
      indices = Seq ( 1 , 2 , 3 ),
      values = Seq ( 8.8 , 7.7 , 2.2 )
    )),
    setMetaData = Map (
      " solid_info " -> " this is the source of the truth "
    )
  ).map(_ =>
    println( s " Vectors updated. " )
  )

Consulta com configurações padrão

  pineconeVectorService.query(
    vector = Seq .fill( 1536 )( Random .nextDouble), // some values/embeddings
    namespace = " my_namespace "
  ).map { queryResponse =>
    queryResponse.matches.foreach { matchInfo =>
      println( s " Matched vector id: ${matchInfo.id} " )
      println( s " Matched vector values: ${matchInfo.values.take( 20 ).mkString( " , " )} .. " )
      println( s " Matched vector score: ${matchInfo.score} " )
      println( s " Matched vector metadata: ${matchInfo.metadata} " )
    }
  }

Consulta com configurações personalizadas

  pineconeVectorService.query(
    vector = Seq .fill( 1536 )( Random .nextDouble), // some values/embeddings
    namespace = " my_namespace " ,
    settings = QuerySettings (
      topK = 5 ,
      includeValues = true ,
      includeMetadata = true
    )
  ).map { queryResponse =>
    queryResponse.matches.foreach { matchInfo =>
      println( s " Matched vector id: ${matchInfo.id} " )
      println( s " Matched vector values: ${matchInfo.values.take( 20 ).mkString( " , " )} .. " )
      println( s " Matched vector score: ${matchInfo.score} " )
      println( s " Matched vector metadata: ${matchInfo.metadata} " )
    }
  }

Buscar

  pineconeVectorService.fetch(
    ids = Seq ( " 666 " , " 777 " ),
    namespace = " my_namespace "
  ).map { fetchResponse =>
    fetchResponse.vectors.values.map { pVector =>
      println( s " Fetched vector id: ${pVector.id} " )
      println( s " Fetched vector values: ${pVector.values.take( 20 ).mkString( " , " )} .. " )
      println( s " Fetched vector metadata: ${pVector.metadata} " )
   }
}

Exclua por IDs

  pineconeVectorService.delete(
    ids = Seq ( " 666 " , " 777 " ),
    namespace = " my_namespace "
  ).map(_ =>
    println( " Vectors deleted " )
  )

Exclua tudo

  pineconeVectorService.deleteAll(
    namespace = " my_namespace "
  ).map(_ =>
    println( " All vectors deleted " )
  )

Descreva estatísticas de índice

  pineconeVectorService.describeIndexStats.map(stats =>
    println(stats)      
  )

Operações de inferência

Gerar incorporações

  pineconeInferenceService.createEmbeddings(
    Seq ( " The quick brown fox jumped over the lazy dog " )
  ).map { embeddings =>
    println(embeddings.data.mkString( " n " ))
  }

Documentos / pedaços re -marítimos

  pineconeInferenceService.rerank(
    query = " The tech company Apple is known for its innovative products like the iPhone. " ,
    documents = Seq (...)  
  ).map(
    _.data.foreach(println)
  )

Avalie as perguntas e respostas

  pineconeInferenceService.evaluate(
    question = " What are the capital cities of France, England and Spain? " ,
    answer = " Paris is a city of France and Barcelona of Spain " ,
    groundTruthAnswer = " Paris is the capital city of France, London of England and Madrid of Spain "
  ).map { response =>
    println(response)
  }

** Operações de Assistente **

Assistentes de lista

  pineconeAssistantService.listAssistants.map(assistants =>
    println(assistants.mkString( " , " ))
  )

Criar assistente

  import io . cequence . pineconescala . domain . response . CreateResponse

  pineconeAssistantService.createAssistant(
    name = " assistant_name " ,
    description = " assistant_description " ,
    assistantType = " assistant_type "
  ).map {
    case CreateResponse . Created => println( " Assistant successfully created. " )
    case CreateResponse . BadRequest => println( " Assistant creation failed. Request exceeds quota or an invalid assistant name. " )
    case CreateResponse . AlreadyExists => println( " Assistant with a given name already exists. " )
  }

Descrever assistente

  pineconeAssistantService.describeAssistant( " assistant_name " ).map(assistant =>
    // if not found, assistant will be None
    println(assistant)
  )

Excluir assistente

  import io . cequence . pineconescala . domain . response . DeleteResponse

  pineconeAssistantService.deleteAssistant( " assistant_name " ).map {
    case DeleteResponse . Deleted => println( " Assistant successfully deleted. " )
    case DeleteResponse . NotFound => println( " Assistant with a given name not found. " )
  }

Listar arquivos de assistente

  pineconeAssistantService.listFiles( " assistant_name " ).map(files =>
    println(files.mkString( " , " ))
  )

Faça o upload do arquivo de assistente

  import io . cequence . pineconescala . domain . response . CreateResponse

  pineconeAssistantService.uploadFile(
    assistantName = " assistant_name " ,
    filePath = " path_to_file "
  ).map {
    case CreateResponse . Created => println( " File successfully uploaded. " )
    case CreateResponse . BadRequest => println( " File upload failed. Request exceeds quota or an invalid file path. " )
    case CreateResponse . AlreadyExists => println( " File with a given name already exists. " )
  }

Descreva o arquivo de assistente

  pineconeAssistantService.describeFile( " assistant_name " , " file_name " ).map(file =>
    // if not found, file will be None
    println(file)
  )

Conversar com um assistente

  pineconeAssistantService.chatWithAssistant(
    " assistant_name " ,
    " What is the maximum height of a red pine? "
  ).map(response =>
    println(response)
  )

Demonstração

Para demos prontos para executar pls. Consulte módulos separados:

Pinecone Scala Demo - mostra como usar operações de vetor, índice e de coleta do Pinecone
Pinecone + Openai Scala Demo - mostra como gerar e armazenar o OpenAi incorporando em Pinecone e consulte -os depois

PERGUNTAS FREQUENTES ?

Recebi uma exceção de tempo limite. Como posso mudar a configuração de tempo limite?
Você pode fazê -lo, passando os timeouts limite para Pinecone{Vector,Index}ServiceFactory ou, se você usar seu próprio arquivo de configuração, poderá simplesmente adicioná -lo lá como:

 pinecone-scala-client {
    timeouts {
        requestTimeoutSec = 200
        readTimeoutSec = 200
        connectTimeoutSec = 5
        pooledConnectionIdleTimeoutSec = 60
    }
}

I got an exception like com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/1.2.2/pinecone-scala-client_2.13-1.2.2.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY} . O que devo fazer?
Defina o Env. variável PINECONE_SCALA_CLIENT_API_KEY . Se você não tiver um registro aqui.
Tudo parece legal. Quero conversar com você sobre sua pesquisa e desenvolvimento?
Basta nos enviar um e-mail para [email protected].