Struct CountTokensRequest 

#[non_exhaustive]
pub struct CountTokensRequest {
    pub endpoint: String,
    pub model: String,
    pub instances: Vec<Value>,
    pub contents: Vec<Content>,
    pub system_instruction: Option<Content>,
    pub tools: Vec<Tool>,
    pub generation_config: Option<GenerationConfig>,
    /* private fields */
}

Available on crate feature llm-utility-service only.

Request message for [PredictionService.CountTokens][].

Fields (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.

endpoint: String

Required. The name of the Endpoint requested to perform token counting. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

model: String

Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*

instances: Vec<Value>

Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

contents: Vec<Content>

Optional. Input content.

system_instruction: Option<Content>

Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

tools: Vec<Tool>

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

generation_config: Option<GenerationConfig>

Optional. Generation config that the model will use to generate the response.

Implementations

impl CountTokensRequest

pub fn new() -> Self

pub fn set_endpoint<T: Into<String>>(self, v: T) -> Self

Sets the value of endpoint.

Example

let x = CountTokensRequest::new().set_endpoint("example");

pub fn set_model<T: Into<String>>(self, v: T) -> Self

Sets the value of model.

Example

let x = CountTokensRequest::new().set_model("example");

pub fn set_instances<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Value>,

Sets the value of instances.

Example

use wkt::Value;
let x = CountTokensRequest::new()
    .set_instances([
        Value::default()/* use setters */,
        Value::default()/* use (different) setters */,
    ]);

pub fn set_contents<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Content>,

Sets the value of contents.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = CountTokensRequest::new()
    .set_contents([
        Content::default()/* use setters */,
        Content::default()/* use (different) setters */,
    ]);

pub fn set_system_instruction<T>(self, v: T) -> Self

where T: Into<Content>,

Sets the value of system_instruction.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = CountTokensRequest::new().set_system_instruction(Content::default()/* use setters */);

pub fn set_or_clear_system_instruction<T>(self, v: Option<T>) -> Self

where T: Into<Content>,

Sets or clears the value of system_instruction.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = CountTokensRequest::new().set_or_clear_system_instruction(Some(Content::default()/* use setters */));
let x = CountTokensRequest::new().set_or_clear_system_instruction(None::<Content>);

pub fn set_tools<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Tool>,

Sets the value of tools.

Example

use google_cloud_aiplatform_v1::model::Tool;
let x = CountTokensRequest::new()
    .set_tools([
        Tool::default()/* use setters */,
        Tool::default()/* use (different) setters */,
    ]);

pub fn set_generation_config<T>(self, v: T) -> Self

where T: Into<GenerationConfig>,

Sets the value of generation_config.

Example

use google_cloud_aiplatform_v1::model::GenerationConfig;
let x = CountTokensRequest::new().set_generation_config(GenerationConfig::default()/* use setters */);

pub fn set_or_clear_generation_config<T>(self, v: Option<T>) -> Self

where T: Into<GenerationConfig>,

Sets or clears the value of generation_config.

Example

use google_cloud_aiplatform_v1::model::GenerationConfig;
let x = CountTokensRequest::new().set_or_clear_generation_config(Some(GenerationConfig::default()/* use setters */));
let x = CountTokensRequest::new().set_or_clear_generation_config(None::<GenerationConfig>);

Trait Implementations

impl Clone for CountTokensRequest

fn clone(&self) -> CountTokensRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CountTokensRequest

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

Formats the value using the given formatter.

impl Default for CountTokensRequest

fn default() -> CountTokensRequest

Returns the “default value” for a type.

impl Message for CountTokensRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CountTokensRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CountTokensRequest