Skip to content

Clarify Local AI managed-model probe naming and verification documentation #1198

Description

@joelagnel

Cleanup

Address the two Local AI API clarity nits from the PR #1178 review.

Rename the managed-model probe

Rename ProbeRouterAsync to ProbeManagedModelAsync across the interface, implementation, runtime-service callers, fakes, and tests.

The operation checks both router health and the evidence for one configured model alias and expected path. The proposed name communicates that contract more precisely than the generic router-oriented name.

Review thread:
#1178 (comment)

Coordinate this rename with #1192, which tightens the same probe's readiness contract.

Document inference verification at the method boundary

Add method-level XML documentation to LlamaServerInferenceClient.VerifyAsync explaining that it:

  • Sends one bounded OpenAI-compatible request to the managed endpoint
  • Intentionally triggers lazy model loading during setup
  • Verifies the response and token/timing evidence
  • Does not return or log prompt and response content

Retain the useful existing class-level documentation while making the public method contract clear to callers and generated documentation.

Review thread:
#1178 (comment)

Acceptance criteria

  • ProbeRouterAsync is fully renamed to ProbeManagedModelAsync with no stale references.
  • Method-level XML documentation is present on the interface and implementation where appropriate.
  • Existing behavior remains unchanged except for any separately reviewed readiness correction from Require verified managed-model evidence before publishing Local AI #1192.
  • Focused Local AI client and runtime-service tests pass.

Reported by @larroy

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Low-risk cleanup, docs, polish, ergonomics, or speculative feature.issue-rating: 🌊 off-meta tidepoolIssue quality rating does not apply to this item.

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions