Dialogflow API . projects . conversations . participants . suggestions

Instance Methods

close()

Close httplib2 connections.

compile(parent, body=None, x__xgafv=None)

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

list_next()

Retrieves the next page of results.

suggestArticles(parent, body=None, x__xgafv=None)

suggestFaqAnswers(parent, body=None, x__xgafv=None)

suggestKnowledgeAssist(parent, body=None, x__xgafv=None)

suggestSmartReplies(parent, body=None, x__xgafv=None)

Method Details

close()
Close httplib2 connections.
compile(parent, body=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
  "contextSize": 42,
  "latestMessage": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "contextSize": 42,
  "latestMessage": "A String",
  "suggestion": {
    "articles": [
      {
        "answerRecord": "A String",
        "metadata": {
          "a_key": "A String",
        },
        "snippets": [
          "A String",
        ],
        "title": "A String",
        "uri": "A String",
      },
    ],
    "createTime": "A String",
    "faqAnswers": [
      {
        "answer": "A String",
        "answerRecord": "A String",
        "confidence": 3.14,
        "metadata": {
          "a_key": "A String",
        },
        "question": "A String",
        "source": "A String",
      },
    ],
    "latestMessage": "A String",
    "name": "A String",
  },
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  filter: string, A parameter
  pageSize: integer, A parameter
  pageToken: string, A parameter
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "nextPageToken": "A String",
  "suggestions": [
    {
      "articles": [
        {
          "answerRecord": "A String",
          "metadata": {
            "a_key": "A String",
          },
          "snippets": [
            "A String",
          ],
          "title": "A String",
          "uri": "A String",
        },
      ],
      "createTime": "A String",
      "faqAnswers": [
        {
          "answer": "A String",
          "answerRecord": "A String",
          "confidence": 3.14,
          "metadata": {
            "a_key": "A String",
          },
          "question": "A String",
          "source": "A String",
        },
      ],
      "latestMessage": "A String",
      "name": "A String",
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
suggestArticles(parent, body=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
  "assistQueryParams": {
    "documentsMetadataFilters": {
      "a_key": "A String",
    },
  },
  "contextSize": 42,
  "latestMessage": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "articleAnswers": [
    {
      "answerRecord": "A String",
      "metadata": {
        "a_key": "A String",
      },
      "snippets": [
        "A String",
      ],
      "title": "A String",
      "uri": "A String",
    },
  ],
  "contextSize": 42,
  "latestMessage": "A String",
}
suggestFaqAnswers(parent, body=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
  "assistQueryParams": {
    "documentsMetadataFilters": {
      "a_key": "A String",
    },
  },
  "contextSize": 42,
  "latestMessage": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "contextSize": 42,
  "faqAnswers": [
    {
      "answer": "A String",
      "answerRecord": "A String",
      "confidence": 3.14,
      "metadata": {
        "a_key": "A String",
      },
      "question": "A String",
      "source": "A String",
    },
  ],
  "latestMessage": "A String",
}
suggestKnowledgeAssist(parent, body=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
  "contextSize": 42,
  "latestMessage": "A String",
  "previousSuggestedQuery": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "contextSize": 42,
  "knowledgeAssistAnswer": {
    "answerRecord": "A String",
    "knowledgeAssistDebugInfo": {
      "datastoreResponseReason": "A String",
      "ingestedContextReferenceDebugInfo": {
        "contextReferenceRetrieved": True or False,
        "ingestedParametersDebugInfo": [
          {
            "ingestionStatus": "A String",
            "parameter": "A String",
          },
        ],
        "projectNotAllowlisted": True or False,
      },
      "knowledgeAssistBehavior": {
        "answerGenerationRewriterOn": True or False,
        "appendedSearchContextCount": 42,
        "conversationTranscriptHasMixedLanguages": True or False,
        "disableSyncDelivery": True or False,
        "endUserMetadataIncluded": True or False,
        "invalidItemsQuerySuggestionSkipped": True or False,
        "multipleQueriesGenerated": True or False,
        "previousQueriesIncluded": True or False,
        "primaryQueryRedactedAndReplaced": True or False,
        "queryContainedSearchContext": True or False,
        "queryGenerationAgentLanguageMismatch": True or False,
        "queryGenerationEndUserLanguageMismatch": True or False,
        "returnQueryOnly": True or False,
        "thirdPartyConnectorAllowed": True or False,
        "useCustomSafetyFilterLevel": True or False,
        "usePubsubDelivery": True or False,
        "useTranslatedMessage": True or False,
      },
      "queryCategorizationFailureReason": "A String",
      "queryGenerationFailureReason": "A String",
      "serviceLatency": {
        "internalServiceLatencies": [
          {
            "completeTime": "A String",
            "latencyMs": 3.14,
            "startTime": "A String",
            "step": "A String",
          },
        ],
      },
    },
    "suggestedQuery": {
      "queryText": "A String",
    },
    "suggestedQueryAnswer": {
      "answerText": "A String",
      "faqSource": {
        "question": "A String",
      },
      "generativeSource": {
        "snippets": [
          {
            "metadata": {
              "a_key": "", # Properties of the object.
            },
            "text": "A String",
            "title": "A String",
            "uri": "A String",
          },
        ],
      },
    },
  },
  "latestMessage": "A String",
}
suggestSmartReplies(parent, body=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
  "contextSize": 42,
  "currentTextInput": {
    "languageCode": "A String",
    "text": "A String",
  },
  "latestMessage": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "contextSize": 42,
  "latestMessage": "A String",
  "smartReplyAnswers": [
    {
      "answerRecord": "A String",
      "confidence": 3.14,
      "reply": "A String",
    },
  ],
}