├── .gitignore ├── LICENSE ├── README.md ├── conf └── keys.json ├── docs ├── 1688642799640-image.png ├── 1688642948745-image.png ├── 1688643113313-image.png ├── 1688643185781-image.png ├── README.md └── 赞助.jpg ├── requirements.txt ├── setup.cfg ├── setup.py ├── sparkdesk_api ├── __init__.py ├── core.py └── utils.py ├── sparkdesk_api_cli.py ├── sparkdesk_web ├── __init__.py ├── core.py ├── utils.py └── web.py └── sparkdesk_web_cli.py /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | sparkdesk_web/log 3 | dist 4 | build 5 | history 6 | sparkdesk_api/__pycache__ 7 | sparkdesk_web/__pycache__ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sparkdesk-api 讯飞星火大模型api 2 | > 如果该项目对你有帮助，不要忘记给我点个 star，或者 [赞助](https://github.com/HildaM/sparkdesk-api#-%E8%B5%9E%E5%8A%A9) 我一杯蜜雪冰城喔~ 3 | ## 使用方法 4 | ```shell 5 | pip install sparkdesk-api==1.6.1 6 | ``` 7 | 或者 8 | ```shell 9 | pip install sparkdesk-api==1.6.1 -i https://pypi.org/simple 10 | ``` 11 | 12 | ### 1. Web模式 13 | Web模式下，需要前往讯飞星火大模型web端通过 F12 抓取 3 个参数：cookie、fd、GtToken 14 | - [获取参数的方法](https://github.com/HildaM/sparkdesk-api/tree/main/docs) 15 | 16 | #### 命令行操作 17 | ```shell 18 | python sparkdesk_web_cli.py 19 | ``` 20 | 21 | #### api调用 22 | - chat()：一次询问 23 | - chat_stream()：连续询问，相当于命令行模式 24 | ```python 25 | from sparkdesk_web.core import SparkWeb 26 | 27 | sparkWeb = SparkWeb( 28 | cookie=cookie, 29 | fd=fd, 30 | GtToken=GtToken 31 | ) 32 | 33 | # single chat 34 | print(sparkWeb.chat("repeat: hello world")) 35 | # continue chat 36 | sparkWeb.chat_stream() 37 | ``` 38 | 39 | ### 2. API模式 40 | 支持v4.0、v3.5、v3.0、v2.0、v1.0 四个版本 以及 [助手API](https://xinghuo.xfyun.cn/botcenter/createbot)，默认接口版本为3.5 41 | - 默认api接口版本为3.5，配置其他版本需要指定Version参数（3.1或者2.1或者1.1） 42 | 43 | 讯飞星火的API需要前往官网进行申请。 44 | 你可以先创建一个服务，然后在该服务的控制台页面左边的：“星火认知大模型”栏目，进入“合作咨询”页面进行申请。 45 | 一般使用公司邮箱申请速度快。 46 | 47 | 该模式需要 3 个参数：app_id、api_key、api_secret 48 | ```python 49 | from sparkdesk_api.core import SparkAPI 50 | # 默认api接口版本为3.1，配置其他版本需要指定Version参数（2.1或者1.1） 51 | sparkAPI = SparkAPI( 52 | app_id=app_id, 53 | api_secret=api_secret, 54 | api_key=api_key, 55 | # version=2.1, 56 | # assistant_id="xyzspsb4i5s7_v1" 57 | ) 58 | sparkAPI.chat_stream() 59 | ``` 60 | 61 | 具体调用方法与相关调用函数与 Web 模式一致。 62 | 63 | # 🙏 赞助 64 | 如果项目对您有帮助，可以赞助我一杯蜜雪冰城哦~ 65 |
66 | 67 |
68 | 69 | # 🤝贡献 70 | 71 | ## 🎉鸣谢 72 | 73 | 感谢以下开发者对该项目做出的贡献： 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /conf/keys.json: -------------------------------------------------------------------------------- 1 | { 2 | "fd": "xxxxxx", 3 | "GtToken": "xxxxxx==", 4 | "Cookie": "xxxxxx==" 5 | } -------------------------------------------------------------------------------- /docs/1688642799640-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HildaM/sparkdesk-api/3a548cfce937a2c4f65badecd66228ed86de95d1/docs/1688642799640-image.png -------------------------------------------------------------------------------- /docs/1688642948745-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HildaM/sparkdesk-api/3a548cfce937a2c4f65badecd66228ed86de95d1/docs/1688642948745-image.png -------------------------------------------------------------------------------- /docs/1688643113313-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HildaM/sparkdesk-api/3a548cfce937a2c4f65badecd66228ed86de95d1/docs/1688643113313-image.png -------------------------------------------------------------------------------- /docs/1688643185781-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HildaM/sparkdesk-api/3a548cfce937a2c4f65badecd66228ed86de95d1/docs/1688643185781-image.png -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # sparkdesk-api 讯飞星火大模型 Web模式 获取参数方法 2 | Web模式下，需要前往讯飞星火大模型web端通过 F12 抓取 3 个参数：cookie、fd、GtToken 3 | 讯飞星火的web端有防护，在web端直接按 F12 不能打开开发者窗口。但是可以通过特殊方法打开： 4 | 1. 进入 [https://xinghuo.xfyun.cn/](https://xinghuo.xfyun.cn/) 后登录账号，不要立即点“进入体验”，而是在这个页面点击 F12 5 | 2. 进入 F12 开发者窗口后，将网页修改为“手机端”窗口 6 | 1. ![](1688642799640-image.png) 7 | 3. 在第二步完成后，才点击“进入体验”，进入讯飞星火的web端，可以发现成功变成手机端 8 | 1. ![](1688642948745-image.png) 9 | 4. 先发一条简单的语句，让讯飞回复一段话，然后在“Network”栏目找到 “chat” 请求，在该请求下抓取 3 个参数 10 | 1. ![](1688643113313-image.png) 11 | 2. ![](1688643185781-image.png) 12 | 5. 获取后，即可开始使用 Web 模式 13 | 14 | #### 命令后模式 15 | ```shell 16 | python sparkdesk_web_cli.py 17 | ``` 18 | 19 | #### api调用 20 | - chat()：一次询问 21 | - chat_stream()：连续询问，相当于命令行模式 22 | ```python 23 | sparkWeb = SparkWeb( 24 | cookie=cookie, 25 | fd=fd, 26 | GtToken=GtToken 27 | ) 28 | 29 | # single chat 30 | print(sparkWeb.chat("repeat: hello world")) 31 | # continue chat 32 | sparkWeb.chat_stream() 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/赞助.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HildaM/sparkdesk-api/3a548cfce937a2c4f65badecd66228ed86de95d1/docs/赞助.jpg -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | setuptools==68.0.0 2 | websocket-client==1.6.3 3 | requests==2.31.0 4 | pyhandytools==0.0.4 5 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description_file=README.md 3 | license_files=LICENSE 4 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | with open("README.md", "r", encoding='utf-8') as fh: 4 | long_description = fh.read() 5 | 6 | setuptools.setup( 7 | name="sparkdesk-api", 8 | version="1.6.2", 9 | author="HildaM", 10 | author_email="Hilda_quan@163.com", 11 | description="sparkdesk-api 讯飞星火大模型api", 12 | long_description=long_description, 13 | long_description_content_type="text/markdown", 14 | url="https://github.com/HildaM/sparkdesk-api", 15 | license='GNU General Public License v3.0', 16 | packages=setuptools.find_packages(), 17 | classifiers=[ 18 | "Programming Language :: Python :: 3", 19 | "License :: OSI Approved :: MIT License", 20 | "Operating System :: OS Independent", 21 | ], 22 | ) -------------------------------------------------------------------------------- /sparkdesk_api/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : PyCharm 4 | @File : __init__.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 19:46 8 | @Description : 9 | """ 10 | 11 | name = "sparkdesk_api" -------------------------------------------------------------------------------- /sparkdesk_api/core.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : core.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/4 16:50 8 | @Description : The core entry point of the API interface 9 | """ 10 | import base64 11 | import hmac 12 | import json, logging 13 | from datetime import datetime, timezone 14 | from urllib.parse import urlencode, urlparse 15 | from websocket import create_connection, WebSocketConnectionClosedException 16 | from sparkdesk_api.utils import get_prompt, process_response, is_support_version 17 | 18 | 19 | class SparkAPI: 20 | __api_url = 'wss://spark-api.xf-yun.com/v3.5/chat' # 默认为3.0版本 21 | __domain = 'generalv3.5' 22 | __max_token = 2048 23 | 24 | def __init__(self, app_id, api_key, api_secret, version=None, assistant_id=None): 25 | self.__app_id = app_id 26 | self.__api_key = api_key 27 | self.__api_secret = api_secret 28 | # 配置版本 29 | if version is not None and is_support_version(version): 30 | self.__set_version(version) 31 | 32 | # 助手API 33 | if assistant_id is not None: 34 | self.__api_url = f'wss://spark-openapi.cn-huabei-1.xf-yun.com/v1/assistants/{assistant_id}' 35 | self.__domain = 'general' 36 | 37 | def __set_version(self, version): 38 | # 讯飞v1.0 39 | if version == 1.1: 40 | self.__api_url = 'wss://spark-api.xf-yun.com/v1.1/chat' 41 | self.__domain = 'general' 42 | # 讯飞v2.0 43 | elif version == 2.1: 44 | self.__api_url = 'wss://spark-api.xf-yun.com/v2.1/chat' 45 | self.__domain = 'generalv2' 46 | elif version == 3.1: 47 | self.__api_url = 'wss://spark-api.xf-yun.com/v3.1/chat' 48 | self.__domain = 'generalv3' 49 | elif version == 3.5: 50 | return 51 | elif version == 3.2: 52 | self.__api_url = 'wss://spark-api.xf-yun.com/chat/pro-128k' 53 | self.__domain = 'pro-128k' 54 | elif version == 4.0: 55 | self.__api_url = 'wss://spark-api.xf-yun.com/v4.0/chat' 56 | self.__domain = '4.0Ultra' 57 | 58 | def __set_max_tokens(self, token): 59 | if isinstance(token, int) is False or token < 0: 60 | print("set_max_tokens() error: tokens should be a positive integer!") 61 | return 62 | self.__max_token = token 63 | 64 | """ 65 | doc url: https://www.xfyun.cn/doc/spark/general_url_authentication.html 66 | """ 67 | 68 | def __get_authorization_url(self): 69 | authorize_url = urlparse(self.__api_url) 70 | # 1. generate data 71 | date = datetime.now(timezone.utc).strftime('%a, %d %b %Y %H:%M:%S %Z') 72 | 73 | """ 74 | Generation rule of Authorization parameters 75 | 1) Obtain the APIKey and APISecret parameters from the console. 76 | 2) Use the aforementioned date to dynamically concatenate a string tmp. Here we take Huobi's URL as an example, 77 | the actual usage requires replacing the host and path with the specific request URL. 78 | """ 79 | signature_origin = "host: {}\ndate: {}\nGET {} HTTP/1.1".format( 80 | authorize_url.netloc, date, authorize_url.path 81 | ) 82 | signature = base64.b64encode( 83 | hmac.new( 84 | self.__api_secret.encode(), 85 | signature_origin.encode(), 86 | digestmod='sha256' 87 | ).digest() 88 | ).decode() 89 | authorization_origin = \ 90 | 'api_key="{}",algorithm="{}",headers="{}",signature="{}"'.format( 91 | self.__api_key, "hmac-sha256", "host date request-line", signature 92 | ) 93 | authorization = base64.b64encode(authorization_origin.encode()).decode() 94 | params = { 95 | "authorization": authorization, 96 | "date": date, 97 | "host": authorize_url.netloc 98 | } 99 | 100 | ws_url = self.__api_url + "?" + urlencode(params) 101 | return ws_url 102 | 103 | def __build_inputs( 104 | self, 105 | message: dict, 106 | user_id: str = "001", 107 | temperature: float = 0.5, 108 | max_tokens: int = 2048 109 | ): 110 | input_dict = { 111 | "header": { 112 | "app_id": self.__app_id, 113 | "uid": user_id, 114 | }, 115 | "parameter": { 116 | "chat": { 117 | "domain": self.__domain, 118 | "temperature": temperature, 119 | "max_tokens": max_tokens, 120 | } 121 | }, 122 | "payload": { 123 | "message": message 124 | } 125 | } 126 | return json.dumps(input_dict) 127 | 128 | def chat( 129 | self, 130 | query: str, 131 | history: list = None, # store the conversation history 132 | user_id: str = "001", 133 | max_tokens: int = 2048, 134 | temperature: float = 0.5, 135 | ): 136 | if history is None: 137 | history = [] 138 | 139 | # the max of max_length is 4096 140 | max_tokens = min(max_tokens, 4096) 141 | url = self.__get_authorization_url() 142 | ws = create_connection(url) 143 | message = get_prompt(query, history) 144 | input_str = self.__build_inputs( 145 | message=message, 146 | user_id=user_id, 147 | temperature=temperature, 148 | max_tokens=max_tokens, 149 | ) 150 | ws.send(input_str) 151 | response_str = ws.recv() 152 | try: 153 | while True: 154 | response, history, status = process_response(response_str, history) 155 | """ 156 | The final return result, which means a complete conversation. 157 | doc url: https://www.xfyun.cn/doc/spark/Web.html#_1-%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E 158 | """ 159 | if len(response) == 0 or status == 2: 160 | if not response and history and history[-1]["role"] == "assistant": 161 | response = history[-1]["content"] 162 | break 163 | response_str = ws.recv() 164 | return response 165 | 166 | except WebSocketConnectionClosedException: 167 | print("Connection closed") 168 | finally: 169 | ws.close() 170 | 171 | # Stream output statement, used for terminal chat. 172 | def __streaming_output( 173 | self, 174 | query: str, 175 | history: list = None, # store the conversation history 176 | user_id: str = "001", 177 | max_tokens: int = 2048, 178 | temperature: float = 0.5, 179 | ): 180 | if history is None: 181 | history = [] 182 | 183 | # the max of max_length is 4096 184 | max_tokens = min(max_tokens, 4096) 185 | url = self.__get_authorization_url() 186 | ws = create_connection(url) 187 | 188 | message = get_prompt(query, history) 189 | input_str = self.__build_inputs( 190 | message=message, 191 | user_id=user_id, 192 | temperature=temperature, 193 | max_tokens=max_tokens, 194 | ) 195 | 196 | # send question or prompt to url, and receive the answer 197 | ws.send(input_str) 198 | response_str = ws.recv() 199 | 200 | # Continuous conversation 201 | try: 202 | while True: 203 | response, history, status = process_response(response_str, history) 204 | yield response, history 205 | if len(response) == 0 or status == 2: 206 | break 207 | response_str = ws.recv() 208 | 209 | except WebSocketConnectionClosedException: 210 | print("Connection closed") 211 | finally: 212 | ws.close() 213 | 214 | def chat_stream(self): 215 | history = [] 216 | print("Enter exit or stop to end the converation.\n") 217 | try: 218 | while True: 219 | query = input("Ask: ") 220 | if query == "exit" or query == "stop": 221 | break 222 | for response, _ in self.__streaming_output(query, history): 223 | print("\r" + response, end="") 224 | print("\n") 225 | except BaseException as e: 226 | if isinstance(e, KeyboardInterrupt): 227 | print(e) 228 | finally: 229 | print("\nThank you for using the SparkDesk AI. Welcome to use it again!") 230 | -------------------------------------------------------------------------------- /sparkdesk_api/utils.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : utils.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/4 20:09 8 | @Description : chat utils 9 | """ 10 | import json 11 | 12 | VERSIONS = {1.1, 2.1, 3.1, 3.2, 3.5, 4.0} 13 | 14 | 15 | def get_prompt(query: str, history: list): 16 | use_message = {"role": "user", "content": query} 17 | if history is None: 18 | history = [] 19 | history.append(use_message) 20 | message = {"text": history} 21 | return message 22 | 23 | 24 | """ 25 | param reference: 26 | status: 27 | Text response status, with values of [0, 1, 2]; 28 | 0 represents the first text result, 1 represents intermediate text results, and 2 represents the last text result. 29 | 30 | """ 31 | 32 | 33 | def process_response(response_str: str, history: list): 34 | res_dict: dict = json.loads(response_str) 35 | code = res_dict.get("header", {}).get("code") 36 | status = res_dict.get("header", {}).get("status", 2) 37 | 38 | if code == 0: 39 | res_dict = res_dict.get("payload", {}).get("choices", {}).get("text", [{}])[0] 40 | res_content = res_dict.get("content", "") 41 | 42 | if len(res_dict) > 0 and len(res_content) > 0: 43 | # Ignore the unnecessary data 44 | if "index" in res_dict: 45 | del res_dict["index"] 46 | response = res_content 47 | 48 | if status == 0: 49 | history.append(res_dict) 50 | else: 51 | history[-1]["content"] += response 52 | response = history[-1]["content"] 53 | 54 | return response, history, status 55 | else: 56 | return "", history, status 57 | else: 58 | print("error code ", code) 59 | print("you can see this website to know code detail") 60 | print("https://www.xfyun.cn/doc/spark/%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E.html") 61 | return "", history, status 62 | 63 | 64 | 65 | # 版本控制 66 | def is_support_version(version): 67 | if version in VERSIONS: 68 | return True 69 | raise RuntimeError("Sparkdesk Version 只支持1.1、2.1、3.1、3.2、3.5、4.0，请输入正确的Version") 70 | -------------------------------------------------------------------------------- /sparkdesk_api_cli.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : sparkdesk_api_cli.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 18:56 8 | @Description : 9 | """ 10 | from sparkdesk_api.core import SparkAPI 11 | 12 | if __name__ == '__main__': 13 | app_id = input("app_id: ") 14 | api_secret = input("api_secret: ") 15 | api_key = input("api_key: ") 16 | 17 | # 默认api接口版本为1.5，2.0需要自行申请。开启v2.0版本只需指定 version=2.1 即可 18 | sparkAPI = SparkAPI( 19 | app_id=app_id, 20 | api_secret=api_secret, 21 | api_key=api_key, 22 | # version=2.1 23 | # assistant_id="xyzspsb4i5s7_v1" 24 | ) 25 | 26 | # single chat 27 | # print(sparkAPI.chat("repeat: hello world")) 28 | 29 | # continue chat 30 | sparkAPI.chat_stream() -------------------------------------------------------------------------------- /sparkdesk_web/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : PyCharm 4 | @File : __init__.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 19:46 8 | @Description : 9 | """ 10 | 11 | name = "sparkdesk_web" -------------------------------------------------------------------------------- /sparkdesk_web/core.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : core.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 15:00 8 | @Description : web接口核心入口 9 | """ 10 | import json 11 | import os 12 | import sys 13 | from datetime import datetime 14 | import requests 15 | from pyhandytools.file import FileUtils 16 | from sparkdesk_web.utils import decode 17 | from sparkdesk_web.web import create_chat_header, create_request_header 18 | 19 | NEW_CHAT = "SparkDesk AI chat" 20 | 21 | 22 | class SparkWeb: 23 | __cookie = "" 24 | __fd = "" 25 | __GtToken = "" 26 | __chat_id = "" 27 | __chat_header = "" 28 | __request_header = "" 29 | __chat_history = list() 30 | 31 | def __init__(self, cookie, fd, GtToken, ChatID=""): 32 | self.__cookie = cookie 33 | self.__fd = fd 34 | self.__GtToken = GtToken 35 | self.__cha_header = create_chat_header(cookie) 36 | self.__request_header = create_request_header(cookie) 37 | self.__chat_id = ChatID 38 | 39 | def __generate_chat_id(self): 40 | if self.__chat_id == "": 41 | url = 'https://xinghuo.xfyun.cn/iflygpt/u/chat-list/v1/create-chat-list' 42 | payload = "{}" 43 | response = requests.request("POST", url, headers=self.__request_header, data=payload) 44 | response_data = json.loads(response.text) 45 | if response_data['code'] == 0: 46 | chat_list_id = response_data['data']['id'] 47 | return chat_list_id 48 | else: 49 | return '0' 50 | else: 51 | return self.__chat_id 52 | 53 | def __set_name(self, chat_name): 54 | url = "https://xinghuo.xfyun.cn/iflygpt/u/chat-list/v1/rename-chat-list" 55 | chat_list_name = chat_name[:15] 56 | payload = { 57 | 'chatListId': self.__chat_id, 58 | 'chatListName': chat_list_name, 59 | } 60 | response = requests.request("POST", url, headers=self.__request_header, data=json.dumps(payload)) 61 | response_data = json.loads(response.text) 62 | if response_data['code'] != 0: 63 | print('\nERROR: Failed to initialize session name. Please reset Cookie, fd and GtToken') 64 | exit(-1) 65 | 66 | def __create_chat(self, chat_name): 67 | self.__chat_id = self.__generate_chat_id() 68 | self.__set_name(chat_name) 69 | 70 | # 获取最近一次的sid用于延续对话，否则对话无记忆 71 | def __get_chat_sid(self) -> str: 72 | try: 73 | response = self.__get_chat_history() 74 | data = json.loads(response.text) 75 | return data['data'][-1]["historyList"][-1]["sid"] 76 | except: 77 | return '' 78 | 79 | def __get_chat_history(self): 80 | 81 | url = f'https://xinghuo.xfyun.cn/iflygpt/u/chat_history/all/{self.__chat_id}' 82 | response = requests.request("GET", url, headers=self.__request_header) 83 | return response 84 | 85 | def __get_resp(self, question): 86 | 87 | sid = self.__get_chat_sid() 88 | url = "https://xinghuo.xfyun.cn/iflygpt-chat/u/chat_message/chat" 89 | payload = { 90 | 'fd': self.__fd, 91 | 'chatId': self.__chat_id, 92 | 'text': question, 93 | 'GtToken': self.__GtToken, 94 | 'sid': sid, 95 | 'clientType': '1' 96 | } 97 | response = requests.request("POST", url, headers=self.__cha_header, data=payload, stream=True) 98 | return response 99 | 100 | def chat(self, question): 101 | self.__create_chat(NEW_CHAT) 102 | 103 | response = self.__get_resp(question) 104 | response_text = '' 105 | for line in response.iter_lines(): 106 | if line: 107 | encoded_data = line[len("data:"):] 108 | missing_padding = len(encoded_data) % 4 109 | if missing_padding != 0: 110 | encoded_data += b'=' * (4 - missing_padding) 111 | if decode(encoded_data) != 'zw': 112 | sys.stdout.flush() 113 | answer = decode(encoded_data).replace('\n\n', '\n') 114 | response_text += answer 115 | 116 | if len(response_text.strip()) == 0: 117 | print("WARNING: 可能触发敏感词监控，对话已被重置，请前往Web页面更新Cookie、fd、GtToken！") 118 | return response_text 119 | 120 | def __streaming_output(self, question): 121 | response = self.__get_resp(question) 122 | response_text = '' 123 | for line in response.iter_lines(): 124 | if line: 125 | encoded_data = line[len("data:"):] 126 | missing_padding = len(encoded_data) % 4 127 | if missing_padding != 0: 128 | encoded_data += b'=' * (4 - missing_padding) 129 | if decode(encoded_data) != 'zw': 130 | sys.stdout.flush() 131 | answer = decode(encoded_data).replace('\n\n', '\n') 132 | response_text += answer 133 | print(answer, end="") 134 | if len(response_text.strip()) == 0: 135 | return '', False 136 | print("\n") 137 | return response_text, True 138 | 139 | def chat_stream(self, history: bool = False, history_path: str = './history/'): 140 | history_file_path = '' 141 | if history: 142 | FileUtils.check_dir_path(history_path) 143 | history_file_path = os.path.join(history_path, f'history_{str(datetime.now().strftime("%Y-%m-%d-%H-%M-%S"))}.json') 144 | try: 145 | self.__create_chat(NEW_CHAT) 146 | print("Enter exit or stop to end the conversation.\n") 147 | count = 0 148 | while True: 149 | count += 1 150 | question = input("Ask: ") 151 | if question == 'exit' or question == 'stop': 152 | break 153 | resp = self.__streaming_output(question) 154 | # If False, regenerate the chat 155 | if resp[1] is False: 156 | print("WARNING: 可能触发敏感词监控，对话已被重置，请前往Web页面更新Cookie、fd、GtToken！") 157 | if history: 158 | self.__chat_history.append({ 159 | 'time': str(datetime.now()), 160 | 'question': question, 161 | 'answer': resp[0] if resp[0] else '触发敏感词监控' 162 | }) 163 | finally: 164 | if history: 165 | FileUtils.write2json(history_file_path, self.__chat_history) 166 | print("\nThank you for using the SparkDesk AI. Welcome to use it again!") 167 | 168 | # 提供连续对话 169 | def create_continuous_chat(self): 170 | # 生成器包装，提供预激服务 171 | class ContextGenWrapper: 172 | def __init__(self, spark, gen): 173 | self._gen = gen 174 | self._spark = spark 175 | # 第一次构建生成器 进行预激 176 | next(gen) 177 | 178 | def chat(self, question): 179 | result = self._gen.send(question) 180 | # 将生成器执行到接受question的位置 181 | self._gen.send(None) 182 | return result 183 | 184 | return ContextGenWrapper(self, self.continuous_chat_gen()) 185 | 186 | # 连续对话生成器 187 | def continuous_chat_gen(self): 188 | self.__create_chat(NEW_CHAT) 189 | count = 0 190 | while True: 191 | count += 1 192 | question = yield 193 | resp = self.__streaming_output(question) 194 | # If False, regenerate the chat 195 | if resp[1] is False: 196 | print("WARNING: 可能触发敏感词监控，对话已被重置，请前往Web页面更新Cookie、fd、GtToken！") 197 | yield resp[0] 198 | -------------------------------------------------------------------------------- /sparkdesk_web/utils.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : utils.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 15:10 8 | @Description : common utils 9 | """ 10 | import base64 11 | import json 12 | 13 | log_file_name = "sparkdesk_web/log/session_log.json" 14 | 15 | 16 | def decode(text): 17 | try: 18 | decoded_data = base64.b64decode(text).decode('utf-8') 19 | return decoded_data 20 | except Exception as e: 21 | return '' 22 | 23 | 24 | def load_log(): 25 | try: 26 | with open(log_file_name, "r", encoding='utf-8') as f: 27 | log_data = json.load(f) 28 | chat_id = log_data["chat_id"] 29 | return True, chat_id 30 | except: 31 | return False, "" 32 | 33 | 34 | def save_log(chat_id): 35 | session_log = {"chat_id": chat_id} 36 | with open(log_file_name, "w", encoding='utf-8') as f: 37 | json.dump(session_log, f, ensure_ascii=False, indent=4) 38 | -------------------------------------------------------------------------------- /sparkdesk_web/web.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : web.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 14:54 8 | @Description : web utils 9 | """ 10 | import copy 11 | 12 | 13 | def create_chat_header(cookie): 14 | headers = { 15 | 'Accept': 'text/event-stream', 16 | 'Accept-Encoding': 'gzip, deflate, br', 17 | 'Accept-Language': 'zh-CN,zh;q=0.9', 18 | 'Connection': 'keep-alive', 19 | 'Cookie': cookie, 20 | 'Origin': 'https://xinghuo.xfyun.cn', 21 | 'Referer': 'https://xinghuo.xfyun.cn/desk', 22 | 'sec-ch-ua': '"Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"', 23 | 'sec-ch-ua-mobile': '?0', 24 | 'sec-ch-ua-platform': '"Windows"', 25 | 'Sec-Fetch-Dest': 'empty', 26 | 'Sec-Fetch-Mode': 'cors', 27 | 'Sec-Fetch-Site': 'same-origin', 28 | 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36' 29 | } 30 | 31 | return headers 32 | 33 | 34 | def create_request_header(cookie): 35 | headers = { 36 | 'Accept': 'application/json, text/plain, */*', 37 | 'Accept-Encoding': 'gzip, deflate, br', 38 | 'Accept-Language': 'zh-CN,zh;q=0.9', 39 | 'Connection': 'keep-alive', 40 | 'Content-Type': 'application/json', 41 | 'Cookie': cookie, 42 | 'Origin': 'https://xinghuo.xfyun.cn', 43 | 'Referer': 'https://xinghuo.xfyun.cn/desk', 44 | 'sec-ch-ua': '"Chromium";v="112", "Google Chrome";v="112", "Not:A-Brand";v="99"', 45 | 'sec-ch-ua-mobile': '?0', 46 | 'sec-ch-ua-platform': '"Windows"', 47 | 'Sec-Fetch-Dest': 'empty', 48 | 'Sec-Fetch-Mode': 'cors', 49 | 'Sec-Fetch-Site': 'same-origin', 50 | 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36', 51 | 'X-Requested-With': 'XMLHttpRequest' 52 | } 53 | 54 | return headers -------------------------------------------------------------------------------- /sparkdesk_web_cli.py: -------------------------------------------------------------------------------- 1 | # -*- coding: UTF-8 -*- 2 | """ 3 | @Project : sparkdesk-api 4 | @File : sparkdesk_web_cli.py 5 | @Author : HildaM 6 | @Email : Hilda_quan@163.com 7 | @Date : 2023/7/6 19:07 8 | @Description : 9 | """ 10 | from sparkdesk_web.core import SparkWeb 11 | from pyhandytools.file import FileUtils 12 | 13 | if __name__ == '__main__': 14 | conf_data = FileUtils.load_json('./conf/keys.json') 15 | 16 | sparkWeb = SparkWeb( 17 | cookie=conf_data['Cookie'], 18 | fd=conf_data['fd'], 19 | GtToken=conf_data['GtToken'] 20 | ) 21 | 22 | # single chat 23 | # print(sparkWeb.chat("repeat: hello world")) 24 | 25 | # stream input chat 26 | # sparkWeb.chat_stream(history=True) 27 | 28 | # continue chat 29 | chat = sparkWeb.create_continuous_chat() 30 | while True: 31 | chat.chat(input("Ask: ")) 32 | # chat.chat("肇庆是一个什么样的城市") 33 | # chat.chat("刚才你说的是哪个城市？") 34 | --------------------------------------------------------------------------------