Struct PineconeConfiguration

#[non_exhaustive]
pub struct PineconeConfiguration {
    pub connection_string: String,
    pub credentials_secret_arn: String,
    pub namespace: Option<String>,
    pub field_mapping: Option<PineconeFieldMapping>,
}

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

connection_string: String

The endpoint URL for your index management page.

credentials_secret_arn: String

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

namespace: Option<String>

The namespace to be used to write new data to your database.

field_mapping: Option<PineconeFieldMapping>

Contains the names of the fields to which to map information about the vector store.

Implementations

impl PineconeConfiguration

pub fn connection_string(&self) -> &str

The endpoint URL for your index management page.

pub fn credentials_secret_arn(&self) -> &str

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

pub fn namespace(&self) -> Option<&str>

The namespace to be used to write new data to your database.

pub fn field_mapping(&self) -> Option<&PineconeFieldMapping>

Contains the names of the fields to which to map information about the vector store.

impl PineconeConfiguration

pub fn builder() -> PineconeConfigurationBuilder

Creates a new builder-style object to manufacture PineconeConfiguration.

Trait Implementations

impl Clone for PineconeConfiguration

fn clone(&self) -> PineconeConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PineconeConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PineconeConfiguration

fn eq(&self, other: &PineconeConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PineconeConfiguration