feat: Add support for perplexity sonar

[charlieyou]

Perplexity released their Sonar API with structured outputs which is not compatible with any of the existing function calling methods currently implemented. Rest of the API is similar to OpenAI.

See references:

• https://docs.perplexity.ai/api-reference/chat-completions
• https://docs.perplexity.ai/guides/structured-outputs

Implemented it with a new client, but don't have a strong opinion on keeping it vs only keeping the new mode.

---

Important

Add support for Perplexity Sonar API with new client and mode, including JSON handling and tests.

• Behavior:
  • Add support for Perplexity Sonar API with new client from_perplexity in client_perplexity.py.
  • Introduce PERPLEXITY_JSON mode in mode.py for handling structured outputs.
  • Update process_response.py and reask.py to handle PERPLEXITY_JSON mode.
• Functions:
  • Add handle_perplexity_json() in process_response.py for processing JSON responses.
  • Add reask_perplexity_json() in reask.py for reasking logic.
• Tests:
  • Add test_perplexity directory with conftest.py and test_modes.py for testing Perplexity integration.
  • Define test models and modes in util.py.

^{This description was created by for 73a9061. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 73a9061 in 51 seconds

More details

• Looked at 415 lines of code in 14 files
• Skipped 0 files when reviewing.
• Skipped posting 4 drafted comments based on config settings.

1. instructor/__init__.py:102

• Draft comment:
  Add a newline at the end of the file for consistency and to follow best practices.
• Reason this comment was not posted:
  Confidence changes required: 10%
  The code in instructor/__init__.py is missing a newline at the end of the file. This is a minor issue but it's a good practice to have a newline at the end of files.

2. instructor/client_perplexity.py:63

• Draft comment:
  Add a newline at the end of the file for consistency and to follow best practices.
• Reason this comment was not posted:
  Confidence changes required: 10%
  The code in instructor/client_perplexity.py is missing a newline at the end of the file. This is a minor issue but it's a good practice to have a newline at the end of files.

3. instructor/reask.py:374

• Draft comment:
  Add a newline at the end of the file for consistency and to follow best practices.
• Reason this comment was not posted:
  Confidence changes required: 10%
  The code in instructor/reask.py is missing a newline at the end of the file. This is a minor issue but it's a good practice to have a newline at the end of files.

4. README.md:298

• Draft comment:
  If a new md file is created for Perplexity Sonar Models, ensure it's added to mkdocs.yml for documentation purposes.
• Reason this comment was not posted:
  Confidence changes required: 50%
  The new md file for Perplexity Sonar Models should be added to mkdocs.yml for documentation purposes.

Workflow ID: wflow_GOqpyzQWupTnARBD

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[rooterkyberian]

this resolves #1005 , but the structured outputs problem has been also discussed here #909

Maybe it would be worth to make it more universal?

BTW, if you add "name" to the json_schema object, then the same mode would also work with nebius API (which also follows OpenAI API but I think for some reason requires "name") https://openai.com/index/introducing-structured-outputs-in-the-api/ .
AFAIK "name' field in "json_schema" should not break perplexity API response.