You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -261,7 +262,8 @@ We have dedicated SDKs for the following providers:
261
262
### [Beta.Agents](docs/sdks/betaagents/README.md)
262
263
263
264
*[create](docs/sdks/betaagents/README.md#create) - Create a agent that can be used within a conversation.
264
-
*[list](docs/sdks/betaagents/README.md#list) - List agent entities.
265
+
*[~~list~~](docs/sdks/betaagents/README.md#list) - List agent entities. :warning:**Deprecated** Use [listPages](docs/sdks/betaagents/README.md#listpages) instead.
266
+
*[listPages](docs/sdks/betaagents/README.md#listpages) - List agent entities, cursor-paginated.
265
267
*[get](docs/sdks/betaagents/README.md#get) - Retrieve an agent entity.
266
268
*[update](docs/sdks/betaagents/README.md#update) - Update an agent entity.
267
269
*[delete](docs/sdks/betaagents/README.md#delete) - Delete an agent entity.
@@ -293,6 +295,7 @@ We have dedicated SDKs for the following providers:
293
295
*[createOrUpdateWorkspaceCredentials](docs/sdks/connectors/README.md#createorupdateworkspacecredentials) - Create or update workspace credentials for a connector.
294
296
*[listUserCredentials](docs/sdks/connectors/README.md#listusercredentials) - List user credentials for a connector.
295
297
*[createOrUpdateUserCredentials](docs/sdks/connectors/README.md#createorupdateusercredentials) - Create or update user credentials for a connector.
298
+
*[deleteAllUserCredentials](docs/sdks/connectors/README.md#deleteallusercredentials) - Delete all user credentials for a connector.
296
299
*[deleteOrganizationCredentials](docs/sdks/connectors/README.md#deleteorganizationcredentials) - Delete organization credentials for a connector.
297
300
*[deleteWorkspaceCredentials](docs/sdks/connectors/README.md#deleteworkspacecredentials) - Delete workspace credentials for a connector.
298
301
*[deleteUserCredentials](docs/sdks/connectors/README.md#deleteusercredentials) - Delete user credentials for a connector.
@@ -452,9 +455,13 @@ We have dedicated SDKs for the following providers:
452
455
*[unregister](docs/sdks/searchindexes/README.md#unregister) - Unregister Search Index
453
456
*[updateIndexMetrics](docs/sdks/searchindexes/README.md#updateindexmetrics) - Update Index Metrics
454
457
*[getIndexDetail](docs/sdks/searchindexes/README.md#getindexdetail) - Get Index Details
458
+
*[getIndexSummary](docs/sdks/searchindexes/README.md#getindexsummary) - Get Index Summary
459
+
*[generateIndexSummary](docs/sdks/searchindexes/README.md#generateindexsummary) - Generate a summary field for an index
455
460
*[setIndexSummary](docs/sdks/searchindexes/README.md#setindexsummary) - Set Index Summary
456
-
*[getIndexSchemaDetail](docs/sdks/searchindexes/README.md#getindexschemadetail) - Get Index Schema Detail
461
+
*[getSchemaSummary](docs/sdks/searchindexes/README.md#getschemasummary) - Get Schema Summary
462
+
*[generateSchemaSummary](docs/sdks/searchindexes/README.md#generateschemasummary) - Generate a summary field for a schema
457
463
*[setSchemaSummary](docs/sdks/searchindexes/README.md#setschemasummary) - Set Schema Summary
464
+
*[getIndexSchemaDetail](docs/sdks/searchindexes/README.md#getindexschemadetail) - Get Index Schema Detail
458
465
*[getIndexSchemaFile](docs/sdks/searchindexes/README.md#getindexschemafile) - Get Index Schema File
<!-- End Server-sent event streaming [eventstream] -->
643
650
651
+
<!-- Start Json Streaming [jsonl] -->
652
+
## Json Streaming
653
+
654
+
Json Streaming ([jsonl][jsonl-format] / [x-ndjson][x-ndjson]) content type can be used to stream content from certain operations. These operations expose the stream as an [AsyncGenerator][async-generator] that can be consumed using a `for await...of` loop in TypeScript/JavaScript. The loop will terminate when the server no longer has any events to send and closes the underlying connection.
655
+
656
+
Here's an example of consuming a JSONL stream:
657
+
658
+
```typescript
659
+
import { Mistral } from"@mistralai/mistralai";
660
+
661
+
const mistral =newMistral({
662
+
apiKey: process.env["MISTRAL_API_KEY"] ??"",
663
+
});
664
+
665
+
asyncfunction run() {
666
+
const result =awaitmistral.beta.rag.searchIndexes.generateIndexSummary({
**Inherit from [`MistralError`](./src/models/errors/mistralerror.ts)**:
853
-
*[`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 146 of 243 methods.*
854
-
*[`ObservabilityError`](./src/models/errors/observabilityerror.ts): Bad Request - Invalid request parameters or data. Applicable to 57 of 243 methods.*
895
+
*[`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 152 of 249 methods.*
896
+
*[`ObservabilityError`](./src/models/errors/observabilityerror.ts): Bad Request - Invalid request parameters or data. Applicable to 57 of 249 methods.*
855
897
*[`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
856
898
857
899
</details>
@@ -866,17 +908,19 @@ run();
866
908
867
909
You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
@@ -1039,7 +1104,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
1039
1104
-[`betaAgentsDeleteVersionAlias`](docs/sdks/betaagents/README.md#deleteversionalias) - Delete an agent version alias.
1040
1105
-[`betaAgentsGet`](docs/sdks/betaagents/README.md#get) - Retrieve an agent entity.
1041
1106
-[`betaAgentsGetVersion`](docs/sdks/betaagents/README.md#getversion) - Retrieve a specific version of an agent.
1042
-
-[`betaAgentsList`](docs/sdks/betaagents/README.md#list) - List agent entities.
1107
+
-[`betaAgentsListPages`](docs/sdks/betaagents/README.md#listpages) - List agent entities, cursor-paginated.
1043
1108
-[`betaAgentsListVersionAliases`](docs/sdks/betaagents/README.md#listversionaliases) - List all aliases for an agent.
1044
1109
-[`betaAgentsListVersions`](docs/sdks/betaagents/README.md#listversions) - List all versions of an agent.
1045
1110
-[`betaAgentsUpdate`](docs/sdks/betaagents/README.md#update) - Update an agent entity.
@@ -1056,6 +1121,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
1056
1121
-[`betaConnectorsDeactivateForUser`](docs/sdks/connectors/README.md#deactivateforuser) - Deactivate a connector for the current user.
1057
1122
-[`betaConnectorsDeactivateForWorkspace`](docs/sdks/connectors/README.md#deactivateforworkspace) - Deactivate a connector for a workspace.
1058
1123
-[`betaConnectorsDelete`](docs/sdks/connectors/README.md#delete) - Delete a connector.
1124
+
-[`betaConnectorsDeleteAllUserCredentials`](docs/sdks/connectors/README.md#deleteallusercredentials) - Delete all user credentials for a connector.
1059
1125
-[`betaConnectorsDeleteOrganizationCredentials`](docs/sdks/connectors/README.md#deleteorganizationcredentials) - Delete organization credentials for a connector.
1060
1126
-[`betaConnectorsDeleteUserCredentials`](docs/sdks/connectors/README.md#deleteusercredentials) - Delete user credentials for a connector.
1061
1127
-[`betaConnectorsDeleteWorkspaceCredentials`](docs/sdks/connectors/README.md#deleteworkspacecredentials) - Delete workspace credentials for a connector.
@@ -1169,10 +1235,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
1169
1235
-[`betaRagIngestionPipelineConfigurationsUpdateRunInfo`](docs/sdks/ingestionpipelineconfigurations/README.md#updateruninfo) - Update Run Info
-~~[`betaAgentsList`](docs/sdks/betaagents/README.md#list)~~ - List agent entities. :warning:**Deprecated** Use [`betaAgentsListPages`](docs/sdks/betaagents/README.md#listpages) instead.
1260
1331
-~~[`betaLibrariesDocumentsLibrariesDocumentsUpdateV1`](docs/sdks/documents/README.md#librariesdocumentsupdatev1)~~ - Update the metadata of a specific document. :warning:**Deprecated**
1261
1332
-~~[`betaLibrariesLibrariesUpdateV1`](docs/sdks/libraries/README.md#librariesupdatev1)~~ - Update a library. :warning:**Deprecated**
0 commit comments