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
chore: regenerate the API reference, CLI surface, and CLI docs
Carries the contract wording and the new bulk-document response shape into
the published reference, the generated command surface, and the command
pages.
|`--file-ids <value...>`| Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
25
-
|`-y, --yes`| Yes | Confirm this destructive operation. |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/cli/knowledge.mdx
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,7 +120,7 @@ Delete Tag (personal API key required)
120
120
121
121
| Option | Required | Description |
122
122
| --- | --- | --- |
123
-
|`-y, --yes`| Yes | Confirm this destructive operation. |
123
+
|`-y, --yes`| Yes | Confirm this operation. |
124
124
125
125
</CommandTable>
126
126
@@ -150,7 +150,7 @@ Remove tag definitions no document still uses (personal API key required)
150
150
| --- | --- | --- |
151
151
|`--unused`| No | Whether to remove only the tag definitions no document in the knowledge base still carries a value for. Defaults to true. Pass --no-unused to delete every definition on the knowledge base, which also clears its slot on every document and chunk and is not recoverable. |
152
152
|`--no-unused`| No | Send --unused as false. |
153
-
|`-y, --yes`| Yes | Confirm this destructive operation. |
153
+
|`-y, --yes`| Yes | Confirm this operation. |
154
154
155
155
</CommandTable>
156
156
@@ -273,7 +273,7 @@ Enable, disable, or delete many chunks at once (personal API key required)
273
273
| --- | --- | --- |
274
274
|`--operation <value>`| Yes | What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`. |
275
275
|`--chunk <value...>`| Yes | Chunks to operate on, by identifier. An id naming no chunk in the document is reported in errors and does not fail the request. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
276
-
|`-y, --yes`| Yes | Confirm this destructive operation. |
276
+
|`-y, --yes`| Yes | Confirm this operation. |
277
277
278
278
</CommandTable>
279
279
@@ -334,7 +334,7 @@ Delete Chunk (personal API key required)
334
334
335
335
| Option | Required | Description |
336
336
| --- | --- | --- |
337
-
|`-y, --yes`| Yes | Confirm this destructive operation. |
|`-y, --yes`| Yes | Confirm this destructive operation. |
972
+
|`-y, --yes`| Yes | Confirm this operation. |
973
973
974
974
</CommandTable>
975
975
@@ -985,7 +985,7 @@ sim knowledge get <knowledgeBaseId>
985
985
986
986
| Argument | Required | Description |
987
987
| --- | --- | --- |
988
-
|`knowledgeBaseId`| Yes |Unique knowledge base identifier. |
988
+
|`knowledgeBaseId`| Yes |Knowledge base to read. Active knowledge bases only: an archived one answers 404 here, is listed by `scope=archived`, and is brought back by the restore endpoint. |
989
989
990
990
</CommandTable>
991
991
@@ -1001,7 +1001,7 @@ sim knowledge list [options]
1001
1001
1002
1002
| Option | Required | Description |
1003
1003
| --- | --- | --- |
1004
-
|`--scope <value>`| No | Which lifecycle set to list: `active` (default) for live knowledge bases, `archived` for knowledge bases a `DELETE` archived and `POST /knowledge/{knowledgeBaseId}/restore`can bring back. `folderPath`resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. |
1004
+
|`--scope <value>`| No | Which lifecycle set to list: `active` (default) for live knowledge bases, `archived` for knowledge bases a delete archived and the restore operation can bring back. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. |
1005
1005
|`--folder <value>`| No | Folder path as shown in the app; the leading / is optional. |
1006
1006
|`--search <value>`| No | Case-insensitive substring match against the resource name. |
1007
1007
|`--sort-by <value>`| No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/cli/logs.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ sim logs get <runId> [options]
21
21
22
22
| Argument | Required | Description |
23
23
| --- | --- | --- |
24
-
|`runId`| Yes | Unique workflow run identifier. |
24
+
|`runId`| Yes | Unique workflow run identifier. A run is addressed globally by this id: unlike the list and statistics routes, this route takes no workspace. The run carries its own workspace and the caller is authorized against that one, so a run the caller cannot reach is concealed as a 404 rather than filtered out. |
25
25
26
26
</CommandTable>
27
27
@@ -35,7 +35,7 @@ sim logs get <runId> [options]
35
35
36
36
</CommandTable>
37
37
38
-
## Summarize run counts, failures, and cost over a window
38
+
## Summarize run counts, failures and latency over a window
0 commit comments