#[non_exhaustive]pub struct ObservationBuilder { /* private fields */ }Expand description
A builder for Observation.
Implementations§
Source§impl ObservationBuilder
impl ObservationBuilder
Sourcepub fn set_trace_id(self, input: Option<String>) -> Self
pub fn set_trace_id(self, input: Option<String>) -> Self
The unique identifier of the trace.
Sourcepub fn get_trace_id(&self) -> &Option<String>
pub fn get_trace_id(&self) -> &Option<String>
The unique identifier of the trace.
Sourcepub fn type(self, input: Type) -> Self
pub fn type(self, input: Type) -> Self
Specifies what kind of information the agent returns in the observation. The following values are possible.
-
ACTION_GROUP– The agent returns the result of an action group. -
KNOWLEDGE_BASE– The agent returns information from a knowledge base. -
FINISH– The agent returns a final response to the user with no follow-up. -
ASK_USER– The agent asks the user a question. -
REPROMPT– The agent prompts the user again for the same information.
Sourcepub fn set_type(self, input: Option<Type>) -> Self
pub fn set_type(self, input: Option<Type>) -> Self
Specifies what kind of information the agent returns in the observation. The following values are possible.
-
ACTION_GROUP– The agent returns the result of an action group. -
KNOWLEDGE_BASE– The agent returns information from a knowledge base. -
FINISH– The agent returns a final response to the user with no follow-up. -
ASK_USER– The agent asks the user a question. -
REPROMPT– The agent prompts the user again for the same information.
Sourcepub fn get_type(&self) -> &Option<Type>
pub fn get_type(&self) -> &Option<Type>
Specifies what kind of information the agent returns in the observation. The following values are possible.
-
ACTION_GROUP– The agent returns the result of an action group. -
KNOWLEDGE_BASE– The agent returns information from a knowledge base. -
FINISH– The agent returns a final response to the user with no follow-up. -
ASK_USER– The agent asks the user a question. -
REPROMPT– The agent prompts the user again for the same information.
Sourcepub fn action_group_invocation_output(
self,
input: ActionGroupInvocationOutput,
) -> Self
pub fn action_group_invocation_output( self, input: ActionGroupInvocationOutput, ) -> Self
Contains the JSON-formatted string returned by the API invoked by the action group.
Sourcepub fn set_action_group_invocation_output(
self,
input: Option<ActionGroupInvocationOutput>,
) -> Self
pub fn set_action_group_invocation_output( self, input: Option<ActionGroupInvocationOutput>, ) -> Self
Contains the JSON-formatted string returned by the API invoked by the action group.
Sourcepub fn get_action_group_invocation_output(
&self,
) -> &Option<ActionGroupInvocationOutput>
pub fn get_action_group_invocation_output( &self, ) -> &Option<ActionGroupInvocationOutput>
Contains the JSON-formatted string returned by the API invoked by the action group.
Sourcepub fn agent_collaborator_invocation_output(
self,
input: AgentCollaboratorInvocationOutput,
) -> Self
pub fn agent_collaborator_invocation_output( self, input: AgentCollaboratorInvocationOutput, ) -> Self
A collaborator's invocation output.
Sourcepub fn set_agent_collaborator_invocation_output(
self,
input: Option<AgentCollaboratorInvocationOutput>,
) -> Self
pub fn set_agent_collaborator_invocation_output( self, input: Option<AgentCollaboratorInvocationOutput>, ) -> Self
A collaborator's invocation output.
Sourcepub fn get_agent_collaborator_invocation_output(
&self,
) -> &Option<AgentCollaboratorInvocationOutput>
pub fn get_agent_collaborator_invocation_output( &self, ) -> &Option<AgentCollaboratorInvocationOutput>
A collaborator's invocation output.
Sourcepub fn knowledge_base_lookup_output(
self,
input: KnowledgeBaseLookupOutput,
) -> Self
pub fn knowledge_base_lookup_output( self, input: KnowledgeBaseLookupOutput, ) -> Self
Contains details about the results from looking up the knowledge base.
Sourcepub fn set_knowledge_base_lookup_output(
self,
input: Option<KnowledgeBaseLookupOutput>,
) -> Self
pub fn set_knowledge_base_lookup_output( self, input: Option<KnowledgeBaseLookupOutput>, ) -> Self
Contains details about the results from looking up the knowledge base.
Sourcepub fn get_knowledge_base_lookup_output(
&self,
) -> &Option<KnowledgeBaseLookupOutput>
pub fn get_knowledge_base_lookup_output( &self, ) -> &Option<KnowledgeBaseLookupOutput>
Contains details about the results from looking up the knowledge base.
Sourcepub fn final_response(self, input: FinalResponse) -> Self
pub fn final_response(self, input: FinalResponse) -> Self
Contains details about the response to the user.
Sourcepub fn set_final_response(self, input: Option<FinalResponse>) -> Self
pub fn set_final_response(self, input: Option<FinalResponse>) -> Self
Contains details about the response to the user.
Sourcepub fn get_final_response(&self) -> &Option<FinalResponse>
pub fn get_final_response(&self) -> &Option<FinalResponse>
Contains details about the response to the user.
Sourcepub fn reprompt_response(self, input: RepromptResponse) -> Self
pub fn reprompt_response(self, input: RepromptResponse) -> Self
Contains details about the response to reprompt the input.
Sourcepub fn set_reprompt_response(self, input: Option<RepromptResponse>) -> Self
pub fn set_reprompt_response(self, input: Option<RepromptResponse>) -> Self
Contains details about the response to reprompt the input.
Sourcepub fn get_reprompt_response(&self) -> &Option<RepromptResponse>
pub fn get_reprompt_response(&self) -> &Option<RepromptResponse>
Contains details about the response to reprompt the input.
Sourcepub fn code_interpreter_invocation_output(
self,
input: CodeInterpreterInvocationOutput,
) -> Self
pub fn code_interpreter_invocation_output( self, input: CodeInterpreterInvocationOutput, ) -> Self
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
Sourcepub fn set_code_interpreter_invocation_output(
self,
input: Option<CodeInterpreterInvocationOutput>,
) -> Self
pub fn set_code_interpreter_invocation_output( self, input: Option<CodeInterpreterInvocationOutput>, ) -> Self
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
Sourcepub fn get_code_interpreter_invocation_output(
&self,
) -> &Option<CodeInterpreterInvocationOutput>
pub fn get_code_interpreter_invocation_output( &self, ) -> &Option<CodeInterpreterInvocationOutput>
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
Sourcepub fn build(self) -> Observation
pub fn build(self) -> Observation
Consumes the builder and constructs a Observation.
Trait Implementations§
Source§impl Clone for ObservationBuilder
impl Clone for ObservationBuilder
Source§fn clone(&self) -> ObservationBuilder
fn clone(&self) -> ObservationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ObservationBuilder
impl Debug for ObservationBuilder
Source§impl Default for ObservationBuilder
impl Default for ObservationBuilder
Source§fn default() -> ObservationBuilder
fn default() -> ObservationBuilder
Source§impl PartialEq for ObservationBuilder
impl PartialEq for ObservationBuilder
impl StructuralPartialEq for ObservationBuilder
Auto Trait Implementations§
impl Freeze for ObservationBuilder
impl RefUnwindSafe for ObservationBuilder
impl Send for ObservationBuilder
impl Sync for ObservationBuilder
impl Unpin for ObservationBuilder
impl UnwindSafe for ObservationBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);