Skip to content

Commit 1152f76

Browse files
committed
Update doc
1 parent b5ea606 commit 1152f76

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

doc/mistral-client/Basics/quick_start.md

+35-12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# PhpMistral
2+
13
**PhpMistral** is an **open-source** PHP client designed to interact with various LLM inference servers (like Mistral, Hugging Face TGI, vLLM, Ollama, llama.cpp, xAI, and more), embedding servers, and Hugging Face datasets.
24
It provides a unified interface for chat completions (streaming & non-streaming), embeddings (dense & sparse), reranking, guided JSON generation, document generation, and Hugging Face dataset management.
35

@@ -6,33 +8,53 @@ It provides a unified interface for chat completions (streaming & non-streaming)
68
79
---
810

11+
## 🛠 PSR-18 Compatible HTTP Client
12+
13+
**PhpMistral** has been fully refactored to comply with **PSR-18** recommendations (PHP Standards Recommendation for HTTP clients).
14+
This means you can plug in **any HTTP client** that implements PSR-18, including:
15+
16+
- **Guzzle**
17+
- **Symfony HttpClient**
18+
- **cURL-based clients**
19+
- **Buzz**
20+
- Any other compliant client!
21+
22+
> [!IMPORTANT]
23+
> The library does **not lock you** into any specific HTTP client. Choose the one that best fits your framework, performance needs, or preferences.
24+
Whether you're using **Symfony**, **Laravel**, or a custom stack, PhpMistral integrates seamlessly into your environment.
25+
26+
This ensures **flexibility**, **interoperability**, and **future-proofing** of your PHP AI integrations.
27+
28+
---
29+
930
## Key Features
1031

11-
- **Open-source**:
12-
- Free to use, modify, and contribute to.
13-
- **Framework-agnostic**:
14-
- Compatible with any PHP framework (Laravel, Symfony, Slim, custom apps, etc.).
15-
- **Multi-backend support**:
32+
- **Open-source**:
33+
- Free to use, modify, and contribute to.
34+
- **Framework-agnostic**:
35+
- Compatible with any PHP framework (Laravel, Symfony, Slim, custom apps, etc.).
36+
- **Multi-backend support**:
1637
- OpenAI, Mistral Platform, Hugging Face TGI, vLLM, Ollama, llama.cpp, xAI, and more.
17-
- **Chat completions**:
38+
- **Chat completions**:
1839
- Streaming and non-streaming interactions.
19-
- **Embeddings**:
40+
- **Embeddings**:
2041
- Dense embeddings and sparse embeddings (Splade pooling).
21-
- **Reranking API**:
42+
- **Reranking API**:
2243
- Compare and rank multiple documents based on a query.
23-
- **Guided JSON generation**:
44+
- **Guided JSON generation**:
2445
- Ensure structured outputs based on a schema.
25-
- **Document generation (Mistral)**:
46+
- **Document generation (Mistral)**:
2647
- Generate structured documents directly from models.
27-
- **Pooling API (vLLM)**:
48+
- **Pooling API (vLLM)**:
2849
- Efficient load balancing across multiple vLLM servers.
29-
- **Hugging Face Dataset API**:
50+
- **Hugging Face Dataset API**:
3051
- Seamlessly interact with Hugging Face datasets, list files, download, manage, and search datasets directly from PHP.
3152

3253
> [!IMPORTANT]
3354
> The Hugging Face Dataset API is a **must-have** for anyone working with finetuning or dataset manipulation. Easily list, fetch, and manage datasets from Hugging Face directly in your PHP applications.
3455
3556
---
57+
3658
## Supported Providers & Features
3759

3860
### Core Features
@@ -67,6 +89,7 @@ It provides a unified interface for chat completions (streaming & non-streaming)
6789
composer require partitech/php-mistral
6890
```
6991

92+
7093
---
7194

7295
## Example Usages

0 commit comments

Comments
 (0)