task_categories:summarization task_categories:text-generation task_categories:text2text-generation size_categories:n<1K language:en license:mit applescript code region:us
---
dataset_info:
  features:
  - name: text
    dtype: string
  - name: source
    dtype: string
  - name: type
    dtype: string
  - name: intents
    sequence: string
  - name: tags
    sequence: string
  - name: description
    dtype: string
  - name: customTerms
    sequence: string
  - name: main_prompt
    dtype: string
  - name: other_prompts
    sequence: string
  splits:
  - name: train
    num_bytes: 345695.0
    num_examples: 510
  download_size: 123493
  dataset_size: 345695.0
license: mit
task_categories:
- summarization
- text-generation
- text2text-generation
language:
- en
tags:
- applescript
- code
pretty_name: ASLines
size_categories:
- n<1K
---
# Dataset Card for "applescript-lines-annotated"

## Description

This is a dataset of single lines of AppleScript code scraped from GitHub and GitHub Gist and manually annotated with descriptions, intents, prompts, and other metadata.

## Content

Each row contains 8 features:

- `text` - The raw text of the AppleScript code.
- `source` - The name of the file from which the line originates.
- `type` - Either `compiled` (files using the `.scpt` extension) or `uncompiled` (everything else).
- `intents` - A list of intents the line invokes. See [Intents](#intents) for more info.
- `tags` - A list of tags associated with the line. See [Tags](#tags) for more info.
- `description` - One or more sentences describing what the line does, what its purpose is, and other relevant context.
- `customTerms` - A list of the custom terms used in the line, such as variable or handler names.
- `main_prompt` - A relevant prompt specific to the line.
- `other_prompts` - A list of prompts relevant to the line (but not necessarily specific to it).

### Intents

Intents describe the actions carried out by a line of code, i.e. what the line *does*. All intents used are listed below.

| Intent | Example Line |
| ----- | ----- |
| set property | `property myProperty: 5` |
| set variable | `set myVariable to 5` |
| begin handler definition | `on makePDF(title, content)` |
| end handler definition | `end makePDF` |
| call handler | `my makePDF("Example Title", "Example content") |
| perform action on script execution | `on run` |
| access value of property | `log myProperty` |
| access value of variable | `log myVariable` |
| get substring | `text 2 thru end of "Hello"` |
| concatenate strings | "Hello" & " world" |
| check condition | `if x > 4 then` |
| end condition | `end if` |
| begin instructions | `tell application "System Events"` |
| end instructions | `end tell` |
| interact with user interface | `click at {100, 200}` |
| pause | `delay 2` |
| begin error handling | `try` |
| end error handling | `end try` |
| perform action | `open location "https://google.com"` |
| begin repetition | `repeat with i from 1 thru 5` |
| end repetition | `end repeat` |
| filter list | `set t to tracks whose unplayed is true` |
| return | `return 5` |
| import library | `use framework "Foundation"` |
| display UI element | `display dialog "Test"` |
| open file | `set f to open for access filePath` |
| close file | `close access f` |
| begin script definition | `script myScript` |
| end script definition | `end script` |
| declare variable | `local x, y` |
| handle error | `on error err` |

### Tags

Tags described what a line *is* or what it *contains*. All tags used are listed below.

- contains handler
- contains list
- contains property
- contains variable
- start of block
- complete statement
- contains raw text
- contains location specifier
- contains condition
- contains number
- end of block
- contains boolean
- gui scripting
- contains comment
- contains cast
- AsOBjC
- shebang
- contains script object
- contains record

## Usage

This dataset was created for the AppleScript-Summarizer model as a personal project, but it can be used by others for any purpose.