Skip to content

[DOC]:Update google-gemini.md #5031

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

httpsyash
Copy link

βœ… Pull Request Title:
Fix incorrect embedding function name in Chroma-Gemini integration

πŸ“„ Description:
This PR corrects a typo in the embedding function used with the Chroma vector database and Google Gemini integration.

πŸ”§ Changes Made:
Replaced GoogleGenerativeAiEmbeddingFunction with the correct GoogleGeminiEmbeddingFunction from @chroma-core/google-gemini.

This resolves runtime errors such as:
TypeError: GoogleGenerativeAiEmbeddingFunction is not a constructor

βœ… Why this is needed:
The incorrect function name causes apps to crash when initializing the embedding function.

This fix ensures proper instantiation of the embedding function and enables successful usage of Gemini embeddings with ChromaDB.-----This is done in js code

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • ...
  • New functionality
    • ...

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

βœ… Pull Request Title:
Fix incorrect embedding function name in Chroma-Gemini integration

πŸ“„ Description:
This PR corrects a typo in the embedding function used with the Chroma vector database and Google Gemini integration.

πŸ”§ Changes Made:
Replaced GoogleGenerativeAiEmbeddingFunction with the correct GoogleGeminiEmbeddingFunction from @chroma-core/google-gemini.

This resolves runtime errors such as:
TypeError: GoogleGenerativeAiEmbeddingFunction is not a constructor

βœ… Why this is needed:
The incorrect function name causes apps to crash when initializing the embedding function.

This fix ensures proper instantiation of the embedding function and enables successful usage of Gemini embeddings with ChromaDB.-----This is done in js code
Copy link

github-actions bot commented Jul 5, 2025

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link
Contributor

This PR updates the TypeScript usage example in the google-gemini.md documentation, correcting the embedding function import and instantiation to use GoogleGeminiEmbeddingFunction instead of the incorrect GoogleGenerativeAiEmbeddingFunction. This resolves mismatches between documentation and actual library exports, preventing potential runtime errors for users following the integration instructions.

This summary was automatically generated by @propel-code-bot

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

Successfully merging this pull request may close these issues.

1 participant