Skip to content

Commit 67448da

Browse files
added note
1 parent dade68c commit 67448da

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/content/docs/workers-ai/configuration/json-mode.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ export const jsonModeResponseExample = `{
8282
}
8383
}`;
8484

85-
When we want text-generation AI models to interact with databases, services, and external systems programmatically, typically when using tool calling or building AI agents, we must have structured response formats rather than natural language.
85+
When we want text-generation AI models to interact with databases, services, and external systems programmatically, typically when using tool calling or [building AI agents](/agents/), we must have structured response formats rather than natural language.
8686

8787
Workers AI supports JSON Mode, enabling applications to request a structured output response when interacting with AI models.
8888

8989
## Schema
9090

91-
JSON Mode is compatible with OpenAIs implementation; to enable add the `response_format` property to the request object using the following convention:
91+
JSON Mode is compatible with OpenAI's implementation; to enable add the `response_format` property to the request object using the following convention:
9292

9393
<Code code={jsonModeSchema} lang="json" />
9494

@@ -122,6 +122,10 @@ This is the list of models that now support JSON Mode:
122122

123123
We will continue extending this list to keep up with new, and requested models.
124124

125-
Note that Workers AI can't guarantee that the model responds according to the requested JSON Schema. Depending on the complexity of the task and adequacy of the JSON Schema, the model may not be able to satisfy the request in extreme situations. If that's the case, then an error `JSON Mode couldn't be met` is returned and must be handled.
125+
:::note[Note]
126126

127-
JSON Mode currently doesn't support streaming.
127+
Workers AI can't guarantee that the model responds according to the requested JSON Schema. Depending on the complexity of the task and adequacy of the JSON Schema, the model may not be able to satisfy the request in extreme situations. If that is the case, then an error `JSON Mode couldn't be met` is returned and must be handled.
128+
129+
:::
130+
131+
JSON Mode currently does not support streaming.

0 commit comments

Comments
 (0)