docs: add support for mistral tool calling #467
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jxnl
reviewed
Feb 26, 2024
| from instructor.function_calls import Mode | ||
|
|
||
| client = MistralClient() | ||
| new_chat = patch(create=client.chat, mode=Mode.MIST_TOOLS) |
There was a problem hiding this comment.
Suggested change
| new_chat = patch(create=client.chat, mode=Mode.MIST_TOOLS) | |
| new_chat = patch(create=client.chat, mode=Mode.MISTRAL) |
jxnl
reviewed
Feb 26, 2024
instructor/function_calls.py
Outdated
| @@ -114,7 +115,7 @@ def from_response( | |||
| context=validation_context, | |||
| strict=strict, | |||
| ) | |||
| elif mode == Mode.TOOLS: | |||
| elif mode == Mode.TOOLS or mode == Mode.MIST_TOOLS: | |||
There was a problem hiding this comment.
mode in
Suggested change
| elif mode == Mode.TOOLS or mode == Mode.MIST_TOOLS: | |
| elif mode in {Mode.TOOLS, Mode.MISTRAL_TOOLS}: |
jxnl
reviewed
Feb 26, 2024
instructor/patch.py
Outdated
| @@ -116,17 +116,20 @@ def handle_response_model( | |||
| if mode == Mode.FUNCTIONS: | |||
| new_kwargs["functions"] = [response_model.openai_schema] # type: ignore | |||
| new_kwargs["function_call"] = {"name": response_model.openai_schema["name"]} # type: ignore | |||
| elif mode == Mode.TOOLS: | |||
| elif mode == Mode.TOOLS or mode == Mode.MIST_TOOLS: | |||
There was a problem hiding this comment.
Suggested change
| elif mode == Mode.TOOLS or mode == Mode.MIST_TOOLS: | |
| elif mode in {Mode.TOOLS, Mode.MISTRAL_TOOLS} |
jxnl
reviewed
Feb 26, 2024
instructor/function_calls.py
Outdated
| @@ -15,6 +15,7 @@ class Mode(enum.Enum): | |||
| FUNCTIONS: str = "function_call" | |||
| PARALLEL_TOOLS: str = "parallel_tool_call" | |||
| TOOLS: str = "tool_call" | |||
| MIST_TOOLS: str = "mistral_tools" | |||
There was a problem hiding this comment.
Suggested change
| MIST_TOOLS: str = "mistral_tools" | |
| MISTRAL_TOOLS: str = "mistral_tools" |
jxnl
reviewed
Feb 26, 2024
| from instructor.function_calls import Mode | ||
|
|
||
| client = MistralClient() | ||
| new_chat = patch(create=client.chat, mode=Mode.MIST_TOOLS) |
There was a problem hiding this comment.
we can make an example in the hub!
and update patch.md
|
beautiful, but no need to shorten MISTRAL |
shanktt
changed the title
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me!
- Reviewed the entire pull request up to 5c9bddd
- Looked at
182lines of code in5files - Took 1 minute and 54 seconds to review
More info
- Skipped
0files when reviewing. - Skipped posting
1additional comments because they didn't meet confidence threshold of85%.
1. examples/mistral/mistral.py:26:
- Assessed confidence :
90% - Grade:
0% - Comment:
It's a good practice to end your file with a newline. Please add a newline at the end of this file. - Reasoning:
The PR author has added support for the Mistral tool calling mode in the Instructor library. The changes include modifications to thepatch.pyandfunction_calls.pyfiles to handle the new mode, and the creation of a new example and documentation file to demonstrate the usage of the new feature. The changes seem to be logically correct and follow the existing patterns in the codebase. However, there is a minor issue with the new example file,mistral.py, where a newline is missing at the end of the file. This is a common convention in Python and many other languages to ensure that the file ends with a newline character. This is not a critical issue but it's a good practice to follow this convention.
Workflow ID: wflow_gPWPboCIefej40cH
Not what you expected? You can customize the content of the reviews using rules. Learn more here.
jxnl
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mistral tool calling doesn't let you force the model to call a specific tool: https://docs.mistral.ai/guides/function-calling/#tool_choice
"auto": default mode. Model decides if it uses the tool or not.
"any": forces tool use.
"none": prevents tool use.
The new tool choice I added is pretty jank ngl so open to better suggestions
Summary:
This PR adds support for the Mistral tool in the Instructor library, including a new mode in the
Modeenum, updates to the client patching process, a new example, and a detailed guide.Key points:
MISTRAL_TOOLS, in theModeenum infunction_calls.py.patch.pyto handle the newMISTRAL_TOOLSmode when patching the client.mistral.pyunder theexamples/mistraldirectory.mistral.mdunder thedocs/hubdirectory.mkdocs.ymlto include the new guide in the documentation navigation.Generated with ❤️ by ellipsis.dev