diff --git a/src/lib.rs b/src/lib.rs index 76c72fb..c6e832e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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; diff --git a/src/v1/chat.rs b/src/v1/chat.rs index 1411357..c4733be 100644 --- a/src/v1/chat.rs +++ b/src/v1/chat.rs @@ -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")] diff --git a/src/v1/model_list.rs b/src/v1/model_list.rs index d0350f2..b4f66ea 100644 --- a/src/v1/model_list.rs +++ b/src/v1/model_list.rs @@ -9,7 +9,7 @@ pub struct ModelListResponse { pub data: Vec, } -/// 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,