Source code for langchain_community.utilities.scenexplain

"""调用SceneXplain的工具。

为了设置这个工具，您需要SceneXplain API的API密钥。
您可以按照以下步骤获取密钥。
- 在https://scenex.jina.ai/注册一个免费账户。
- 转到API访问页面（https://scenex.jina.ai/api）并创建一个新的API密钥。
"""
from typing import Dict

import requests
from langchain_core.pydantic_v1 import BaseModel, BaseSettings, Field, root_validator
from langchain_core.utils import get_from_dict_or_env


class SceneXplainAPIWrapper(BaseSettings, BaseModel):
    """用于SceneXplain API的包装器。

为了设置这个，您需要SceneXplain API的API密钥。
您可以按照以下步骤获取密钥。
- 在https://scenex.jina.ai/注册一个免费账户。
- 转到API访问页面（https://scenex.jina.ai/api）
  并创建一个新的API密钥。"""

    scenex_api_key: str = Field(..., env="SCENEX_API_KEY")
    scenex_api_url: str = "https://api.scenex.jina.ai/v1/describe"

    def _describe_image(self, image: str) -> str:
        headers = {
            "x-api-key": f"token {self.scenex_api_key}",
            "content-type": "application/json",
        }
        payload = {
            "data": [
                {
                    "image": image,
                    "algorithm": "Ember",
                    "languages": ["en"],
                }
            ]
        }
        response = requests.post(self.scenex_api_url, headers=headers, json=payload)
        response.raise_for_status()
        result = response.json().get("result", [])
        img = result[0] if result else {}

        return img.get("text", "")

    @root_validator(pre=True)
    def validate_environment(cls, values: Dict) -> Dict:
        """验证环境中是否存在API密钥。"""
        scenex_api_key = get_from_dict_or_env(
            values, "scenex_api_key", "SCENEX_API_KEY"
        )
        values["scenex_api_key"] = scenex_api_key

        return values

    def run(self, image: str) -> str:
        """运行SceneXplain图像解释器。"""
        description = self._describe_image(image)
        if not description:
            return "No description found."

        return description