vikingowl
5471723acc
Add doc.go with package-level godoc for all 15 packages, runnable example functions for chat completion, streaming, embeddings, and error handling, plus build-tagged integration tests for live API validation.
46 lines
1.3 KiB
Go
46 lines
1.3 KiB
Go
// Package mistral provides an idiomatic Go client for the Mistral AI API.
|
|
//
|
|
// Create a client with your API key, then call methods for each endpoint:
|
|
//
|
|
// client := mistral.NewClient("sk-...")
|
|
//
|
|
// // Chat completion
|
|
// resp, err := client.ChatComplete(ctx, &chat.CompletionRequest{
|
|
// Model: "mistral-small-latest",
|
|
// Messages: []chat.Message{&chat.UserMessage{Content: chat.TextContent("Hello!")}},
|
|
// })
|
|
//
|
|
// // Streaming
|
|
// stream, err := client.ChatCompleteStream(ctx, req)
|
|
// defer stream.Close()
|
|
// for stream.Next() {
|
|
// chunk := stream.Current()
|
|
// fmt.Print(chunk.Choices[0].Delta.Content)
|
|
// }
|
|
//
|
|
// # Configuration
|
|
//
|
|
// Use functional options to configure the client:
|
|
//
|
|
// client := mistral.NewClient("sk-...",
|
|
// mistral.WithTimeout(30 * time.Second),
|
|
// mistral.WithRetry(3, 500*time.Millisecond),
|
|
// )
|
|
//
|
|
// # Error Handling
|
|
//
|
|
// API errors are returned as *[APIError] values. Use sentinel checkers
|
|
// for common cases:
|
|
//
|
|
// if mistral.IsRateLimit(err) {
|
|
// // back off and retry
|
|
// }
|
|
//
|
|
// # Sub-packages
|
|
//
|
|
// Types are organized into sub-packages by domain: [chat], [agents],
|
|
// [conversation], [embedding], [model], [file], [finetune], [batch],
|
|
// [ocr], [audio], [library], [moderation], [classification], and [fim].
|
|
// All service methods live directly on [Client].
|
|
package mistral
|