langchain-google-genai 3.0.1__tar.gz → 3.0.2__tar.gz

langchain_google_genai-3.0.2/.gitignore

@@ -0,0 +1 @@
+__pycache__

langchain_google_genai-3.0.2/Makefile

@@ -0,0 +1,70 @@
+.PHONY: all format lint test tests integration_tests help
+
+# Default target executed when no arguments are given to make.
+all: help
+
+.EXPORT_ALL_VARIABLES:
+UV_FROZEN = true
+
+# Define a variable for the test file path.
+TEST_FILE ?= tests/unit_tests/
+
+integration_test integration_tests: TEST_FILE = tests/integration_tests/
+
+test tests:
+	uv run --group test pytest --disable-socket --allow-unix-socket $(TEST_FILE)
+
+integration_test integration_tests:
+	uv run --group test --group test_integration pytest --retries 3 --retry-delay 1 $(TEST_FILE)
+
+check_imports: $(shell find langchain_google_genai -name '*.py')
+	uv run --all-groups python ./scripts/check_imports.py $^
+
+test_watch:
+	uv run ptw --snapshot-update --now . -- -vv $(TEST_FILE)
+
+# Run unit tests and generate a coverage report.
+coverage:
+	uv run pytest --cov \
+		--cov-config=.coveragerc \
+		--cov-report xml \
+		--cov-report term-missing:skip-covered \
+		$(TEST_FILE)
+
+######################
+# LINTING AND FORMATTING
+######################
+
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+MYPY_CACHE=.mypy_cache
+lint format: PYTHON_FILES=.
+lint_diff format_diff: PYTHON_FILES=$(shell git diff --name-only --diff-filter=d main | grep -E '\.py$$|\.ipynb$$')
+lint_package: PYTHON_FILES=langchain_google_genai
+lint_tests: PYTHON_FILES=tests
+lint_tests: MYPY_CACHE=.mypy_cache_test
+
+lint lint_diff lint_package lint_tests:
+	./scripts/lint_imports.sh
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff check $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff format $(PYTHON_FILES) --diff
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff check --select I $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || mkdir -p $(MYPY_CACHE) && uv run --all-groups mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
+
+format format_diff:
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff format $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff check --fix $(PYTHON_FILES)
+
+######################
+# HELP
+######################
+
+help:
+	@echo '----'
+	@echo 'check_imports                - check imports'
+	@echo 'format                       - run code formatters'
+	@echo 'lint                         - run linters'
+	@echo 'test                         - run unit tests'
+	@echo 'tests                        - run unit tests'
+	@echo 'integration_test             - run integration tests(NOTE: "export GOOGLE_API_KEY=..." is needed.)'
+	@echo 'test TEST_FILE=<test_file>   - run all tests in file'

langchain_google_genai-3.0.2/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: langchain-google-genai
+Version: 3.0.2
+Summary: An integration package connecting Google's genai package and LangChain
+Project-URL: Homepage, https://docs.langchain.com/oss/python/integrations/providers/google
+Project-URL: Documentation, https://reference.langchain.com/python/integrations/langchain_google_genai/
+Project-URL: Source, https://github.com/langchain-ai/langchain-google/tree/master/libs/genai
+Project-URL: Changelog, https://github.com/langchain-ai/langchain-google/releases?q=%22genai%22
+Project-URL: Twitter, https://x.com/LangChainAI
+Project-URL: Slack, https://www.langchain.com/join-community
+Project-URL: Reddit, https://www.reddit.com/r/LangChain/
+License: MIT
+License-File: LICENSE
+Requires-Python: <4.0.0,>=3.10.0
+Requires-Dist: filetype<2.0.0,>=1.2.0
+Requires-Dist: google-ai-generativelanguage<1.0.0,>=0.7.0
+Requires-Dist: langchain-core<2.0.0,>=1.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Description-Content-Type: text/markdown
+
+# langchain-google-genai
+
+[![PyPI - Version](https://img.shields.io/pypi/v/langchain-google-genai?label=%20)](https://pypi.org/project/langchain-google-genai/#history)
+[![PyPI - License](https://img.shields.io/pypi/l/langchain-google-genai)](https://opensource.org/licenses/MIT)
+[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-google-genai)](https://pypistats.org/packages/langchain-google-genai)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+
+Looking for the JS/TS version? Check out [LangChain.js](https://github.com/langchain-ai/langchainjs).
+
+This package provides access to Google Gemini's chat, vision, embeddings, and other capabilities within the LangChain ecosystem.
+
+## Quick Install
+
+```bash
+pip install langchain-google-genai
+```
+
+## 📖 Documentation
+
+For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_google_genai/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/google#google-generative-ai).
+
+## 📕 Releases & Versioning
+
+See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
+
+## 💁 Contributing
+
+As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
+
+For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

langchain_google_genai-3.0.2/README.md

@@ -0,0 +1,30 @@
+# langchain-google-genai
+
+[![PyPI - Version](https://img.shields.io/pypi/v/langchain-google-genai?label=%20)](https://pypi.org/project/langchain-google-genai/#history)
+[![PyPI - License](https://img.shields.io/pypi/l/langchain-google-genai)](https://opensource.org/licenses/MIT)
+[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-google-genai)](https://pypistats.org/packages/langchain-google-genai)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+
+Looking for the JS/TS version? Check out [LangChain.js](https://github.com/langchain-ai/langchainjs).
+
+This package provides access to Google Gemini's chat, vision, embeddings, and other capabilities within the LangChain ecosystem.
+
+## Quick Install
+
+```bash
+pip install langchain-google-genai
+```
+
+## 📖 Documentation
+
+For full documentation, see the [API reference](https://reference.langchain.com/python/integrations/langchain_google_genai/). For conceptual guides, tutorials, and examples on using these classes, see the [LangChain Docs](https://docs.langchain.com/oss/python/integrations/providers/google#google-generative-ai).
+
+## 📕 Releases & Versioning
+
+See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
+
+## 💁 Contributing
+
+As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
+
+For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).

langchain_google_genai-3.0.2/langchain_google_genai/__init__.py

@@ -0,0 +1,93 @@
+"""LangChain Google Generative AI Integration (GenAI).
+
+This module integrates Google's Generative AI models, specifically the Gemini series,
+with the LangChain framework. It provides classes for interacting with chat models and
+generating embeddings, leveraging Google's advanced AI capabilities.
+
+**Chat Models**
+
+The `ChatGoogleGenerativeAI` class is the primary interface for interacting with
+Google's Gemini chat models. It allows users to send and receive messages using a
+specified Gemini model, suitable for various conversational AI applications.
+
+**LLMs**
+
+The `GoogleGenerativeAI` class is the primary interface for interacting with Google's
+Gemini LLMs. It allows users to generate text using a specified Gemini model.
+
+**Embeddings**
+
+The `GoogleGenerativeAIEmbeddings` class provides functionalities to generate embeddings
+using Google's models. These embeddings can be used for a range of NLP tasks, including
+semantic analysis, similarity comparisons, and more.
+
+**Using Chat Models**
+
+After setting up your environment with the required API key, you can interact with the
+Google Gemini models.
+
+```python
+from langchain_google_genai import ChatGoogleGenerativeAI
+
+llm = ChatGoogleGenerativeAI(model="gemini-2.5-pro")
+llm.invoke("Sing a ballad of LangChain.")
+```
+
+**Using LLMs**
+
+The package also supports generating text with Google's models.
+
+```python
+from langchain_google_genai import GoogleGenerativeAI
+
+llm = GoogleGenerativeAI(model="gemini-2.5-pro")
+llm.invoke("Once upon a time, a library called LangChain")
+```
+
+**Embedding Generation**
+
+The package also supports creating embeddings with Google's models, useful for textual
+similarity and other NLP applications.
+
+```python
+from langchain_google_genai import GoogleGenerativeAIEmbeddings
+
+embeddings = GoogleGenerativeAIEmbeddings(model="models/gemini-embedding-001")
+embeddings.embed_query("hello, world!")
+```
+"""
+
+from langchain_google_genai._enums import (
+    HarmBlockThreshold,
+    HarmCategory,
+    MediaResolution,
+    Modality,
+)
+from langchain_google_genai.chat_models import ChatGoogleGenerativeAI
+from langchain_google_genai.embeddings import GoogleGenerativeAIEmbeddings
+from langchain_google_genai.genai_aqa import (
+    AqaInput,
+    AqaOutput,
+    GenAIAqa,
+)
+from langchain_google_genai.google_vector_store import (
+    DoesNotExistsException,
+    GoogleVectorStore,
+)
+from langchain_google_genai.llms import GoogleGenerativeAI
+
+__all__ = [
+    "AqaInput",
+    "AqaOutput",
+    "ChatGoogleGenerativeAI",
+    "DoesNotExistsException",
+    "DoesNotExistsException",
+    "GenAIAqa",
+    "GoogleGenerativeAI",
+    "GoogleGenerativeAIEmbeddings",
+    "GoogleVectorStore",
+    "HarmBlockThreshold",
+    "HarmCategory",
+    "MediaResolution",
+    "Modality",
+]

{langchain_google_genai-3.0.1 → langchain_google_genai-3.0.2}/langchain_google_genai/_common.py

@@ -1,6 +1,6 @@
 import os
 from importlib import metadata
-from typing import Any, Dict, List, Optional, Tuple, TypedDict
+from typing import Any, TypedDict
 
 from google.api_core.gapic_v1.client_info import ClientInfo
 from langchain_core.utils import secret_from_env
@@ -16,6 +16,12 @@ from langchain_google_genai._enums import (
 _TELEMETRY_TAG = "remote_reasoning_engine"
 _TELEMETRY_ENV_VARIABLE_NAME = "GOOGLE_CLOUD_AGENT_ENGINE_ID"
 
+# Cache package version at module import time to avoid blocking I/O in async contexts
+try:
+    LC_GOOGLE_GENAI_VERSION = metadata.version("langchain-google-genai")
+except metadata.PackageNotFoundError:
+    LC_GOOGLE_GENAI_VERSION = "0.0.0"
+
 
 class GoogleGenerativeAIError(Exception):
     """Custom exception class for errors associated with the `Google GenAI` API."""
@@ -27,116 +33,132 @@ class _BaseGoogleGenerativeAI(BaseModel):
     model: str = Field(...)
     """Model name to use."""
 
-    google_api_key: Optional[SecretStr] = Field(
+    google_api_key: SecretStr | None = Field(
         alias="api_key", default_factory=secret_from_env("GOOGLE_API_KEY", default=None)
     )
     """Google AI API key.
-    
-    If not specified will be read from env var å`GOOGLE_API_KEY`.
+
+    If not specified will be read from env var `GOOGLE_API_KEY`.
     """
 
     credentials: Any = None
-    """The default custom credentials (`google.auth.credentials.Credentials`) to use 
-    when making API calls.
-    
+    """The default custom credentials to use when making API calls.
+
     If not provided, credentials will be ascertained from the `GOOGLE_API_KEY` env var.
     """
 
     temperature: float = 0.7
-    """Run inference with this temperature. Must be within `[0.0, 2.0]`.
-    
-    If unset, will default to `0.7`.
+    """Run inference with this temperature.
+
+    Must be within `[0.0, 2.0]`.
     """
 
-    top_p: Optional[float] = None
-    """Decode using nucleus sampling: consider the smallest set of tokens whose
-    probability sum is at least `top_p`.
-    
+    top_p: float | None = None
+    """Decode using nucleus sampling.
+
+    Consider the smallest set of tokens whose probability sum is at least `top_p`.
+
     Must be within `[0.0, 1.0]`.
     """
 
-    top_k: Optional[int] = None
+    top_k: int | None = None
     """Decode using top-k sampling: consider the set of `top_k` most probable tokens.
-    
+
     Must be positive.
     """
 
-    max_output_tokens: Optional[int] = Field(default=None, alias="max_tokens")
-    """Maximum number of tokens to include in a candidate. Must be greater than zero.
-    
+    max_output_tokens: int | None = Field(default=None, alias="max_tokens")
+    """Maximum number of tokens to include in a candidate.
+
+    Must be greater than zero.
+
     If unset, will use the model's default value, which varies by model.
-    
-    See https://ai.google.dev/gemini-api/docs/models for model-specific limits.
+
+    See [docs](https://ai.google.dev/gemini-api/docs/models) for model-specific limits.
     """
 
     n: int = 1
     """Number of chat completions to generate for each prompt.
-    
+
     Note that the API may not return the full `n` completions if duplicates are
     generated.
     """
 
     max_retries: int = Field(default=6, alias="retries")
-    """The maximum number of retries to make when generating.
-    
-    If unset, will default to `6`.
-    """
+    """The maximum number of retries to make when generating."""
 
-    timeout: Optional[float] = Field(default=None, alias="request_timeout")
+    timeout: float | None = Field(default=None, alias="request_timeout")
     """The maximum number of seconds to wait for a response."""
 
-    client_options: Optional[Dict] = Field(
+    client_options: dict | None = Field(
         default=None,
     )
-    """"A dictionary of client options to pass to the Google API client, such as
-    `api_endpoint`.
+    """A dictionary of client options to pass to the Google API client.
+
+    Example: `api_endpoint`
+
+    !!! warning
+
+        If both `client_options['api_endpoint']` and `base_url` are specified,
+        the `api_endpoint` in `client_options` takes precedence.
     """
 
-    base_url: Optional[str] = Field(
+    base_url: str | None = Field(
         default=None,
     )
-    """The base URL to use for the API client.
-    
-    Alias of `client_options['api_endpoint']`.
+    """Base URL to use for the API client.
+
+    This is a convenience alias for `client_options['api_endpoint']`.
+
+    !!! warning
+
+        If `client_options` already contains an `api_endpoint`, this parameter will be
+        ignored in favor of the existing value.
     """
 
-    transport: Optional[str] = Field(
+    transport: str | None = Field(
         default=None,
         alias="api_transport",
     )
-    """A string, one of: `[rest, grpc, grpc_asyncio]`."""
+    """A string, one of: `['rest', 'grpc', 'grpc_asyncio']`.
 
-    additional_headers: Optional[Dict[str, str]] = Field(
+    The Google client library defaults to `'grpc'` for sync clients.
+
+    For async clients, `'rest'` is converted to `'grpc_asyncio'` unless
+    a custom endpoint is specified.
+    """
+
+    additional_headers: dict[str, str] | None = Field(
         default=None,
     )
-    """"Key-value dictionary representing additional headers for the model call"""
+    """Key-value dictionary representing additional headers for the model call"""
 
-    response_modalities: Optional[List[Modality]] = Field(
+    response_modalities: list[Modality] | None = Field(
         default=None,
     )
     """A list of modalities of the response"""
 
-    thinking_budget: Optional[int] = Field(
+    thinking_budget: int | None = Field(
         default=None,
     )
     """Indicates the thinking budget in tokens."""
 
-    media_resolution: Optional[MediaResolution] = Field(
+    media_resolution: MediaResolution | None = Field(
         default=None,
     )
     """Media resolution for the input media."""
 
-    include_thoughts: Optional[bool] = Field(
+    include_thoughts: bool | None = Field(
         default=None,
     )
     """Indicates whether to include thoughts in the response."""
 
-    safety_settings: Optional[Dict[HarmCategory, HarmBlockThreshold]] = None
-    """The default safety settings to use for all generations.
+    safety_settings: dict[HarmCategory, HarmBlockThreshold] | None = None
+    """Default safety settings to use for all generations.
 
-        For example:
+        !!! example
 
-        .. code-block:: python
+            ```python
             from google.generativeai.types.safety_types import HarmBlockThreshold, HarmCategory
 
             safety_settings = {
@@ -145,14 +167,15 @@ class _BaseGoogleGenerativeAI(BaseModel):
                 HarmCategory.HARM_CATEGORY_HARASSMENT: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE,
                 HarmCategory.HARM_CATEGORY_SEXUALLY_EXPLICIT: HarmBlockThreshold.BLOCK_NONE,
             }
+            ```
     """  # noqa: E501
 
     @property
-    def lc_secrets(self) -> Dict[str, str]:
+    def lc_secrets(self) -> dict[str, str]:
         return {"google_api_key": "GOOGLE_API_KEY"}
 
     @property
-    def _identifying_params(self) -> Dict[str, Any]:
+    def _identifying_params(self) -> dict[str, Any]:
         """Get the identifying parameters."""
         return {
             "model": self.model,
@@ -164,37 +187,25 @@ class _BaseGoogleGenerativeAI(BaseModel):
         }
 
 
-def get_user_agent(module: Optional[str] = None) -> Tuple[str, str]:
+def get_user_agent(module: str | None = None) -> tuple[str, str]:
     r"""Returns a custom user agent header.
 
     Args:
-        module (Optional[str]):
-            Optional. The module for a custom user agent header.
-
-    Returns:
-        Tuple[str, str]
+        module: The module for a custom user agent header.
     """
-    try:
-        langchain_version = metadata.version("langchain-google-genai")
-    except metadata.PackageNotFoundError:
-        langchain_version = "0.0.0"
     client_library_version = (
-        f"{langchain_version}-{module}" if module else langchain_version
+        f"{LC_GOOGLE_GENAI_VERSION}-{module}" if module else LC_GOOGLE_GENAI_VERSION
     )
     if os.environ.get(_TELEMETRY_ENV_VARIABLE_NAME):
         client_library_version += f"+{_TELEMETRY_TAG}"
     return client_library_version, f"langchain-google-genai/{client_library_version}"
 
 
-def get_client_info(module: Optional[str] = None) -> "ClientInfo":
+def get_client_info(module: str | None = None) -> "ClientInfo":
     r"""Returns a client info object with a custom user agent header.
 
     Args:
-        module (Optional[str]):
-            Optional. The module for a custom user agent header.
-
-    Returns:
-        ``google.api_core.gapic_v1.client_info.ClientInfo``
+        module: The module for a custom user agent header.
     """
     client_library_version, user_agent = get_user_agent(module)
     # TODO: remove ignore once google-auth has types.
@@ -206,4 +217,5 @@ def get_client_info(module: Optional[str] = None) -> "ClientInfo":
 
 class SafetySettingDict(TypedDict):
     category: HarmCategory
+
     threshold: HarmBlockThreshold

{langchain_google_genai-3.0.1 → langchain_google_genai-3.0.2}/langchain_google_genai/_compat.py

@@ -1,18 +1,18 @@
 """Go from v1 content blocks to generativelanguage_v1beta format."""
 
 import json
-from typing import Any, Optional, cast
+from typing import Any, cast
 
 from langchain_core.messages import content as types
 
 
 def translate_citations_to_grounding_metadata(
-    citations: list[types.Citation], web_search_queries: Optional[list[str]] = None
+    citations: list[types.Citation], web_search_queries: list[str] | None = None
 ) -> dict[str, Any]:
     """Translate LangChain Citations to Google AI grounding metadata format.
 
     Args:
-        citations: List of Citation content blocks.
+        citations: List of `Citation` content blocks.
         web_search_queries: Optional list of search queries that generated
             the grounding data.
 
@@ -40,7 +40,7 @@ def translate_citations_to_grounding_metadata(
 
     # Group citations by text segment (start_index, end_index, cited_text)
     segment_to_citations: dict[
-        tuple[Optional[int], Optional[int], Optional[str]], list[types.Citation]
+        tuple[int | None, int | None, str | None], list[types.Citation]
     ] = {}
 
     for citation in citations:
@@ -131,7 +131,7 @@ def _convert_from_v1_to_generativelanguage_v1beta(
 
     Returns:
         List of dictionaries in `google.ai.generativelanguage_v1beta.types.Content`
-        format, ready to be sent to the API.
+            format, ready to be sent to the API.
     """
     new_content: list = []
     for block in content:
@@ -247,7 +247,7 @@ def _convert_from_v1_to_generativelanguage_v1beta(
         elif block_dict["type"] == "server_tool_call":
             if block_dict.get("name") == "code_interpreter":
                 # LangChain v0 format
-                args = cast(dict, block_dict.get("args", {}))
+                args = cast("dict", block_dict.get("args", {}))
                 executable_code = {
                     "type": "executable_code",
                     "executable_code": args.get("code", ""),
@@ -265,7 +265,7 @@ def _convert_from_v1_to_generativelanguage_v1beta(
                 )
 
         elif block_dict["type"] == "server_tool_result":
-            extras = cast(dict, block_dict.get("extras", {}))
+            extras = cast("dict", block_dict.get("extras", {}))
             if extras.get("block_type") == "code_execution_result":
                 # LangChain v0 format
                 code_execution_result = {

{langchain_google_genai-3.0.1 → langchain_google_genai-3.0.2}/langchain_google_genai/_enums.py

@@ -5,4 +5,4 @@ HarmCategory = genai.HarmCategory
 Modality = genai.GenerationConfig.Modality
 MediaResolution = genai.GenerationConfig.MediaResolution
 
-__all__ = ["HarmBlockThreshold", "HarmCategory", "Modality", "MediaResolution"]
+__all__ = ["HarmBlockThreshold", "HarmCategory", "MediaResolution", "Modality"]