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.

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

added image loader with Cloud Vision API #107

Merged
merged 2 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions libs/community/langchain_google_community/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@
VertexAIMultiTurnSearchRetriever,
VertexAISearchRetriever,
)
from langchain_google_community.vision import CloudVisionLoader

__all__ = [
"BigQueryLoader",
"BigQueryVectorSearch",
"CloudVisionLoader",
"DocAIParser",
"DocAIParsingResults",
"DocumentAIWarehouseRetriever",
Expand Down
42 changes: 42 additions & 0 deletions libs/community/langchain_google_community/vision.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
from typing import Iterator, Optional

from langchain_core.document_loaders import BaseBlobParser
from langchain_core.document_loaders.blob_loaders import Blob
from langchain_core.documents import Document

from langchain_google_community._utils import get_client_info


class CloudVisionLoader(BaseBlobParser):
def __init__(self, project: Optional[str] = None):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with other connectors, can this variable be project_id

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, for LLM/ChatModels we use project, so I'd rather stick to project and eventually change everything else to follow the most frequently used integration, wdyt?

try:
from google.cloud import vision # type: ignore[attr-defined]
except ImportError as e:
raise ImportError(
"Cannot import google.cloud.vision, please install "
"`pip install google-cloud-vision`."
) from e
client_options = None
if project:
client_options = {"quota_project_id": project}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you change this to use the ClientOptions class from google.api_core.client_options?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why? the client expect ClientOptions or a dict.

self._client = vision.ImageAnnotatorClient(
client_options=client_options,
client_info=get_client_info(module="cloud-vision"),
)

def load(self, gcs_uri: str) -> Document:
"""Loads an image from GCS path to a Document, only the text."""
from google.cloud import vision # type: ignore[attr-defined]

image = vision.Image(source=vision.ImageSource(gcs_image_uri=gcs_uri))
text_detection_response = self._client.text_detection(image=image)
annotations = text_detection_response.text_annotations

if annotations:
text = annotations[0].description
else:
text = ""
return Document(page_content=text, metadata={"source": gcs_uri})

def lazy_parse(self, blob: Blob) -> Iterator[Document]:
yield self.load(blob.path) # type: ignore[arg-type]
19 changes: 19 additions & 0 deletions libs/community/tests/integration_tests/test_vision.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import os

import pytest
from langchain_core.document_loaders.blob_loaders import Blob
from langchain_core.documents import Document

from langchain_google_community import CloudVisionLoader


@pytest.mark.skip(reason="CI/CD not ready.")
def test_parse_image() -> None:
gcs_path = os.environ["IMAGE_GCS_PATH"]
project = os.environ["PROJECT"]
blob = Blob(path=gcs_path, data="") # type: ignore
loader = CloudVisionLoader(project=project)
documents = loader.parse(blob)
assert len(documents) == 1
assert isinstance(documents[0], Document)
assert len(documents[0].page_content) > 1
Loading