Update version to v0.0.97

mistralai · Nov 7, 2024 · 88316e4 · 88316e4
1 parent 6a5b68e
commit 88316e4
Show file tree

Hide file tree

Showing 14 changed files with 6,761 additions and 7,133 deletions.
diff --git a/docs/capabilities/batch.md b/docs/capabilities/batch.md
diff --git a/docs/capabilities/completion.mdx b/docs/capabilities/completion.mdx
@@ -70,25 +70,34 @@ for chunk in stream_response:
 
 ### With async 
 ```python
+import asyncio
+import os
+
 from mistralai import Mistral
 
-api_key = os.environ["MISTRAL_API_KEY"]
-model = "mistral-large-latest"
 
-client = Mistral(api_key=api_key)
+async def main():
+    api_key = os.environ["MISTRAL_API_KEY"]
+    model = "mistral-tiny"
 
-async_response = await client.chat.stream_async(
-    model = model,
-    messages = [
-        {
-            "role": "user",
-            "content": "Who is the best French painter? Answer in JSON.",
-        },
-    ]
-)
+    client = Mistral(api_key=api_key)
 
-async for chunk in async_response: 
-    print(chunk.data.choices[0].delta.content)
+    response = await client.chat.stream_async(
+        model=model,
+        messages=[
+             {
+                  "role": "user",
+                  "content": "Who is the best French painter? Answer in JSON.",
+              },
+        ],
+    )
+    async for chunk in response:
+        if chunk.data.choices[0].delta.content is not None:
+            print(chunk.data.choices[0].delta.content, end="")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
 ```
 
 

diff --git a/docs/capabilities/finetuning.mdx b/docs/capabilities/finetuning.mdx
@@ -316,7 +316,7 @@ curl https://api.mistral.ai/v1/fine_tuning/jobs \
 You can also list jobs, retrieve a job, or cancel a job. 
 
 You can filter and view a list of jobs using various parameters such as 
-`page`, `page_size`, `model`, `created_after`, `created_by_me`, `status`, `wandb_project`, `wandb_name`, and `suffix`. Check out our [API specs](/api/#operation/jobs_api_routes_fine_tuning_get_fine_tuning_jobs) for details.
+`page`, `page_size`, `model`, `created_after`, `created_by_me`, `status`, `wandb_project`, `wandb_name`, and `suffix`. Check out our [API specs](https://docs.mistral.ai/api/#tag/fine-tuning) for details.
 
 <Tabs>
   <TabItem value="python" label="python" default>

diff --git a/docs/capabilities/function-calling.mdx b/docs/capabilities/function-calling.mdx
@@ -14,10 +14,14 @@ Function calling allows Mistral models to connect to external tools. By integrat
 
 ### Available models
 Currently, function calling is available for the following models:
-- Mistral Small 
 - Mistral Large 
+- Mistral Small 
+- Codestral 22B 
+- Ministral 8B 
+- Ministral 3B 
+- Pixtral 12B 
 - Mixtral 8x22B 
-- Mistral Nemo
+- Mistral Nemo 
 
 
 ### Four steps 

diff --git a/docs/capabilities/guardrailing.mdx b/docs/capabilities/guardrailing.mdx
@@ -1,12 +1,189 @@
 ---
 id: guardrailing
-title: Guardrailing
+title: Moderation
 sidebar_position: 2.7
 ---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+## Moderation API
+
+We are introducing our new moderation service, which is powered by the Mistral Moderation model, a classifier model
+based on Ministral 8B 24.10. It enables our users to detect harmful text content along several policy dimensions.
+
+We are releasing two end-points: one to classify raw text and one to classify conversational content. More details below.
+
+### Raw-text endpoint
+
+<Tabs>
+  <TabItem value="python" label="python" default>
+```python
+import os
+from mistralai import Mistral
+
+api_key = os.environ["MISTRAL_API_KEY"]
+
+client = Mistral(api_key=api_key)
+
+response = client.classifiers.moderate(
+    model = "mistral-moderation-latest",  
+    inputs=["...text to classify..."]
+)
+
+print(response)
+```
+  </TabItem>
+  <TabItem value="typescript" label="typescript">
+```typescript 
+import { Mistral } from "@mistralai/mistralai";
+
+const apiKey = process.env.MISTRAL_API_KEY;
+const client = new Mistral({apiKey});
+
+const response = await client.classifiers.moderate({
+    model: "mistral-moderation-latest",
+    inputs: ["...text to classify..."],
+});
+
+console.log(response);
+
+```
+  </TabItem>
+  <TabItem value="curl" label="curl">
+```curl
+curl https://api.mistral.ai/v1/moderations \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer $MISTRAL_API_KEY" \
+  -d '{
+    "model": "mistral-moderation-latest", 
+    "input": ["...text to classify..."]
+  }'
+```
+  </TabItem>
+</Tabs>
+
+
+### Conversational endpoint
+
+If you are using the moderation API in a conversational setting, we recommend
+using the conversational endpoint and sending your conversation payload as shown
+below. Note that the model is trained to classify the last turn of a conversation
+given the conversational context.
+
+<Tabs>
+  <TabItem value="python" label="python" default>
+```python 
+import os
+
+from mistralai import Mistral
+
+api_key = os.environ["MISTRAL_API_KEY"]
+client = Mistral(api_key=api_key)
+
+response = client.classifiers.moderate_chat(
+    model="mistral-moderation-latest",
+    inputs=[
+        {"role": "user", "content": "...user prompt ..."},
+        {"role": "assistant", "content": "...assistant response..."},
+    ],
+)
+
+print(response)
+```
+  </TabItem>
+  <TabItem value="typescript" label="typescript">
+```typescript 
+import { Mistral } from "@mistralai/mistralai";
+
+const apiKey = process.env.MISTRAL_API_KEY;
+const client = new Mistral({apiKey});
+
+const response = await client.classifiers.moderateChat({
+  model: "mistral-moderation-latest",
+  inputs = [
+    { role: "user", content: "...user prompt ..." },
+    { role: "assistant", content: "...assistant response..." },
+  ],
+});
+
+console.log(response);
+
+```
+  </TabItem>
+  <TabItem value="curl" label="curl">
+```curl
+curl https://api.mistral.ai/v1/chat/moderations \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer $MISTRAL_API_KEY" \
+  -d '{
+    "model": "mistral-moderation-latest", 
+    "input": [{"role": "user", "content": "...user prompt ..."}, {"role": "assistant", "content": "...assistant response..."}]
+  }'
+```
+  </TabItem>
+</Tabs>
+
+
+Below is an example outputs
+
+```
+ClassificationResponse(
+    id='091b378dec1444e2a4800d6915aad0fa',
+    model='mistral-moderation-latest',
+    results=[
+        ClassificationObject(
+            categories={
+                'sexual': False,
+                'hate_and_discrimination': False,
+                'violence_and_threats': True,
+                'dangerous_and_criminal_content': False,
+                'selfharm': False,
+                'health': False,
+                'financial': False,
+                'law': False,
+                'pii': False
+            },
+            category_scores={
+                'sexual': 9.608268737792969e-05,
+                'hate_and_discrimination': 0.0001398324966430664,
+                'violence_and_threats': 0.9990234375,
+                'dangerous_and_criminal_content': 1.5676021575927734e-05,
+                'selfharm': 0.0001233816146850586,
+                'health': 3.2782554626464844e-06,
+                'financial': 1.3828277587890625e-05,
+                'law': 2.282857894897461e-05,
+                'pii': 0.0001233816146850586
+            }
+        )
+    ]
+)
+```
+:::note[ ]
+The policy threshold is determined based on the optimal performance of our internal test set. 
+You can use the raw score or adjust the threshold according to your specific use cases. 
+
+We intend to continually improve the underlying model of the moderation endpoint.
+Custom policies that depend on `category_scores` can require recalibration.
+:::
+
+
+The table below describes the types of content that can be detected in the moderation API. 
+| Category | Description |
+| --- | --- |
+| Sexual | Material that explicitly depicts, describes, or promotes sexual activities, nudity, or sexual services. This includes pornographic content, graphic descriptions of sexual acts, and solicitation for sexual purposes. Educational or medical content about sexual health presented in a non-explicit, informational context is generally exempted. |
+| Hate and Discrimination | Content that expresses prejudice, hostility, or advocates discrimination against individuals or groups based on protected characteristics such as race, ethnicity, religion, gender, sexual orientation, or disability. This includes slurs, dehumanizing language, calls for exclusion or harm targeted at specific groups, and persistent harassment or bullying of individuals based on these characteristics. |
+| Violence and Threats | Content that describes, glorifies, incites, or threatens physical violence against individuals or groups. This includes graphic depictions of injury or death, explicit threats of harm, and instructions for carrying out violent acts. This category covers both targeted threats and general promotion or glorification of violence. |
+| Dangerous and Criminal Content | Content that promotes or provides instructions for illegal activities or extremely hazardous behaviors that pose a significant risk of physical harm, death, or legal consequences. This includes guidance on creating weapons or explosives, encouragement of extreme risk-taking behaviors, and promotion of non-violent crimes such as fraud, theft, or drug trafficking. |
+| Self-Harm | Content that promotes, instructs, plans, or encourages deliberate self-injury, suicide, eating disorders, or other self-destructive behaviors. This includes detailed methods, glorification, statements of intent, dangerous challenges, and related slang terms |
+| Health | Content that contains or tries to elicit detailed or tailored medical advice. |
+| Financial | Content that contains or tries to elicit detailed or tailored financial advice. |
+| Law | Content that contains or tries to elicit detailed or tailored legal advice. |
+| PII | Content that requests, shares, or attempts to elicit personal identifying information such as full names, addresses, phone numbers, social security numbers, or financial account details. |
+
+
+
+
 ## System prompt to enforce guardrails
 
 The ability to enforce guardrails in chat generations is crucial for front-facing applications. We introduce an optional system prompt to enforce guardrails on top of our models. You can activate this prompt through a `safe_prompt` boolean flag in API calls as follows :
@@ -55,7 +232,7 @@ Toggling the safe prompt will prepend your messages with the following system pr
 Always assist with care, respect, and truth. Respond with utmost utility yet securely. Avoid harmful, unethical, prejudiced, or negative content. Ensure replies promote fairness and positivity.
 ```
 
-## Guardrailing results with Mistral safety prompt
+### Guardrailing results with Mistral safety prompt
 
 To evaluate the ability of the model to avoid inappropriate outputs we used a set of adversarial prompts deliberately asking for content excluded by guardrails, kindly provided by the community. 
 
@@ -70,40 +247,26 @@ As an illustration, we provide below the answers of Mistral 7B and Mistral Large
 
 ## Content moderation with self-reflection
 
-Mistral models also act as great content moderators: the model itself is able to accurately classify a user prompt or its generated answer as being either acceptable or falling into one of the following categories:
+Mistral models can also act as great content moderators: the model itself is able to accurately classify a user prompt or its generated answer as being either acceptable or falling into one of the following categories:
 
 - Illegal activities such as terrorism, child abuse or fraud
 - Hateful, harassing or violent content such as discrimination, self-harm or bullying.
 - Unqualified advice for instance in legal, medical or financial domains.
 
-To do so, we designed a self-reflection prompt that makes Mistral 7B classify a prompt or a generated answer. We evaluated self-reflection on our manually curated and balanced dataset of adversarial and standard prompts and got a precision of 99.4% for a recall of 95.6% (considering acceptable prompts as positives).
-
-Strong and subtle moderation models have many applications, ranging from comments on social media or forums to brand monitoring on the internet. It can serve as a plug-in post-processing on top of model output to ban selected types of content and report misusage.
-
-Reversely, Mistral 7B can be used in an adversarial way to stress test content moderation and improve it.
+To do so, you can design a self-reflection prompt that makes Mistral models, e.g., Mistral Large 2, classify a prompt or a generated answer.
 
-We also provide our self-reflection prompt, strongly inspired by many initiatives from the AI community.
+Here is an example self-reflection prompt for classifying text into categories such as physical harm, economic harm, and fraud:
 
 ```
 You're given a list of moderation categories as below:
 
-- illegal: Illegal activity.
-- child abuse: child sexual abuse material or any content that exploits or harms children.
-- hate violence harassment: Generation of hateful, harassing, or violent content: content that expresses, incites, or promotes hate based on identity, content that intends to harass, threaten, or bully an individual, content that promotes or glorifies violence or celebrates the suffering or humiliation of others.
-- malware: Generation of malware: content that attempts to generate code that is designed to disrupt, damage, or gain unauthorized access to a computer system.
 - physical harm: activity that has high risk of physical harm, including: weapons development, military and warfare, management or operation of critical infrastructure in energy, transportation, and water, content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.
 - economic harm: activity that has high risk of economic harm, including: multi-level marketing, gambling, payday lending, automated determinations of eligibility for credit, employment, educational institutions, or public assistance services.
 - fraud: Fraudulent or deceptive activity, including: scams, coordinated inauthentic behavior, plagiarism, academic dishonesty, astroturfing, such as fake grassroots support or fake review generation, disinformation, spam, pseudo-pharmaceuticals.
-- adult: Adult content, adult industries, and dating apps, including: content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness), erotic chat, pornography.
-- political: Political campaigning or lobbying, by: generating high volumes of campaign materials, generating campaign materials personalized to or targeted at specific demographics, building conversational or interactive systems such as chatbots that provide information about campaigns or engage in political advocacy or lobbying, building products for political campaigning or lobbying purposes.
-- privacy: Activity that violates people's privacy, including: tracking or monitoring an individual without their consent, facial recognition of private individuals, classifying individuals based on protected characteristics, using biometrics for identification or assessment, unlawful collection or disclosure of personal identifiable information or educational, financial, or other protected records.
-- unqualified law: Engaging in the unauthorized practice of law, or offering tailored legal advice without a qualified person reviewing the information.
-- unqualified financial: Offering tailored financial advice without a qualified person reviewing the information.
-- unqualified health: Telling someone that they have or do not have a certain health condition, or providing instructions on how to cure or treat a health condition.
 
 Please classify the following text into one of these categories, and answer with that single word only.
 
 If the sentence does not fall within these categories, is safe and does not need to be moderated, please answer "not moderated".
 ```
 
-*The answers of Mistral 7B-Instruct without prompt and with Mistral prompts are available on demand as they contain examples of text that may be considered unsafe, offensive, or upsetting.*
+Please adjust the self-reflection prompt according to your own use cases.
diff --git a/docs/getting-started/changelog.mdx b/docs/getting-started/changelog.mdx
@@ -4,7 +4,13 @@ title: Changelog
 sidebar_position: 1.8
 ---
 
-This is the list of changes to the Mistral API. 
+This is the list of changes to the Mistral API.  
+November 6, 2029
+- We released moderation API and batch API. 
+- We introduced three new parameters:
+    - `presence_penalty`: penalizes the repetition of words or phrases
+    - `frequency_penalty`: penalizes the repetition of words based on their frequency in the generated text
+    - `n`: number of completions to return for each request, input tokens are only billed once. 
 
 October 9, 2024
 - We released Ministral 3B (`ministral-3b-2410`) and Ministral 8B (`ministral-8b-2410`). 

diff --git a/docs/getting-started/models/overview.md b/docs/getting-started/models/overview.md
@@ -22,6 +22,7 @@ Mistral provides two types of models: free models and premier models.
 | Mistral Small | :heavy_check_mark: <br/> [Mistral Research License](https://mistral.ai/licenses/MRL-0.1.md) | :heavy_check_mark: | Our latest enterprise-grade small model with the lastest version v2 released September 2024. Learn more on our [blog post](https://mistral.ai/news/september-24-release/) | 32k  | `mistral-small-latest` | 24.09|
 | Codestral |:heavy_check_mark: <br/> [Mistral Non-Production License](https://mistral.ai/licenses/MNPL-0.1.md) | :heavy_check_mark: | Our cutting-edge language model for coding released May 2024 | 32k  | `codestral-latest` | 24.05|
 | Mistral Embed | | :heavy_check_mark: | Our state-of-the-art semantic for extracting representation of text extracts | 8k  | `mistral-embed` | 23.12|
+| Mistral Moderation | | :heavy_check_mark: | Our moderation service that enables our users to detect harmful text content | 8k  | `mistral-moderation-latest` | 24.11|
 
 
 ### Free models
@@ -58,6 +59,7 @@ it is recommended to use the dated versions of the Mistral AI API.
 Additionally, be prepared for the deprecation of certain endpoints in the coming months.
 
 Here are the details of the available versions:
+- `mistral-moderation-latest`: currently points to `mistral-moderation-2411`.
 - `ministral-3b-latest`: currently points to `ministral-3b-2410`.
 - `ministral-8b-latest`: currently points to `ministral-8b-2410`.
 - `open-mistral-nemo`: currently points to `open-mistral-nemo-2407`.

diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx
@@ -14,6 +14,13 @@ import TabItem from '@theme/TabItem';
 Looking for La Plateforme? Head to [console.mistral.ai][platform_url]
 :::
 
+## Account setup
+
+- To get started, create a Mistral account or sign in at [console.mistral.ai][platform_url].
+- Then, navigate to "Workspace" and "Billing" to add your payment information and activate payments on your account. 
+- After that, go to the "API keys" page and make a new API key by clicking "Create new key". 
+Make sure to copy the API key, save it safely, and do not share it with anyone.
+
 ## Getting started with Mistral AI API
 
 <a target="_blank" href="https://colab.research.google.com/github/mistralai/cookbook/blob/main/quickstart.ipynb">
@@ -143,9 +150,3 @@ curl --location "https://api.mistral.ai/v1/embeddings" \
 
 For a full description of the models offered on the API, head on to the **[model documentation](../models/models_overview)**.
 
-## Account setup
-
-- To get started, create a Mistral account or sign in at [console.mistral.ai][platform_url].
-- Then, navigate to "Workspace" and "Billing" to add your payment information and activate payments on your account. 
-- After that, go to the "API keys" page and make a new API key by clicking "Create new key". 
-Make sure to copy the API key, save it safely, and do not share it with anyone.