Skip to content

Update gpt4-1_prompting_guide.ipynb #1835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions examples/gpt4-1_prompting_guide.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -576,19 +576,7 @@
"\n",
"Guidance specifically for adding a large number of documents or files to input context:\n",
"\n",
"* XML performed well in our long context testing. \n",
" * Example: `<doc id="1" title="The Fox">The quick brown fox jumps over the lazy dog</doc>` \n",
"* This format, proposed by Lee et al. ([ref](https://arxiv.org/pdf/2406.13121)), also performed well in our long context testing. \n",
" * Example: `ID: 1 | TITLE: The Fox | CONTENT: The quick brown fox jumps over the lazy dog` \n",
"* JSON performed particularly poorly. \n",
" * Example: `[{"id": 1, "title": "The Fox", "content": "The quick brown fox jumped over the lazy dog"}]`\n",
"\n",
"The model is trained to robustly understand structure in a variety of formats. Generally, use your judgement and think about what will provide clear information and “stand out” to the model. For example, if you’re retrieving documents that contain lots of XML, an XML-based delimiter will likely be less effective. \n",
"\n",
"## Caveats\n",
"\n",
"* In some isolated cases we have observed the model being resistant to producing very long, repetitive outputs, for example, analyzing hundreds of items one by one. If this is necessary for your use case, instruct the model strongly to output this information in full, and consider breaking down the problem or using a more concise approach. \n",
"* We have seen some rare instances of parallel tool calls being incorrect. We advise testing this, and considering setting the [parallel\\_tool\\_calls](https://platform.openai.com/docs/api-reference/responses/create#responses-create-parallel_tool_calls) param to false if you’re seeing issues."
"* XML performed well in our long context testing. \n * Example: `<doc id=\"1\" title=\"The Fox\">The quick brown fox jumps over the lazy dog</doc>` \n* This format, proposed by Lee et al. ([ref](https://arxiv.org/pdf/2406.13121)), also performed well in our long context testing. \n * Example: `ID: 1 | TITLE: The Fox | CONTENT: The quick brown fox jumps over the lazy dog` \n* JSON performed particularly poorly. \n * Example: `[{\"id\": 1, \"title\": \"The Fox\", \"content\": \"The quick brown fox jumped over the lazy dog\"}]`\n\nThe model is trained to robustly understand structure in a variety of formats. Generally, use your judgement and think about what will provide clear information and “stand out” to the model. For example, if you’re retrieving documents that contain lots of XML, an XML‑based delimiter will likely be less effective. \n\n## Caveats\n\n* In some isolated cases we have observed the model being resistant to producing very long, repetitive outputs, for example, analyzing hundreds of items one by one. If this is necessary for your use case, instruct the model strongly to output this information in full, and consider breaking down the problem or using a more concise approach. \n* We have seen some rare instances of parallel tool calls being incorrect. We advise testing this, and considering setting the [parallel\\\\_tool\\\\_calls](https://platform.openai.com/docs/api-reference/responses/create#responses-create-parallel_tool_calls) param to false if you’re seeing issues."
]
},
{
Expand Down