Descarga pinecone rust client - Descargar el código fuente pinecone rust client

Pinecone Rust Sdk

️ ADVERTENCIA: Este SDK todavía está en un estado alfa. Si bien se construye principalmente y está funcional, puede sufrir cambios a medida que continuamos mejorando el UX. Pruébelo y danos sus comentarios, pero tenga en cuenta que las actualizaciones pueden introducir cambios de ruptura.

Documentación

La documentación se puede encontrar aquí.

Requisitos previos

Versión de óxido: probado con óxido versión 1.78.0

Antes de que pueda usar el SDK de Pinecone, debe registrarse para obtener una cuenta y encontrar su tecla API en el tablero de la consola Pinecone en https://app.pinecone.io.

Instalación

Ejecute cargo add pinecone-sdk para agregar la caja como dependencia, o agregue la línea pinecone-sdk = "0.1.2" a su archivo de carga. Toml en [dependencies] . Se puede encontrar más sobre la caja aquí.

Uso

La clase PineconeClient es el punto principal de entrada en el SDK de Rust. Los parámetros pueden pasar directamente en Options o leer las variables de entorno de la siguiente manera. Más detalle:

La tecla API debe pasar en un argumento o como una variable de entorno llamada PINECONE_API_KEY . Si se pasa como None , el cliente intentará leer en un valor variable de entorno.
El host del plano de control, si se pasa como None , intentará leer en una variable de entorno llamada PINECONE_CONTROLLER_HOST . Si no es una variable de entorno, será predeterminado a https://api.pinecone.io .

Hay un par de formas de instanciar al cliente, detallado a continuación:

Pineconeclientconfig

Inicialice una estructura PineconeClientConfig con parámetros y llame config mediante la estructura.

 use pinecone_sdk :: pinecone :: { PineconeClient , PineconeClientConfig } ;

let config = PineconeClientConfig {
    api_key : Some ( "INSERT_API_KEY" . to_string ( ) ) ,
    control_plane_host : Some ( "INSERT_CONTROLLER_HOST" . to_string ( ) ) ,
    .. Default :: default ( )
} ;

let pinecone : PineconeClient = config . client ( ) . expect ( "Failed to create Pinecone instance" ) ;

Cliente predeterminado

Use la función default_client() , que es el equivalente de construir una estructura PineconeClientConfig con todos los campos establecidos en None . La clave API y el host del plano de control (opcional) se leerán de las variables de entorno.

 let pinecone : PineconeClient = pinecone_sdk :: pinecone :: default_client ( ) . expect ( "Failed to create Pinecone instance" ) ;

Índices

Crear índice

Crear índice sin servidor

El siguiente ejemplo crea un índice sin servidor en la región us-east-1 de AWS. Para obtener más información sobre la disponibilidad sin servidor y regional, consulte Índices de comprensión

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Metric , Cloud , WaitPolicy , IndexModel } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_description : IndexModel = pinecone . create_serverless_index (
    "index-name" ,       // Name of the index
    10 ,                 // Dimension of the vectors
    Metric :: Cosine ,     // Distance metric
    Cloud :: Aws ,         // Cloud provider
    "us-east-1" ,        // Region
    WaitPolicy :: NoWait  // Timeout
) . await ? ;

Crear índice POD

El siguiente ejemplo crea un índice POD en la región us-east-1 de AWS.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Metric , Cloud , WaitPolicy , IndexModel } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_description : IndexModel = pinecone . create_pod_index (
    "index-name" ,       // Index name
    10 ,                 // Dimension
    Metric :: Cosine ,     // Distance metric
    "us-east-1" ,        // Region
    "p1.x1" ,            // Pod type
    1 ,                  // Number of pods
    None ,               // Number of replicas
    None ,               // Number of shards
    None ,               // Metadata to index
    None ,               // Source collection
    WaitPolicy :: NoWait  // Wait policy
) . await ? ;

Los índices POD admiten varios campos de configuración opcionales. El siguiente ejemplo construye un índice POD con alguna especificación para estos campos.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Metric , Cloud , WaitPolicy , IndexModel } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_description : IndexModel = pinecone . create_pod_index (
    "index-name" ,       // Index name
    10 ,                 // Dimension
    Metric :: Cosine ,     // Distance metric
    "us-east-1" ,        // Region
    "p1.x1" ,            // Pod type
    1 ,                  // Number of pods
    Some ( 1 ) ,            // Number of replicas
    Some ( 1 ) ,            // Number of shards
    Some (               // Metadata fields to index
        & vec ! [ "genre" ,
            "title" ,
            "imdb_rating" ] ) ,
    Some ( "collection" ) , // Source collection
    WaitPolicy :: NoWait  // Wait policy
) . await ? ;

Índices de listas

El siguiente ejemplo enumera todos los índices en su proyecto.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: IndexList ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_list : IndexList = pinecone . list_indexes ( ) . await ? ;

Describir el índice

El siguiente ejemplo devuelve información sobre el index-name .

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: IndexModel ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_description : IndexModel = pinecone . describe_index ( "index-name" ) . await ? ;

Configurar índice

La configuración de un índice toma tres parámetros opcionales: un enum de la protección de eliminación, el número de réplicas y el tipo de POD. La protección de eliminación se puede actualizar para cualquier tipo de índice, mientras que el número de réplicas y el tipo de POD solo se pueden actualizar para los índices POD.

El siguiente ejemplo deshabilita la protección de deleción para el index-name índice.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: IndexModel ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_description : IndexModel = pinecone . configure_index ( "index-name" , Some ( DeletionProtection :: Disabled ) , None , None ) . await ? ;

El siguiente ejemplo cambia el index-name índice para tener 6 réplicas y el tipo de POD s1 . El tipo de protección de deleción no se cambiará en este caso.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: IndexModel ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let index_description : IndexModel = pinecone . configure_index ( "index-name" , None , Some ( 6 ) , Some ( "s1" ) ) . await ? ;

Eliminar índice

El siguiente ejemplo elimina el index-name índice.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

pinecone . delete_index ( "index-name" ) . await ? ;

Describe estadísticas de índice

El siguiente ejemplo devuelve estadísticas sobre el índice con host index-host . Sin filtro

 use std :: collections :: BTreeMap ;
use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: DescribeIndexStatsResponse ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let response : DescribeIndexStatsResponse = index . describe_index_stats ( None ) . await ? ;

Con filtro

 use std :: collections :: BTreeMap ;
use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Value , Kind , Metadata , DescribeIndexStatsResponse } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let mut fields = BTreeMap :: new ( ) ;
let kind = Some ( Kind :: StringValue ( "value" . to_string ( ) ) ) ;
fields . insert ( "field" . to_string ( ) , Value { kind } ) ;

let response : DescribeIndexStatsResponse = index . describe_index_stats ( Some ( Metadata { fields } ) ) . await ? ;

Vectores Upsert

El siguiente ejemplo eleva dos vectores en el índice con el host index-host .

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Vector , UpsertResponse } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let vectors = [ Vector {
    id : "id1" . to_string ( ) ,
    values : vec ! [ 1.0 , 2.0 , 3.0 , 4.0 ] ,
    sparse_values : None ,
    metadata : None ,
} , Vector {
    id : "id2" . to_string ( ) ,
    values : vec ! [ 2.0 , 3.0 , 4.0 , 5.0 ] ,
    sparse_values : None ,
    metadata : None ,
} ] ;

let response : UpsertResponse = index . upsert ( & vectors , & "namespace" . into ( ) ) . await ? ;

Vectores de consulta

Hay dos formas compatibles de consultar un índice.

Consulta por índice

El siguiente ejemplo consulta el índice con Host index-host para el vector con ID vector-id , y devuelve las 10 coincidencias principales.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Namespace , QueryResponse } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

// Connect to index at host "index-host"
let mut index = pinecone . index ( "index-host" ) . await ? ;

// Query the vector with id "vector-id" in the namespace "namespace"
let response : QueryResponse = index . query_by_id (
    "vector-id" . to_string ( ) ,
    10 ,
    & Namespace :: default ( ) ,
    None ,
    None ,
    None
) . await ? ;

Consulta por valor

El siguiente ejemplo consulta el índice con index-host para el vector con valores [1.0, 2.0, 3.0, 4.0] , y devuelve las 10 coincidencias principales.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Namespace , QueryResponse } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let vector = vec ! [ 1.0 , 2.0 , 3.0 , 4.0 ] ;

let response : QueryResponse = index . query_by_value (
    vector ,
    None ,
    10 ,
    & Namespace :: default ( ) ,
    None ,
    None ,
    None
) . await ? ;

Eliminar vectores

Hay tres formas compatibles de eliminar vectores.

Eliminar por ID

El siguiente ejemplo elimina el vector con ID vector-id en el namespace de nombres.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let ids = [ "vector-id" ]

index . delete_by_id ( & ids , & "namespace" . into ( ) ) . await ? ;

Eliminar por filtro:

El siguiente ejemplo elimina los vectores que satisfacen el filtro en el namespace nombres.

 use std :: collections :: BTreeMap ;
use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Metadata , Value , Kind , Namespace } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut fields = BTreeMap :: new ( ) ;
let kind = Some ( Kind :: StringValue ( "value" . to_string ( ) ) ) ;
fields . insert ( "field" . to_string ( ) , Value { kind } ) ;

index . delete_by_filter ( Metadata { fields } , & "namespace" . into ( ) ) . await ? ;

Eliminar todo:

El siguiente ejemplo elimina todos los vectores en el namespace nombres.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

index . delete_all ( & "namespace" . into ( ) ) . await ? ;

Buscar vectores

El siguiente ejemplo obtiene los vectores con IDS 1 y 2 del espacio de nombres predeterminado.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: FetchResponse ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let vectors = & [ "1" , "2" ] ;

let response : FetchResponse = index . fetch ( vectors , & Default :: default ( ) ) . await ? ;

Actualizar vectores

El siguiente ejemplo actualiza el Vector con ID vector-id en el namespace de nombres para tener valores [1.0, 2.0, 3.0, 4.0] .

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: UpdateResponse ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let response : UpdateResponse = index . update ( "vector-id" , vec ! [ 1.0 , 2.0 , 3.0 , 4.0 ] , None , None , & "namespace" . into ( ) ) . await ? ;

Vectores de lista

El siguiente ejemplo enumera los vectores en el namespace de nombres.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: { Namespace , ListResponse } ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let mut index = pinecone . index ( "index-host" ) . await ? ;

let response : ListResponse = index . list ( & "namespace" . into ( ) , None , None , None ) . await ? ;

Colecciones

Crear colección

El siguiente ejemplo crea un collection-name colección en el index-name índice.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: CollectionModel ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let collection : CollectionModel = pinecone . create_collection ( "collection-name" , "index-name" ) . await ? ;

Colecciones de listas

El siguiente ejemplo enumera todas las colecciones en un proyecto.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: CollectionList ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let collection_list : CollectionList = pinecone . list_collections ( ) . await ? ;

Describe la colección

El siguiente ejemplo describe el collection-name la colección.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;
use pinecone_sdk :: models :: CollectionModel ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

let collection : CollectionModel = pinecone . describe_collection ( "collection-name" ) . await ? ;

Colección de eliminación

El siguiente ejemplo elimina el collection-name la colección.

 use pinecone_sdk :: pinecone :: PineconeClientConfig ;

let config = PineconeClientConfig {
    api_key : Some ( ' << PINECONE_API_KEY >> ' ) ,
    .. Default :: default ( )
} ;
let pinecone = config . client ( ) ? ;

pinecone . delete_collection ( "collection-name" ) . await ? ;

Que contribuye

Si desea hacer una contribución o configurar localmente para desarrollar el cliente de óxido de Pinecone, consulte nuestra guía de contribución

Expandir