docs: update doc comments with current Mistral API links
Some checks failed
Test / Test (push) Has been cancelled
Test / Test Documentation (push) Has been cancelled
Test / Test Examples (push) Has been cancelled

- Update crate-level docs with full API coverage description
- Fix stale docs.mistral.ai URLs to current endpoint references
- Point ChatMessageRole to chat completions API docs
- Point ModelListData to models API docs
This commit is contained in:
2026-03-20 18:02:30 +00:00
parent 63f0edf574
commit 5e6fac99a9
3 changed files with 7 additions and 4 deletions

View File

@@ -1,4 +1,7 @@
//! This crate provides a easy bindings and types for MistralAI's API.
//! Rust client for the [Mistral AI API](https://docs.mistral.ai/api/).
//!
//! Supports chat completions, embeddings, FIM, files, fine-tuning, batch jobs,
//! OCR, audio transcription, moderations, classifications, and agent completions.
/// The v1 module contains the types and methods for the v1 API endpoints.
/// The v1 module contains types and methods for all `/v1/` API endpoints.
pub mod v1;

View File

@@ -60,7 +60,7 @@ impl ChatMessage {
}
}
/// See the [Mistral AI API documentation](https://docs.mistral.ai/capabilities/completion/#chat-messages) for more information.
/// See the [chat completions API](https://docs.mistral.ai/api/#tag/chat/operation/chat_completion_v1_chat_completions_post).
#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
pub enum ChatMessageRole {
#[serde(rename = "system")]

View File

@@ -9,7 +9,7 @@ pub struct ModelListResponse {
pub data: Vec<ModelListData>,
}
/// See: https://docs.mistral.ai/api/#tag/models
/// See the [models API](https://docs.mistral.ai/api/#tag/models/operation/list_models_v1_models_get).
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ModelListData {
pub id: String,