Waii
Waii工具规范 #
Bases: BaseToolSpec, BaseReader
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
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 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
load_data #
load_data(ask: str) -> List[文档]
使用自然语言查询并从数据库加载数据,返回一个文档列表。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
ask
|
str
|
一个自然语言问题。 |
required |
返回:
| 类型 | 描述 |
|---|---|
List[文档]
|
List[Document]: 一个文档对象列表。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 | |
get_answer #
get_answer(ask: str) -> List[文档]
生成一个SQL查询并在数据库中执行,返回答案的摘要 参数: ask: 一个自然语言问题。
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
List[文档]
|
一个包含答案摘要的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
99 100 101 102 103 104 105 106 107 108 109 110 111 | |
generate_query_only #
generate_query_only(ask: str) -> str
生成一个SQL查询但不要执行它,返回查询语句。如需获取答案,应改用get_answer。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
ask
|
str
|
一个自然语言问题。 |
required |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
包含查询的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | |
describe_query #
describe_query(question: str, query: str) -> str
描述一个SQL查询,返回答案的摘要。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
question
|
str
|
人们想要提问的自然语言问题。 |
required |
query
|
str
|
一个SQL查询。 |
required |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
一个包含答案摘要的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
performance_analyze #
performance_analyze(query_uuid: str) -> str
分析查询的性能,返回答案的摘要。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
query_uuid
|
str
|
一个查询UUID,例如 xxxxxxxxxxxxx... |
required |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
一个包含答案摘要的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | |
diff_query #
diff_query(previous_query: str, current_query: str) -> str
对比两个SQL查询,返回答案的总结。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
previous_query
|
str
|
上一条SQL查询。 |
required |
current_query
|
str
|
当前SQL查询。 |
required |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
一个包含答案摘要的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | |
describe_dataset #
describe_dataset(ask: str, schema_name: Optional[str] = None, table_name: Optional[str] = None) -> str
描述一个数据集(无论是表还是模式),返回答案的摘要。 示例问题如:“描述该数据集”、“该模式是关于什么的”、“表xxx的示例问题”等。 当模式和表均为None时,描述整个数据库。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
ask
|
str
|
一个自然语言问题(您希望如何描述数据集)。 |
required |
schema_name
|
Optional[str]
|
一个模式名称(不应包含数据库名称或表名称)。 |
None
|
table_name
|
Optional[str]
|
表名。(不应包含数据库名称或模式名称)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
一个包含答案摘要的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
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 | |
转码 #
transcode(instruction: Optional[str] = '', source_dialect: Optional[str] = None, source_query: Optional[str] = None, target_dialect: Optional[str] = None) -> str
将SQL查询从一种方言转换为另一种方言,返回生成的查询。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
instruction
|
Optional[str]
|
自然语言指令。 |
''
|
source_dialect
|
Optional[str]
|
查询的源方言。 |
None
|
source_query
|
Optional[str]
|
源查询。 |
None
|
target_dialect
|
Optional[str]
|
查询的目标方言。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
一个包含生成查询的字符串。 |
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
get_semantic_contexts #
get_semantic_contexts() -> Any
获取所有预定义的语义上下文。
workflows/handler.py 中的源代码llama_index/tools/waii/base.py
283 284 285 286 287 | |
选项: 成员:- WaiiToolSpec