Jira
Jira工具规范 #
基类:EventBaseToolSpec
Atlassian Jira 工具规范。
workflows/handler.py 中的源代码llama_index/tools/jira/base.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 | |
jira_all_projects #
jira_all_projects() -> dict
从Atlassian Jira账户中检索所有项目。
此方法从Jira获取项目列表,并以结构化格式返回它们,包括项目ID、键和名称。如果在检索过程中发生错误,将返回错误信息。
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
dict |
dict
|
一个包含以下内容的字典: - 'error'(布尔值):指示请求是否成功。 - 'message'(字符串):对结果的描述。 - 'projects'(列表,可选):如果检索成功,包含项目详情(ID、键、名称)的项目列表。 |
workflows/handler.py 中的源代码llama_index/tools/jira/base.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
jira_comments_query #
jira_comments_query(issue_key: str, author_email: Optional[str] = None) -> dict
获取指定 Jira 问题的所有评论,可选择按作者邮箱进行筛选。
此函数从指定的Jira问题中获取评论,并以结构化JSON响应的形式返回。如果提供了author_email,则仅包含该特定作者的评论。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
issue_key
|
str
|
要获取评论的 Jira 问题键。 |
required |
author_email
|
(str, Optional)
|
根据作者邮箱筛选评论。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
dict |
dict
|
一个包含以下内容的字典: - 'error' (布尔值): 指示请求是否成功。 - 'message' (字符串): 关于结果的描述性信息。 - 'comments' (列表, 可选): 评论列表,其中每条评论包含: - 'id' (字符串): 评论的唯一标识符。 - 'author' (字符串): 评论作者的显示名称。 - 'author_email' (字符串): 作者的电子邮件地址。 - 'body' (字符串): 评论内容。 - 'created_at' (字符串): 评论创建时间戳。 - 'updated_at' (字符串): 评论最后更新时间戳。 |
workflows/handler.py 中的源代码llama_index/tools/jira/base.py
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | |
jira_issue_query #
jira_issue_query(issue_key: str, just_payload: bool = False) -> Union[None, dict]
获取特定 Jira 问题的详细信息。
此方法获取问题详情,例如摘要、描述、类型、项目、优先级、状态、报告人、负责人、标签和时间戳。响应结构可以使用 just_payload 标志进行调整。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
issue_key
|
str
|
Jira 问题的唯一键或工单编号。 |
required |
just_payload
|
bool
|
如果为True,仅返回问题负载而不包含响应元数据。默认为False。 |
False
|
返回:
| 类型 | 描述 |
|---|---|
Union[None, dict]
|
Union[None, dict]: 如果找到问题,则包含问题详情的字典;如果无法获取问题,则返回错误响应。 |
示例
jira_client.load_issue("JIRA-123", just_payload=True) { 'key': 'JIRA-123', 'summary': '修复登录错误', 'description': '用户在某些条件下无法登录...', 'type': 'Bug', 'project_name': 'Web App', 'priority': 'High', 'status': '进行中', 'reporter': 'John Doe', 'reporter_email': 'john.doe@example.com', 'labels': ['authentication', 'urgent'], 'created_at': '2024-02-01T10:15:30.000Z', 'updated_at': '2024-02-02T12:20:45.000Z', 'assignee': 'Jane Smith', 'assignee_email': 'jane.smith@example.com' }
workflows/handler.py 中的源代码llama_index/tools/jira/base.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | |
jira_issues_query #
jira_issues_query(keyword: str, max_results: int = 10) -> dict
搜索包含特定关键词的 Jira 问题。
此函数搜索在摘要、描述或评论中出现指定 keyword 的 Jira 问题。
结果按创建日期降序排列。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
keyword
|
str
|
在问题摘要、描述或评论中搜索的关键词。 |
required |
max_results
|
int
|
返回问题的最大数量。默认为10。如果设置高于100,将被限制为100。 |
10
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
dict |
dict
|
一个具有以下结构的字典: - 'error' (布尔值): 指示在获取操作期间是否发生错误。 - 'message' (字符串): 描述操作结果。 - 'results' (列表, 可选): 符合搜索条件的问题列表,仅在未发生错误时存在。 |
workflows/handler.py 中的源代码llama_index/tools/jira/base.py
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 | |
选项: 成员:- JiraToolSpec