pinecone scala

Cliente de Scala Pinecone

Este es un cliente SCALA completo de Async intuitivo para la API de Pinecone que admite todos los índices disponibles, vector, colección, inferencia y operaciones/puntos finales de asistente, proporcionados en dos servicios convenientes llamados PineconeVectorService y PineconeIndexService. Las llamadas compatibles son:

• Operaciones vectoriales : describirindexstats, consulta, eliminar, buscar, actualizar y upsert
• Operaciones de recolección : ListCollections, CreateCollection, DescribeCollection y DeleteCollection
• Operaciones de índice : Listindexes, CreateIndex, DeccyIndex, DeleteIndex y ConfigurureIndex
• Operaciones de inferencia : incrustación, volver a serk y evaluar
• Operaciones de asistente : ListSistants, CreateAssistant, DescribeSistant, DeleteasSistant, ListFiles, UploadFile, DescribeFile, DeleteFile, ChatWithAssistant
  • Estas operaciones son proporcionadas por dos servicios: PineconeAssistantService y PineconeAssistantFileService

Tenga en cuenta que para ser consistente con el nombre de la API de Pinecone, los nombres de funciones de servicio coinciden exactamente con los títulos/descripciones de punto final de la API con CamelCase. Además, apuntamos a Lib para que fuera autónomo con la menor cantidad de dependencias posibles, por lo tanto, terminamos usando solo dos libs play-ahc-ws-standalone y play-ws-standalone-json (en el nivel superior).

✔️ IMPORTANTE : Esta es una biblioteca "mantenida por la comunidad" y, como tal, no tiene relación con Pinecone Company.

Consulte un artículo sobre Lib/Client en Medium. Además, si desea ver ejemplos prácticos de inmediato, vaya a los ejemplos de Pinecone o los módulos de ejemplos de Pinecone OpenAI +.

Instalación

Las versiones Scala actualmente compatibles son 2.12, 2.13 y 3 .

Para extraer la biblioteca debe agregar la siguiente dependencia a su compilación.

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

o a pom.xml (si usa Maven)

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

Configuración

• Env. Variables: PINECONE_SCALA_CLIENT_API_KEY , y PINECONE_SCALA_CLIENT_ENV si se usa el servicio basado en pod
• Archivo config (predeterminado): pinecone-scala-client.conf

¿Uso? ‍?

Iowa. Obtener PineconeIndexService

Primero debe proporcionar un contexto de ejecución implícito, así como Akka Materializer, por ejemplo, como

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

Luego puede obtener un servicio (POD o sin servidor) de una de las siguientes maneras.

• Configuración predeterminada (espera que la variable (s) Config .

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

  val service = PineconeIndexServiceFactory ().asOne

• Configuración personalizada

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

• Sin configuración para el servicio basado en POD (con env): crea una instancia de PineconePodBasedIndexService

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

• Sin configuración para el servicio sin servidor: crea una instancia de PineconeServerlessIndexService

  val service = PineconeIndexServiceFactory (
    apiKey = " your_api_key "
  )

Ib. Obtener PineconeVectorService

Al igual que con PineconeIndexService , primero debe proporcionar un contexto de ejecución implícito y Akka Materializer. Luego puede obtener un servicio de una de las siguientes maneras.

• Config predeterminado (espera que la variable (s) Config . Tenga en cuenta que si el índice con un nombre de pila no está disponible, la fábrica no devolverá 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. Obtener PineconeInferenceService

Al igual que con PineconeIndexService , primero debe proporcionar un contexto de ejecución implícito y Akka Materializer. Luego puede obtener un servicio de una de las siguientes maneras.

• Configuración predeterminada

  val service = PineconeInferenceServiceFactory ()

• Configuración personalizada

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

• Directamente con apikey

  val service = PineconeInferenceServiceFactory (
    apiKey = " your_api_key "
  )

Identificación. Obtener PineconeAssistantService

• Configuración predeterminada

  val service = PineconeAssistantServiceFactory ()

• Configuración personalizada

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

• Directamente con apikey

  val service = PineconeAssistantServiceFactory (
    apiKey = " your_api "
  )

Es decir. Obtención de servicio PineconeAssistantFileService

• Configuración predeterminada

  val service = PineconeAssistantFileServiceFactory ()

• Configuración personalizada

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

• Directamente con apikey

  val service = PineconeAssistantFileServiceFactory (
    apiKey = " your_api "
  )

II. Funciones de llamadas

La documentación completa de cada llamada con sus respectivas entradas y configuraciones se proporciona en PineconeVectorService y PineconeIndexService. Dado que todas las llamadas son asíncronas, devuelven respuestas envueltas en Future .

Ejemplos:

Operaciones de índice

• Índices de listas

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

• Crear índice (con configuración predeterminada)

  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. " )
  }

• Describir el índice

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

• Eliminar í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. " )
  }

Operaciones de recolección

• Colecciones de listas

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

• Crear colección

  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. " )
  }

• Describe la colección

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

• Colección de eliminación

  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. " )
  }

Operaciones de vector

• 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. " )
  )

• Actualizar

  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 con configuración predeterminada

  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 con configuraciones 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} " )
   }
}

• Eliminar por id (s)

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

• Eliminar todo

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

• Describe las estadísticas del índice

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

Operaciones de inferencia

• Generar incrustaciones

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

• Documentos / trozos de Rerank

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

• Evaluar preguntas y respuestas

  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)
  }

** Operaciones de asistente **

• Asistentes de lista

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

• Crear asistente

  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. " )
  }

• Describir asistente

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

• Eliminar asistente

  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. " )
  }

• Lista de archivos de asistente

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

• Subir el archivo del asistente

  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. " )
  }

• Describe el archivo del asistente

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

• Chatear con un asistente

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

Manifestación

Para demostraciones listas para ejecutar por favor. Consulte los módulos separados:

• Demo de Pinecone Scala: muestra cómo usar las operaciones de Pinecone Vector, Index y Collection
• Pinecone + OpenAi Scala Demo - Muestra cómo generar y almacenar incrustaciones de Operai en Pinecone y consultarlos después

Preguntas frecuentes?

1. Tengo una excepción de tiempo de espera. ¿Cómo puedo cambiar la configuración de tiempo de espera?

   Puede hacerlo pasando el timeouts de espera a Pinecone{Vector,Index}ServiceFactory o, si usa su propio archivo de configuración, simplemente puede agregarlo allí como:

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

2. Obtuve una excepción como 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} . ¿Qué tengo que hacer?

   Establezca el env. variable PINECONE_SCALA_CLIENT_API_KEY . Si no tiene un registro aquí.

3. Todo se ve genial. ¿Quiero charlar contigo sobre tu investigación y desarrollo?

   Simplemente envíenos un correo electrónico a [email protected].

Licencia ⚖️

Esta biblioteca está disponible y publicada como código abierto bajo los términos de la licencia MIT.

Colaboradores

Este proyecto es de código abierto y da la bienvenida a cualquier contribución o retroalimentación (aquí).

El desarrollo de esta biblioteca ha sido respaldado por - Cequence.io - The future of contracting

Creado y mantenido por Peter Banda.