Skip to navigation

Struct LlmStream Call Execute Params

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay-builtins -p nemo-relay-diagnostics -p nemo-relay-logging -p nemo-relay-plugin-host -p nemo-relay-codecs -p nemo-relay -p nemo-relay-runtime -p nemo-relay-model-pricing -p nemo-relay-resource-metrics -p nemo-relay-observability -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker.

pub struct LlmStreamCallExecuteParams {Show 13 fields
    pub name: String,
    pub request: LlmRequest,
    pub func: Arc<dyn Fn(LlmRequest) -> Pin<Box<dyn Future<Output = Result<LlmJsonStream, FlowError>> + Send>> + Sync + Send>,
    pub collector: LlmCollector,
    pub borrowed_collector: Option<Box<dyn FnMut(&Value) -> Result<(), FlowError> + Send>>,
    pub finalizer: LlmFinalizer,
    pub parent: Option<ScopeHandle>,
    pub attributes: LlmAttributes,
    pub data: Option<Value>,
    pub metadata: Option<Value>,
    pub model_name: Option<String>,
    pub codec: Option<Arc<dyn LlmCodec>>,
    pub response_codec: Option<Arc<dyn LlmResponseCodec>>,
}

Builder parameters for llm_stream_call_execute.

Fields

name: String

Logical provider or model family name recorded on emitted events.

request: LlmRequest

Raw request passed into the managed pipeline.

func: Arc<dyn Fn(LlmRequest) -> Pin<Box<dyn Future<Output = Result<LlmJsonStream, FlowError>> + Send>> + Sync + Send>

Streaming provider callback or execution continuation.

collector: LlmCollector

Per-chunk collector used to accumulate stream state.

borrowed_collector: Option<Box<dyn FnMut(&Value) -> Result<(), FlowError> + Send>>

Optional callback that reads each chunk by reference. If set, the runtime calls this callback instead of collector.

finalizer: LlmFinalizer

Finalizer used to construct the completed response.

parent: Option<ScopeHandle>

Optional explicit parent scope for the emitted LLM span.

attributes: LlmAttributes

LLM attribute bitflags applied to the managed span.

data: Option<Value>

Optional application payload stored on the handle but not emitted as Agent Trajectory Observability Format (ATOF) data.

metadata: Option<Value>

Optional JSON metadata recorded on emitted events.

model_name: Option<String>

Optional normalized model name for observability output.

codec: Option<Arc<dyn LlmCodec>>

Optional request codec used to produce annotated request data.

response_codec: Option<Arc<dyn LlmResponseCodec>>

Optional response codec used to attach annotated response data.

Implementations

impl LlmStreamCallExecuteParams

impl LlmStreamCallExecuteParams

builder

pub fn builder() -> LlmStreamCallExecuteParamsBuilder

Create a builder for building LlmStreamCallExecuteParams. On the builder, call .name(...), .request(...), .func(...), .collector(...), .borrowed_collector(...)(optional), .finalizer(...), .parent(...)(optional), .attributes(...)(optional), .data(...)(optional), .metadata(...)(optional), .model_name(...)(optional), .codec(...)(optional), .response_codec(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of LlmStreamCallExecuteParams.