Struct google_api_proto::google::cloud::dataqna::v1alpha::Question

pub struct Question {
    pub name: String,
    pub scopes: Vec<String>,
    pub query: String,
    pub data_source_annotations: Vec<String>,
    pub interpret_error: Option<InterpretError>,
    pub interpretations: Vec<Interpretation>,
    pub create_time: Option<Timestamp>,
    pub user_email: String,
    pub debug_flags: Option<DebugFlags>,
    pub debug_info: Option<Any>,
}

The question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified.

Fields

name: String

Output only. Immutable. The unique identifier for the Question. The ID is server-generated. Example: projects/foo/locations/bar/questions/123

scopes: Vec<String>

Required. Immutable. Scopes to be used for the question. A scope defines the relevant data set scope. It can be a reference to a specific data source or a collection of data sources. Currently, support is limited to a single BigQuery table. There must be exactly one scopes element.

Example: //bigquery.googleapis.com/projects/test-project/datasets/foo/tables/bar

query: String

Required. Immutable. The query in natural language.

data_source_annotations: Vec<String>

A list of annotations to use instead of the default annotation of a data source (set in the data source reference resource). There must not be more than one annotation with the same data source reference.

interpret_error: Option<InterpretError>

An error field explaining why interpretation failed. This is only populated if the interpretation failed.

Note: This is different from getting a status error on the request itself. This is not a client or server error and the Question resource is still persisted, but the service could not interpret the question. Clients should present the error to the user so the user can rephrase the question.

interpretations: Vec<Interpretation>

A list of interpretations for this question.

create_time: Option<Timestamp>

Time when the question was created.

user_email: String

Output only. The e-mail address of the user that created this question.

debug_flags: Option<DebugFlags>

Input only. Immutable. Flags to request additional information for debugging purposes.

debug_info: Option<Any>

Top level debug information. This will be stored as the type DebugInformation. Using Any so clients don’t need to pull in anything inside the debug message.

Trait Implementations

impl Clone for Question

fn clone(&self) -> Question

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Question

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

Formats the value using the given formatter.

impl Default for Question

fn default() -> Self

Returns the “default value” for a type.

impl Message for Question

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Question

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Question