@mistralai/mistralai 1.10.0 → 1.12.0

package/docs/sdks/mistralagents/README.md

@@ -1,386 +0,0 @@
-# MistralAgents
-(*beta.agents*)
-
-## Overview
-
-(beta) Agents API
-
-### Available Operations
-
-* [create](#create) - Create a agent that can be used within a conversation.
-* [list](#list) - List agent entities.
-* [get](#get) - Retrieve an agent entity.
-* [update](#update) - Update an agent entity.
-* [updateVersion](#updateversion) - Update an agent version.
-
-## create
-
-Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="agents_api_v1_agents_create" method="post" path="/v1/agents" -->
-```typescript
-import { Mistral } from "@mistralai/mistralai";
-
-const mistral = new Mistral({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await mistral.beta.agents.create({
-    model: "LeBaron",
-    name: "<value>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { MistralCore } from "@mistralai/mistralai/core.js";
-import { betaAgentsCreate } from "@mistralai/mistralai/funcs/betaAgentsCreate.js";
-
-// Use `MistralCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const mistral = new MistralCore({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await betaAgentsCreate(mistral, {
-    model: "LeBaron",
-    name: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("betaAgentsCreate failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.AgentCreationRequest](../../models/components/agentcreationrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.Agent](../../models/components/agent.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## list
-
-Retrieve a list of agent entities sorted by creation time.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="agents_api_v1_agents_list" method="get" path="/v1/agents" -->
-```typescript
-import { Mistral } from "@mistralai/mistralai";
-
-const mistral = new Mistral({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await mistral.beta.agents.list({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { MistralCore } from "@mistralai/mistralai/core.js";
-import { betaAgentsList } from "@mistralai/mistralai/funcs/betaAgentsList.js";
-
-// Use `MistralCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const mistral = new MistralCore({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await betaAgentsList(mistral, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("betaAgentsList failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AgentsApiV1AgentsListRequest](../../models/operations/agentsapiv1agentslistrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.Agent[]](../../models/.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## get
-
-Given an agent retrieve an agent entity with its attributes.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="agents_api_v1_agents_get" method="get" path="/v1/agents/{agent_id}" -->
-```typescript
-import { Mistral } from "@mistralai/mistralai";
-
-const mistral = new Mistral({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await mistral.beta.agents.get({
-    agentId: "<id>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { MistralCore } from "@mistralai/mistralai/core.js";
-import { betaAgentsGet } from "@mistralai/mistralai/funcs/betaAgentsGet.js";
-
-// Use `MistralCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const mistral = new MistralCore({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await betaAgentsGet(mistral, {
-    agentId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("betaAgentsGet failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AgentsApiV1AgentsGetRequest](../../models/operations/agentsapiv1agentsgetrequest.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.Agent](../../models/components/agent.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## update
-
-Update an agent attributes and create a new version.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="agents_api_v1_agents_update" method="patch" path="/v1/agents/{agent_id}" -->
-```typescript
-import { Mistral } from "@mistralai/mistralai";
-
-const mistral = new Mistral({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await mistral.beta.agents.update({
-    agentId: "<id>",
-    agentUpdateRequest: {},
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { MistralCore } from "@mistralai/mistralai/core.js";
-import { betaAgentsUpdate } from "@mistralai/mistralai/funcs/betaAgentsUpdate.js";
-
-// Use `MistralCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const mistral = new MistralCore({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await betaAgentsUpdate(mistral, {
-    agentId: "<id>",
-    agentUpdateRequest: {},
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("betaAgentsUpdate failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AgentsApiV1AgentsUpdateRequest](../../models/operations/agentsapiv1agentsupdaterequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.Agent](../../models/components/agent.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-
-## updateVersion
-
-Switch the version of an agent.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="agents_api_v1_agents_update_version" method="patch" path="/v1/agents/{agent_id}/version" -->
-```typescript
-import { Mistral } from "@mistralai/mistralai";
-
-const mistral = new Mistral({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await mistral.beta.agents.updateVersion({
-    agentId: "<id>",
-    version: 157995,
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { MistralCore } from "@mistralai/mistralai/core.js";
-import { betaAgentsUpdateVersion } from "@mistralai/mistralai/funcs/betaAgentsUpdateVersion.js";
-
-// Use `MistralCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const mistral = new MistralCore({
-  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await betaAgentsUpdateVersion(mistral, {
-    agentId: "<id>",
-    version: 157995,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("betaAgentsUpdateVersion failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AgentsApiV1AgentsUpdateVersionRequest](../../models/operations/agentsapiv1agentsupdateversionrequest.md)                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.Agent](../../models/components/agent.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |