Skip to content

Commit

Permalink
Docs: Update GeminiGenerator docstrings (#964)
Browse files Browse the repository at this point in the history
* Update docstrings

* Update integrations/google_ai/src/haystack_integrations/components/generators/google_ai/gemini.py

Co-authored-by: Daria Fokina <[email protected]>

---------

Co-authored-by: Daria Fokina <[email protected]>
  • Loading branch information
2 people authored and Amnah199 committed Oct 2, 2024
1 parent 0bf4866 commit 263aab2
Showing 1 changed file with 8 additions and 6 deletions.
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

0 comments on commit 263aab2

Please sign in to comment.