duo-chat-evaluation / README.md
khulnasoft's picture
Upload 15 files
0d914ec verified
# AI Evaluation Data
## Getting started
This repo contains datasets used to evaluate the quality of AI features we are developing at GitLab.
We follow a similar approach to HuggingFace and store the datasets as LFS objects under the `data` folder.
## Datasets
### AI Feature: Duo Chat
#### Context dataset
| Field name | Type | Additional notes |
|----------------|------------------|--------------------------------------------------------------|
| `context_id` | STRING | Valid UUIDs, generated as `uuid4().hex` in Python |
| `context` | STRING | JSON string describing one of the GitLab resources |
| `context_type` | STRING | GitLab resource type, either `issue` or `epic` |
| `referer_url` | STRING, NULLABLE | Not used in this iteration, added for Chat API compatibility |
#### Queries dataset
| Field name | Type | Additional notes |
|-----------------|------------------|--------------------------------------------------------------|
| `query_id` | STRING | Valid UUIDs, generated as `uuid4().hex` in Python |
| `query` | STRING | User query submitted to Duo Chat |
| `context` | STRING | JSON string describing one of the GitLab resources |
| `resource_id` | INT, NULLABLE | GitLab global resource identifier |
| `resource_type` | STRING | GitLab resource type, either `issue` or `epic` |
| `referer_url` | STRING, NULLABLE | Not used in this iteration, added for Chat API compatibility |
#### Code generations
| Field name | Type | Additional notes |
|-----------------|------------------|--------------------------------------------------------------|
| `query_id` | STRING | Valid UUIDs, generated as `uuid4().hex` in Python |
| `query` | STRING | User query submitted to Duo Chat |
## Usage
Refer to a specific commit SHA1 if you need to get a concrete revision of the dataset.
```shell
GIT_LFS_SKIP_SMUDGE=1 git clone $URL
git reset --hard $SHA1
git lfs pull
```
## Authors
- Alexander Chueshev - achueshev@gitlab.com
- Bruno Cardoso - bcardoso@gitlab.com
- David O'Regan - doregan@gitlab.com