Skip to content
98 changes: 49 additions & 49 deletions apps/docs/content/docs/en/cli/knowledge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ sim knowledge create [options]
## Create knowledge connector

```bash
sim knowledge connectors create <id> [options]
sim knowledge connectors create <knowledgeBaseId> [options]
```

**Arguments**
Expand All @@ -225,7 +225,7 @@ sim knowledge connectors create <id> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Unique knowledge base identifier. |
| `knowledgeBaseId` | Yes | Unique knowledge base identifier. |

</CommandTable>

Expand All @@ -246,7 +246,7 @@ sim knowledge connectors create <id> [options]
## Delete knowledge connector

```bash
sim knowledge connectors delete <id> <connectorId> [options]
sim knowledge connectors delete <knowledgeBaseId> <connectorId> [options]
```

**Arguments**
Expand All @@ -255,7 +255,7 @@ sim knowledge connectors delete <id> <connectorId> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Knowledge base that owns the connector. |
| `knowledgeBaseId` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>
Expand All @@ -275,7 +275,7 @@ sim knowledge connectors delete <id> <connectorId> [options]
## Get knowledge connector

```bash
sim knowledge connectors get <id> <connectorId>
sim knowledge connectors get <knowledgeBaseId> <connectorId>
```

**Arguments**
Expand All @@ -284,15 +284,15 @@ sim knowledge connectors get <id> <connectorId>

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Knowledge base that owns the connector. |
| `knowledgeBaseId` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>

## List knowledge connector documents

```bash
sim knowledge connectors documents list <id> <connectorId> [options]
sim knowledge connectors documents list <knowledgeBaseId> <connectorId> [options]
```

**Arguments**
Expand All @@ -301,7 +301,7 @@ sim knowledge connectors documents list <id> <connectorId> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Knowledge base that owns the connector. |
| `knowledgeBaseId` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>
Expand All @@ -318,10 +318,38 @@ sim knowledge connectors documents list <id> <connectorId> [options]

</CommandTable>

## Update knowledge connector documents

```bash
sim knowledge connectors documents update <knowledgeBaseId> <connectorId> [options]
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `knowledgeBaseId` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--operation <value>` | Yes | Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`. |
| `--document <value...>` | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line). |

</CommandTable>

## List knowledge connectors

```bash
sim knowledge connectors list <id> [options]
sim knowledge connectors list <knowledgeBaseId> [options]
```

**Arguments**
Expand All @@ -330,7 +358,7 @@ sim knowledge connectors list <id> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Unique knowledge base identifier. |
| `knowledgeBaseId` | Yes | Unique knowledge base identifier. |

</CommandTable>

Expand All @@ -346,10 +374,10 @@ sim knowledge connectors list <id> [options]

</CommandTable>

## Update knowledge connector
## Queue a knowledge connector synchronization

```bash
sim knowledge connectors update <id> <connectorId> [options]
sim knowledge connectors sync <knowledgeBaseId> <connectorId> [options]
```

**Arguments**
Expand All @@ -358,7 +386,7 @@ sim knowledge connectors update <id> <connectorId> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Knowledge base that owns the connector. |
| `knowledgeBaseId` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>
Expand All @@ -369,16 +397,15 @@ sim knowledge connectors update <id> <connectorId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `--source-config <json\|@file>` | No | Replacement source selection and filtering configuration. (JSON, or @path / @- to read a file or stdin). |
| `--sync-interval-minutes <value>` | No | New scheduled synchronization interval in minutes. |
| `--status <value>` | No | New connector state. Accepted values: `active`, `paused`. |
| `--rehydrate` | No | Re-fetch and re-index every existing connector document. |
| `--no-rehydrate` | No | Send --rehydrate as false. |

</CommandTable>

## Update knowledge connector documents
## Update knowledge connector

```bash
sim knowledge connectors documents update <id> <connectorId> [options]
sim knowledge connectors update <knowledgeBaseId> <connectorId> [options]
```

**Arguments**
Expand All @@ -387,7 +414,7 @@ sim knowledge connectors documents update <id> <connectorId> [options]

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Knowledge base that owns the connector. |
| `knowledgeBaseId` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>
Expand All @@ -398,8 +425,9 @@ sim knowledge connectors documents update <id> <connectorId> [options]

| Option | Required | Description |
| --- | --- | --- |
| `--operation <value>` | Yes | Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`. |
| `--document <value...>` | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line). |
| `--source-config <json\|@file>` | No | Replacement source selection and filtering configuration. Updating a runnable connector queues synchronization; paused connectors remain paused. (JSON, or @path / @- to read a file or stdin). |
| `--sync-interval-minutes <value>` | No | New scheduled synchronization interval in minutes. |
| `--status <value>` | No | New connector state. Accepted values: `active`, `paused`. |

</CommandTable>

Expand Down Expand Up @@ -588,34 +616,6 @@ sim knowledge search [options]

</CommandTable>

## Sync knowledge connector

```bash
sim knowledge sync create <id> <connectorId> [options]
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Knowledge base that owns the connector. |
| `connectorId` | Yes | Connector selected for the operation. |

</CommandTable>

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--rehydrate` | No | Re-fetch and re-index every existing connector document. |
| `--no-rehydrate` | No | Send --rehydrate as false. |

</CommandTable>

## Update knowledge base

```bash
Expand Down
Loading
Loading