Skip to main content

PromptSuggestionsCapabilities

Struct PromptSuggestionsCapabilities 

Source
#[non_exhaustive]
pub struct PromptSuggestionsCapabilities { pub image: Option<PromptSuggestionsImageCapabilities>, pub audio: Option<PromptSuggestionsAudioCapabilities>, pub embedded_context: Option<PromptSuggestionsEmbeddedContextCapabilities>, pub meta: Option<Map<String, Value>>, }
Expand description

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Client support for prompt_suggestions_update session updates.

Supplying {} means the client can offer prompt suggestions made of text and resource_link content blocks. The client opts in to other content block types with the fields below. They have the same names as the agent’s prompt capabilities.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§image: Option<PromptSuggestionsImageCapabilities>

Whether prompt suggestions may include image content blocks.

Optional. Omitted or null both mean the client does not advertise support. Supplying {} means the client can offer suggestions that include images.

§audio: Option<PromptSuggestionsAudioCapabilities>

Whether prompt suggestions may include audio content blocks.

Optional. Omitted or null both mean the client does not advertise support. Supplying {} means the client can offer suggestions that include audio.

§embedded_context: Option<PromptSuggestionsEmbeddedContextCapabilities>

Whether prompt suggestions may include resource content blocks.

Optional. Omitted or null both mean the client does not advertise support. Supplying {} means the client can offer suggestions that include embedded resources.

§meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations§

Source§

impl PromptSuggestionsCapabilities

Source

pub fn new() -> PromptSuggestionsCapabilities

Available on crate feature unstable_prompt_suggestions only.

Builds an empty PromptSuggestionsCapabilities. Use builder methods to advertise supported sub-capabilities.

Source

pub fn image( self, image: impl IntoOption<PromptSuggestionsImageCapabilities>, ) -> PromptSuggestionsCapabilities

Available on crate feature unstable_prompt_suggestions only.

Whether prompt suggestions may include image content blocks.

Source

pub fn audio( self, audio: impl IntoOption<PromptSuggestionsAudioCapabilities>, ) -> PromptSuggestionsCapabilities

Available on crate feature unstable_prompt_suggestions only.

Whether prompt suggestions may include audio content blocks.

Source

pub fn embedded_context( self, embedded_context: impl IntoOption<PromptSuggestionsEmbeddedContextCapabilities>, ) -> PromptSuggestionsCapabilities

Available on crate feature unstable_prompt_suggestions only.

Whether prompt suggestions may include resource content blocks.

Source

pub fn meta( self, meta: impl IntoOption<Map<String, Value>>, ) -> PromptSuggestionsCapabilities

Available on crate feature unstable_prompt_suggestions only.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations§

Source§

impl Clone for PromptSuggestionsCapabilities

Source§

fn clone(&self) -> PromptSuggestionsCapabilities

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptSuggestionsCapabilities

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PromptSuggestionsCapabilities

Source§

fn default() -> PromptSuggestionsCapabilities

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PromptSuggestionsCapabilities

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<PromptSuggestionsCapabilities, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for PromptSuggestionsCapabilities

Source§

impl JsonSchema for PromptSuggestionsCapabilities

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for PromptSuggestionsCapabilities

Source§

fn eq(&self, other: &PromptSuggestionsCapabilities) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for PromptSuggestionsCapabilities

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PromptSuggestionsCapabilities

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoMaybeUndefined<T> for T

Source§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more