docs: add docs for GoogleGenAIMultimodalDocumentEmbedder#10784
docs: add docs for GoogleGenAIMultimodalDocumentEmbedder#10784
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## Overview | ||
|
|
||
| `GoogleGenAIMultimodalDocumentEmbedder` expects a list of documents containing a file path in a meta field. The meta field can be specified with the `file_path_meta_field` init parameter of this component. |
There was a problem hiding this comment.
[Google.WordList] Use 'path' instead of 'file path'.
| Google Gen AI is compatible with both the Gemini Developer API and the Vertex AI API. | ||
|
|
||
| To use this component with the Gemini Developer API and get an API key, visit [Google AI Studio](https://aistudio.google.com/). | ||
| To use this component with the Vertex AI API, visit [Google Cloud > Vertex AI](https://cloud.google.com/vertex-ai). |
There was a problem hiding this comment.
[Google.WordList] Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.
| ) | ||
| ``` | ||
|
|
||
| The following examples show how to use the component with the Gemini Developer API and the Vertex AI API. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[MyStyle.TheFollowing] Avoid 'The following'—it's implied by the colon. Rephrase or remove.
|
|
||
| The following examples show how to use the component with the Gemini Developer API and the Vertex AI API. | ||
|
|
||
| #### Gemini Developer API (API Key Authentication) |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| embedder = GoogleGenAIMultimodalDocumentEmbedder() | ||
| ``` | ||
|
|
||
| #### Vertex AI (Application Default Credentials) |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
|
|
||
| ### In a pipeline | ||
|
|
||
| In the following example, we look for a specific plot in the "Scaling Instruction-Finetuned Language Models" paper (PDF format). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[MyStyle.TheFollowing] Avoid 'the following'—it's implied by the colon. Rephrase or remove.
|
|
||
| ### In a pipeline | ||
|
|
||
| In the following example, we look for a specific plot in the "Scaling Instruction-Finetuned Language Models" paper (PDF format). |
There was a problem hiding this comment.
[Google.We] Try to avoid using first-person plural like 'we'.
|
|
||
| ### In a pipeline | ||
|
|
||
| In the following example, we look for a specific plot in the "Scaling Instruction-Finetuned Language Models" paper (PDF format). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
|
|
||
| In the following example, we look for a specific plot in the "Scaling Instruction-Finetuned Language Models" paper (PDF format). | ||
|
|
||
| You first need to download the PDF file from https://arxiv.org/pdf/2210.11416.pdf. |
There was a problem hiding this comment.
[MyStyle.FileExtensions] Use uppercase for file extensions: 'PDF' → 'pdf'.
|
|
||
| In the following example, we look for a specific plot in the "Scaling Instruction-Finetuned Language Models" paper (PDF format). | ||
|
|
||
| You first need to download the PDF file from https://arxiv.org/pdf/2210.11416.pdf. |
There was a problem hiding this comment.
[MyStyle.FileExtensions] Use uppercase for file extensions: 'PDF' → 'pdf'.
anakin87
requested review from
bilgeyucel and
bogdankostic
and removed request for
a team
2 participants
Related Issues
Proposed Changes:
How did you test it?
Vercel -> https://haystack-docs-git-genai-multimodal-emb-deepset-ai.vercel.app/docs/googlegenaimultimodaldocumentembedder
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.