Documentation updates #450
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Problem
If you only care about doing async index oeprations, it's cumbersome to
have to manage nested async contexts by going through the
`PineconeAsyncio` class.
## Solution
This is a very simple change that enables people to create an async
index client.
## Usage
You can now do index operations via asyncio like this:
```python
import asyncio
from pinecone import Pinecone
async def main():
async with Pinecone().IndexAsyncio(host='myhost') as idx:
await idx.uspert(...) # do async things
asyncio.run(main())
```
## Type of Change
- [x] New feature (non-breaking change which adds functionality)
## Problem Need to wire up several properties that pass configurations in to the underlying aiohttp library. ## Solution Wire up several properties for `PineconeAsyncio` that are already supported in `Pinecone`: - `additional_headers` to pass extra headers on each request. Useful for internal testing. - `ssl_verify` to turn off ssl verification. Sometimes useful for testing. - `proxy_url` to send traffic through a proxy - `ssl_ca_certs` to specify a custom cert bundle. Expecting a path to a PEM file. Currently `proxy_headers` is not accepted by `PineconeAsyncio` because I haven't figured out how to use these with aiohttp. ## Type of Change - [x] New feature (non-breaking change which adds functionality)
## Problem When migrating the `embed` and `rerank` over from the plugin, I forgot to include these custom return objects. ## Solution Add custom return types, adjust tests to ensure result is iterable. ## Type of Change - [x] Bug fix (non-breaking change which fixes an issue)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Need to overhaul README, other markdown docs, and docstrings to reflect recent changes and additions to the SDK.
Solution