Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add link to documentation in readme #52

Merged
merged 2 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This SDK is still in an alpha state. While it is mostly built out and functional

## Documentation

[reference the documentation here]
The documentation can be found [here](https://docs.rs/pinecone-sdk/latest/pinecone_sdk/).

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions src/pinecone/data.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
#[derive(Debug)]
pub struct Index {
/// The name of the index.
host: String,

Check warning on line 38 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

field `host` is never read

Check warning on line 38 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

field `host` is never read
connection: VectorServiceClient<InterceptedService<Channel, ApiKeyInterceptor>>,
}

Expand Down Expand Up @@ -305,7 +305,7 @@
filter,
include_values: include_values.unwrap_or(false),
include_metadata: include_metadata.unwrap_or(false),
queries: vec![],

Check warning on line 308 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

use of deprecated field `protos::QueryRequest::queries`

Check warning on line 308 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

use of deprecated field `protos::QueryRequest::queries`
vector: vec![],
sparse_vector: None,
};
Expand Down Expand Up @@ -362,7 +362,7 @@
filter,
include_values: include_values.unwrap_or(false),
include_metadata: include_metadata.unwrap_or(false),
queries: vec![],

Check warning on line 365 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

use of deprecated field `protos::QueryRequest::queries`

Check warning on line 365 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

use of deprecated field `protos::QueryRequest::queries`
vector,
sparse_vector,
};
Expand Down Expand Up @@ -660,7 +660,7 @@

#[cfg(test)]
mod tests {
use super::*;

Check warning on line 663 in src/pinecone/data.rs

View workflow job for this annotation

GitHub Actions / test (ubuntu-latest, stable)

unused import: `super::*`
use crate::pinecone::default_client;
use httpmock::prelude::*;

Expand Down Expand Up @@ -689,7 +689,7 @@
then.status(200);
});

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

let addr = server.address().to_string();

Expand All @@ -708,7 +708,7 @@
then.status(200);
});

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

let scheme_host = format!("http://{}", server.host());

Expand Down
Loading