Struct GoogleCloudDialogflowV2Document

pub struct GoogleCloudDialogflowV2Document {
    pub content_uri: Option<String>,
    pub display_name: Option<String>,
    pub enable_auto_reload: Option<bool>,
    pub knowledge_types: Option<Vec<String>>,
    pub latest_reload_status: Option<GoogleCloudDialogflowV2DocumentReloadStatus>,
    pub metadata: Option<HashMap<String, String>>,
    pub mime_type: Option<String>,
    pub name: Option<String>,
    pub raw_content: Option<Vec<u8>>,
    pub state: Option<String>,
}

A knowledge document to be used by a KnowledgeBase. For more information, see the knowledge base guide. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• agent knowledge bases documents create projects (request)
• agent knowledge bases documents get projects (response)
• agent knowledge bases documents patch projects (request)
• knowledge bases documents create projects (request)
• knowledge bases documents get projects (response)
• knowledge bases documents patch projects (request)
• locations knowledge bases documents create projects (request)
• locations knowledge bases documents get projects (response)
• locations knowledge bases documents patch projects (request)

Fields

content_uri: Option<String>

The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.

display_name: Option<String>

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

enable_auto_reload: Option<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.

knowledge_types: Option<Vec<String>>

Required. The knowledge type of document content.

latest_reload_status: Option<GoogleCloudDialogflowV2DocumentReloadStatus>

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: Option<HashMap<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.

mime_type: Option<String>

Required. The MIME type of this document.

name: Option<String>

Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.

raw_content: Option<Vec<u8>>

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

state: Option<String>

Output only. The current state of the document.

Trait Implementations

impl Clone for GoogleCloudDialogflowV2Document

fn clone(&self) -> GoogleCloudDialogflowV2Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudDialogflowV2Document

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

Formats the value using the given formatter.

impl Default for GoogleCloudDialogflowV2Document

fn default() -> GoogleCloudDialogflowV2Document

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudDialogflowV2Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudDialogflowV2Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for GoogleCloudDialogflowV2Document

impl ResponseResult for GoogleCloudDialogflowV2Document