shern commited on
Commit
43dfb0e
·
1 Parent(s): eddeeee

refactor: update llms.txt agent generated output reference example

Browse files
Files changed (1) hide show
  1. llms-txt/mistral-python-sdk_llms.txt +19 -16
llms-txt/mistral-python-sdk_llms.txt CHANGED
@@ -1,27 +1,30 @@
1
  # Mistral Python SDK
2
 
3
- > Mistral Python SDK: A Python client library for interacting with Mistral AI's API, enabling seamless integration of Mistral's language models into Python applications.
4
 
5
- Key Tips / Caveats
6
- - Always set your Mistral API key securely in your environment variables to avoid exposure in your code.
7
- - Use context managers or explicitly close the Mistral client to ensure proper resource cleanup.
8
- - The SDK supports both synchronous and asynchronous interactions with Mistral's API.
9
- - Handle API rate limits gracefully by implementing retry logic in your application.
10
- - For streaming responses, ensure your application can process data incrementally to avoid memory issues.
11
 
12
  ## Docs
13
- - [Official Documentation](https://raw.githubusercontent.com/mistralai/client-python/main/README.md): Comprehensive guide to using the Mistral Python SDK.
14
- - [Quickstart Guide](https://docs.mistral.ai/getting-started/quickstart/): Step-by-step instructions to get started with the Mistral API.
15
- - [Mistral AI API Specification](https://docs.mistral.ai/api/): Detailed API specification for Mistral's Chat Completion and Embeddings APIs.
 
16
 
17
  ## API
18
- - [Mistral Class Reference](https://raw.githubusercontent.com/mistralai/client-python/main/README.md): Detailed reference for the Mistral class and its methods.
19
- - [API Specification](https://docs.mistral.ai/api/): OpenAPI specification for Mistral's Chat Completion and Embeddings APIs.
20
 
21
  ## Examples
22
- - [Chat No Streaming Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/chat_no_streaming.py): Example of a basic chat interaction without streaming.
23
- - [Embeddings Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/embeddings.py): Example demonstrating how to use embeddings with the Mistral API.
 
 
 
24
 
25
  ## Optional
26
- - [Function Calling Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/function_calling.py): Advanced example showing function calling with the Mistral API.
27
- - [Langfuse Integration Cookbook](https://langfuse.com/docs/integrations/mistral-sdk): Cookbook with examples of integrating Langfuse with the Mistral SDK.
 
 
1
  # Mistral Python SDK
2
 
3
+ > Mistral Python SDK: A Python client library for seamless integration with Mistral AI's state-of-the-art models, enabling developers to build applications with advanced language processing capabilities.
4
 
5
+ * Set `MISTRAL_API_KEY` environment variable before using the SDK to authenticate with Mistral AI API.
6
+ * Use the `Mistral` class context manager to handle resources efficiently, especially in long-running applications.
7
+ * Override default retry strategy for API calls by providing a `RetryConfig` object to customize backoff behavior.
8
+ * Ensure Python version compatibility as the SDK updates its minimum supported version after end-of-life grace periods.
 
 
9
 
10
  ## Docs
11
+ * [Mistral Python SDK README](https://raw.githubusercontent.com/mistralai/client-python/main/README.md): Overview and setup instructions for the Mistral Python SDK.
12
+ * [Mistral AI Quickstart Guide](https://docs.mistral.ai/getting-started/quickstart/): Guide to integrating Mistral's models into applications with minimal code.
13
+ * [Mistral AI Clients Documentation](https://docs.mistral.ai/getting-started/clients/): Information on available client libraries, including Python and TypeScript.
14
+ * [Mistral AI API Specification](https://docs.mistral.ai/api/): Detailed specification for Mistral's Chat Completion and Embeddings APIs.
15
 
16
  ## API
17
+ * [Mistral Python SDK Source Code](https://raw.githubusercontent.com/mistralai/client-python/main/mistral/__init__.py): Source code for the Mistral Python SDK, showing implementation details and usage examples.
18
+ * [Mistral AI API OpenAPI Specification](https://raw.githubusercontent.com/mistralai/api-spec/main/openapi.yaml): OpenAPI specification for Mistral's Chat Completion and Embeddings APIs.
19
 
20
  ## Examples
21
+ * [Basic Chat Completion Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/chat_no_streaming.py): Example of using the Mistral Python SDK for basic chat completion without streaming.
22
+ * [Streaming Chat Completion Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/chat_streaming.py): Example of using the Mistral Python SDK for streaming chat completion.
23
+ * [Embeddings Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/embeddings.py): Example of generating embeddings using the Mistral Python SDK.
24
+ * [Function Calling Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/function_calling.py): Example of using the Mistral Python SDK for function calling.
25
+ * [Custom Retry Strategy Example](https://raw.githubusercontent.com/mistralai/client-python/main/examples/custom_retry_strategy.py): Example of customizing the retry strategy for API calls using the Mistral Python SDK.
26
 
27
  ## Optional
28
+ * [Langfuse Integration Cookbook](https://langfuse.com/docs/integrations/mistral-sdk): Cookbook with examples of integrating Langfuse with the Mistral Python SDK for logging and tracing.
29
+ * [Mistral AI Agents API](https://venturebeat.com/ai/mistral-launches-api-for-building-ai-agents-that-run-python-generate-images-perform-rag-and-more/): Information on Mistral's Agents API for building AI agents with advanced capabilities.
30
+ * [Mistral Python SDK Retry Configuration](https://raw.githubusercontent.com/mistralai/client-python/main/mistral/utils.py): Detailed information on configuring retry strategies for API calls in the Mistral Python SDK.