Ping

Endpoint health probes — single-shot and streaming.

Namespace: Goodmem.Client.Api · Class: PingApi

Reach this surface as client.Ping on a GoodmemClient. Every network method is asynchronous — it returns a Task<T> (or an IAsyncEnumerable<T> for pagination and streaming) and accepts a CancellationToken; the Async suffix marks the standard .NET Task-based async pattern.

Methods

OnceAsync

Runs a single ping probe and returns the probe result.

Declaration

public Task<PingResult> OnceAsync(PingOnceRequest request, CancellationToken ct = default)

HTTP — POST /v1/ping:once

Parameters

Returns

Task<PingResult> — an awaitable that resolves to PingResult.

Exceptions

Example

var result = await client.Ping.OnceAsync(
    new PingOnceRequest { TargetId = "your-embedder-id" }
);
Console.WriteLine($"{result.RttMs}ms ok={result.Ok}");

StreamAsync

Opens a streaming ping session and returns per-probe results plus a terminal summary.

Declaration

public IAsyncEnumerable<PingEvent> StreamAsync(PingStreamRequest request, CancellationToken ct = default)

HTTP — POST /v1/ping:stream

Parameters

Returns

IAsyncEnumerable<PingEvent> — an async stream; await foreach yields each PingEvent across pages / events.

Exceptions

Example

await foreach (
    var ev in client.Ping.StreamAsync(
        new PingStreamRequest { TargetId = "your-embedder-id", Count = 2 }
    )
)
{
    if (ev.Result is { } result)
        Console.WriteLine($"{result.Seq}: {result.RttMs}ms");
}

Data Models

Types in the Goodmem.Client.Models namespace. Each row lists the C# property, its type, the JSON wire name, and a description.

PingOnceRequest

Request payload for a single ping probe

PingTargetType

Target types for ping operations

String enum: "TARGET_TYPE_UNSPECIFIED" · "EMBEDDER" · "RERANKER" · "LLM"

PingPayloadType

Payload types supported by ping operations

String enum: "PAYLOAD_TYPE_UNSPECIFIED" · "TEXT" · "JSON" · "BINARY"

PingResult

Result from an individual ping probe

PingEndpointInfo

Resolved endpoint metadata for ping responses

PingTiming

Timing information captured during a ping probe

PingStreamRequest

Request payload for a streaming ping session

PingEvent

Streaming event from a ping session

PingSummary

Summary emitted at the end of a ping session

PingNotice

Non-fatal notice emitted during a ping session