[Feature] Structured Outputs

Author: amenasria

.genignore

@@ -1,2 +1,3 @@
 pyproject.toml
-examples/*
+examples/*
+src/mistral/extra/*

.github/workflows/lint_custom_code.yaml

@@ -0,0 +1,32 @@
+name: Linting Python custom files
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Lint with ruff
+        # No need to lint the automatically generated Speakeasy code
+        run: |
+          ruff check examples/
+          ruff check src/mistralai/_hooks/ --exclude __init__.py --exclude sdkhooks.py --exclude types.py
+          ruff check src/mistralai/extra/

.github/workflows/test_custom_code.yaml

@@ -0,0 +1,31 @@
+name: Testing Python custom files
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install Poetry
+        uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a # v1.4.1
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Run the 'src/mistralai/extra' package unit tests
+        run: python3.12 -m unittest discover -s src/mistralai/extra/tests -t src

.speakeasy/gen.yaml

@@ -23,7 +23,7 @@ python:
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
   description: Python Client SDK for the Mistral AI API.
-  enableCustomCodeRegions: false
+  enableCustomCodeRegions: true
   enumFormat: union
   envVarPrefix: MISTRAL
   fixFlags:

.vscode/settings.json

@@ -9,11 +9,12 @@
 
 async def main():
     api_key = os.environ["MISTRAL_API_KEY"]
+    agent_id = os.environ["MISTRAL_AGENT_ID"]
 
     client = Mistral(api_key=api_key)
 
     chat_response = await client.agents.complete_async(
-        agent_id="<your_agent_id>",
+        agent_id=agent_id,
         messages=[UserMessage(content="What is the best French cheese?")],
     )
 

examples/async_agents_no_streaming.py

@@ -3,10 +3,9 @@
 import asyncio
 import os
 
-import httpx
 
 from mistralai import Mistral
-from mistralai.models import ImageURLChunk, TextChunk, UserMessage
+from mistralai.models import UserMessage
 
 
 async def main():

examples/async_chat_with_image_no_streaming.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+
+import asyncio
+import os
+from pydantic import BaseModel
+
+from mistralai import Mistral
+
+async def main():
+
+    api_key = os.environ["MISTRAL_API_KEY"]
+    client = Mistral(api_key=api_key)
+
+    class Explanation(BaseModel):
+        explanation: str
+        output: str
+
+    class MathDemonstration(BaseModel):
+        steps: list[Explanation]
+        final_answer: str
+
+    chat_response = await client.chat.parse_async(
+        model="mistral-large-2411",
+        messages=[
+            {"role": "system", "content": "You are a helpful math tutor. You will be provided with a math problem, and your goal will be to output a step by step solution, along with a final answer. For each step, just provide the output as an equation use the explanation field to detail the reasoning."},
+            {"role": "user", "content": "How can I solve 8x + 7 = -23"},
+        ],
+        response_format = MathDemonstration
+    )
+    print(chat_response.choices[0].message.parsed)
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/async_structured_outputs.py

@@ -8,7 +8,7 @@
 
 def main():
     api_key = os.environ["MISTRAL_API_KEY"]
-    model = "mistral-tiny"
+    model = "mistral-large-latest"
 
     client = Mistral(api_key=api_key)
 
@@ -17,7 +17,7 @@ def main():
         messages=[UserMessage(content="What is the best French cheese?")],
     ):
 
-        print(chunk.data.choices[0].delta.content)
+        print(chunk.data.choices[0].delta.content, end="")
 
 
 if __name__ == "__main__":

examples/chat_with_streaming.py

@@ -117,6 +117,8 @@ def retrieve_payment_date(data: Dict[str, List], transaction_id: str) -> str:
             tool_call_id=tool_call.id,
         )
     )
+print(messages)
+
 response = client.chat.complete(model=model, messages=messages, tools=tools)
 
 print(f"{response.choices[0].message.content}")