-
Notifications
You must be signed in to change notification settings - Fork 13
Add LivingBrain Brain API client #143
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # LivingBrain client | ||
|
|
||
| This module is a brain-scoped client for LivingBrain's hosted API. It is not a | ||
| `MemoryProvider`: captures are asynchronously compiled into native pages, so | ||
| the service cannot provide TinyMemory's exact namespace/key CRUD contract. | ||
|
|
||
| `LivingBrain` is constructed with the API endpoint, a bearer key, a subject id, | ||
| and one brain id. It sends the key only in `Authorization: Bearer` and attaches | ||
| the subject id as `x-subject-id`; neither credential is rendered through the | ||
| client's `Debug` output. | ||
|
|
||
| The public surface submits individual and bounded batch captures, conversation | ||
| turns, semantic searches, and source cleanup. It also reads native pages, | ||
| graphs, source status, and markdown exports. Native page and graph shapes are | ||
| returned as JSON because LivingBrain owns their schema. | ||
|
|
||
| Captures with a stable `origin_ref` are retry-safe and retry transient failures. | ||
| Captures without one make exactly one request. Batch captures require an | ||
| `origin_ref` per item and accept at most 100 items. Callers can preserve host | ||
| provenance with `Capture::source`. | ||
|
|
||
| `types.rs` contains the request and response contracts. `test.rs` uses a local | ||
| HTTP simulation to verify wire routes, headers, payloads, validation, and | ||
| credential redaction without contacting the hosted service. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a request or its headers are formatted by diagnostics or middleware, this plain
HeaderValuerenders the configured subject ID because, unlikecredential_header, it is never marked sensitive. That contradicts the accepted specification's requirement that neither required header value appear inDebug; set the sensitive flag before storing the subject header.AGENTS.md reference: AGENTS.md:L196-L196
Useful? React with 👍 / 👎.