Skip to content
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

Tool choice docs #349

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Tool choice docs #349

wants to merge 3 commits into from

Conversation

mrmer1
Copy link
Contributor

@mrmer1 mrmer1 commented Jan 13, 2025

This pull request introduces a new section titled "Forcing Tool Use" in the documentation, which explains how to force the model to make tool calls during the tool calling step.

  • A new section titled "Forcing Tool Use" is added to the documentation.
  • The section describes two options for the model during the tool calling step: making tool calls or responding to a user message directly.
  • It explains that setting the force_single_step parameter to True forces the model to make at least one tool call, equivalent to setting tool_choice as REQUIRED in the v2 API.
  • The section also mentions that if force_single_step is True and tool_results are passed, it is equivalent to specifying NONE.
  • A code snippet is provided to demonstrate how to force tool use by setting the tool_choice parameter to REQUIRED.

@mrmer1 mrmer1 requested a review from a team as a code owner January 13, 2025 15:25
Copy link

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant