<h1 align="center">
  Carbon AI Chat (Beta)
</h1>

> Carbon AI Chat is an opinionated but extensible full fledged chat application. It is available as a React or web component.
>
> The Carbon AI Chat is a combination of the watsonx Assistant, watsonx Orchestrate and Carbon Labs AI Chat projects. As this combination matures and as feedback from other implementing teams is gather, this project will be labeled as "beta" status.
>
> Don't let that stop you from using it in production, it is currently being used in production in watsonx Assistant and Orchestrate, just be sure to lock to an exact version as this project won't follow semantic versioning for breaking changes until the `1.0.0` release.

## Getting started

```bash
npm install @carbon/ai-chat
```

or

```bash
yarn add @carbon/ai-chat
```

This will install the package that contains both the web component and React versions of the chat application.


## Documentation

- [See our documentation site](https://web-chat.global.assistant.watson.cloud.ibm.com/carbon-chat.html).
- [See examples in React](https://github.com/carbon-design-system/carbon-ai-chat/tree/main/examples/react).
- [See examples as a web component](https://github.com/carbon-design-system/carbon-ai-chat/tree/main/examples/web-components).

## Contributing

Coming soon. This project will be inner-sourced for IBMers.