Skip to content

Commit 6dae7df

Browse files
authored
docs(openai-structured-output): add comment (langfuse#765)
1 parent 1243fb5 commit 6dae7df

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

cookbook/integration_openai_structured_output.ipynb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,13 @@
101101
"(Example taken from [OpenAI cookbook](https://cookbook.openai.com/examples/structured_outputs_intro))"
102102
]
103103
},
104+
{
105+
"cell_type": "markdown",
106+
"metadata": {},
107+
"source": [
108+
"**Note:** While OpenAI also offer structured output parsing via its beta API (`client.beta.chat.completions.parse`), this approach currently does not allow setting Langfuse specific attributes such as `name`, `metadata`, `userId` etc. Please use the approach using `response_format` with the standard `client.chat.completions.create` as described below."
109+
]
110+
},
104111
{
105112
"cell_type": "code",
106113
"execution_count": 3,

pages/docs/integrations/openai/python/structured-outputs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ This setup is useful for applications where each step needs to be displayed sepa
5555

5656
(Example taken from [OpenAI cookbook](https://cookbook.openai.com/examples/structured_outputs_intro))
5757

58+
**Note:** While OpenAI also offer structured output parsing via its beta API (`client.beta.chat.completions.parse`), this approach currently does not allow setting Langfuse specific attributes such as `name`, `metadata`, `userId` etc. Please use the approach using `response_format` with the standard `client.chat.completions.create` as described below.
59+
5860

5961
```python
6062
# Use the Langfuse drop-in replacement to get full logging by changing only the import.

pages/guides/cookbook/integration_openai_structured_output.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ This setup is useful for applications where each step needs to be displayed sepa
5555

5656
(Example taken from [OpenAI cookbook](https://cookbook.openai.com/examples/structured_outputs_intro))
5757

58+
**Note:** While OpenAI also offer structured output parsing via its beta API (`client.beta.chat.completions.parse`), this approach currently does not allow setting Langfuse specific attributes such as `name`, `metadata`, `userId` etc. Please use the approach using `response_format` with the standard `client.chat.completions.create` as described below.
59+
5860

5961
```python
6062
# Use the Langfuse drop-in replacement to get full logging by changing only the import.

0 commit comments

Comments
 (0)