Skip to content
Merged
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
148 changes: 148 additions & 0 deletions pe/docs/AiChatControllerApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
# AiChatControllerApi

`ThingsboardClient` methods:

```
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(@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
```


## createChat

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

**POST** `/api/ai/chats`

createChat


### Parameters

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

### Return type

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


## deleteChat

```
void deleteChat(@Nonnull UUID chatId)
```

**DELETE** `/api/ai/chats/{chatId}`

deleteChat


### Parameters

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

### Return type

null (empty response body)


## getChatMessages

```
com.fasterxml.jackson.databind.JsonNode getChatMessages(@Nonnull UUID chatId)
```

**GET** `/api/ai/chats/{chatId}/messages`

getChatMessages


### Parameters

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

### Return type

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


## listChats

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

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

listChats


### Parameters

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

### Return type

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


## sendChatMessage

```
List<Object> sendChatMessage(@Nonnull UUID chatId, @Nonnull String xAuthorization, @Nonnull String body)
```

**POST** `/api/ai/chats/{chatId}/messages`

sendChatMessage


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **chatId** | **UUID** | | |
| **xAuthorization** | **String** | | |
| **body** | **String** | | |

### Return type

**List<Object>**


## updateChat

```
void updateChat(@Nonnull UUID chatId, @Nonnull Object body)
```

**PATCH** `/api/ai/chats/{chatId}`

updateChat


### Parameters

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

### Return type

null (empty response body)

230 changes: 230 additions & 0 deletions pe/docs/AiSolutionControllerApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
# 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 getSolution(@Nonnull UUID solutionId) // getSolution
com.fasterxml.jackson.databind.JsonNode getSolutions() // getSolutions
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)


## 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**


## 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**

Loading
Loading