mirror of
https://github.com/hwchase17/langchain.git
synced 2025-05-04 06:37:58 +00:00
b9746a6910
The OpenAI API requires function names to match the pattern
'^[a-zA-Z0-9_-]+$'. This updates the JIRA toolkit's tool names to use
underscores instead of spaces to comply with this requirement and
prevent BadRequestError when using the tools with OpenAI functions.
Error fixed:
```
File "langgraph-bug-fix/.venv/lib/python3.13/site-packages/openai/_base_client.py", line 1023, in _request
raise self._make_status_error_from_response(err.response) from None
openai.BadRequestError: Error code: 400 - {'error': {'message': "Invalid 'tools[0].function.name': string does not match pattern. Expected a string that matches the pattern '^[a-zA-Z0-9_-]+$'.", 'type': 'invalid_request_error', 'param': 'tools[0].function.name', 'code': 'invalid_value'}}
During task with name 'agent' and id 'aedd7537-e8d5-6678-d0c5-98129586d3ac'
```
Issue:#30182
84 lines
2.5 KiB
Python
84 lines
2.5 KiB
Python
from typing import Dict, List
|
|
|
|
from langchain_core.tools import BaseTool
|
|
from langchain_core.tools.base import BaseToolkit
|
|
|
|
from langchain_community.tools.jira.prompt import (
|
|
JIRA_CATCH_ALL_PROMPT,
|
|
JIRA_CONFLUENCE_PAGE_CREATE_PROMPT,
|
|
JIRA_GET_ALL_PROJECTS_PROMPT,
|
|
JIRA_ISSUE_CREATE_PROMPT,
|
|
JIRA_JQL_PROMPT,
|
|
)
|
|
from langchain_community.tools.jira.tool import JiraAction
|
|
from langchain_community.utilities.jira import JiraAPIWrapper
|
|
|
|
|
|
class JiraToolkit(BaseToolkit):
|
|
"""Jira Toolkit.
|
|
|
|
*Security Note*: This toolkit contains tools that can read and modify
|
|
the state of a service; e.g., by creating, deleting, or updating,
|
|
reading underlying data.
|
|
|
|
See https://python.langchain.com/docs/security for more information.
|
|
|
|
Parameters:
|
|
tools: List[BaseTool]. The tools in the toolkit. Default is an empty list.
|
|
"""
|
|
|
|
tools: List[BaseTool] = []
|
|
|
|
@classmethod
|
|
def from_jira_api_wrapper(cls, jira_api_wrapper: JiraAPIWrapper) -> "JiraToolkit":
|
|
"""Create a JiraToolkit from a JiraAPIWrapper.
|
|
|
|
Args:
|
|
jira_api_wrapper: JiraAPIWrapper. The Jira API wrapper.
|
|
|
|
Returns:
|
|
JiraToolkit. The Jira toolkit.
|
|
"""
|
|
|
|
operations: List[Dict] = [
|
|
{
|
|
"mode": "jql",
|
|
"name": "jql_query",
|
|
"description": JIRA_JQL_PROMPT,
|
|
},
|
|
{
|
|
"mode": "get_projects",
|
|
"name": "get_projects",
|
|
"description": JIRA_GET_ALL_PROJECTS_PROMPT,
|
|
},
|
|
{
|
|
"mode": "create_issue",
|
|
"name": "create_issue",
|
|
"description": JIRA_ISSUE_CREATE_PROMPT,
|
|
},
|
|
{
|
|
"mode": "other",
|
|
"name": "catch_all_jira_api",
|
|
"description": JIRA_CATCH_ALL_PROMPT,
|
|
},
|
|
{
|
|
"mode": "create_page",
|
|
"name": "create_confluence_page",
|
|
"description": JIRA_CONFLUENCE_PAGE_CREATE_PROMPT,
|
|
},
|
|
]
|
|
tools = [
|
|
JiraAction(
|
|
name=action["name"],
|
|
description=action["description"],
|
|
mode=action["mode"],
|
|
api_wrapper=jira_api_wrapper,
|
|
)
|
|
for action in operations
|
|
]
|
|
return cls(tools=tools) # type: ignore[arg-type]
|
|
|
|
def get_tools(self) -> List[BaseTool]:
|
|
"""Get the tools in the toolkit."""
|
|
return self.tools
|