Skip to content

Commit d43955a

Browse files
authored
Merge pull request #525 from mistralai/sync/latest
Sync docs to v1.1.19
2 parents 2e04c92 + 12ad8f9 commit d43955a

168 files changed

Lines changed: 4206 additions & 4755 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

pnpm-lock.yaml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

public/admin/security-access/api-keys.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ API keys authenticate your requests to the Mistral API. Each key is scoped to a
1010
<SectionTab as="h1" sectionId="creating-keys">Create an API key</SectionTab>
1111

1212
1. <AppLink href="https://console.mistral.ai/api-keys" app="studio">API keys</AppLink>.
13-
2. Click **Create new key**.
14-
3. Optionally set a **name** (e.g., "Production pipeline") and an **expiration date**.
15-
4. Click **Create new key**.
16-
5. Copy the key immediately.
13+
2. Click `Create new key`.
14+
3. Optionally set a `Name` (for example, `Production pipeline`) and an `Expiration` date.
15+
4. Choose a `Connector access scope`.
16+
5. Click `Create new key`.
17+
6. Copy the key immediately.
1718

1819
:::warning
1920
**The full key is shown only once**. After you close the dialog, you can't retrieve it. Store the key securely in a password manager or secrets vault. Don't share it or commit it to version control.
@@ -38,10 +39,23 @@ export MISTRAL_API_KEY="your-api-key"
3839

3940
<SectionTab as="h1" sectionId="workspace-scoping">Workspace scoping</SectionTab>
4041

41-
API keys are **scoped to the Workspace** where they were created. Resources created with a key (like datasets, batch jobs, etc.) are visible to all members of that Workspace.
42+
API keys are **scoped to the Workspace** where they were created. Resources created with a key, such as datasets and batch jobs, are visible to all members of that Workspace.
4243

4344
To use different keys for different environments (development, staging, production), create separate [Workspaces](/admin/security-access/organization).
4445

46+
<SectionTab as="h1" sectionId="connector-access-scope">Connector access scope</SectionTab>
47+
48+
When you create an API key, use `Connector access scope` to control which Connectors the key can use:
49+
50+
| Scope | Access |
51+
|-------|--------|
52+
| `Shared connectors only` | Access only Connectors shared with the Workspace, not your private Connectors. |
53+
| `Private and shared connectors` | Access both your private Connectors and the Connectors shared with the Workspace. |
54+
55+
:::tip
56+
Use `Shared connectors only` for automation. Use `Private and shared connectors` only when the application needs private Connectors owned by the key creator.
57+
:::
58+
4559
<SectionTab as="h1" sectionId="key-management">Key management</SectionTab>
4660

4761
- **Rotate keys** regularly. Create a new key, update your applications, then delete the old one.

public/admin/security-access/back-office.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ From the Admin Panel, administrators can:
4040
- **Organization**: rename, configure settings, view the Organization ID
4141
- **Members**: invite users, assign seats and roles, remove members
4242
- **Workspaces**: create isolated environments with independent API keys and usage tracking
43+
- **Connectors**: connect organization-level bots and control Connector tool access
4344
- **Access**: configure SSO and Email Domain Authentication
4445
- **Billing**: manage payment methods, subscriptions, and invoices
4546
- **Usage limits**: set spending caps per Workspace

public/admin/security-access/organization.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ At the Organization level, administrators can manage:
1616
- **Billing** for all Workspaces
1717
- **Subscriptions** (Vibe and Studio)
1818
- **Members** and role assignments
19+
- **Connectors** and organization-level app connections
1920
- **Security** settings (SSO, domain authentication)
2021
- **Privacy** and data handling preferences
2122
- **Audit logs** (Enterprise)

public/getting-started/quickstarts/admin/manage-workspaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ Control who has access to each workspace independently.
6060
<TableBody>
6161
<TableRow>
6262
<TableCell>**Admin**</TableCell>
63-
<TableCell>Full workspace control: manage members, keys, settings</TableCell>
63+
<TableCell>Full workspace control: manage members, keys, settings, view usage</TableCell>
6464
</TableRow>
6565
<TableRow>
6666
<TableCell>**Member**</TableCell>
67-
<TableCell>Use API keys, view usage: no management access</TableCell>
67+
<TableCell>Use API keys</TableCell>
6868
</TableRow>
6969
</TableBody>
7070
</Table>

public/getting-started/quickstarts/studio/activate-and-generate-api-key.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,21 @@ By the end you will have a working API key ready to use in your first request.
2323
<SectionTab as="h2" sectionId="step-1">Step 1: Generate an API key</SectionTab>
2424

2525
1. Open the <AppLink href="https://console.mistral.ai" app="studio">Studio console</AppLink>.
26-
2. Navigate to **API Keys** in the left sidebar.
27-
3. Click **Create new key**.
26+
2. Navigate to `API Keys` in the left sidebar.
27+
3. Click `Create new key`.
2828

2929
![Click Create new key](/assets/quickstarts/studio/new-key-button.png)
3030

31-
4. Add a **Name** to identify the key (for example, "First test key").
32-
5. Set an **Expiration** date. Regular rotation improves security.
31+
1. Add a `Name` to identify the key (for example, `First test key`).
32+
2. Set an `Expiration` date. Regular rotation improves security.
33+
3. Choose a `Connector access scope`:
34+
- `Shared connectors only`: access only Connectors shared with the Workspace, not your private Connectors.
35+
- `Private and shared connectors`: access both your private Connectors and the Connectors shared with the Workspace.
3336

3437
![Configure the API key with optional name and expiration date](/assets/quickstarts/studio/new-key-modal.png)
3538

36-
6. Click **Create new key**.
37-
7. Copy the key immediately and store it in a secure location (password manager or secrets vault).
39+
1. Click `Create new key`.
40+
2. Copy the key immediately and store it in a secure location (password manager or secrets vault).
3841

3942
:::warning
4043
The full key appears only once. You cannot retrieve it after closing the confirmation dialog.

public/models/best-practices/sampling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ Dragon
392392
In this example, the model generates a response considering only the top tokens that cumulatively reach a 50% probability threshold. This ensures that the output keeps some uniform diversity while still taking only the best tokens, in this case only 2 tokens reach the 50% threshold.
393393
</ExplorerTab>
394394
<ExplorerTab value="penalties" label="Penalties">
395-
Presence and Frequency Penalties are parameters that repetition, it allows you to control the diversity of the generated text.
395+
Presence and frequency penalties are parameters that penalize repetition. They let you control the diversity of generated text.
396396

397397
<SectionTab as="h2" variant="secondary" sectionId="presence-penalty">Presence Penalty</SectionTab>
398398

public/studio-api/agents/agent-tools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ We provide a variety of different **types** of tools agents can use.
2424
|[Web Search](/studio-api/agents/agent-tools/websearch)| Built-in. Search the web for up-to-date information not in the agent's knowledge.|
2525
|[Code Interpreter](/studio-api/agents/agent-tools/code_interpreter)| Built-in. Run code and generate plots, useful for data analysis, visualization, or sandboxed execution.|
2626
|[Image Generation](/studio-api/agents/agent-tools/image_generation)| Built-in. Generate images based on a prompt or description.|
27-
|[Document Library](/studio-api/knowledge-rag/libraries#connecting-libraries-to-agents)| Built-in. Search through documents uploaded to your [Libraries](/studio-api/knowledge-rag/libraries), enabling RAG to answer questions based on specific information.|
27+
|[Document Library](/studio-api/libraries#connecting-libraries-to-agents)| Built-in. Search through documents uploaded to your [Libraries](/studio-api/libraries), enabling RAG to answer questions based on specific information.|
2828
|[Function Calling](/studio-api/agents/agent-tools/function-calling)| Custom local tools: functions defined in your environment that can be called by the agent. Execution happens locally.|
29-
|[Connectors](/studio-api/knowledge-rag/connectors)| Register MCP servers as managed Connectors. Tools are discovered automatically and executed server-side.|
29+
|[Connectors](/studio-api/connectors)| Register MCP servers as managed Connectors. Tools are discovered automatically and executed server-side.|
3030

3131
<SectionTab as="h1" sectionId="built-in-tools">Built-in tools</SectionTab>
3232

public/studio-api/agents/agent-tools/function-calling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The core of an agent relies on its tool usage capabilities, enabling it to use a
1111

1212
Built into our API, we provide [built-in tools](/studio-api/agents/agent-tools#built-in-tools) such as `websearch`, `code_interpreter`, `image_generation` and `document_library`. However, you can also use standard function tool calling by defining a JSON schema for your function.
1313

14-
You can also register MCP servers as [Connectors](/studio-api/knowledge-rag/connectors) to use external tools in conversations and Agents.
14+
You can also register MCP servers as [Connectors](/studio-api/connectors) to use external tools in conversations and Agents.
1515

1616
For more information regarding function calling, we recommend to visit our [function calling docs](/studio-api/conversations/function-calling).
1717

public/studio-api/agents/agent-tools/websearch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,5 +268,5 @@ Below we will explain the different outputs of the response of the previous snip
268268

269269
<SectionTab as="h3" variant="secondary" sectionId="more">More</SectionTab>
270270

271-
Another tool that uses references is the Document Library tool — see the [Libraries guide](/studio-api/knowledge-rag/libraries#connecting-libraries-to-agents) for details.
271+
Another tool that uses references is the Document Library tool — see the [Libraries guide](/studio-api/libraries#connecting-libraries-to-agents) for details.
272272
For more on citations, see the [citations guide](/studio-api/conversations/citations).

0 commit comments

Comments
 (0)