GoodMemGoodMem
ReferenceClient SDKsRust

Ping

Rust ping API reference: typed methods, request options, return values, and resource models.

goodmem::api::Ping

Access this service with client.ping().

pub struct Ping<'a> {
    /* private fields */
}

Methods

MethodHTTPPath
oncePOST/v1/ping:once
streamPOST/v1/ping:stream

Errors and cancellation

Calls return Result<T>. See Error for validation, HTTP, transport, decoding, and timeout failures. Stream items can also return errors after the call succeeds.

Pagination helpers fetch pages when polled. Drop a page or event stream to cancel further work.

Implementations

impl Ping<'_>

once

pub async fn once(&self, body: &PingOnceRequest) -> Result<PingResult>

Run a single ping probe

Runs a single ping probe and returns the probe result. Requires both the target-specific PING operation and its corresponding EXECUTE operation: PING_EMBEDDER plus EXECUTE_EMBEDDER, PING_RERANKER plus EXECUTE_RERANKER, or PING_LLM plus EXECUTE_LLM. Decision models require READ_DECISION_MODEL, PING_DECISION_MODEL, and EXECUTE_DECISION_MODEL. Probes make real provider calls and may incur charges.

Errors include local validation, HTTP failures, and malformed responses.

HTTP: POST /v1/ping:once

stream

pub async fn stream( &self, body: &PingStreamRequest, options: &PingStreamOptions, ) -> Result<EventStream<PingEvent>>

Stream ping probe results

Opens a streaming ping session and returns per-probe results plus a terminal summary. Requires both the target-specific PING operation and its corresponding EXECUTE operation: PING_EMBEDDER plus EXECUTE_EMBEDDER, PING_RERANKER plus EXECUTE_RERANKER, or PING_LLM plus EXECUTE_LLM. Decision models require READ_DECISION_MODEL, PING_DECISION_MODEL, and EXECUTE_DECISION_MODEL. Probes make real provider calls and may incur charges.

Errors include local validation, HTTP failures, and malformed responses.

HTTP: POST /v1/ping:stream

Types

Trait implementations

  • Clone (derived)
  • Copy (derived)
  • Debug (derived)

On this page