Document

google.cloud.dialogflow.v2. Document

Represents a Document.

Constructor

new Document(propertiesopt)

Constructs a new Document.

Parameters:
Name Type Attributes Description
properties google.cloud.dialogflow.v2.IDocument <optional>

Properties to set
Implements:
  • IDocument

Classes

ReloadStatus

Members

KnowledgeType

KnowledgeType enum.

Properties:
Name Type Description
KNOWLEDGE_TYPE_UNSPECIFIED number

KNOWLEDGE_TYPE_UNSPECIFIED value
FAQ number

FAQ value
EXTRACTIVE_QA number

EXTRACTIVE_QA value
ARTICLE_SUGGESTION number

ARTICLE_SUGGESTION value

contentUri

Document contentUri.

displayName

Document displayName.

enableAutoReload

Document enableAutoReload.

knowledgeTypes

Document knowledgeTypes.

latestReloadStatus

Document latestReloadStatus.

metadata

Document metadata.

mimeType

Document mimeType.

name

Document name.

rawContent

Document rawContent.

source

Document source.

Methods

(static) create(propertiesopt) → {google.cloud.dialogflow.v2.Document}

Creates a new Document instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.dialogflow.v2.IDocument <optional>

Properties to set
Returns:
Type Description
google.cloud.dialogflow.v2.Document

Document instance

(static) decode(reader, lengthopt) → {google.cloud.dialogflow.v2.Document}

Decodes a Document message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.dialogflow.v2.Document

Document
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.dialogflow.v2.Document}

Decodes a Document message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.dialogflow.v2.Document

Document
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Document message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.v2.IDocument

Document message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Document message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.v2.IDocument

Document message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.dialogflow.v2.Document}

Creates a Document message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.dialogflow.v2.Document

Document

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Document message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.v2.Document

Document
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Document message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Document to JSON.

Returns:
Type Description
Object.<string, *>

JSON object