Description

Python Client for Generative Language API ========================================= |preview| |pypi| |versions| `Generative Language API`_: The Gemini API allows developers to build generative AI applications using Gemini models. Gemini is our most capable model, built from the ground up to be multimodal. It can generalize and seamlessly understand, operate across, and combine different types of information including language, images, audio, video, and code. You can use the Gemini API for use cases like reasoning across text and images, content generation, dialogue agents, summarization and classification systems, and more. - `Client Library Documentation`_ - `Product Documentation`_ .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels .. |pypi| image:: https://img.shields.io/pypi/v/google-ai-generativelanguage.svg :target: https://pypi.org/project/google-ai-generativelanguage/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-ai-generativelanguage.svg :target: https://pypi.org/project/google-ai-generativelanguage/ .. _Generative Language API: https://ai.google.dev/docs .. _Client Library Documentation: https://googleapis.dev/python/generativelanguage/latest .. _Product Documentation: https://ai.google.dev/docs Quick Start ----------- In order to use this library, you first need to go through the following steps: 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ 3. `Enable the Generative Language API.`_ 4. `Set up Authentication.`_ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project .. _Enable the Generative Language API.: https://ai.google.dev/docs .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html Installation ~~~~~~~~~~~~ Install this library in a virtual environment using `venv`_. `venv`_ is a tool that creates isolated Python environments. These isolated environments can have separate versions of Python packages, which allows you to isolate one project's dependencies from the dependencies of other projects. With `venv`_, it's possible to install this library without needing system install permissions, and without clashing with the installed system dependencies. .. _`venv`: https://docs.python.org/3/library/venv.html Code samples and snippets ~~~~~~~~~~~~~~~~~~~~~~~~~ Code samples and snippets live in the `samples/`_ folder. .. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-ai-generativelanguage/samples Supported Python Versions ^^^^^^^^^^^^^^^^^^^^^^^^^ Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of Python. Python >= 3.9, including 3.14 .. _active: https://devguide.python.org/devcycle/#in-development-main-branch .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches Unsupported Python Versions ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Python <= 3.8 If you are using an `end-of-life`_ version of Python, we recommend that you update as soon as possible to an actively supported version. .. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches Mac/Linux ^^^^^^^^^ .. code-block:: console python3 -m venv <your-env> source <your-env>/bin/activate pip install google-ai-generativelanguage Windows ^^^^^^^ .. code-block:: console py -m venv <your-env> .\<your-env>\Scripts\activate pip install google-ai-generativelanguage Next Steps ~~~~~~~~~~ - Read the `Client Library Documentation`_ for Generative Language API to see other available methods on the client. - Read the `Generative Language API Product documentation`_ to learn more about the product and see How-to Guides. - View this `README`_ to see the full list of Cloud APIs that we cover. .. _Generative Language API Product documentation: https://ai.google.dev/docs .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst Logging ------- This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. Note the following: #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. Simple, environment-based configuration ~~~~~~~~~~~~~~~~~