Struct google_api_proto::google::cloud::dialogflow::v2::Document

pub struct Document {
    pub name: String,
    pub display_name: String,
    pub mime_type: String,
    pub knowledge_types: Vec<i32>,
    pub enable_auto_reload: bool,
    pub latest_reload_status: Option<ReloadStatus>,
    pub metadata: BTreeMap<String, String>,
    pub state: i32,
    pub source: Option<Source>,
}

A knowledge document to be used by a [KnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBase].

For more information, see the knowledge base guide.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Fields

name: String

Optional. The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

display_name: String

Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.

mime_type: String

Required. The MIME type of this document.

knowledge_types: Vec<i32>

Required. The knowledge type of document content.

enable_auto_reload: bool

Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don’t try to automatically reload the document.

Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types.

Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged.

If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.

latest_reload_status: Option<ReloadStatus>

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

metadata: BTreeMap<String, String>

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document’s title, an external URL distinct from the document’s content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

state: i32

Output only. The current state of the document.

source: Option<Source>

Required. The source of this document.

Implementations

impl Document

pub fn knowledge_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<KnowledgeType>>

Returns an iterator which yields the valid enum values contained in knowledge_types.

pub fn push_knowledge_types(&mut self, value: KnowledgeType)

Appends the provided enum value to knowledge_types.

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Message for Document

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 Document

fn eq(&self, other: &Document) -> 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 Document