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.

Sign up for GitHub

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

Docs: Update GeminiGenerator docstrings #964

Merged
merged 2 commits into from
Aug 8, 2024
Merged

Docs: Update GeminiGenerator docstrings #964

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46ca889
Update docstrings
agnieszka-m Aug 8, 2024
7c559a6
Update integrations/google_ai/src/haystack_integrations/components/ge…
agnieszka-m Aug 8, 2024
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
14 changes: 8 additions & 6 deletions integrations/google_ai/src/haystack_integrations/components/generators/google_ai/gemini.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
@component
class GoogleAIGeminiGenerator:
"""
`GoogleAIGeminiGenerator` is a multimodal generator supporting Gemini via Google AI Studio.
Generates text using multimodal Gemini models through Google AI Studio.

### Usage example

Usage example:
```python
from haystack.utils import Secret
from haystack_integrations.components.generators.google_ai import GoogleAIGeminiGenerator
Expand All @@ -30,7 +31,8 @@ class GoogleAIGeminiGenerator:
print(answer)
```

Multimodal usage example:
#### Multimodal example

```python
import requests
from haystack.utils import Secret
Expand Down Expand Up @@ -81,9 +83,9 @@ def __init__(

:param api_key: Google AI Studio API key.
:param model: Name of the model to use.
:param generation_config: The generation config to use.
Can either be a `GenerationConfig` object or a dictionary of parameters.
For the available parameters, see
:param generation_config: The generation configuration to use.
This can either be a `GenerationConfig` object or a dictionary of parameters.
For available parameters, see
[the `GenerationConfig` API reference](https://ai.google.dev/api/python/google/generativeai/GenerationConfig).
:param safety_settings: The safety settings to use.
A dictionary with `HarmCategory` as keys and `HarmBlockThreshold` as values.
Expand Down