Skip to content

Commit

Permalink
Merge pull request #246 from openai/revert-244-revert-242-brianz/cc-t…
Browse files Browse the repository at this point in the history
…ool-choice-required

Add required as an option for tool_choice in chat/completions api
  • Loading branch information
brianz-openai authored Apr 29, 2024
2 parents a6aadda + 2954f15 commit 38c9c20
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6731,7 +6731,7 @@ paths:
}
}
main();
main();
response: |
{
"object": "list",
Expand Down Expand Up @@ -6818,7 +6818,7 @@ paths:
console.log(batch);
}
main();
main();
response: &batch_object |
{
"id": "batch_abc123",
Expand Down Expand Up @@ -6897,7 +6897,7 @@ paths:
console.log(batch);
}
main();
main();
response: |
{
"id": "batch_abc123",
Expand Down Expand Up @@ -7523,18 +7523,20 @@ components:

ChatCompletionToolChoiceOption:
description: |
Controls which (if any) function is called by the model.
`none` means the model will not call a function and instead generates a message.
`auto` means the model can pick between generating a message or calling a function.
Specifying a particular function via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that function.
Controls which (if any) tool is called by the model.
`none` means the model will not call any tool and instead generates a message.
`auto` means the model can pick between generating a message or calling one or more tools.
`required` means the model must call one or more tools.
Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
`none` is the default when no functions are present. `auto` is the default if functions are present.
`none` is the default when no tools are present. `auto` is the default if tools are present.
oneOf:
- type: string
description: >
`none` means the model will not call a function and instead generates a message.
`auto` means the model can pick between generating a message or calling a function.
enum: [none, auto]
`none` means the model will not call any tool and instead generates a message.
`auto` means the model can pick between generating a message or calling one or more tools.
`required` means the model must call one or more tools.
enum: [none, auto, required]
- $ref: "#/components/schemas/ChatCompletionNamedToolChoice"
x-oaiExpandable: true

Expand Down Expand Up @@ -10001,15 +10003,17 @@ components:
description: |
Controls which (if any) tool is called by the model.
`none` means the model will not call any tools and instead generates a message.
`auto` is the default value and means the model can pick between generating a message or calling a tool.
`auto` is the default value and means the model can pick between generating a message or calling one or more tools.
`required` means the model must call one or more tools before responding to the user.
Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
oneOf:
- type: string
description: >
`none` means the model will not call a function and instead generates a message.
`auto` means the model can pick between generating a message or calling a function.
enum: [none, auto]
`none` means the model will not call any tools and instead generates a message.
`auto` means the model can pick between generating a message or calling one or more tools.
`required` means the model must call one or more tools before responding to the user.
enum: [none, auto, required]
- $ref: "#/components/schemas/AssistantsNamedToolChoice"
x-oaiExpandable: true

Expand Down

0 comments on commit 38c9c20

Please sign in to comment.