Dialogflow API (dialogflow:v2)

2022-01-08

4 new methods | 6 updated methods

Additions

    Methods

  • ▼ ▲ dialogflow.projects.conversations.participants.suggestions.suggestSmartReplies

      HTTP Method : POST

      Parameter Order : parent

      Parameters :

        parent

          Required : Yes

          Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

          Location : path

          Pattern : ^projects/[^/]+/conversations/[^/]+/participants/[^/]+$

          Type : string

      Description : Gets smart replies for a participant based on specific historical messages.

      Flat Path : v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dialogflow

      • Path : v2/{+parent}/suggestions:suggestSmartReplies

  • ▼ ▲ dialogflow.projects.locations.conversations.participants.suggestions.suggestSmartReplies

      HTTP Method : POST

      Parameter Order : parent

      Parameters :

        parent

          Description : Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$

          Location : path

      Description : Gets smart replies for a participant based on specific historical messages.

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies

      Path : v2/{+parent}/suggestions:suggestSmartReplies

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dialogflow

  • ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.export

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

          Type : string

          Description : Required. The name of the document to export. Format: `projects//locations//knowledgeBases//documents/`.

          Required : Yes

          Location : path

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dialogflow

      • Path : v2/{+name}:export

      Description : Exports a smart messaging candidate document into the specified destination. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document

      HTTP Method : POST

      Parameter Order : name

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}:export

  • ▼ ▲ dialogflow.projects.knowledgeBases.documents.export

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$

          Type : string

          Required : Yes

          Description : Required. The name of the document to export. Format: `projects//locations//knowledgeBases//documents/`.

      Parameter Order : name

      Flat Path : v2/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}:export

      HTTP Method : POST

      Description : Exports a smart messaging candidate document into the specified destination. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/dialogflow

      • Path : v2/{+name}:export

Updates

    Methods

  • ▼ ▲ dialogflow.projects.agent.knowledgeBases.documents.list

      Parameters :

        filter

          Description : The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... 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](https://aip.dev/160).

          Type : string

          Location : query

  • ▼ ▲ dialogflow.projects.agent.knowledgeBases.list

      Parameters :

        filter

          Location : query

          Description : The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).

          Type : string

  • ▼ ▲ dialogflow.projects.locations.knowledgeBases.documents.list

      Parameters :

        filter

          Description : The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... 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](https://aip.dev/160).

          Type : string

          Location : query

  • ▼ ▲ dialogflow.projects.locations.knowledgeBases.list

      Parameters :

        filter

          Description : The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).

          Location : query

          Type : string

  • ▼ ▲ dialogflow.projects.knowledgeBases.documents.list

      Parameters :

        filter

          Type : string

          Location : query

          Description : The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... 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](https://aip.dev/160).

  • ▼ ▲ dialogflow.projects.knowledgeBases.list

      Parameters :

        filter

          Type : string

          Location : query

          Description : The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * 'display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).