You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit b35139d
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/EMBEDDING-API-V1.md
+27-6Lines changed: 27 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,8 +47,8 @@ Issue #203's "In scope" list, mapped to real code, as of this tranche:
47
47
| Candidate validate/replay |`src/project/candidate/**` implements this for the Project workspace transaction path. |[`ProjectSession::validate_candidate_v2`](../src/embedding_api/project_session.rs) and [`ProjectSession::replay_candidate_v2`](../src/embedding_api/project_session.rs) return canonical authority-free reports over the active generation. |
48
48
| Deterministic interpreter execution for admitted profiles |`interpreter`/`hosted_interpreter` exist. |[`execute_entry_source(capability, unit_name, source, options, cancellation)`](../src/embedding_api/execution.rs) executes only the existing prepared, zero-argument `i64` entrypoint profile. It requires [`ExecutionCapability`](../src/embedding_api/execution.rs), caller bounds, and a cooperative cancellation token; no source-native host effect receives a provider or ambient fallback. |
49
49
| Explicit provider/capability injection | Done, for the vector-embedding effect only, by `semantic_embedding::EmbeddingCapability`/`EmbeddingProvider` (see above). |`check_source` needs no capability because checking is pure and effect-free; this bullet is satisfied for *this* operation by construction (nothing to inject authority into), not by adding an unnecessary capability type. |
50
-
| Memory/resource ownership and cancellation | Not documented for any embedding surface. | Stateless analysis calls hold no resource across calls. A `ProjectSession` owns only in-memory compiler cache/service state and normal Rust drop releases it. [`ExecutionCancellation`](../src/embedding_api/execution.rs)provides monotonic cooperative cancellation for the bounded interpreter call. Project-service operations currently provide no cancellation kernel, so the session facade does not falsely advertise one. |
51
-
| Version/feature negotiation | Not present for any embedding surface. |[`EMBEDDING_API_VERSION`](../src/embedding_api.rs) and `EmbeddingApiVersion::is_compatible_with` exist and are tested against both a matching and two non-matching major versions. |
50
+
| Memory/resource ownership and cancellation | Not documented for any embedding surface. | Stateless analysis calls hold no resource across calls. A `ProjectSession` owns only in-memory compiler cache/service state and normal Rust drop releases it. [`EmbeddingCancellation`](../src/embedding_api.rs)pre-cancels Project opening/refresh and samples bounded context before work and before returning a successful report; it does not promise an unsafe mid-refresh interruption. [`ExecutionCancellation`](../src/embedding_api/execution.rs) cooperatively cancels the bounded interpreter call. |
51
+
| Version/feature negotiation | Not present for any embedding surface. |[`EMBEDDING_API_VERSION`](../src/embedding_api.rs), `EmbeddingApiVersion::is_compatible_with`, `require_compatible`, and `negotiate_features` check major/minimum minor and exact operation/profile names. Unknown features fail closed with `SPX-EMB004`. |
52
52
| Thread-safety and reentrancy contract | Not documented. |`check_source` takes no shared or mutable state. `ProjectSession` makes no `Sync`, clone, reentrancy, or simultaneous-refresh promise; refresh/candidate validation take `&mut self`. A caught stateful-operation panic poisons the handle, requiring callers to drop and reopen it from explicit bytes. |
53
53
54
54
## The `CheckOutcome` contract
@@ -207,15 +207,20 @@ option types or traversal state.
207
207
208
208
## Compatibility policy
209
209
210
-
`EMBEDDING_API_VERSION` (currently `1.6.0`; `1.1.0` after `format_source`,
210
+
`EMBEDDING_API_VERSION` (currently `1.7.0`; `1.1.0` after `format_source`,
211
211
`1.2.0` after `graph_source`, `1.3.0` after `context_source`, and `1.4.0`
212
212
after `context_v2_source`, then `1.5.0` after `execute_entry_source`, and
213
-
`1.6.0` after the Project session facade) names
213
+
`1.6.0` after the Project session facade, and `1.7.0` after explicit
214
+
version-refusal and pre-cancelled request entry points) names
214
215
this Rust surface's own version,
215
216
independent of any checked SEMAPRAX program's semantics.
0 commit comments