Skip to content

Commit eb97ea0

Browse files
author
caffeine-ci-generic-rw[bot]
committed
docs: seed AGENTS.md
1 parent 3209b12 commit eb97ea0

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md
2+
3+
Generated Motoko client library for (a curated subset of) the OpenAI REST API, distributed as the `openai-client` mops package.
4+
5+
## Generated code — do not hand-edit
6+
7+
This entire repository is produced by the OpenAPI Generator (`MotokoClientCodegen`); see `.openapi-generator/FILES` for the exact list of generated paths. Do not hand-edit generated files — changes are lost on regeneration. Files listed in `.openapi-generator-ignore` are exempt from overwrite. The generator version is pinned in `.openapi-generator/VERSION`.
8+
9+
## Layout
10+
11+
- `src/Apis/` — one Motoko module per included API (Audio, Chat, Completions, Embeddings, Files, Images, Models, Moderations).
12+
- `src/Models/` — request/response types referenced by the APIs.
13+
- `src/Config.mo` — shared `Config` type and `defaultConfig`.
14+
15+
Note: `README.md` lists more APIs/Models than exist under `src/`; only the curated subset in `src/` is actually shipped (the `files` field of `mops.toml` is the source of truth for published files).
16+
17+
## Toolchain & build
18+
19+
- Package manager: [mops](https://mops.one). Dependencies and the pinned Motoko compiler version (`[toolchain] moc`) are declared in `mops.toml`; `mops.lock` pins resolved versions.
20+
- Install dependencies with `mops install` before compiling. `.mops/` (git-ignored) is the local dependency cache and must not be committed.
21+
- There are no build, test, lint, or format scripts defined in this repository (no Makefile, no CI workflows, no package scripts). Do not invent one; compile against `moc`/mops as the consuming Internet Computer project requires.
22+
23+
## Usage conventions
24+
25+
- Import modules as `mo:openai-client/Apis/<Name>` and `mo:openai-client/Config`.
26+
- Configure via record update on `defaultConfig`, e.g. `{ defaultConfig with auth = ?#bearer "..." }`; auth supports `#bearer`, `#apiKey`, and `#basicAuth`.
27+
- API calls perform HTTP outcalls and require cycles; `defaultConfig.cycles` defaults to `30_000_000_000`.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See @AGENTS.md

0 commit comments

Comments
 (0)