Skip to content

Commit 29bb697

Browse files
committed
manual: Add note about JSON schema output compatibility
* doc/manual.org (Output in a specified JSON schema):
1 parent 186b83b commit 29bb697

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/manual.org

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1644,12 +1644,19 @@ Note:
16441644
# =gptel-send='s default
16451645

16461646
** Output in a specified JSON schema
1647+
:PROPERTIES:
1648+
:CUSTOM_ID: output-schema
1649+
:END:
16471650

16481651
~gptel-request~ can force the LLM to generate output that follows a
16491652
specified JSON schema. This can be useful when it is used as part of
16501653
a data processing pipeline, or when gptel-request needs to be plugged
16511654
into Elisp code that expects structured data.
16521655

1656+
NOTE(v{{{stable-version}}}): JSON output is compatible with tool-use
1657+
for all gptel backends except for Anthropic. Requests to Anthropic
1658+
models cannot include both tools and a JSON schema.
1659+
16531660
Here is a frivolous example demonstrating this feature:
16541661

16551662
#+begin_src emacs-lisp

0 commit comments

Comments
 (0)