pinecone rust client Download - pinecone rust client Quellcode Download

Tinecone Rost SDK

Euen Warnung: Dieser SDK befindet sich immer noch in einem Alpha -Zustand. Während es größtenteils ausgebaut und funktional ist, kann es sich ändern, wenn wir die UX weiter verbessern. Bitte probieren Sie es aus und geben Sie uns Ihr Feedback. Beachten Sie jedoch, dass Updates möglicherweise Veränderungen führen.

Dokumentation

Die Dokumentation finden Sie hier.

Voraussetzungen

Rostversion: getestet mit Rust Version 1.78.0

Bevor Sie das PineCone SDK verwenden können, müssen Sie sich für ein Konto anmelden und Ihre API -Taste im Pinecone -Konsolen -Dashboard unter https://app.pinecone.io finden.

Installation

Fügen Sie cargo add pinecone-sdk um die Kiste als Abhängigkeit hinzuzufügen, oder fügen Sie die Zeile pinecone-sdk = "0.1.2" Ihrer Datei mit Cargo.toml unter [dependencies] hinzu. Weitere Informationen zur Kiste finden Sie hier.

Verwendung

Die PineconeClient -Klasse ist der Haupteintrittspunkt in das Rust SDK. Parameter können entweder direkt als Options übergeben oder wie folgt Umgebungsvariablen durchlesen. Weitere Details:

Der API -Schlüssel muss entweder als Argument oder als Umgebungsvariable als PINECONE_API_KEY übergeben werden. Wenn der Kunde als None weitergegeben wird, versucht er, in einem Umgebungsvariablenwert zu lesen.
Wenn der Steuerebene -Host als None weitergegeben wird, wird versucht, in einer Umgebungsvariablen namens PINECONE_CONTROLLER_HOST zu lesen. Wenn es sich nicht um eine Umgebungsvariable handelt, ist es standardmäßig https://api.pinecone.io .

Es gibt einige Möglichkeiten, den Kunden zu instanziieren, detailliert:

PineconeClientConfig

Initialisieren Sie eine PineconeClientConfig -Struktur mit Parametern und rufen Sie config mit der Struktur auf.

 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" ) ;

Standard Client

Verwenden Sie die Funktion default_client() , die das Erstellen einer PineconeClientConfig -Struktur mit allen auf None festgelegten Feldern entspricht. Der API -Schlüssel- und Kontrollebene -Host (optional) wird aus Umgebungsvariablen gelesen.

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

Indizes

Index erstellen

Serverloser Index erstellen

Das folgende Beispiel erstellt einen serverlosen Index in der us-east-1 Region von AWS. Weitere Informationen zu serverloser und regionaler Verfügbarkeit finden Sie unter Verständnis -Indizes

 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 ? ;

POD -Index erstellen

Das folgende Beispiel erstellt einen POD-Index in der us-east-1 Region von 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 ? ;

POD -Indizes unterstützen mehrere optionale Konfigurationsfelder. Das folgende Beispiel konstruiert einen POD -Index mit einigen Spezifikationen für diese Felder.

 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 ? ;

Listenindizes

Das folgende Beispiel listet alle Indizes in Ihrem Projekt auf.

 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 ? ;

Beschreiben Sie den Index

Das folgende Beispiel gibt Informationen über den index-name zurück.

 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 ? ;

Index konfigurieren

Das Konfigurieren eines Index erfordert drei optionale Parameter - eine Löschprotektion, die Anzahl der Repliken und den POD -Typ. Der Löschschutz kann für jeden Indextyp aktualisiert werden, während die Anzahl der Replikate und der POD -Typ nur für POD -Indizes aktualisiert werden kann.

Das folgende Beispiel deaktiviert den Löscherschutz für den Index 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 . configure_index ( "index-name" , Some ( DeletionProtection :: Disabled ) , None , None ) . await ? ;

Das folgende Beispiel ändert den Index index-name auf 6 Replikate und den POD-Typ s1 . Der Löschschutztyp wird in diesem Fall nicht geändert.

 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 ? ;

Index löschen

Das folgende Beispiel löscht den Index index-name .

 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 ? ;

Beschreiben Sie die Indexstatistik

Das folgende Beispiel gibt Statistiken zum Index mit Host index-host zurück. Ohne Filter

 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 ? ;

Mit Filter

 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 ? ;

Höhenvektoren

Das folgende Beispiel erhöht zwei Vektoren mit Host index-host in den Index.

 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 ? ;

Abfragevektoren

Es gibt zwei unterstützte Möglichkeiten, einen Index abzufragen.

Abfrage nach Index

Das folgende Beispiel fragt den Index mit dem Host index-host für den Vektor mit ID- vector-id ab und gibt die Top 10 Übereinstimmungen zurück.

 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 ? ;

Nach Wert abfragen

Das folgende Beispiel gibt den Index mit dem Host index-host für den Vektor mit Werten [1.0, 2.0, 3.0, 4.0] ab und gibt die Top 10 Übereinstimmungen zurück.

 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 ? ;

Vektoren löschen

Es gibt drei unterstützte Möglichkeiten zum Löschen von Vektoren.

Durch ID löschen

Das folgende Beispiel löscht den Vektor mit ID- vector-id im Namespace namespace .

 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 ? ;

Durch Filter löschen:

Das folgende Beispiel löscht Vektoren, die den Filter im Namespace namespace erfüllen.

 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 ? ;

Alle löschen:

Das folgende Beispiel löscht alle Vektoren im Namespace namespace .

 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 ? ;

Vektoren holen

Das folgende Beispiel holt die Vektoren mit IDS 1 und 2 aus dem Standard -Namespace.

 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 ? ;

Vektoren aktualisieren

Das folgende Beispiel aktualisiert den Vektor mit ID- vector-id im Namespace namespace mit Werten [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 ? ;

Listen Sie Vektoren auf

Das folgende Beispiel listet Vektoren im Namespace namespace auf.

 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 ? ;

Sammlungen

Sammlung erstellen

Das folgende Beispiel erstellt im Index index-name einen collection-name .

 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 ? ;

Auflistungssammlungen

Das folgende Beispiel listet alle Sammlungen in einem Projekt auf.

 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 ? ;

Beschreiben Sie die Sammlung

Das folgende Beispiel beschreibt den collection-name .

 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 ? ;

Sammlung löschen

Das folgende Beispiel löscht den collection-name .

 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 ? ;

Beitragen

Wenn Sie einen Beitrag leisten möchten oder lokal einrichten, um den Pinecone Rust -Kunden zu entwickeln, finden Sie in unserem Beitragsführer

Expandieren