Struct ProxyRequestMetadata

pub struct ProxyRequestMetadata {

    pub application: Option<String>,
    pub environment: Option<String>,
    pub organization_id: Option<String>,
    pub project_id: Option<String>,
    pub user_id: Option<String>,
    pub workflow_id: Option<String>,
    pub workflow_name: Option<String>,
    pub run_id: Option<Uuid>,
    pub step_id: Option<Uuid>,
    pub step_index: Option<u32>,
    pub prompt_id: Option<String>,
    pub prompt_version: Option<u32>,
    pub extra: Option<Map<String, Value>>,
}

Metadata about the request and how it fits into the system as a whole. All of these fields are optional, and the extra field can be used to add anything else that useful for your use case.

Fields

application: Option<String>

The application making this call. This can also be set by passing the x-chronicle-application HTTP header.

environment: Option<String>

The environment the application is running in. This can also be set by passing the x-chronicle-environment HTTP header.

organization_id: Option<String>

The organization related to the request. This can also be set by passing the x-chronicle-organization-id HTTP header.

project_id: Option<String>

The project related to the request. This can also be set by passing the x-chronicle-project-id HTTP header.

user_id: Option<String>

The id of the user that triggered the request. This can also be set by passing the x-chronicle-user-id HTTP header.

workflow_id: Option<String>

The id of the workflow that this request belongs to. This can also be set by passing the x-chronicle-workflow-id HTTP header.

workflow_name: Option<String>

A readable name of the workflow that this request belongs to. This can also be set by passing the x-chronicle-workflow-name HTTP header.

run_id: Option<Uuid>

The id of of the specific run that this request belongs to. This can also be set by passing the x-chronicle-run-id HTTP header.

step_id: Option<Uuid>

The name of the workflow step. This can also be set by passing the x-chronicle-step-id HTTP header.

step_index: Option<u32>

The index of the step within the workflow. This can also be set by passing the x-chronicle-step-index HTTP header.

prompt_id: Option<String>

A unique ID for this prompt. This can also be set by passing the x-chronicle-prompt-id HTTP header.

prompt_version: Option<u32>

The version of this prompt. This can also be set by passing the x-chronicle-prompt-version HTTP header.

extra: Option<Map<String, Value>>

Any other metadata to include. When passing this in the request body, any unknown fields are collected here. This can also be set by passing a JSON object to the x-chronicle-extra-meta HTTP header.

Implementations

impl ProxyRequestMetadata

pub fn merge_request_headers( &mut self, headers: &HeaderMap, ) -> Result<(), Report<Error>>

pub fn merge_from(&mut self, other: &Self)

Merge values from other, when the values in the current object are not set.

Trait Implementations

impl Debug for ProxyRequestMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProxyRequestMetadata

fn default() -> ProxyRequestMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProxyRequestMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProxyRequestMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.