Qdrant Client

https://docs.rs/qdrant-client/latest/qdrant_client/
Admin
Qdrant Client is a Rust library that provides an easy-to-use API interface to connect to and...
Tokens:65,070
Snippets:727
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### recommend

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/points_server/trait.Points.html

Look for the points which are closer to stored positive examples and at the same time further to negative examples. Note: This method is deprecated; use Query with a recommend query instead.

```APIDOC
## recommend

### Description
Look for the points which are closer to stored positive examples and at the same time further to negative examples.

### Parameters
- **request** (Request<RecommendPoints>) - Required - The recommendation request parameters.
```

--------------------------------

### FeedbackItemBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.FeedbackItemBuilder.html

Creates a new instance of the FeedbackItemBuilder with a specified example and score.

```APIDOC
## FeedbackItemBuilder::new(example: impl Into<VectorInput>, score: f32) -> Self

### Description
Creates a new builder instance with an example (ID or vector) and its associated score.

### Parameters
- **example** (impl Into<VectorInput>) - Required - The ID or vector from the original model.
- **score** (f32) - Required - Score for this vector as determined by the feedback provider.

### Example
```rust
use qdrant_client::qdrant::{FeedbackItemBuilder, PointId, VectorInput};

let item = FeedbackItemBuilder::new(VectorInput::new_id(PointId::from(42)), 0.9);
```
```

--------------------------------

### Initialize Qdrant client with configuration

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/struct.QdrantConfig.html

Example of using the builder pattern to construct a Qdrant client instance with specific configuration options.

```rust
use qdrant_client::Qdrant;
use qdrant_client::config::CompressionEncoding;

let client = Qdrant::from_url("http://localhost:6334")
    .api_key(std::env::var("QDRANT_API_KEY"))
    .timeout(std::time::Duration::from_secs(10))
    .compression(Some(CompressionEncoding::Gzip))
    .build();
```

--------------------------------

### update_collection_cluster_setup

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_server/trait.Collections.html

Update cluster setup for a collection.

```APIDOC
## update_collection_cluster_setup(request: Request<UpdateCollectionClusterSetupRequest>)

### Description
Update cluster setup for a collection.

### Parameters
- **request** (Request<UpdateCollectionClusterSetupRequest>) - Required - The cluster setup update parameters.
```

--------------------------------

### ContextExamplePairBuilder Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ContextExamplePairBuilder.html

The structure definition for the builder used to create context example pairs.

```rust
pub struct ContextExamplePairBuilder { /* private fields */ }
```

--------------------------------

### Recommend points in Qdrant

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Retrieves recommendations based on positive and negative examples. Deprecated since 1.20.0; use query with a RecommendInput query instead.

```rust
use qdrant_client::qdrant::{Condition, Filter, RecommendPointsBuilder, RecommendStrategy};

client
    .recommend(
        RecommendPointsBuilder::new("my_collection", 3)
            .add_positive(100)
            .add_positive(200)
            .add_positive(vec![100.0, 231.0])
            .add_negative(718)
            .add_negative(vec![0.2, 0.3, 0.4, 0.5])
            .strategy(RecommendStrategy::AverageVector)
            .filter(Filter::must([Condition::matches(
                "city",
                "London".to_string(),
            )])),
    )
    .await?;
```

--------------------------------

### ContextExamplePair struct definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ContextExamplePair.html

The structure definition for ContextExamplePair, containing optional positive and negative vector examples.

```rust
pub struct ContextExamplePair {
    pub positive: Option<VectorExample>,
    pub negative: Option<VectorExample>,
}
```

--------------------------------

### RecommendInput Struct Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RecommendInput.html

The structure definition for RecommendInput, containing vectors for positive and negative examples and an optional strategy.

```rust
pub struct RecommendInput {
    pub positive: Vec<VectorInput>,
    pub negative: Vec<VectorInput>,
    pub strategy: Option<i32>,
}
```

--------------------------------

### get

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_client/struct.CollectionsClient.html

Retrieves detailed information about a specified existing collection.

```APIDOC
## pub async fn get(&mut self, request: impl IntoRequest<GetCollectionInfoRequest>) -> Result<Response<GetCollectionInfoResponse>, Status>

### Description
Get detailed information about a specified existing collection.

### Parameters
- **request** (impl IntoRequest<GetCollectionInfoRequest>) - Required - The request object containing the collection name.
```

--------------------------------

### VectorExample Struct Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.VectorExample.html

The definition of the VectorExample struct containing an optional example field.

```rust
pub struct VectorExample {
    pub example: Option<Example>,
}
```

--------------------------------

### Update collection cluster setup

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Performs cluster operations like moving, replicating, or creating shard keys for a specified collection.

```rust
use qdrant_client::qdrant::{MoveShardBuilder, UpdateCollectionClusterSetupRequestBuilder};

client
    .update_collection_cluster_setup(UpdateCollectionClusterSetupRequestBuilder::new(
        "my_collection",
        MoveShardBuilder::new(
            0, // Shard ID
            0, // From peer ID
            1, // To peer ID
        ),
    ))
    .await?;
```

--------------------------------

### Match keywords by prefix

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.Condition.html

Creates a condition to match keywords starting with a specific prefix. Requires the keyword index to have prefix matching enabled.

```rust
qdrant_client::qdrant::Condition::matches_prefix("city", "Ber");
```

--------------------------------

### Example Enum Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/vector_example/enum.Example.html

The definition of the Example enum, which can hold either a PointId or a Vector.

```rust
pub enum Example {
    Id(PointId),
    Vector(Vector),
}
```

--------------------------------

### Initialize Qdrant Client

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Demonstrates basic and advanced client initialization using URLs, API keys, and timeouts.

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("http://localhost:6334").build()?;
```

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("http://localhost:6334")
    .api_key(std::env::var("QDRANT_API_KEY"))
    .timeout(std::time::Duration::from_secs(10))
    .build()?;
```

--------------------------------

### Discover points in a collection

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Uses the discovery API to find points based on context examples and a target vector. This method is deprecated since 1.20.0; use query with DiscoverInput or ContextInput instead.

```rust
use qdrant_client::qdrant::{
    target_vector::Target, vector_example::Example, ContextExamplePairBuilder,
    DiscoverPointsBuilder, VectorExample,
};

client
    .discover(
        DiscoverPointsBuilder::new(
            "my_collection", // Collection name
            vec![
                ContextExamplePairBuilder::default()
                    .positive(Example::Id(100.into()))
                    .negative(Example::Id(718.into()))
                    .build(),
                ContextExamplePairBuilder::default()
                    .positive(Example::Id(200.into()))
                    .negative(Example::Id(300.into()))
                    .build(),
            ],
            10,              // Search limit
        )
        .target(Target::Single(VectorExample {
            example: Some(Example::Vector(vec![0.2, 0.1, 0.9, 0.7].into())),
        })),
    )
    .await?;
```

--------------------------------

### Initialize Qdrant client from URL

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/struct.QdrantConfig.html

Create a Qdrant client instance using a specific server URL.

```rust
let client = QdrantConfig::from_url("http://localhost:6334").build();
```

--------------------------------

### Qdrant::from_url

Source: https://docs.rs/qdrant-client/latest/qdrant_client/index.html

Initializes a new Qdrant client instance to connect to a server.

```APIDOC
## Qdrant::from_url

### Description
Initializes a new Qdrant client instance using the provided URL and optional API key.

### Method
Rust Method

### Parameters
- **url** (string) - Required - The URL of the Qdrant instance.
- **api_key** (string) - Optional - The API key for authentication.

### Request Example
```rust
let client = Qdrant::from_url("http://localhost:6334")
    .api_key(std::env::var("QDRANT_API_KEY"))
    .build()?;
```
```

--------------------------------

### collection_cluster_info

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_server/trait.Collections.html

Get cluster information for a collection.

```APIDOC
## collection_cluster_info(request: Request<CollectionClusterInfoRequest>)

### Description
Get cluster information for a collection.

### Parameters
- **request** (Request<CollectionClusterInfoRequest>) - Required - The request specifying the collection.
```

--------------------------------

### Connect to Qdrant instance

Source: https://docs.rs/qdrant-client/latest/qdrant_client/index.html

Initializes a Qdrant client using a URL and an optional API key from environment variables.

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("http://localhost:6334")
    .api_key(std::env::var("QDRANT_API_KEY"))
    .build()?;
```

--------------------------------

### list_aliases

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_server/trait.Collections.html

Get a list of all aliases for all existing collections.

```APIDOC
## list_aliases(request: Request<ListAliasesRequest>)

### Description
Get list of all aliases for all existing collections.

### Parameters
- **request** (Request<ListAliasesRequest>) - Required - The request object.
```

--------------------------------

### list_collection_aliases

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_server/trait.Collections.html

Get a list of all aliases for a specific collection.

```APIDOC
## list_collection_aliases(request: Request<ListCollectionAliasesRequest>)

### Description
Get list of all aliases for a collection.

### Parameters
- **request** (Request<ListCollectionAliasesRequest>) - Required - The request specifying the collection.
```

--------------------------------

### create_full

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/snapshots_client/struct.SnapshotsClient.html

Creates a full storage snapshot.

```APIDOC
## pub async fn create_full(&mut self, request: impl IntoRequest<CreateFullSnapshotRequest>) -> Result<Response<CreateSnapshotResponse>, Status>

### Description
Creates a snapshot of the entire Qdrant storage.
```

--------------------------------

### Qdrant Configuration

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Methods for configuring the Qdrant client during initialization.

```APIDOC
## Qdrant Configuration Methods

### Description
Methods used on the builder returned by `from_url` to configure authentication and connection settings.

### Methods
- **api_key(key: String)**: Sets the API key for authentication.
- **timeout(duration: Duration)**: Sets the request timeout duration.
- **build()**: Finalizes the configuration and returns the Qdrant client instance.

### Example
```rust
let client = Qdrant::from_url("http://localhost:6334")
    .api_key(std::env::var("QDRANT_API_KEY"))
    .timeout(std::time::Duration::from_secs(10))
    .build()?;
```
```

--------------------------------

### Get collection information

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Retrieves metadata for a specific collection.

```rust
client.collection_info("my_collection").await?;
```

--------------------------------

### Constructing AcornSearchParams

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.AcornSearchParamsBuilder.html

Demonstrates initializing the builder and configuring the maximum selectivity threshold.

```rust
use qdrant_client::qdrant::AcornSearchParamsBuilder;

let acorn = AcornSearchParamsBuilder::new(true).build();
let acorn_with_selectivity = AcornSearchParamsBuilder::new(true)
    .max_selectivity(0.5)
    .build();
```

--------------------------------

### Create a Qdrant collection

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Initializes a new collection with specified vector parameters.

```rust
use qdrant_client::qdrant::{CreateCollectionBuilder, Distance, VectorParamsBuilder};

client
    .create_collection(
        CreateCollectionBuilder::new("my_collection")
            .vectors_config(VectorParamsBuilder::new(100, Distance::Cosine)),
    )
    .await?;
```

--------------------------------

### Get collection cluster info

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Retrieves cluster-related information for a specific collection.

```rust
client.collection_cluster_info("my_collection").await?;
```

--------------------------------

### QdrantConfig Builder Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/struct.QdrantConfig.html

Methods used to configure the Qdrant client before building it.

```APIDOC
## QdrantConfig Builder

### Description
The `QdrantConfig` struct allows for the configuration of a `Qdrant` client instance. It supports setting connection parameters, authentication, and performance settings before finalizing the client with the `build()` method.

### Methods
- **from_url(url: &str) -> Self**: Initializes the configuration with a base URL.
- **header(key: impl Into<String>, value: impl Into<String>) -> Self**: Adds a custom header to every request.
- **api_key(api_key: impl AsOptionApiKey) -> Self**: Sets an optional API key for authentication.
- **timeout(timeout: impl AsTimeout) -> Self**: Sets the request timeout duration.
- **connect_timeout(timeout: impl AsTimeout) -> Self**: Sets the connection timeout duration.
- **compression(compression: Option<CompressionEncoding>) -> Self**: Configures the compression encoding (e.g., Gzip).
- **keep_alive_while_idle() -> Self**: Enables keeping the connection alive during idle periods.
- **check_connection() -> Self**: Forces a health check during the build process to verify server connectivity.
- **skip_compatibility_check() -> Self**: Skips the compatibility check during build.
- **build() -> Result<Qdrant, QdrantError>**: Finalizes the configuration and returns a `Qdrant` client instance.

### Example
```rust
let client = Qdrant::from_url("http://localhost:6334")
    .header("x-custom-id", "my-client")
    .api_key("my-secret-key")
    .timeout(std::time::Duration::from_secs(10))
    .check_connection()
    .build();
```
```

--------------------------------

### Get last element

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns the last element of the slice, or None if it is empty.

```rust
let v = [10, 40, 30];
assert_eq!(Some(&30), v.last());

let w: &[i32] = &[];
assert_eq!(None, w.last());
```

--------------------------------

### Get first element

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns the first element of the slice, or None if it is empty.

```rust
let v = [10, 40, 30];
assert_eq!(Some(&10), v.first());

let w: &[i32] = &[];
assert_eq!(None, w.first());
```

--------------------------------

### Create a ShardKeySelectorBuilder with with_shard_keys()

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ShardKeySelectorBuilder.html

Initializes a builder directly with a collection of shard keys.

```rust
use qdrant_client::qdrant::{ShardKey, ShardKeySelectorBuilder};

let selector = ShardKeySelectorBuilder::with_shard_keys(
    vec![ShardKey::from("key1".to_string())]
).build();
```

--------------------------------

### Target Enum Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/target_vector/enum.Target.html

The definition of the Target enum, which encapsulates a single vector example.

```rust
pub enum Target {
    Single(VectorExample),
}
```

--------------------------------

### Usage of AsOptionApiKey

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/trait.AsOptionApiKey.html

Demonstrates passing different types to a configuration method that accepts AsOptionApiKey.

```rust
config
    .api_key("secret")
    .api_key(String::from("secret"))
    .api_key(std::env::var("QDRANT_API_KEY"))
    .api_key(None::<String>);
```

--------------------------------

### Create a naive feedback strategy in Rust

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.FeedbackStrategyBuilder.html

Initializes a new FeedbackStrategyBuilder using the naive method with specified coefficients.

```rust
use qdrant_client::qdrant::FeedbackStrategyBuilder;

let strategy = FeedbackStrategyBuilder::naive(1.0, 1.0, 1.0);
```

--------------------------------

### Get facet counts

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Retrieves the count of records for each unique value of a specified field.

```rust
use qdrant_client::qdrant::{Condition, FacetCountsBuilder, Filter};

let ten_countries_with_most_points_in_europe = client
   .facet(
        FacetCountsBuilder::new("world_data", "country")
            .limit(10)
            .filter(Filter::must(vec![Condition::matches(
                "continent",
                "Europe".to_string(),
            )])),
    )
    .await
    .unwrap();
```

--------------------------------

### MmrBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.MmrBuilder.html

Creates a new instance of MmrBuilder with default configuration values.

```APIDOC
## pub fn new() -> Self

### Description
Creates a new MmrBuilder with default values.
```

--------------------------------

### Get last chunk

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns an array reference to the last N items in the slice.

```rust
let u = [10, 40, 30];
assert_eq!(Some(&[40, 30]), u.last_chunk::<2>());

let v: &[i32] = &[10];
assert_eq!(None, v.last_chunk::<2>());

let w: &[i32] = &[];
assert_eq!(Some(&[]), w.last_chunk::<0>());
```

--------------------------------

### Query Constructors

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.Query.html

Available methods for initializing different types of queries.

```rust
pub fn new_nearest(value: impl Into<VectorInput>) -> Self
```

```rust
pub fn new_nearest_with_mmr( vector: impl Into<VectorInput>, mmr: impl Into<Mmr>, ) -> Self
```

```rust
pub fn new_recommend(value: impl Into<RecommendInput>) -> Self
```

```rust
pub fn new_discover(value: impl Into<DiscoverInput>) -> Self
```

```rust
pub fn new_context(value: impl Into<ContextInput>) -> Self
```

```rust
pub fn new_order_by(value: impl Into<OrderBy>) -> Self
```

```rust
pub fn new_fusion(value: Fusion) -> Self
```

```rust
pub fn new_rrf(rrf: impl Into<Rrf>) -> Self
```

```rust
pub fn new_formula(formula: impl Into<Formula>) -> Self
```

```rust
pub fn new_sample(value: Sample) -> Self
```

```rust
pub fn new_relevance_feedback(value: impl Into<RelevanceFeedbackInput>) -> Self
```

--------------------------------

### Get first chunk

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns an array reference to the first N items in the slice.

```rust
let u = [10, 40, 30];
assert_eq!(Some(&[10, 40]), u.first_chunk::<2>());

let v: &[i32] = &[10];
assert_eq!(None, v.first_chunk::<2>());

let w: &[i32] = &[];
assert_eq!(Some(&[]), w.first_chunk::<0>());
```

--------------------------------

### Check if a slice starts with a prefix

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Determine if a slice begins with a specific sequence of elements.

```rust
let v = [10, 40, 30];
assert!(v.starts_with(&[10]));
assert!(v.starts_with(&[10, 40]));
assert!(v.starts_with(&v));
assert!(!v.starts_with(&[50]));
assert!(!v.starts_with(&[10, 50]));
```

```rust
let v = &[10, 40, 30];
assert!(v.starts_with(&[]));
let v: &[u8] = &[];
assert!(v.starts_with(&[]));
```

--------------------------------

### Create a ShardKeySelectorBuilder with new()

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ShardKeySelectorBuilder.html

Initializes a builder with default values and adds a shard key using the fluent API.

```rust
use qdrant_client::qdrant::{ShardKey, ShardKeySelectorBuilder};

let selector = ShardKeySelectorBuilder::new()
    .add_shard_key(ShardKey::from("key1".to_string()))
    .build();
```

--------------------------------

### Get element or subslice by index

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns a reference to an element or subslice depending on the type of index.

```rust
let v = [10, 40, 30];
assert_eq!(Some(&40), v.get(1));
assert_eq!(Some(&[10, 40][..]), v.get(0..2));
assert_eq!(None, v.get(3));
assert_eq!(None, v.get(0..4));
```

--------------------------------

### DiscoverInputBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.DiscoverInputBuilder.html

Creates a new instance of the DiscoverInputBuilder with the specified target and context.

```APIDOC
## fn new(target: impl Into<VectorInput>, context: impl Into<ContextInput>) -> Self

### Description
Initializes a new builder instance with a primary search objective and contextual constraints.

### Parameters
- **target** (impl Into<VectorInput>) - The primary search objective.
- **context** (impl Into<ContextInput>) - The search space constraints defined by pairs of vectors.
```

--------------------------------

### list_full

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/snapshots_client/struct.SnapshotsClient.html

Lists all full storage snapshots.

```APIDOC
## pub async fn list_full(&mut self, request: impl IntoRequest<ListFullSnapshotsRequest>) -> Result<Response<ListSnapshotsResponse>, Status>

### Description
Retrieves a list of all full storage snapshots available.
```

--------------------------------

### ProductQuantizationBuilder Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ProductQuantizationBuilder.html

Methods available for configuring and building a ProductQuantization object.

```APIDOC
## ProductQuantizationBuilder::new(compression: i32)

### Description
Creates a new instance of the ProductQuantizationBuilder with the specified compression ratio.

## ProductQuantizationBuilder::compression(value: i32)

### Description
Sets the compression ratio for the quantization configuration.

## ProductQuantizationBuilder::always_ram(value: bool)

### Description
Configures whether quantized vectors are stored in RAM. Note: This is deprecated since 1.19.0; use `memory` instead.

## ProductQuantizationBuilder::memory<VALUE: Into<i32>>(value: VALUE)

### Description
Sets the memory placement configuration for quantized vectors. This overrides the `always_ram` flag.

## ProductQuantizationBuilder::build()

### Description
Finalizes the configuration and returns a `ProductQuantization` object.
```

--------------------------------

### Get payload value

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RetrievedPoint.html

Access a payload value by key. Returns a null value if the key is missing.

```rust
use qdrant_client::qdrant::RetrievedPoint;
let point = RetrievedPoint::default();
assert!(point.get("not_present").is_null());
```

--------------------------------

### Vector Creation Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.Vector.html

Methods for initializing different types of vectors.

```rust
pub fn new(values: Vec<f32>) -> Self
```

```rust
pub fn new_dense(values: impl Into<Vec<f32>>) -> Self
```

```rust
pub fn new_sparse( indices: impl Into<Vec<u32>>, values: impl Into<Vec<f32>>, ) -> Self
```

```rust
pub fn new_multi(vectors: impl Into<Vec<Vec<f32>>>) -> Self
```

--------------------------------

### client.create_collection

Source: https://docs.rs/qdrant-client/latest/qdrant_client/index.html

Creates a new collection in the Qdrant instance.

```APIDOC
## client.create_collection

### Description
Creates a new collection with specified vector parameters.

### Method
Rust Method

### Parameters
- **collection_name** (string) - Required - The name of the collection to create.
- **vectors_config** (VectorParamsBuilder) - Required - Configuration for the vectors (dimension and distance metric).

### Request Example
```rust
let response = client
    .create_collection(
        CreateCollectionBuilder::new("my_collection")
            .vectors_config(VectorParamsBuilder::new(512, Distance::Cosine)),
    )
    .await?;
```
```

--------------------------------

### Try get payload value

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RetrievedPoint.html

Attempt to access a payload value by key. Returns None if the key is missing.

```rust
use qdrant_client::qdrant::RetrievedPoint;
let point = RetrievedPoint::default();
assert_eq!(point.try_get("not_present"), None);
```

--------------------------------

### Configure collection optimizers with OptimizersConfigDiffBuilder

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.OptimizersConfigDiffBuilder.html

Demonstrates how to use the builder to set optimization thread limits and apply the configuration to a collection update.

```rust
use qdrant_client::qdrant::{OptimizersConfigDiffBuilder, UpdateCollectionBuilder, MaxOptimizationThreadsBuilder};

let optimizers_config = OptimizersConfigDiffBuilder::default()
    // Use exactly 8 threads
    .max_optimization_threads(8)
    // Or automatically choose
    .max_optimization_threads(MaxOptimizationThreadsBuilder::auto())
    // Or disable
    .max_optimization_threads(MaxOptimizationThreadsBuilder::disabled());

client
    .update_collection(
        UpdateCollectionBuilder::new("my_collection").optimizers_config(optimizers_config),
    )
    .await?;
```

--------------------------------

### Reverse split a slice into at most n items

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Split a slice starting from the end, limiting the number of returned items.

```rust
let v = [10, 40, 30, 20, 60, 50];

for group in v.rsplitn(2, |num| *num % 3 == 0) {
    println!("{group:?}");
}
```

--------------------------------

### QdrantClient::connect

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/qdrant_client/struct.QdrantClient.html

Attempts to create a new client by connecting to a given endpoint.

```APIDOC
## pub async fn connect<D>(dst: D) -> Result<Self, Error>

### Description
Attempt to create a new client by connecting to a given endpoint.

### Parameters
- **dst** (D) - Required - The destination endpoint to connect to.
```

--------------------------------

### Iterate over chunks from the end using rchunks

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns an iterator over non-overlapping chunks of a specified size, starting from the end of the slice.

```rust
let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.rchunks(2);
assert_eq!(iter.next().unwrap(), &['e', 'm']);
assert_eq!(iter.next().unwrap(), &['o', 'r']);
assert_eq!(iter.next().unwrap(), &['l']);
assert!(iter.next().is_none());
```

--------------------------------

### Create overlapping windows using array_windows

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns an iterator over overlapping windows of N elements starting from the beginning of the slice.

```rust
let slice = [0, 1, 2, 3];
let mut iter = slice.array_windows();
assert_eq!(iter.next().unwrap(), &[0, 1]);
assert_eq!(iter.next().unwrap(), &[1, 2]);
assert_eq!(iter.next().unwrap(), &[2, 3]);
assert!(iter.next().is_none());
```

--------------------------------

### create

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_client/struct.CollectionsClient.html

Creates a new collection with the provided parameters.

```APIDOC
## pub async fn create(&mut self, request: impl IntoRequest<CreateCollection>) -> Result<Response<CollectionOperationResponse>, Status>

### Description
Create new collection with given parameters.
```

--------------------------------

### pub async fn create_shard_key

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Create a new shard key in a collection.

```APIDOC
## pub async fn create_shard_key( &self, request: impl Into<CreateShardKeyRequest>, ) -> Result<CreateShardKeyResponse, QdrantError>

### Description
Creates a new shard key for the specified collection to support distributed deployment.

### Parameters
- **request** (impl Into<CreateShardKeyRequest>) - Required - The request object containing the collection name and the shard key definition.
```

--------------------------------

### Clone Client with Header

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Creates a lightweight clone of the client that includes an additional header in every request, useful for tracing.

```rust
use qdrant_client::Qdrant;

let traced = client.with_header("x-request-id", "abc-123");
// traced shares the same connection pool, but adds the header to every request
```

--------------------------------

### Get a range of raw pointers for a slice

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Returns a half-open range of pointers. Useful for C++ interoperability or checking if a pointer belongs to the slice.

```rust
let a = [1, 2, 3];
let x = &a[1] as *const _;
let y = &5 as *const _;

assert!(a.as_ptr_range().contains(&x));
assert!(!a.as_ptr_range().contains(&y));
```

--------------------------------

### ReplicatePointsBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ReplicatePointsBuilder.html

Initializes a new builder instance with the required source and target shard keys.

```APIDOC
## pub fn new(from_shard_key: impl Into<ShardKey>, to_shard_key: impl Into<ShardKey>) -> Self

### Description
Creates a new ReplicatePointsBuilder instance to define the replication source and target shards.

### Parameters
- **from_shard_key** (impl Into<ShardKey>) - Required - The source shard key to replicate points from.
- **to_shard_key** (impl Into<ShardKey>) - Required - The target shard key to replicate points to.
```

--------------------------------

### Split slice into chunks from the end using as_rchunks

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Splits a slice into N-element arrays starting from the end, returning a remainder and a slice of arrays.

```rust
let slice = ['l', 'o', 'r', 'e', 'm'];
let (remainder, chunks) = slice.as_rchunks();
assert_eq!(remainder, &['l']);
assert_eq!(chunks, &[['o', 'r'], ['e', 'm']]);
```

--------------------------------

### Create a new ReplicatePointsBuilder

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ReplicatePointsBuilder.html

Initializes a builder instance with the required source and target shard keys.

```rust
use qdrant_client::qdrant::{ReplicatePointsBuilder, ShardKey};

let replicate = ReplicatePointsBuilder::new(
    ShardKey::from("shard_1".to_string()),
    ShardKey::from("shard_2".to_string())
).build();
```

--------------------------------

### Create MmrBuilder with parameters

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.MmrBuilder.html

Initializes an MmrBuilder with specific diversity and candidate limit values using the with_params constructor.

```rust
use qdrant_client::qdrant::MmrBuilder;

let mmr = MmrBuilder::with_params(0.6, 100).build();
```

--------------------------------

### BinaryQuantizationBuilder Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.BinaryQuantizationBuilder.html

Methods available for configuring and building a BinaryQuantization configuration.

```APIDOC
## BinaryQuantizationBuilder::new(always_ram: bool)

### Description
Creates a new instance of the BinaryQuantizationBuilder.

### Parameters
- **always_ram** (bool) - Required - If true, quantized vectors are stored in RAM.

## BinaryQuantizationBuilder::always_ram(value: bool)

### Description
Configures whether quantized vectors are stored in RAM. Note: This is deprecated since 1.19.0, use `memory` instead.

## BinaryQuantizationBuilder::encoding(value: BinaryQuantizationEncoding)

### Description
Sets the binary quantization encoding method.

## BinaryQuantizationBuilder::query_encoding(value: BinaryQuantizationQueryEncoding)

### Description
Configures asymmetric quantization, allowing a query to have different quantization than stored vectors to improve accuracy.

## BinaryQuantizationBuilder::memory(value: i32)

### Description
Sets the memory placement of quantized vectors. This overrides the deprecated `always_ram` flag.

## BinaryQuantizationBuilder::build()

### Description
Finalizes the configuration and returns a BinaryQuantization object.
```

--------------------------------

### pub async fn list_shard_keys

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

List all shard keys in a collection.

```APIDOC
## pub async fn list_shard_keys( &self, request: impl Into<ListShardKeysRequest>, ) -> Result<ListShardKeysResponse, QdrantError>

### Description
Retrieves a list of all shard keys currently defined for a collection.

### Parameters
- **request** (impl Into<ListShardKeysRequest>) - Required - The request object identifying the collection.
```

--------------------------------

### create

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/snapshots_client/struct.SnapshotsClient.html

Creates a new snapshot for a specific collection.

```APIDOC
## pub async fn create(&mut self, request: impl IntoRequest<CreateSnapshotRequest>) -> Result<Response<CreateSnapshotResponse>, Status>

### Description
Creates a snapshot for a specific collection in Qdrant.
```

--------------------------------

### Usage of AsTimeout

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/trait.AsTimeout.html

Demonstrates setting a timeout using both integer and Duration types.

```rust
config
    .timeout(10)
    .timeout(Duration::from_secs(10));
```

--------------------------------

### Set API key for Qdrant client

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/struct.QdrantConfig.html

Configure an optional API key for authentication, typically retrieved from environment variables or configuration files.

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("http://localhost:6334")
    .api_key(std::env::var("QDRANT_API_KEY"))
    .build();
```

```rust
let client = Qdrant::from_url("http://localhost:6334")
    .api_key(config.get("api_key"))
    .build();
```

--------------------------------

### Create a new RelevanceFeedbackInputBuilder

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RelevanceFeedbackInputBuilder.html

Initializes a new builder instance using a target vector.

```rust
use qdrant_client::qdrant::{RelevanceFeedbackInputBuilder, VectorInput};

let builder = RelevanceFeedbackInputBuilder::new(VectorInput::new_dense(vec![0.1, 0.2, 0.3]));
```

--------------------------------

### Compute Timestamp from Java Instant.now()

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.Timestamp.html

Create a Timestamp using the Java Instant API.

```java
Instant now = Instant.now();

Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();
```

--------------------------------

### with_header

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Creates a client clone with an additional header for requests.

```APIDOC
## pub fn with_header( &self, key: impl Into<String>, value: impl Into<String>, ) -> Self

### Description
Create a lightweight clone of this client with an additional header. The returned client shares the same connection pool.

### Usage
```rust
use qdrant_client::Qdrant;

let traced = client.with_header("x-request-id", "abc-123");
```
```

--------------------------------

### Perform binary search on a slice

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ListValue.html

Shows how to use binary_search to find elements in a sorted slice and how to use partition_point for range-based logic.

```rust
let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

assert_eq!(s.binary_search(&13),  Ok(9));
assert_eq!(s.binary_search(&4),   Err(7));
assert_eq!(s.binary_search(&100), Err(13));
let r = s.binary_search(&1);
assert!(match r { Ok(1..=4) => true, _ => false, });
```

```rust
let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

let low = s.partition_point(|x| x < &1);
assert_eq!(low, 1);
let high = s.partition_point(|x| x <= &1);
assert_eq!(high, 5);
let r = s.binary_search(&1);
assert!((low..high).contains(&r.unwrap()));

assert!(s[..low].iter().all(|&x| x < 1));
assert!(s[low..high].iter().all(|&x| x == 1));
assert!(s[high..].iter().all(|&x| x > 1));

// For something not found, the "range" of equal items is empty
assert_eq!(s.partition_point(|x| x < &11), 9);
assert_eq!(s.partition_point(|x| x <= &11), 9);
assert_eq!(s.binary_search(&11), Err(9));
```

```rust
let mut s = vec![0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
let num = 42;
let idx = s.partition_point(|&x| x <= num);
// If `num` is unique, `s.partition_point(|&x| x < num)` (with `<`) is equivalent to
// `s.binary_search(&num).unwrap_or_else(|x| x)`, but using `<=` will allow `insert`
// to shift less elements.
s.insert(idx, num);
assert_eq!(s, [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 42, 55]);
```

--------------------------------

### Recommend points in batch

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Executes multiple recommendation requests in a single batch. Deprecated since 1.20.0; use query_batch with RecommendInput queries instead.

```rust
use qdrant_client::qdrant::{Condition, Filter, RecommendBatchPointsBuilder, RecommendPointsBuilder};

let filter = Filter::must([Condition::matches("city", "London".to_string())]);

let recommend_queries = vec![
    RecommendPointsBuilder::new("my_collection", 3)
        .add_positive(100)
        .add_positive(231)
        .add_negative(718)
        .filter(filter.clone())
        .build(),
    RecommendPointsBuilder::new("my_collection", 3)
        .add_positive(200)
        .add_positive(67)
        .add_negative(300)
        .filter(filter.clone())
        .build(),
];

client
    .recommend_batch(RecommendBatchPointsBuilder::new(
        "my_collection",
        recommend_queries,
    ))
    .await?;
```

--------------------------------

### AcornSearchParamsBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.AcornSearchParamsBuilder.html

Creates a new instance of the builder with the required enable flag.

```APIDOC
## pub fn new(enable: bool) -> Self

### Description
Creates a new AcornSearchParamsBuilder with the required enable parameter. If set to true, ACORN may be used for HNSW search based on filter selectivity.

### Parameters
- **enable** (bool) - Required - If true, ACORN may be used for HNSW search based on filter selectivity.
```

--------------------------------

### SearchBatchPointsBuilder::build

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.SearchBatchPointsBuilder.html

Finalizes the configuration and builds the SearchBatchPoints object.

```APIDOC
## pub fn build(self) -> SearchBatchPoints

### Description
Constructs the final SearchBatchPoints object from the configured builder.
```

--------------------------------

### create_shard_key

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/collections_server/trait.Collections.html

Create a shard key.

```APIDOC
## create_shard_key(request: Request<CreateShardKeyRequest>)

### Description
Create shard key.

### Parameters
- **request** (Request<CreateShardKeyRequest>) - Required - The shard key creation parameters.
```

--------------------------------

### TurboQuantizationBuilder Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.TurboQuantizationBuilder.html

Methods available for configuring and building a TurboQuantization instance.

```APIDOC
## new()

### Description
Creates a new instance of TurboQuantizationBuilder.

## bits(value: impl Into<TurboQuantBitSize>)

### Description
Sets the number of bits used to encode each component of the quantized vector.

## memory(value: impl Into<i32>)

### Description
Sets the memory placement of quantized vectors. This overrides the deprecated always_ram flag.

## build()

### Description
Consumes the builder and returns a TurboQuantization instance.
```

--------------------------------

### SearchBatchPointsBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.SearchBatchPointsBuilder.html

Initializes a new instance of the SearchBatchPointsBuilder with the specified collection name and search points.

```APIDOC
## pub fn new(collection_name: impl Into<String>, search_points: impl Into<Vec<SearchPoints>>) -> Self

### Description
Creates a new builder instance for a batch search request.

### Parameters
- **collection_name** (impl Into<String>) - Required - The name of the collection to search.
- **search_points** (impl Into<Vec<SearchPoints>>) - Required - A list of search point definitions.
```

--------------------------------

### RecommendBatchPoints Struct Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RecommendBatchPoints.html

The structure definition for RecommendBatchPoints, detailing the available fields for batch recommendation requests.

```rust
pub struct RecommendBatchPoints {
    pub collection_name: String,
    pub recommend_points: Vec<RecommendPoints>,
    pub read_consistency: Option<ReadConsistency>,
    pub timeout: Option<u64>,
}
```

--------------------------------

### DiscoverInputBuilder::context

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.DiscoverInputBuilder.html

Sets the contextual constraints for the discovery request.

```APIDOC
## fn context<VALUE: Into<ContextInput>>(self, value: VALUE) -> Self

### Description
Constrains the search space using pairs of vectors.

### Parameters
- **value** (VALUE: Into<ContextInput>) - The context input.
```

--------------------------------

### SnapshotDownloadBuilder API

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.SnapshotDownloadBuilder.html

Methods for configuring and building a SnapshotDownload instance.

```APIDOC
## SnapshotDownloadBuilder

### Description
A builder pattern implementation for constructing a `SnapshotDownload` object.

### Methods

#### new(out_path: impl Into<PathBuf>, collection_name: impl Into<String>) -> Self
Creates a new instance of the builder.

#### out_path(self, value: PathBuf) -> Self
Sets the destination path for the downloaded snapshot.

#### collection_name(self, value: String) -> Self
Sets the name of the collection associated with the snapshot.

#### snapshot_name<VALUE: Into<String>>(self, value: VALUE) -> Self
Sets the specific name of the snapshot to download.

#### rest_api_uri<VALUE: Into<String>>(self, value: VALUE) -> Self
Sets the URI for the Qdrant REST API.

#### build(self) -> SnapshotDownload
Consumes the builder and returns a configured `SnapshotDownload` instance.
```

--------------------------------

### List all collections

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Returns a list of all collection names.

```rust
client.list_collections().await?;
```

--------------------------------

### MultiVectorConfigBuilder Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.MultiVectorConfigBuilder.html

Methods available for configuring and building the MultiVectorConfig.

```rust
pub fn comparator<VALUE: Into<i32>>(self, value: VALUE) -> Self
```

```rust
pub fn build(self) -> MultiVectorConfig
```

```rust
pub fn new(comparator: impl Into<MultiVectorComparator>) -> Self
```

--------------------------------

### MmrBuilder::build

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.MmrBuilder.html

Finalizes the configuration and returns an Mmr object.

```APIDOC
## pub fn build(self) -> Mmr

### Description
Consumes the builder and returns the configured Mmr instance.
```

--------------------------------

### Create a new FeedbackItemBuilder

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.FeedbackItemBuilder.html

Initializes a builder with a specific point ID and a corresponding score.

```rust
use qdrant_client::qdrant::{FeedbackItemBuilder, PointId, VectorInput};

let item = FeedbackItemBuilder::new(VectorInput::new_id(PointId::from(42)), 0.9);
```

--------------------------------

### DiscoverInputBuilder::build

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.DiscoverInputBuilder.html

Finalizes the construction of the DiscoverInput object.

```APIDOC
## fn build(self) -> DiscoverInput

### Description
Consumes the builder and returns the final DiscoverInput object.
```

--------------------------------

### Build MaxOptimizationThreads

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.MaxOptimizationThreadsBuilder.html

Converts the builder into the final MaxOptimizationThreads configuration.

```rust
pub fn build(self) -> MaxOptimizationThreads
```

--------------------------------

### RecommendBatchPointsBuilder

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RecommendBatchPointsBuilder.html

A builder for constructing batch recommendation requests, allowing configuration of collection names, recommendation points, read consistency, and timeouts.

```APIDOC
## RecommendBatchPointsBuilder

### Description
A builder struct used to configure and construct a batch recommendation request for Qdrant.

### Methods

#### new(collection_name: impl Into<String>, recommend_points: impl Into<Vec<RecommendPoints>>) -> Self
Creates a new instance of the builder.

#### collection_name(value: String) -> Self
Sets the name of the collection.

#### recommend_points(value: Vec<RecommendPoints>) -> Self
Sets the points to be used for recommendation.

#### read_consistency<VALUE: Into<Value>>(value: VALUE) -> Self
Sets the read consistency guarantees for the request.

#### timeout(value: u64) -> Self
Overrides the global timeout setting for this request (in seconds).

#### build() -> RecommendBatchPoints
Finalizes the builder and returns the constructed RecommendBatchPoints object.
```

--------------------------------

### SearchBatchPointsBuilder Configuration Methods

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.SearchBatchPointsBuilder.html

Methods to configure the search request parameters.

```APIDOC
## Configuration Methods

### pub fn collection_name(self, value: String) -> Self
Sets the name of the collection.

### pub fn search_points(self, value: Vec<SearchPoints>) -> Self
Sets the list of search points for the batch request.

### pub fn read_consistency<VALUE: Into<Value>>(self, value: VALUE) -> Self
Sets the read consistency guarantees for the request.

### pub fn timeout(self, value: u64) -> Self
Overrides the global timeout setting for this request (in seconds).
```

--------------------------------

### Create Full Node Snapshot

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Creates a snapshot of the entire node. This operation is only supported in single-node deployments.

```rust
client.create_full_snapshot().await?;
```

--------------------------------

### Configure Timeouts

Source: https://docs.rs/qdrant-client/latest/qdrant_client/type.QdrantBuilder.html

Set request and connection timeouts for the client.

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("http://localhost:6334")
    .timeout(std::time::Duration::from_secs(10))
    .build();
```

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("http://localhost:6334")
    .connect_timeout(std::time::Duration::from_secs(10))
    .build();
```

--------------------------------

### Create RrfBuilder with default values

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.RrfBuilder.html

Initializes a new RrfBuilder instance using default configuration settings.

```rust
use qdrant_client::qdrant::RrfBuilder;

let rrf = RrfBuilder::new().build();
```

--------------------------------

### AcornSearchParamsBuilder::build

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.AcornSearchParamsBuilder.html

Finalizes the configuration and returns an AcornSearchParams object.

```APIDOC
## pub fn build(self) -> AcornSearchParams

### Description
Consumes the builder and returns the constructed AcornSearchParams instance.
```

--------------------------------

### ProductQuantization Struct Definition

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ProductQuantization.html

The primary structure definition for configuring product quantization parameters.

```rust
pub struct ProductQuantization {
    pub compression: i32,
    pub always_ram: Option<bool>,
    pub memory: Option<i32>,
}
```

--------------------------------

### List Full Node Snapshots

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Lists all full-node snapshots available on the current node.

```rust
client.list_full_snapshots().await?;
```

--------------------------------

### FeedbackStrategyBuilder::build

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.FeedbackStrategyBuilder.html

Finalizes the construction of the feedback strategy.

```APIDOC
## pub fn build(self) -> FeedbackStrategy

### Description
Builds the desired FeedbackStrategy object from the builder configuration.
```

--------------------------------

### pub async fn discover

Source: https://docs.rs/qdrant-client/latest/qdrant_client/struct.Qdrant.html

Discover points in a collection. Note: This method is deprecated since 1.20.0, use `query` with a `DiscoverInput` or `ContextInput` query instead.

```APIDOC
## pub async fn discover( &self, request: impl Into<DiscoverPoints>, ) -> Result<DiscoverResponse, QdrantError>

### Description
Discover points in a collection based on positive and negative examples.

### Parameters
- **request** (impl Into<DiscoverPoints>) - Required - The discovery request containing collection name, context examples, and search limit.
```

--------------------------------

### SparseVectorCreationConfigBuilder API

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.SparseVectorCreationConfigBuilder.html

Methods available for configuring and building sparse vector creation parameters.

```APIDOC
## new()

### Description
Creates a new instance of the SparseVectorCreationConfigBuilder.

## modifier(value: Into<i32>)

### Description
Sets the modifier to be applied to the vector values (e.g., IDF).

## datatype(value: Into<i32>)

### Description
Sets the data type used to store weights in the index.

## build()

### Description
Consumes the builder and returns a SparseVectorCreationConfig object.
```

--------------------------------

### MmrBuilder::with_params

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.MmrBuilder.html

Creates a new MmrBuilder instance initialized with specific diversity and candidate limit parameters.

```APIDOC
## pub fn with_params(diversity: f32, candidates_limit: u32) -> Self

### Description
Create a new MmrBuilder with both diversity and candidates limit.

### Parameters
- **diversity** (f32) - Required - Must be in the range [0, 1]. Higher values favor diversity.
- **candidates_limit** (u32) - Required - Maximum number of candidates to consider for re-ranking.
```

--------------------------------

### IdfParamsBuilder::new

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.IdfParamsBuilder.html

Creates a new instance of the IdfParamsBuilder.

```APIDOC
## pub fn new() -> Self

### Description
Creates a new instance of the IdfParamsBuilder.
```

--------------------------------

### Set compression encoding

Source: https://docs.rs/qdrant-client/latest/qdrant_client/config/struct.QdrantConfig.html

Configure the compression algorithm used for client-server communication.

```rust
use qdrant_client::Qdrant;
use qdrant_client::config::CompressionEncoding;

let client = Qdrant::from_url("http://localhost:6334")
    .compression(Some(CompressionEncoding::Gzip))
    .build();
```

--------------------------------

### ReplicatePointsBuilder::build

Source: https://docs.rs/qdrant-client/latest/qdrant_client/qdrant/struct.ReplicatePointsBuilder.html

Finalizes the configuration and constructs the ReplicatePoints object.

```APIDOC
## pub fn build(self) -> ReplicatePoints

### Description
Consumes the builder and returns the configured ReplicatePoints instance.
```
Tokens:
Raw