Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

feat: Amazon Bedrock Embedding doc #204

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

chezou
Copy link

@chezou chezou commented Jan 20, 2024

This is follow-up for chroma-core/chroma#1361

When I find time to contribute JS SDK, I will send another PR for document update as well.

JS client is now ready for review chroma-core/chroma#1659
So, I added a JS document as well.

Copy link

vercel bot commented Jan 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 4:59am

Copy link
Contributor

@tazarov tazarov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small nits. Otherwise looks good.

</TabItem>
<TabItem value="js" label="JavaScript">

To use Amazon Bedrock embedding API, you must have `@aws-sdk/client-bedrock-runtime` installed. To use:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chezou, do you think users can benefit from explaining how to supply the credentials e.g. export them as env vars or use aws cli to login?

Copy link
Author

@chezou chezou Jan 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's too much to explain AWS credential preparation stuff in detail, so I added an example with Access Key ID and Secret Access Key instead.
Also, added the link to more information on AWS credential handling.
7390e29

docs/embeddings/amazon-bedrock.md Outdated Show resolved Hide resolved
- Add boto3 installation
- Add more JS authentication details
@chezou
Copy link
Author

chezou commented Jan 28, 2024

@tazarov I think I updated with enough information, but let me know if there is anything I can improve.

@chezou
Copy link
Author

chezou commented Feb 26, 2024

@jeffchuber Can I ask you to review this PR?

Copy link
Contributor

@jeffchuber jeffchuber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good - pending the one nit, thanks!

const collection = await client.getCollection({name: "name", embeddingFunction: ef})
```

If you want to use other credentials, you need to install `@aws-sdk/credential-providers`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you provide an example or two of "other credentials"? thanks!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, added db5ee3c

@chezou
Copy link
Author

chezou commented Feb 28, 2024

@jeffchuber Can you merge it when you have time?

@chezou
Copy link
Author

chezou commented Mar 12, 2024

@jeffchuber @HammadB Can you merge this PR?

@JGalego
Copy link

JGalego commented Apr 15, 2024

@jeffchuber can we merge this PR? chroma-core/chroma#1675 is waiting for this one

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants