# Chat

> Resource Chat in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Resource Chat in pulumi-portainer.

Pulumi type: `portainer:index/chat:Chat`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const resource = new portainer.Chat("chat", {
  context: "<context>",
  environmentId: 0,
  message: "<message>",
})
```

## Arguments

| Property        | Type     | Required | Description                                                                     |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------- |
| `chatId`        | `string` | no       |                                                                                 |
| `context`       | `string` | yes      | Conversation context identifier passed to the Portainer chat assistant.         |
| `environmentId` | `number` | yes      | Identifier of the Portainer environment the chat request is scoped to.          |
| `message`       | `string` | yes      | User prompt sent to the Portainer chat assistant.                               |
| `model`         | `string` | no       | AI model name used to generate the chat response (defaults to `gpt-3.5-turbo`). |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property          | Type     | Computed | Description                                                                     |
| ----------------- | -------- | -------- | ------------------------------------------------------------------------------- |
| `chatId`          | `string` | no       |                                                                                 |
| `context`         | `string` | no       | Conversation context identifier passed to the Portainer chat assistant.         |
| `environmentId`   | `number` | no       | Identifier of the Portainer environment the chat request is scoped to.          |
| `message`         | `string` | no       | User prompt sent to the Portainer chat assistant.                               |
| `model`           | `string` | no       | AI model name used to generate the chat response (defaults to `gpt-3.5-turbo`). |
| `responseMessage` | `string` | yes      | Textual response returned by the Portainer chat assistant.                      |
| `responseYaml`    | `string` | yes      | YAML manifest extracted from the chat response, when applicable.                |