Metadata-Version: 2.4
Name: arkadia-ai-data
Version: 0.1.0
Summary: Arkadia AI Data Format (AID) - A versatile data serialization format optimized for AI applications.
Author-email: Arkadiusz Klemenko <arek.klemenko@gmail.com>
License-File: LICENCE
Requires-Python: >=3.10
Requires-Dist: dotenv>=0.9.9
Requires-Dist: openai>=2.14.0
Requires-Dist: pytest>=9.0.2
Requires-Dist: tiktoken>=0.12.0
Requires-Dist: toon-format
Description-Content-Type: text/markdown

# AI.DATA-FORMAT

```

                             :SB@MMWBZSr,
                         ,irXX7ri, iaBWMMMMM@a:    :,
                    i2WMMMMMMMMMMMM@a:7ZZWMMMMM@7 :i,02,
                 ,7S7;i::i;72Z2S0@ZZWMW;r7iBWWM@M2 rM0BM;
                   ia@@08Z0B2:  :,i0r rBZ,: XSBMZM: 2MMMMi
                 iBZ7i:,   iXZZSi   i;  ia   ;:@22: ;M@MMS
                 ,:    ,, ,7:  ,Xi  ;r,   :   ,SS,  rBZ8MiX7,
             r8WZ: XW@0Z8WMZ: rX: :M2;BZ ;r:   ;,   ::Si;ii   :7
          :8MM@a,:@0:      XM2  , i@WZMZ 28MMMBr     , :ZW@a  iB@;
        ,Z0MMWZi BB  ,aZ8i      S7,,  ;SXZMMMMMMMa::r ,         7M8,
        :;MMZ:   8Z  :07Z7   @X XaSa,:8MMMM2ZMMMMMMM@MS   i2 ,BX :WW:
        iM0:  ,X,i8r        XM:,S7a; XZWMMMM2,8MMMMMWr8M2, iS,    ,B@:
        87  iB0:,,,XZX,  XW S@    ,;aZ00ZZ2SX7,:S8082,iM00, :i  ar ,WW,
        : :0MB@Zi,,      iM2 Sr :;Xriirr:  ZM8      ,XBM@X   :   ,: i@a
         rMMMW0X:  8Z     : ;a00Z7,,2BMMWBZXi  :,   iaWMMMMB7    :;  2Wi
        rMMBr     ZW ,i   rW7a00Z702 78@MMMMMMMM0@MMM@@@MMMMMM0r     iWS
       :MZ,  ,7: ;M2;Zii,:MrB,   2S07 ZZ8BZ,XB0WMMMMMMMMW280BWWWW8i   8Z
       S:  ,ZZ   XMZW:rr, Z;B:  ,ZXSi S2222XXX7ZBZ;:BMMM@X:   irr:    ZZ
          ;MZ;   rMMX   : ,27XZZS;S;     ii    ,i,ZMMMMMMMMM@7  ,8Z   aa
         ;MM0: ,  BMi  iS   ,irr;:;, :7,,Wa S8Z,,aXMZWBBMMMMMMS:MM8  ,ZX
        ,WMM0,2   :@,  0rr        ;@Br2,7S ::r7,ir;rr8ZZMMMMMMSiMMa  ;ai
        rMMM8a7    ,:  @0:  ,:    ,   ,         ,Z222X77@MW02i iZW: ,SX
        X@SM0@:        BB   ;r   :S     ,;7XS77; ,XZZZZ82r, :;i ,,  ;X:
        ;riMMM:  , r , ;0 ,:7Z  ;SS   ;     ,       ,:  iZ@MMMMM2
           8MM;  ; Z ;i ;, XrMi  B8   X7 , ,7        ,XZWMMMMMM@B
           ,WM2  7;87:8    XXMW, ,Bi ;7@i i Z     ,;2aa8MWWMMMM02
            ,B@, :ZaMiBX   :ZBMWr, ;  XB@iiXX2::     Xa7;80Z@0a :
              X8  r8WMaMr   iZ0MM0,    ,X@;;ZWX8       :S; 7:
               ,i  rBWMMMr   :X;WM@r      ir:0@W0
                    ,0@MMM2    : ;BMWi        7@MW:
                      :0MMMWi       ;aBS:       i8MZ:
                         XBMMW;                    ,;r,
                            iS0@8;


   Arkadia AI DATA TOOL
   --------------------------------------------------
   Unified interface for AI Data Format operations (Encoding,
   Decoding, Benchmarking).

   Version:     1.2.0
   Model:       gpt-4o-mini
   Repeats:     50
   Data Dir:    data


USAGE:
   aid <command> [flags]

COMMANDS:
   enc             [ENCODE] Convert JSON/YAML/TOON to AI.Data format
   dec             [DECODE] Parse AI.Data format back to JSON
   benchmark       [BENCHMARK] Run performance and token usage tests
   ai-benchmark    [AI] Run AI understanding tests

GLOBAL OPTIONS:
   -h, --help       Show this help message
   -v, --version    Show version info
```


This document describes the **actual**, **implemented**, **non-future** syntax of AI.DATA-FORMAT.

Only the following features are included:

* Type definitions
* Positional records
* Named records
* Lists
* Multiline text
* Comments 

Nothing else exists in the current version.

---

## 1. Type Definition

A type defines a name and an ordered list of fields.

```aid
User</comment/ ={(23,"A",3) #tag1 #tag2} %[{ id: 4, b: "a", c: 43}]: id:number,
b: string , c:number, >
@Users
<
 @list 
 a: number,
 b: string
>
[
  @size=5
  /example list of values/

  (1,`text`,5)
  (2,`Text can be

multiline
`,5)
  {
    id:3,
    b: "text"
  }
]
```



Rules:

* The type name (`Name`) is optional but recommended.
* The header `<...>` defines field names and their order.
* Comments (`/.../`) are **allowed here**.
* After the header, the type may contain a list of values.

---

## 2. Data Structures

### 2.1 Positional Record

```
(a,b,c)
```

* Must follow the exact order of fields in the type header.

### 2.2 Named Record

```
{key:value}
```

* May be used wherever the type is known (declared or inline).
* Keys must match field names.
* Must contain **no spaces**.

### 2.3 List

```
[ ... ]
```

* Contains positional or named records.

### 2.4 Multiline Text

```
`
line
line
`
```

* Ends with a line containing only a backtick.
* Allowed as a string value.

---

## 3. Comments

```
/ comment /
```

Rules:

* Allowed only inside type definitions.
* Forbidden in data.

---

## 4. General Rules

* **Data must contain NO spaces.**
* Schema may contain spaces and comments.
* Named fields always use `key:value` without spaces.
* Positional order must exactly match the declared order.

---

## 5. Inline Type Usage

### Type used after declaration

```aid
@User<id:number name:string desc:string>

value:@User(2,"Alice","Hello")
value2:@User(3,"Bob","World")
```


---

## 6. Nested Types — Current Allowed Form

Nested types are allowed **only as pure structural definitions**, without modifiers or validators.

```
@User<
  id:string
  name:string
  profile: < level:number, score:number >
>
[
  ("u1","Aga",{level:5,score:82})
  ("u2","Marek",{level:7,score:91})
]
```



## 7. Data Example (fully valid)

```
[
@User<id,name,age,profile,score,active>
("u1","Aga",31,{level:5,prefs:{color:red,badge:{code:"X21",exp:1800000000}}},82,true)
("u2","Marek",28,{level:7,prefs:{color:blue,badge:{code:"D55",exp:1850000000}}},91,false)
]
```

This uses **only the currently implemented features**.


# FUTURES

This is planned futures for the format


* Modifiers applied inside type definitions:

```
!required                 field must be included
?empty                    field must not be "", [] or {}
=value                    default value for optional fields
N..M                      numeric range
lenN..M                   string length range
in(a,b,c)                 enumeration
re"pattern"               regular expression
$key=value                metadata attribute
#["tag1","tag2"]          tags (schema only)
%[ 4, 32, 12]             Examples
```

* If a field has no `?optional`, it is required unless default behavior is overridden.
* `!empty` forbids explicit empty values.
* `=value` applies only when the field is omitted.

* BINARY DATA

```
<me: binary>
{
  me: ~<bin:3>0F 0A B3~
}
```

* HEX DATA

```
<me: binary>
{
  me: ~[hex]1A0F4F~
}
```


* BASE64 DATA

```
<me: binary>
{
  me: ~[b64]ADFKDXKZK56434~
}
```


* Pointers:


```
[
  @User<id: number, name: string, friend *@User>
 (1, "Alex", *User[2])
 (2, "Alice", *User[1])
]

```

* Points to previously defined value whose `id` equals `id`.
* Type hint is optional but recommended.

* Named initialization:

```
@User<id: string, name: string>
users: [
  @User

]

```

---


### Inline type + value

```aid
value: @User<id:number name:string desc:string>(2,"Alice","Hello")
```

Both forms are valid.