fix(ai): add properties for OpenAI compat (#3799)

tgenaitay · web-flow · commit b33aef93e354 · 2024-10-07T14:04:43.000+02:00
diff --git a/ai-data/generative-apis/how-to/use-structured-outputs.mdx b/ai-data/generative-apis/how-to/use-structured-outputs.mdx
@@ -215,6 +215,7 @@ extract = client.chat.completions.create(
                         "items": {"type": "string"}
                     }
                 },
+                "additionalProperties": false,
                 "required": ["title", "summary", "actionItems"]
             }
         }
@@ -237,6 +238,10 @@ Output example:
 }
 ```
 
+<Message type="tip">
+  When using the OpenAI SDKs like in the examples above, you are expected to set `additionalProperties` to false, and to specify all your properties as required.
+</Message>
+
 ## Conclusion
 
 Using structured outputs with LLMs can significantly enhance data handling in your applications.

Original file line number	Diff line number	Diff line change
`@@ -215,6 +215,7 @@ extract = client.chat.completions.create(`
`215`	`215`	`"items": {"type": "string"}`
`216`	`216`	`}`
`217`	`217`	`},`
	`218`	`+ "additionalProperties": false,`
`218`	`219`	`"required": ["title", "summary", "actionItems"]`
`219`	`220`	`}`
`220`	`221`	`}`
`@@ -237,6 +238,10 @@ Output example:`
`237`	`238`	`}`
`238`	`239`	```
`239`	`240`
	`241`	`+<Message type="tip">`
	`242`	+ When using the OpenAI SDKs like in the examples above, you are expected to set `additionalProperties` to false, and to specify all your properties as required.
	`243`	`+</Message>`
	`244`	`+`
`240`	`245`	`## Conclusion`
`241`	`246`
`242`	`247`	`Using structured outputs with LLMs can significantly enhance data handling in your applications.`