docs: update installation and usage examples for LLM integrations

[jxnl]

Important

Updated documentation to include installation and usage examples for multiple LLM integrations, and highlighted new features like hooks, type inference, templating, and validation.

• Integrations:
  • Added installation and usage examples for OpenAI, Ollama, llama-cpp-python, Anthropic, Gemini, Vertex AI, Groq, Litellm, Cohere, Cerebras, and Fireworks.
• Features:
  • Introduced hooks system for event management during LLM interactions.
  • Improved type inference with new create_* methods for iterables and partials.
  • Added templating support using Jinja for dynamic prompts.
  • Enhanced validation with Pydantic, including retry mechanisms on failure.
• Misc:
  • Updated Why use Instructor? section to highlight API simplicity, multi-language support, reasking, streaming, and type hinting.

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

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 27e67cc in 33 seconds

More details

• Looked at 1109 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 7 drafted comments based on config settings.

1. docs/index.md:70

• Draft comment:
  Ensure that all necessary imports are included in the code examples. For instance, Mode is used but not imported in this example.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The code examples in the documentation are missing imports for some classes and functions, which could confuse users trying to follow along.

2. docs/index.md:120

• Draft comment:
  Ensure that all necessary imports are included in the code examples. For instance, Mode is used but not imported in this example. This applies to other examples as well.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The code examples in the documentation are missing imports for some classes and functions, which could confuse users trying to follow along.

3. docs/index.md:162

• Draft comment:
  Ensure that all necessary imports are included in the code examples. For instance, Mode is used but not imported in this example. This applies to other examples as well.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The code examples in the documentation are missing imports for some classes and functions, which could confuse users trying to follow along.

4. docs/index.md:239

• Draft comment:
  Ensure that all necessary imports are included in the code examples. For instance, Mode is used but not imported in this example. This applies to other examples as well.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The code examples in the documentation are missing imports for some classes and functions, which could confuse users trying to follow along.

5. docs/index.md:279

• Draft comment:
  Ensure that all necessary imports are included in the code examples. For instance, Mode is used but not imported in this example. This applies to other examples as well.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The code examples in the documentation are missing imports for some classes and functions, which could confuse users trying to follow along.

6. docs/index.md:121

• Draft comment:
  Ensure that all necessary imports are included in the code examples. For instance, Mode is used but not imported in this example. This applies to other examples as well.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The code examples in the documentation are missing imports for some classes and functions, which could confuse users trying to follow along.

7. docs/index.md:97

• Draft comment:
  Make sure to add new examples to mkdocs.yml when they are created or updated. This applies to all new examples added in this PR.
• Reason this comment was not posted:
  Confidence changes required: 80%
  The PR adds new examples and documentation for various integrations. However, it does not update the mkdocs.yml file to include these new examples, which is a requirement when new examples are added.

Workflow ID: wflow_beUmBPZQYR6ERG7h

---

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

[cloudflare-workers-and-pages]

Deploying instructor-py with    Cloudflare Pages

Latest commit:	a1241f6
Status:	✅  Deploy successful!
Preview URL:	https://b4175c05.instructor-py.pages.dev
Branch Preview URL:	https://improve-index.instructor-py.pages.dev

View logs