Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ListDocumentsRequest (v0.27.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ListDocumentsRequest.

Request message for Documents.ListDocuments.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — The filter expression used to filter documents returned by the list method. The expression has the following syntax:

    The following fields and operators are supported:

    • knowledge_types with has(:) operator
    • display_name with has(:) operator
    • state with equals(=) operator

    Examples:

    • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
    • "display_name:customer" matches documents whose display name contains "customer".
    • "state=ACTIVE" matches documents with ACTIVE state.
    • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

    For more information about filtering, see API Filtering.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — The filter expression used to filter documents returned by the list method. The expression has the following syntax:

    The following fields and operators are supported:

    • knowledge_types with has(:) operator
    • display_name with has(:) operator
    • state with equals(=) operator

    Examples:

    • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
    • "display_name:customer" matches documents whose display name contains "customer".
    • "state=ACTIVE" matches documents with ACTIVE state.
    • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

    For more information about filtering, see API Filtering.

Returns
  • (::String) — The filter expression used to filter documents returned by the list method. The expression has the following syntax:

    The following fields and operators are supported:

    • knowledge_types with has(:) operator
    • display_name with has(:) operator
    • state with equals(=) operator

    Examples:

    • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
    • "display_name:customer" matches documents whose display name contains "customer".
    • "state=ACTIVE" matches documents with ACTIVE state.
    • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

    For more information about filtering, see API Filtering.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The maximum number of items to return in a single page. By default 10 and at most 100.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum number of items to return in a single page. By default 10 and at most 100.
Returns
  • (::Integer) — The maximum number of items to return in a single page. By default 10 and at most 100.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The next_page_token value returned from a previous list request.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The next_page_token value returned from a previous list request.
Returns
  • (::String) — The next_page_token value returned from a previous list request.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.
Returns
  • (::String) — Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.