Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions paas/docs/AiChatControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
com.fasterxml.jackson.databind.JsonNode createChat(@Nonnull Object body) // createChat
void deleteChat(@Nonnull UUID chatId) // deleteChat
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId) // getChatMessages
com.fasterxml.jackson.databind.JsonNode listChats() // listChats
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType) // listChats
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body) // sendChatMessage
void updateChat(@Nonnull UUID chatId, @Nonnull Object body) // updateChat
```
Expand Down Expand Up @@ -81,13 +81,20 @@ getChatMessages
## listChats

```
com.fasterxml.jackson.databind.JsonNode listChats()
com.fasterxml.jackson.databind.JsonNode listChats(@Nonnull ChatType chatType)
```

**GET** `/api/ai/chats`
**GET** `/api/ai/chats/{chatType}`

listChats


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **chatType** | **ChatType** | | [enum: GENERIC, SOLUTION_BUILDER] |

### Return type

**com.fasterxml.jackson.databind.JsonNode**
Expand Down
276 changes: 276 additions & 0 deletions paas/docs/AiSolutionControllerApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
# AiSolutionControllerApi

`ThingsboardClient` methods:

```
com.fasterxml.jackson.databind.JsonNode chat(@Nonnull UUID solutionId, @Nonnull SolutionStep step, @Nonnull String body) // chat
void clearStep(@Nonnull UUID solutionId, @Nonnull SolutionStep step) // clearStep
com.fasterxml.jackson.databind.JsonNode createSolution(@Nonnull UUID solutionId) // createSolution
void deleteSolution(@Nonnull UUID solutionId) // deleteSolution
com.fasterxml.jackson.databind.JsonNode exportSolution(@Nonnull UUID solutionId) // exportSolution
com.fasterxml.jackson.databind.JsonNode getSolution(@Nonnull UUID solutionId) // getSolution
com.fasterxml.jackson.databind.JsonNode getSolutions() // getSolutions
com.fasterxml.jackson.databind.JsonNode importSolution(@Nonnull Object body) // importSolution
com.fasterxml.jackson.databind.JsonNode installSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization) // installSolution
com.fasterxml.jackson.databind.JsonNode startNew() // startNew
com.fasterxml.jackson.databind.JsonNode uninstallSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization) // uninstallSolution
com.fasterxml.jackson.databind.JsonNode updateData(@Nonnull UUID solutionId, @Nonnull String dataKey, @Nonnull Object body) // updateData
```


## chat

```
com.fasterxml.jackson.databind.JsonNode chat(@Nonnull UUID solutionId, @Nonnull SolutionStep step, @Nonnull String body)
```

**POST** `/api/ai/solution/{solutionId}/{step}/chat`

chat


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |
| **step** | **SolutionStep** | | [enum: INITIAL_CONFIGURATION, DASHBOARDS_CONFIGURATION] |
| **body** | **String** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## clearStep

```
void clearStep(@Nonnull UUID solutionId, @Nonnull SolutionStep step)
```

**DELETE** `/api/ai/solution/{solutionId}/{step}/clear`

clearStep


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |
| **step** | **SolutionStep** | | [enum: INITIAL_CONFIGURATION, DASHBOARDS_CONFIGURATION] |

### Return type

null (empty response body)


## createSolution

```
com.fasterxml.jackson.databind.JsonNode createSolution(@Nonnull UUID solutionId)
```

**POST** `/api/ai/solution/{solutionId}/create`

createSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## deleteSolution

```
void deleteSolution(@Nonnull UUID solutionId)
```

**DELETE** `/api/ai/solution/{solutionId}`

deleteSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |

### Return type

null (empty response body)


## exportSolution

```
com.fasterxml.jackson.databind.JsonNode exportSolution(@Nonnull UUID solutionId)
```

**GET** `/api/ai/solution/{solutionId}/export`

exportSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## getSolution

```
com.fasterxml.jackson.databind.JsonNode getSolution(@Nonnull UUID solutionId)
```

**GET** `/api/ai/solution/{solutionId}`

getSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## getSolutions

```
com.fasterxml.jackson.databind.JsonNode getSolutions()
```

**GET** `/api/ai/solution/infos`

getSolutions

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## importSolution

```
com.fasterxml.jackson.databind.JsonNode importSolution(@Nonnull Object body)
```

**POST** `/api/ai/solution/import`

importSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **body** | **Object** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## installSolution

```
com.fasterxml.jackson.databind.JsonNode installSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization)
```

**POST** `/api/ai/solution/{solutionId}/install`

installSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |
| **xAuthorization** | **String** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## startNew

```
com.fasterxml.jackson.databind.JsonNode startNew()
```

**POST** `/api/ai/solution/start`

startNew

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## uninstallSolution

```
com.fasterxml.jackson.databind.JsonNode uninstallSolution(@Nonnull UUID solutionId, @Nonnull String xAuthorization)
```

**DELETE** `/api/ai/solution/{solutionId}/uninstall`

uninstallSolution


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |
| **xAuthorization** | **String** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**


## updateData

```
com.fasterxml.jackson.databind.JsonNode updateData(@Nonnull UUID solutionId, @Nonnull String dataKey, @Nonnull Object body)
```

**PUT** `/api/ai/solution/{solutionId}/{dataKey}`

updateData


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **solutionId** | **UUID** | | |
| **dataKey** | **String** | | |
| **body** | **Object** | | |

### Return type

**com.fasterxml.jackson.databind.JsonNode**

1 change: 0 additions & 1 deletion paas/docs/CalculatedFieldConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
|------------ | ------------- | ------------- | -------------|
| **type** | **String** | | |
| **output** | **Output** | | [optional] |
| **aiGenerated** | **Boolean** | | [optional] |



Expand Down
23 changes: 23 additions & 0 deletions paas/docs/ChatType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

# ChatType

`org.thingsboard.client.model.ChatType`

## Enum Values


* `GENERIC` (value: `"GENERIC"`)

* `SOLUTION_BUILDER` (value: `"SOLUTION_BUILDER"`)



---

### Conventions

- **Package:** `org.thingsboard.client.model`
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions

2 changes: 1 addition & 1 deletion paas/docs/Resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@

* `AI_MODEL` (value: `"AI_MODEL"`)

* `AI_SOLUTION_CREATOR` (value: `"AI_SOLUTION_CREATOR"`)
* `AI` (value: `"AI"`)

* `API_KEY` (value: `"API_KEY"`)

Expand Down
1 change: 1 addition & 0 deletions paas/docs/RuleChainMetaData.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ A JSON value representing the rule chain metadata.
| **nodes** | **List\<RuleNode\>** | List of rule node JSON objects | |
| **connections** | **List\<NodeConnectionInfo\>** | List of JSON objects that represent connections between rule nodes | |
| **ruleChainConnections** | **List\<RuleChainConnectionInfo\>** | List of JSON objects that represent connections between rule nodes and other rule chains. | |
| **notes** | **List\<RuleChainNote\>** | List of sticky notes placed on the rule chain canvas | [optional] |



Expand Down
32 changes: 32 additions & 0 deletions paas/docs/RuleChainNote.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

# RuleChainNote

`org.thingsboard.client.model.RuleChainNote`

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **id** | **String** | Unique identifier of the note on the canvas | [optional] |
| **x** | **Integer** | Horizontal position of the note on the canvas, in pixels | [optional] |
| **y** | **Integer** | Vertical position of the note on the canvas, in pixels | [optional] |
| **width** | **Integer** | Width of the note, in pixels | [optional] |
| **height** | **Integer** | Height of the note, in pixels | [optional] |
| **content** | **String** | Markdown or HTML content of the note | [optional] |
| **backgroundColor** | **String** | Background color of the note in CSS hex format, e.g. '#FFF9C4' | [optional] |
| **borderColor** | **String** | Border color of the note in CSS hex format, e.g. '#E6C800' | [optional] |
| **borderWidth** | **Integer** | Border width of the note in pixels | [optional] |
| **applyDefaultMarkdownStyle** | **Boolean** | Whether to apply the default markdown stylesheet to the note content | [optional] |
| **markdownCss** | **String** | Custom CSS styles applied to the note content | [optional] |



---

### Conventions

- **Package:** `org.thingsboard.client.model`
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions

2 changes: 1 addition & 1 deletion paas/docs/ShortCustomerInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
| **customerId** | **CustomerId** | JSON object with the customer Id. | [optional] |
| **title** | **String** | Title of the customer. | [optional] |
| **isPublic** | **Boolean** | Indicates special 'Public' customer used to embed dashboards on public websites. | [optional] |
| **_public** | **Boolean** | Indicates special 'Public' customer used to embed dashboards on public websites. | [optional] |



Expand Down
Loading
Loading