mirror of
https://github.com/hwchase17/langchain.git
synced 2025-09-12 12:59:07 +00:00
community[minor]: Connery Tool and Toolkit (#14506)
## Summary This PR implements the "Connery Action Tool" and "Connery Toolkit". Using them, you can integrate Connery actions into your LangChain agents and chains. Connery is an open-source plugin infrastructure for AI. With Connery, you can easily create a custom plugin with a set of actions and seamlessly integrate them into your LangChain agents and chains. Connery will handle the rest: runtime, authorization, secret management, access management, audit logs, and other vital features. Additionally, Connery and our community offer a wide range of ready-to-use open-source plugins for your convenience. Learn more about Connery: - GitHub: https://github.com/connery-io/connery-platform - Documentation: https://docs.connery.io - Twitter: https://twitter.com/connery_io ## TODOs - [x] API wrapper - [x] Integration tests - [x] Connery Action Tool - [x] Docs - [x] Example - [x] Integration tests - [x] Connery Toolkit - [x] Docs - [x] Example - [x] Formatting (`make format`) - [x] Linting (`make lint`) - [x] Testing (`make test`)
This commit is contained in:
committed by
GitHub
parent
8457c31c04
commit
32c5be8b73
165
libs/community/langchain_community/tools/connery/service.py
Normal file
165
libs/community/langchain_community/tools/connery/service.py
Normal file
@@ -0,0 +1,165 @@
|
||||
import json
|
||||
from typing import Dict, List, Optional
|
||||
|
||||
import requests
|
||||
from langchain_core.pydantic_v1 import BaseModel, root_validator
|
||||
from langchain_core.utils.env import get_from_dict_or_env
|
||||
|
||||
from langchain_community.tools.connery.models import Action
|
||||
from langchain_community.tools.connery.tool import ConneryAction
|
||||
|
||||
|
||||
class ConneryService(BaseModel):
|
||||
"""
|
||||
A service for interacting with the Connery Runner API.
|
||||
It gets the list of available actions from the Connery Runner,
|
||||
wraps them in ConneryAction Tools and returns them to the user.
|
||||
It also provides a method for running the actions.
|
||||
"""
|
||||
|
||||
runner_url: Optional[str] = None
|
||||
api_key: Optional[str] = None
|
||||
|
||||
@root_validator()
|
||||
def validate_attributes(cls, values: Dict) -> Dict:
|
||||
"""
|
||||
Validate the attributes of the ConneryService class.
|
||||
Parameters:
|
||||
values (dict): The arguments to validate.
|
||||
Returns:
|
||||
dict: The validated arguments.
|
||||
"""
|
||||
|
||||
runner_url = get_from_dict_or_env(values, "runner_url", "CONNERY_RUNNER_URL")
|
||||
api_key = get_from_dict_or_env(values, "api_key", "CONNERY_RUNNER_API_KEY")
|
||||
|
||||
if not runner_url:
|
||||
raise ValueError("CONNERY_RUNNER_URL environment variable must be set.")
|
||||
if not api_key:
|
||||
raise ValueError("CONNERY_RUNNER_API_KEY environment variable must be set.")
|
||||
|
||||
values["runner_url"] = runner_url
|
||||
values["api_key"] = api_key
|
||||
|
||||
return values
|
||||
|
||||
def list_actions(self) -> List[ConneryAction]:
|
||||
"""
|
||||
Returns the list of actions available in the Connery Runner.
|
||||
Returns:
|
||||
List[ConneryAction]: The list of actions available in the Connery Runner.
|
||||
"""
|
||||
|
||||
return [
|
||||
ConneryAction.create_instance(action, self)
|
||||
for action in self._list_actions()
|
||||
]
|
||||
|
||||
def get_action(self, action_id: str) -> ConneryAction:
|
||||
"""
|
||||
Returns the specified action available in the Connery Runner.
|
||||
Parameters:
|
||||
action_id (str): The ID of the action to return.
|
||||
Returns:
|
||||
ConneryAction: The action with the specified ID.
|
||||
"""
|
||||
|
||||
return ConneryAction.create_instance(self._get_action(action_id), self)
|
||||
|
||||
def run_action(self, action_id: str, input: Dict[str, str] = {}) -> Dict[str, str]:
|
||||
"""
|
||||
Runs the specified Connery Action with the provided input.
|
||||
Parameters:
|
||||
action_id (str): The ID of the action to run.
|
||||
input (Dict[str, str]): The input object expected by the action.
|
||||
Returns:
|
||||
Dict[str, str]: The output of the action.
|
||||
"""
|
||||
|
||||
return self._run_action(action_id, input)
|
||||
|
||||
def _list_actions(self) -> List[Action]:
|
||||
"""
|
||||
Returns the list of actions available in the Connery Runner.
|
||||
Returns:
|
||||
List[Action]: The list of actions available in the Connery Runner.
|
||||
"""
|
||||
|
||||
response = requests.get(
|
||||
f"{self.runner_url}/v1/actions", headers=self._get_headers()
|
||||
)
|
||||
|
||||
if not response.ok:
|
||||
raise ValueError(
|
||||
(
|
||||
"Failed to list actions."
|
||||
f"Status code: {response.status_code}."
|
||||
f"Error message: {response.json()['error']['message']}"
|
||||
)
|
||||
)
|
||||
|
||||
return [Action(**action) for action in response.json()["data"]]
|
||||
|
||||
def _get_action(self, action_id: str) -> Action:
|
||||
"""
|
||||
Returns the specified action available in the Connery Runner.
|
||||
Parameters:
|
||||
action_id (str): The ID of the action to return.
|
||||
Returns:
|
||||
Action: The action with the specified ID.
|
||||
"""
|
||||
|
||||
actions = self._list_actions()
|
||||
action = next((action for action in actions if action.id == action_id), None)
|
||||
if not action:
|
||||
raise ValueError(
|
||||
(
|
||||
f"The action with ID {action_id} was not found in the list"
|
||||
"of available actions in the Connery Runner."
|
||||
)
|
||||
)
|
||||
return action
|
||||
|
||||
def _run_action(self, action_id: str, input: Dict[str, str] = {}) -> Dict[str, str]:
|
||||
"""
|
||||
Runs the specified Connery Action with the provided input.
|
||||
Parameters:
|
||||
action_id (str): The ID of the action to run.
|
||||
prompt (str): This is a plain English prompt
|
||||
with all the information needed to run the action.
|
||||
input (Dict[str, str]): The input object expected by the action.
|
||||
If provided together with the prompt,
|
||||
the input takes precedence over the input specified in the prompt.
|
||||
Returns:
|
||||
Dict[str, str]: The output of the action.
|
||||
"""
|
||||
|
||||
response = requests.post(
|
||||
f"{self.runner_url}/v1/actions/{action_id}/run",
|
||||
headers=self._get_headers(),
|
||||
data=json.dumps({"input": input}),
|
||||
)
|
||||
|
||||
if not response.ok:
|
||||
raise ValueError(
|
||||
(
|
||||
"Failed to run action."
|
||||
f"Status code: {response.status_code}."
|
||||
f"Error message: {response.json()['error']['message']}"
|
||||
)
|
||||
)
|
||||
|
||||
if not response.json()["data"]["output"]:
|
||||
return {}
|
||||
else:
|
||||
return response.json()["data"]["output"]
|
||||
|
||||
def _get_headers(self) -> Dict[str, str]:
|
||||
"""
|
||||
Returns a standard set of HTTP headers
|
||||
to be used in API calls to the Connery runner.
|
||||
Returns:
|
||||
Dict[str, str]: The standard set of HTTP headers.
|
||||
"""
|
||||
|
||||
return {"Content-Type": "application/json", "x-api-key": self.api_key or ""}
|
Reference in New Issue
Block a user