├── .gitignore ├── LICENSE ├── LICENSE.md ├── README.md ├── client.go ├── context.go ├── context_test.go ├── helpers.go ├── intent.go ├── intent_test.go ├── query.go ├── query_response.go ├── query_test.go └── util.go /.gitignore: -------------------------------------------------------------------------------- 1 | apiai 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 3-Clause License 2 | 3 | Copyright (c) 2017, Kamal Singh 4 | All rights reserved. 5 | 6 | Redistribution and use in source and binary forms, with or without 7 | modification, are permitted provided that the following conditions are met: 8 | 9 | * Redistributions of source code must retain the above copyright notice, this 10 | list of conditions and the following disclaimer. 11 | 12 | * Redistributions in binary form must reproduce the above copyright notice, 13 | this list of conditions and the following disclaimer in the documentation 14 | and/or other materials provided with the distribution. 15 | 16 | * Neither the name of the copyright holder nor the names of its 17 | contributors may be used to endorse or promote products derived from 18 | this software without specific prior written permission. 19 | 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Overview 2 | 3 | A simple API.ai SDK for Go. 4 | 5 | # Features 6 | 7 | - Query 8 | - Supports all query response fields, including: 9 | - Multiple Fulfillment message types 10 | - Params 11 | - List Intents 12 | - Add/Fetch/Delete/Clear Context 13 | 14 | # Examples 15 | 16 | Example: Perform a query and access some response params. 17 | 18 | ```golang 19 | 20 | c := apiai.NewClient("") 21 | 22 | answer, err := c.Query("", "Hi there!") 23 | 24 | params := struct { 25 | MyParam1 string `json:"my-param-1"` 26 | MyParam2 string `json:"my-param-2"` 27 | }{} 28 | json.Unmarshal(*answer.Result.Parameters, ¶ms) 29 | 30 | fmt.Printf("got params: %+v", params) 31 | 32 | ``` 33 | 34 | # Running Tests 35 | 36 | NOTE: Running tests require an API.ai Access Token. The tests use this token to 37 | perform a query triggering the Default Fallback Intent for that account to ensure 38 | basic tests pass. 39 | 40 | ``API_AI_ACCESS_TOKEN= go test`` 41 | -------------------------------------------------------------------------------- /client.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | const ( 4 | APIAIBaseURL = "https://api.api.ai/v1" 5 | APIVersion = "20150910" 6 | ) 7 | 8 | type Client struct { 9 | accessToken string 10 | } 11 | 12 | func NewClient(accessToken string) *Client { 13 | return &Client{ 14 | accessToken: accessToken, 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /context.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "bytes" 5 | "encoding/json" 6 | "fmt" 7 | "net/http" 8 | ) 9 | 10 | type Context struct { 11 | Name string `json:"name"` 12 | Lifespan int `json:"lifespan"` 13 | Parameters map[string]interface{} `json:"parameters"` 14 | } 15 | 16 | type AddContextResponse struct { 17 | Names []string `json:"names"` 18 | Status ResponseStatus `json:"status"` 19 | } 20 | 21 | // AddContext adds a context to the session 22 | func (c *Client) AddContext(sessionID string, context *Context) ( 23 | answer *AddContextResponse, err error) { 24 | 25 | url := fmt.Sprintf("%s/contexts?v=%s&lang=en&sessionId=%v", 26 | APIAIBaseURL, APIVersion, sessionID) 27 | 28 | b := new(bytes.Buffer) 29 | json.NewEncoder(b).Encode(context) 30 | data, err := c.httpCall("POST", url, b) 31 | 32 | answer = &AddContextResponse{} 33 | if err := json.Unmarshal(data, &answer); err != nil { 34 | return answer, err 35 | } 36 | if answer.Status.Code != http.StatusOK { 37 | err = fmt.Errorf("API.ai response code was %d", answer.Status.Code) 38 | return answer, err 39 | } 40 | return 41 | } 42 | 43 | // FetchContexts Retrieves the list of all currently active contexts for the specified session. 44 | func (c *Client) FetchContexts(sessionID string) ( 45 | contexts []*Context, err error) { 46 | 47 | url := fmt.Sprintf("%s/contexts?v=%s&sessionId=%v", 48 | APIAIBaseURL, APIVersion, sessionID) 49 | 50 | data, err := c.httpCall("GET", url, httpBody("")) 51 | 52 | contexts = []*Context{} 53 | if err := json.Unmarshal(data, &contexts); err != nil { 54 | return contexts, err 55 | } 56 | return 57 | } 58 | 59 | // DeleteContext Deletes the specified context from the specified session. 60 | func (c *Client) DeleteContext(sessionID string, name string) ( 61 | status *ResponseStatus, err error) { 62 | 63 | url := fmt.Sprintf("%s/contexts/%s?v=%s&sessionId=%v", 64 | APIAIBaseURL, name, APIVersion, sessionID) 65 | 66 | data, err := c.httpCall("DELETE", url, httpBody("")) 67 | 68 | status = &ResponseStatus{} 69 | if err := json.Unmarshal(data, &status); err != nil { 70 | return status, err 71 | } 72 | return 73 | } 74 | 75 | // ClearContext clears all contexts 76 | func (c *Client) ClearContext(sessionID string) ( 77 | answer *QueryResponse, err error) { 78 | 79 | url := fmt.Sprintf("%s/contexts?v=%s&lang=en&sessionId=%v", 80 | APIAIBaseURL, APIVersion, sessionID) 81 | 82 | data, err := c.httpCall("DELETE", url, nil) 83 | 84 | answer = &QueryResponse{} 85 | if err := json.Unmarshal(data, &answer); err != nil { 86 | return answer, err 87 | } 88 | return 89 | } 90 | -------------------------------------------------------------------------------- /context_test.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "os" 5 | "strings" 6 | "testing" 7 | 8 | "github.com/stretchr/testify/assert" 9 | ) 10 | 11 | func TestAPIAIContexts(t *testing.T) { 12 | 13 | assert := assert.New(t) 14 | 15 | accessToken := os.Getenv("API_AI_ACCESS_TOKEN") 16 | if len(accessToken) == 0 { 17 | t.Fatalf("please set env var API_AI_ACCESS_TOKEN to run tests") 18 | } 19 | c := NewClient(accessToken) 20 | 21 | sid := randomString() 22 | 23 | c1 := &Context{ 24 | Name: randomString(), 25 | Lifespan: 5, 26 | } 27 | a1, err := c.AddContext(sid, c1) 28 | assert.NoError(err) 29 | assert.Equal(200, a1.Status.Code) 30 | 31 | c2 := &Context{ 32 | Name: randomString(), 33 | Lifespan: 5, 34 | } 35 | a2, err := c.AddContext(sid, c2) 36 | assert.NoError(err) 37 | assert.Equal(200, a2.Status.Code) 38 | 39 | contexts, err := c.FetchContexts(sid) 40 | assert.NoError(err) 41 | assert.Equal(2, len(contexts)) 42 | c1Found := false 43 | for _, c := range contexts { 44 | if c.Name == strings.ToLower(c1.Name) { 45 | c1Found = true 46 | break 47 | } 48 | } 49 | assert.True(c1Found) 50 | c2Found := false 51 | for _, c := range contexts { 52 | if c.Name == strings.ToLower(c2.Name) { 53 | c2Found = true 54 | break 55 | } 56 | } 57 | assert.True(c2Found) 58 | 59 | _, err = c.DeleteContext(sid, c1.Name) 60 | assert.NoError(err) 61 | 62 | contexts, err = c.FetchContexts(sid) 63 | assert.NoError(err) 64 | assert.Equal(1, len(contexts)) 65 | assert.Equal(strings.ToLower(c2.Name), contexts[0].Name) // NOTE api.ai lowercases any set context names 66 | 67 | _, err = c.ClearContext(sid) 68 | assert.NoError(err) 69 | } 70 | 71 | func TestAPIAIContextParamsWithQuery(t *testing.T) { 72 | 73 | assert := assert.New(t) 74 | 75 | accessToken := os.Getenv("API_AI_ACCESS_TOKEN") 76 | if len(accessToken) == 0 { 77 | t.Fatalf("please set env var API_AI_ACCESS_TOKEN to run tests") 78 | } 79 | c := NewClient(accessToken) 80 | 81 | sid := randomString() 82 | 83 | ctxKey1 := randomString() 84 | ctxVal1 := randomString() 85 | m1 := map[string]interface{}{ 86 | ctxKey1: ctxVal1, 87 | } 88 | c1 := &Context{ 89 | Name: randomString(), 90 | Lifespan: 5, 91 | Parameters: m1, 92 | } 93 | _, err := c.AddContext(sid, c1) 94 | assert.NoError(err) 95 | 96 | answer, err := c.Query(sid, "bla bla bla") 97 | assert.Equal(ctxVal1, answer.Result.Contexts[0].Parameters[ctxKey1]) 98 | } 99 | -------------------------------------------------------------------------------- /helpers.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | "io/ioutil" 7 | "net/http" 8 | "strings" 9 | ) 10 | 11 | func (c *Client) httpCall(method string, url string, body io.Reader) ( 12 | data []byte, err error) { 13 | 14 | // construct request 15 | req, err := http.NewRequest(method, url, body) 16 | if err != nil { 17 | err = fmt.Errorf("couldn't instantiate new API.ai request with URL %v: %v", url, err) 18 | return 19 | } 20 | req.Header.Add("Accept", "application/json") 21 | req.Header.Add("Content-Type", "application/json") 22 | req.Header.Add("Authorization", "Bearer "+c.accessToken) 23 | client := &http.Client{} 24 | 25 | // perform request 26 | resp, err := client.Do(req) 27 | if err != nil { 28 | err = fmt.Errorf("couldn't perform API.ai query request %+v: %+v", req, err) 29 | return 30 | } 31 | defer resp.Body.Close() 32 | 33 | // parse response body 34 | if resp.Body != nil { 35 | data, err = ioutil.ReadAll(resp.Body) 36 | if err != nil { 37 | err = fmt.Errorf("couldn't read API.ai response body: %+v", err) 38 | return 39 | } 40 | if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated { 41 | err = fmt.Errorf("unsuccessful response status %d from API.ai: %v", 42 | resp.StatusCode, string(data)) 43 | return 44 | } 45 | } 46 | return 47 | } 48 | 49 | func httpBody(val string) io.Reader { 50 | return strings.NewReader(val) 51 | } 52 | -------------------------------------------------------------------------------- /intent.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | ) 7 | 8 | type Intent struct { 9 | ID string `json:"id"` 10 | Name string `json:"name"` 11 | ContextIn []string `json:"contextIn"` 12 | ContextOut []*Context `json:"contextOut"` 13 | Actions []string `json:"actions"` 14 | } 15 | 16 | // TODO add remaining fields https://docs.api.ai/docs/intents#get-intents 17 | 18 | // ListIntents fetches all intents 19 | func (c *Client) ListIntents() (list []*Intent, err error) { 20 | 21 | url := fmt.Sprintf("%s/intents?v=%s", APIAIBaseURL, APIVersion) 22 | 23 | data, err := c.httpCall("GET", url, httpBody("")) 24 | if err != nil { 25 | return 26 | } 27 | //fmt.Printf("%v", string(data)) 28 | list = []*Intent{} 29 | if err := json.Unmarshal(data, &list); err != nil { 30 | return list, err 31 | } 32 | return 33 | } 34 | -------------------------------------------------------------------------------- /intent_test.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "os" 5 | "testing" 6 | 7 | "github.com/stretchr/testify/assert" 8 | ) 9 | 10 | func TestAPIAIIntents(t *testing.T) { 11 | 12 | assert := assert.New(t) 13 | 14 | accessToken := os.Getenv("API_AI_ACCESS_TOKEN") 15 | if len(accessToken) == 0 { 16 | t.Fatalf("please set env var API_AI_ACCESS_TOKEN to run tests") 17 | } 18 | c := NewClient(accessToken) 19 | 20 | list, err := c.ListIntents() 21 | assert.NoError(err) 22 | assert.NotEmpty(list) 23 | assert.NotEmpty(list[0].Name) 24 | } 25 | -------------------------------------------------------------------------------- /query.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "net/url" 7 | ) 8 | 9 | // Query performs a simple API.ai query 10 | func (c *Client) Query(sessionID string, q string) (answer *QueryResponse, err error) { 11 | 12 | q = url.QueryEscape(q) 13 | url := fmt.Sprintf("%s/query?v=%s&query=%s&lang=en&sessionId=%v", 14 | APIAIBaseURL, APIVersion, q, sessionID) 15 | 16 | data, err := c.httpCall("GET", url, httpBody("")) 17 | if err != nil { 18 | return 19 | } 20 | 21 | answer = &QueryResponse{} 22 | if err := json.Unmarshal(data, &answer); err != nil { 23 | return answer, err 24 | } 25 | 26 | // hydrate specific fulfillment message types 27 | f := answer.Result.Fulfillment 28 | f.TextMessages = []*TextMessage{} 29 | f.ImageMessages = []*ImageMessage{} 30 | f.CardMessages = []*CardMessage{} 31 | f.QuickRepliesMessages = []*QuickRepliesMessage{} 32 | f.CustomPayloadMessages = []*CustomPayloadMessage{} 33 | for _, rawMsg := range f.RawMessages { 34 | 35 | // unmarshal to a generic message 36 | genMsg := &GenericMessage{} 37 | if err := json.Unmarshal(*rawMsg, genMsg); err != nil { 38 | return nil, err 39 | } 40 | 41 | // based on type value, unmarshal accordingly 42 | if genMsg.Type == TextMessageType { 43 | obj := &TextMessage{} 44 | if err := json.Unmarshal(*rawMsg, obj); err != nil { 45 | return nil, err 46 | } 47 | answer.Result.Fulfillment.TextMessages = append(answer.Result.Fulfillment.TextMessages, obj) 48 | } else if genMsg.Type == ImageMessageType { 49 | obj := &ImageMessage{} 50 | if err := json.Unmarshal(*rawMsg, obj); err != nil { 51 | return nil, err 52 | } 53 | answer.Result.Fulfillment.ImageMessages = append(answer.Result.Fulfillment.ImageMessages, obj) 54 | } else if genMsg.Type == CardMessageType { 55 | obj := &CardMessage{} 56 | if err := json.Unmarshal(*rawMsg, obj); err != nil { 57 | return nil, err 58 | } 59 | answer.Result.Fulfillment.CardMessages = append(answer.Result.Fulfillment.CardMessages, obj) 60 | } else if genMsg.Type == QuickRepliesMessageType { 61 | obj := &QuickRepliesMessage{} 62 | if err := json.Unmarshal(*rawMsg, obj); err != nil { 63 | return nil, err 64 | } 65 | answer.Result.Fulfillment.QuickRepliesMessages = append(answer.Result.Fulfillment.QuickRepliesMessages, obj) 66 | } else if genMsg.Type == CustomPayloadMessageType { 67 | obj := &CustomPayloadMessage{} 68 | if err := json.Unmarshal(*rawMsg, obj); err != nil { 69 | return nil, err 70 | } 71 | answer.Result.Fulfillment.CustomPayloadMessages = append(answer.Result.Fulfillment.CustomPayloadMessages, obj) 72 | } 73 | } 74 | return 75 | } 76 | -------------------------------------------------------------------------------- /query_response.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "encoding/json" 5 | "time" 6 | ) 7 | 8 | type QueryResponse struct { 9 | ID string `json:"id"` 10 | Timestamp time.Time `json:"timestamp"` 11 | Lang string `json:"lang"` 12 | Result struct { 13 | Source string `json:"source"` 14 | ResolvedQuery string `json:"resolvedQuery"` 15 | Action string `json:"action"` 16 | ActionIncomplete bool `json:"actionIncomplete"` 17 | Parameters *json.RawMessage `json:"parameters"` 18 | Contexts []*Context `json:"contexts"` 19 | Metadata struct { 20 | IntentID string `json:"intentId"` 21 | WebhookUsed string `json:"webhookUsed"` 22 | WebhookForSlotFillingUsed string `json:"webhookForSlotFillingUsed"` 23 | IntentName string `json:"intentName"` 24 | } `json:"metadata"` 25 | Fulfillment struct { 26 | Speech string `json:"speech"` 27 | RawMessages []*json.RawMessage `json:"messages"` 28 | TextMessages []*TextMessage `json:"-""` 29 | ImageMessages []*ImageMessage `json:"-""` 30 | CardMessages []*CardMessage `json:"-""` 31 | QuickRepliesMessages []*QuickRepliesMessage `json:"-""` 32 | CustomPayloadMessages []*CustomPayloadMessage `json:"-"` 33 | } `json:"fulfillment"` 34 | Score float64 `json:"score"` 35 | } `json:"result"` 36 | Status ResponseStatus `json:"status"` 37 | SessionID string `json:"sessionId"` 38 | } 39 | 40 | type ResponseStatus struct { 41 | Code int `json:"code"` 42 | ErrorType string `json:"errorType"` 43 | } 44 | 45 | type MessageType int 46 | 47 | // https://docs.api.ai/docs/query#section-message-objects 48 | const ( 49 | TextMessageType MessageType = 0 50 | CardMessageType MessageType = 1 51 | QuickRepliesMessageType MessageType = 2 52 | ImageMessageType MessageType = 3 53 | CustomPayloadMessageType MessageType = 4 54 | ) 55 | 56 | type GenericMessage struct { 57 | Type MessageType `json:"type"` 58 | } 59 | 60 | type TextMessage struct { 61 | GenericMessage 62 | Speech string `json:"speech"` 63 | } 64 | 65 | type ImageMessage struct { 66 | GenericMessage 67 | ImageURL string `json:"imageUrl"` 68 | } 69 | 70 | type CardMessage struct { 71 | GenericMessage 72 | Title string `json:"title"` 73 | SubTitle string `json:"subtitle"` 74 | Buttons []*CardButton `json:"buttons"` 75 | } 76 | 77 | type QuickRepliesMessage struct { 78 | GenericMessage 79 | Title string `json:"title"` 80 | Replies []string `json:"replies"` 81 | } 82 | 83 | type CardButton struct { 84 | Text string `json:"text"` 85 | Postback string `json:"postback"` 86 | } 87 | 88 | type CustomPayloadMessage struct { 89 | GenericMessage 90 | Payload *json.RawMessage `json:"payload"` 91 | } 92 | -------------------------------------------------------------------------------- /query_test.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "os" 5 | "testing" 6 | 7 | "github.com/stretchr/testify/assert" 8 | ) 9 | 10 | func TestAPIAIQueries(t *testing.T) { 11 | 12 | assert := assert.New(t) 13 | 14 | accessToken := os.Getenv("API_AI_ACCESS_TOKEN") 15 | if len(accessToken) == 0 { 16 | t.Fatalf("please set env var API_AI_ACCESS_TOKEN to run tests") 17 | } 18 | c := NewClient(accessToken) 19 | 20 | msg := "bla bla bla" 21 | answer, err := c.Query(randomString(), msg) 22 | assert.NoError(err) 23 | assert.Equal(200, answer.Status.Code) 24 | assert.NotEmpty(answer.Result.Fulfillment.TextMessages) 25 | assert.NotEmpty(answer.Result.Fulfillment.TextMessages[0].Speech) 26 | } 27 | -------------------------------------------------------------------------------- /util.go: -------------------------------------------------------------------------------- 1 | package apiai 2 | 3 | import ( 4 | "fmt" 5 | "time" 6 | 7 | "github.com/jmcvetta/randutil" 8 | ) 9 | 10 | func randomString() string { 11 | rand, _ := randutil.String(12, randutil.Alphabet) 12 | ts := time.Now().Unix() 13 | return fmt.Sprintf("%v%v", rand, ts) 14 | } 15 | --------------------------------------------------------------------------------