mirror of
https://github.com/hwchase17/langchain.git
synced 2025-09-04 20:46:45 +00:00
community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463)
Moved the following modules to new package langchain-community in a backwards compatible fashion: ``` mv langchain/langchain/adapters community/langchain_community mv langchain/langchain/callbacks community/langchain_community/callbacks mv langchain/langchain/chat_loaders community/langchain_community mv langchain/langchain/chat_models community/langchain_community mv langchain/langchain/document_loaders community/langchain_community mv langchain/langchain/docstore community/langchain_community mv langchain/langchain/document_transformers community/langchain_community mv langchain/langchain/embeddings community/langchain_community mv langchain/langchain/graphs community/langchain_community mv langchain/langchain/llms community/langchain_community mv langchain/langchain/memory/chat_message_histories community/langchain_community mv langchain/langchain/retrievers community/langchain_community mv langchain/langchain/storage community/langchain_community mv langchain/langchain/tools community/langchain_community mv langchain/langchain/utilities community/langchain_community mv langchain/langchain/vectorstores community/langchain_community mv langchain/langchain/agents/agent_toolkits community/langchain_community mv langchain/langchain/cache.py community/langchain_community mv langchain/langchain/adapters community/langchain_community mv langchain/langchain/callbacks community/langchain_community/callbacks mv langchain/langchain/chat_loaders community/langchain_community mv langchain/langchain/chat_models community/langchain_community mv langchain/langchain/document_loaders community/langchain_community mv langchain/langchain/docstore community/langchain_community mv langchain/langchain/document_transformers community/langchain_community mv langchain/langchain/embeddings community/langchain_community mv langchain/langchain/graphs community/langchain_community mv langchain/langchain/llms community/langchain_community mv langchain/langchain/memory/chat_message_histories community/langchain_community mv langchain/langchain/retrievers community/langchain_community mv langchain/langchain/storage community/langchain_community mv langchain/langchain/tools community/langchain_community mv langchain/langchain/utilities community/langchain_community mv langchain/langchain/vectorstores community/langchain_community mv langchain/langchain/agents/agent_toolkits community/langchain_community mv langchain/langchain/cache.py community/langchain_community ``` Moved the following to core ``` mv langchain/langchain/utils/json_schema.py core/langchain_core/utils mv langchain/langchain/utils/html.py core/langchain_core/utils mv langchain/langchain/utils/strings.py core/langchain_core/utils cat langchain/langchain/utils/env.py >> core/langchain_core/utils/env.py rm langchain/langchain/utils/env.py ``` See .scripts/community_split/script_integrations.sh for all changes
This commit is contained in:
110
libs/community/langchain_community/tools/plugin.py
Normal file
110
libs/community/langchain_community/tools/plugin.py
Normal file
@@ -0,0 +1,110 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
from typing import Optional, Type
|
||||
|
||||
import requests
|
||||
import yaml
|
||||
from langchain_core.callbacks import (
|
||||
AsyncCallbackManagerForToolRun,
|
||||
CallbackManagerForToolRun,
|
||||
)
|
||||
from langchain_core.pydantic_v1 import BaseModel
|
||||
from langchain_core.tools import BaseTool
|
||||
|
||||
|
||||
class ApiConfig(BaseModel):
|
||||
"""API Configuration."""
|
||||
|
||||
type: str
|
||||
url: str
|
||||
has_user_authentication: Optional[bool] = False
|
||||
|
||||
|
||||
class AIPlugin(BaseModel):
|
||||
"""AI Plugin Definition."""
|
||||
|
||||
schema_version: str
|
||||
name_for_model: str
|
||||
name_for_human: str
|
||||
description_for_model: str
|
||||
description_for_human: str
|
||||
auth: Optional[dict] = None
|
||||
api: ApiConfig
|
||||
logo_url: Optional[str]
|
||||
contact_email: Optional[str]
|
||||
legal_info_url: Optional[str]
|
||||
|
||||
@classmethod
|
||||
def from_url(cls, url: str) -> AIPlugin:
|
||||
"""Instantiate AIPlugin from a URL."""
|
||||
response = requests.get(url).json()
|
||||
return cls(**response)
|
||||
|
||||
|
||||
def marshal_spec(txt: str) -> dict:
|
||||
"""Convert the yaml or json serialized spec to a dict.
|
||||
|
||||
Args:
|
||||
txt: The yaml or json serialized spec.
|
||||
|
||||
Returns:
|
||||
dict: The spec as a dict.
|
||||
"""
|
||||
try:
|
||||
return json.loads(txt)
|
||||
except json.JSONDecodeError:
|
||||
return yaml.safe_load(txt)
|
||||
|
||||
|
||||
class AIPluginToolSchema(BaseModel):
|
||||
"""Schema for AIPluginTool."""
|
||||
|
||||
tool_input: Optional[str] = ""
|
||||
|
||||
|
||||
class AIPluginTool(BaseTool):
|
||||
"""Tool for getting the OpenAPI spec for an AI Plugin."""
|
||||
|
||||
plugin: AIPlugin
|
||||
api_spec: str
|
||||
args_schema: Type[AIPluginToolSchema] = AIPluginToolSchema
|
||||
|
||||
@classmethod
|
||||
def from_plugin_url(cls, url: str) -> AIPluginTool:
|
||||
plugin = AIPlugin.from_url(url)
|
||||
description = (
|
||||
f"Call this tool to get the OpenAPI spec (and usage guide) "
|
||||
f"for interacting with the {plugin.name_for_human} API. "
|
||||
f"You should only call this ONCE! What is the "
|
||||
f"{plugin.name_for_human} API useful for? "
|
||||
) + plugin.description_for_human
|
||||
open_api_spec_str = requests.get(plugin.api.url).text
|
||||
open_api_spec = marshal_spec(open_api_spec_str)
|
||||
api_spec = (
|
||||
f"Usage Guide: {plugin.description_for_model}\n\n"
|
||||
f"OpenAPI Spec: {open_api_spec}"
|
||||
)
|
||||
|
||||
return cls(
|
||||
name=plugin.name_for_model,
|
||||
description=description,
|
||||
plugin=plugin,
|
||||
api_spec=api_spec,
|
||||
)
|
||||
|
||||
def _run(
|
||||
self,
|
||||
tool_input: Optional[str] = "",
|
||||
run_manager: Optional[CallbackManagerForToolRun] = None,
|
||||
) -> str:
|
||||
"""Use the tool."""
|
||||
return self.api_spec
|
||||
|
||||
async def _arun(
|
||||
self,
|
||||
tool_input: Optional[str] = None,
|
||||
run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
|
||||
) -> str:
|
||||
"""Use the tool asynchronously."""
|
||||
return self.api_spec
|
Reference in New Issue
Block a user