Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.378.0 (#24)
Browse files Browse the repository at this point in the history
Co-authored-by: speakeasybot <[email protected]>
  • Loading branch information
github-actions[bot] and speakeasybot authored Aug 23, 2024
1 parent f03ae7d commit 85ad688
Show file tree
Hide file tree
Showing 26 changed files with 105 additions and 107 deletions.
10 changes: 5 additions & 5 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ id: 81b65c50-f2e3-40a3-bd65-346524007b3d
management:
docChecksum: ad1a7d6946828a089ca3831e257d307d
docVersion: 0.0.2
speakeasyVersion: 1.376.0
generationVersion: 2.402.5
releaseVersion: 1.0.3
configChecksum: 29f53c823f9a93ba50ba681063a0f8e8
speakeasyVersion: 1.378.0
generationVersion: 2.404.3
releaseVersion: 1.0.4
configChecksum: fed25c0901d68ea1f724aabbc1e3e84f
repoURL: https://github.com/mistralai/client-ts.git
installationURL: https://github.com/mistralai/client-ts
published: true
features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.10
constsAndDefaults: 0.1.11
core: 3.14.1
defaultEnabledRetries: 0.1.0
devContainers: 2.90.0
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
typescript:
version: 1.0.3
version: 1.0.4
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,14 @@ Based on:
### Generated
- [typescript v1.0.3] .
### Releases
- [NPM v1.0.3] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.3 - .
- [NPM v1.0.3] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.3 - .

## 2024-08-23 13:33:36
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.378.0 (2.404.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v1.0.4] .
### Releases
- [NPM v1.0.4] https://www.npmjs.com/package/@mistralai/mistralai/v/1.0.4 - .
31 changes: 15 additions & 16 deletions docs/sdks/agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ const mistral = new Mistral({
async function run() {
const result = await mistral.agents.complete({
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
agentId: "<value>",
});
Expand All @@ -41,7 +41,6 @@ async function run() {
run();
```


### Standalone function

The standalone function version of this method:
Expand All @@ -59,10 +58,10 @@ const mistral = new MistralCore({
async function run() {
const res = await agentsComplete(mistral, {
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
agentId: "<value>",
});
Expand All @@ -89,17 +88,18 @@ run();
| `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.ChatCompletionResponse](../../models/components/chatcompletionresponse.md)\>**

### Errors

| Error Object | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| errors.HTTPValidationError | 422 | application/json |
| errors.SDKError | 4xx-5xx | */* |


## stream

Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
Expand All @@ -116,10 +116,10 @@ const mistral = new Mistral({
async function run() {
const result = await mistral.agents.stream({
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
agentId: "<value>",
});
Expand All @@ -132,7 +132,6 @@ async function run() {
run();
```


### Standalone function

The standalone function version of this method:
Expand All @@ -150,10 +149,10 @@ const mistral = new MistralCore({
async function run() {
const res = await agentsStream(mistral, {
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
agentId: "<value>",
});
Expand Down Expand Up @@ -181,10 +180,10 @@ run();
| `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\<[EventStream<components.CompletionEvent>](../../models/.md)\>**

### Errors

| Error Object | Status Code | Content Type |
Expand Down
31 changes: 15 additions & 16 deletions docs/sdks/chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ async function run() {
const result = await mistral.chat.complete({
model: "mistral-small-latest",
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
});

Expand All @@ -41,7 +41,6 @@ async function run() {
run();
```


### Standalone function

The standalone function version of this method:
Expand All @@ -60,10 +59,10 @@ async function run() {
const res = await chatComplete(mistral, {
model: "mistral-small-latest",
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
});

Expand All @@ -89,17 +88,18 @@ run();
| `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.ChatCompletionResponse](../../models/components/chatcompletionresponse.md)\>**

### Errors

| Error Object | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| errors.HTTPValidationError | 422 | application/json |
| errors.SDKError | 4xx-5xx | */* |


## stream

Mistral AI provides the ability to stream responses back to a client in order to allow partial results for certain requests. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
Expand All @@ -117,10 +117,10 @@ async function run() {
const result = await mistral.chat.stream({
model: "mistral-small-latest",
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
});

Expand All @@ -132,7 +132,6 @@ async function run() {
run();
```


### Standalone function

The standalone function version of this method:
Expand All @@ -151,10 +150,10 @@ async function run() {
const res = await chatStream(mistral, {
model: "mistral-small-latest",
messages: [
{
{
content: "Who is the best French painter? Answer in one short sentence.",
role: "user",
},
role: "user",
},
],
});

Expand All @@ -181,10 +180,10 @@ run();
| `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\<[EventStream<components.CompletionEvent>](../../models/.md)\>**

### Errors

| Error Object | Status Code | Content Type |
Expand Down
7 changes: 3 additions & 4 deletions docs/sdks/embeddings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const mistral = new Mistral({

async function run() {
const result = await mistral.embeddings.create({
inputs: "<value>",
inputs: "<value>",
model: "Wrangler",
});

Expand All @@ -35,7 +35,6 @@ async function run() {
run();
```


### Standalone function

The standalone function version of this method:
Expand All @@ -52,7 +51,7 @@ const mistral = new MistralCore({

async function run() {
const res = await embeddingsCreate(mistral, {
inputs: "<value>",
inputs: "<value>",
model: "El Camino",
});

Expand All @@ -78,10 +77,10 @@ run();
| `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.EmbeddingResponse](../../models/components/embeddingresponse.md)\>**

### Errors

| Error Object | Status Code | Content Type |
Expand Down
Loading

0 comments on commit 85ad688

Please sign in to comment.