|
9 | 9 | #+export_file_name: manual |
10 | 10 | #+startup: content |
11 | 11 |
|
12 | | -#+infojs_opt: view:info toc:nil mouse:underline ftoc:nil ltoc:nil |
| 12 | +#+infojs_opt: view:overview toc:nil mouse:underline ftoc:nil ltoc:nil |
13 | 13 | #+html_head: <link rel="stylesheet" type="text/css" href="style.css" /> |
14 | 14 | #+html_head_extra: <style>blockquote { font-style: normal; }</style> |
15 | 15 | #+html_head: <script src="toc-and-theme-loader.js"></script> |
@@ -477,6 +477,9 @@ always contains the last request as a gptel state-machine object (see |
477 | 477 | - ~gptel-org-set-properties~ |
478 | 478 |
|
479 | 479 | ** Directives |
| 480 | +:PROPERTIES: |
| 481 | +:CUSTOM_ID: directives |
| 482 | +:END: |
480 | 483 |
|
481 | 484 | #+cindex: system message |
482 | 485 | In addition to the text in your buffer, LLMs can be prompted with |
@@ -561,6 +564,9 @@ the box: |
561 | 564 | #+end_src |
562 | 565 |
|
563 | 566 | ** Backends |
| 567 | +:PROPERTIES: |
| 568 | +:CUSTOM_ID: backends |
| 569 | +:END: |
564 | 570 |
|
565 | 571 | #+tindex: backend, gptel-backend |
566 | 572 | A ~gptel-backend~ is an object containing LLM connection, |
@@ -703,6 +709,9 @@ the list of models in the above backend, for example, you can use |
703 | 709 | #+end_src |
704 | 710 |
|
705 | 711 | ** Models |
| 712 | +:PROPERTIES: |
| 713 | +:CUSTOM_ID: models |
| 714 | +:END: |
706 | 715 |
|
707 | 716 | #+cindex: model, gptel model |
708 | 717 | A /model/ in gptel is a symbol denoting a specific LLM, whose name is |
@@ -784,6 +793,9 @@ Keys used by gptel: |
784 | 793 | # #+INCLUDE: ../README.org::#include-context :only-contents t |
785 | 794 |
|
786 | 795 | ** TODO Tools |
| 796 | +:PROPERTIES: |
| 797 | +:CUSTOM_ID: tools |
| 798 | +:END: |
787 | 799 |
|
788 | 800 | gptel can provide the LLM with client-side elisp "tools", or function |
789 | 801 | specifications, along with the request. A "tool" is an elisp function |
@@ -813,6 +825,9 @@ To use tools in gptel, you need |
813 | 825 |
|
814 | 826 | *** Obtaining tools |
815 | 827 | *** Writing tools |
| 828 | +:PROPERTIES: |
| 829 | +:CUSTOM_ID: writing-tools |
| 830 | +:END: |
816 | 831 |
|
817 | 832 | A gptel tool is a structure specifying an Elisp function, the format |
818 | 833 | of its arguments and accompanying documentation intended for the LLM. |
@@ -1070,6 +1085,9 @@ Interactively: |
1070 | 1085 | Via elisp: |
1071 | 1086 |
|
1072 | 1087 | ** Presets |
| 1088 | +:PROPERTIES: |
| 1089 | +:CUSTOM_ID: presets |
| 1090 | +:END: |
1073 | 1091 |
|
1074 | 1092 | #+cindex: agent |
1075 | 1093 | #+cindex: preset |
@@ -1243,6 +1261,9 @@ programmatic use of gptel, where you can let-bind ~gptel-backend~, |
1243 | 1261 | simplify this too, see ~gptel-with-preset~ above. |
1244 | 1262 |
|
1245 | 1263 | *** Specifying presets in the prompt |
| 1264 | +:PROPERTIES: |
| 1265 | +:CUSTOM_ID: presets-in-prompts |
| 1266 | +:END: |
1246 | 1267 |
|
1247 | 1268 | It is sometimes useful to be able to send a single LLM query with |
1248 | 1269 | options different from the active ones. One way to do this is to set |
@@ -1371,6 +1392,9 @@ LLMs.) gptel does not currently ship with tools, but a preset |
1371 | 1392 | * Advanced configuration |
1372 | 1393 |
|
1373 | 1394 | ** The ~gptel-request~ API |
| 1395 | +:PROPERTIES: |
| 1396 | +:CUSTOM_ID: gptel-request |
| 1397 | +:END: |
1374 | 1398 |
|
1375 | 1399 | The heart of gptel is the function ~gptel-request~. It offers an |
1376 | 1400 | easy, flexible and comprehensive way to interact with LLMs, and is |
@@ -1612,6 +1636,9 @@ Note: |
1612 | 1636 | are specified in greater detail in the sections that follow. |
1613 | 1637 |
|
1614 | 1638 | ** Prompt transformations |
| 1639 | +:PROPERTIES: |
| 1640 | +:CUSTOM_ID: gptel-prompt-transform-functions |
| 1641 | +:END: |
1615 | 1642 | ** Output in a specified JSON schema |
1616 | 1643 |
|
1617 | 1644 | ~gptel-request~ can force the LLM to generate output that follows a |
@@ -1849,6 +1876,9 @@ the top-level is expected to be a JSON object, not an array. gptel |
1849 | 1876 | handles this issue internally and wraps it an object if required. |
1850 | 1877 |
|
1851 | 1878 | ** gptel's finite state machine |
| 1879 | +:PROPERTIES: |
| 1880 | +:CUSTOM_ID: fsm |
| 1881 | +:END: |
1852 | 1882 |
|
1853 | 1883 | #+cindex: finite state machine |
1854 | 1884 | gptel's interactions with LLMs are typically limited to a query |
|
0 commit comments