Dialogflow API . projects . locations . conversations . suggestions

Instance Methods

close()

Close httplib2 connections.

generate(conversation, body=None, x__xgafv=None)

searchKnowledge(conversation, body=None, x__xgafv=None)

suggestConversationSummary(conversation, body=None, x__xgafv=None)

Method Details

close()
Close httplib2 connections.
generate(conversation, body=None, x__xgafv=None)

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

{
  "latestMessage": "A String",
  "triggerEvents": [
    "A String",
  ],
}

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

Returns:
  An object of the form:

    {
  "generatorSuggestionAnswers": [
    {
      "answerRecord": "A String",
      "generatorSuggestion": {
        "agentCoachingSuggestion": {
          "agentActionSuggestions": [
            {
              "agentAction": "A String",
              "duplicateCheckResult": {
                "duplicateSuggestions": [
                  {
                    "answerRecord": "A String",
                    "similarityScore": 3.14,
                    "sources": {
                      "instructionIndexes": [
                        42,
                      ],
                    },
                    "suggestionIndex": 42,
                  },
                ],
              },
              "sources": {
                "instructionIndexes": [
                  42,
                ],
              },
            },
          ],
          "applicableInstructions": [
            {
              "agentAction": "A String",
              "condition": "A String",
              "displayDetails": "A String",
              "displayName": "A String",
              "duplicateCheckResult": {
                "duplicateSuggestions": [
                  {
                    "answerRecord": "A String",
                    "similarityScore": 3.14,
                    "suggestionIndex": 42,
                  },
                ],
              },
              "systemAction": "A String",
              "triggeringEvent": "A String",
            },
          ],
          "sampleResponses": [
            {
              "duplicateCheckResult": {
                "duplicateSuggestions": [
                  {
                    "answerRecord": "A String",
                    "similarityScore": 3.14,
                    "sources": {
                      "instructionIndexes": [
                        42,
                      ],
                    },
                    "suggestionIndex": 42,
                  },
                ],
              },
              "responseText": "A String",
              "sources": {
                "instructionIndexes": [
                  42,
                ],
              },
            },
          ],
        },
        "freeFormSuggestion": {
          "response": "A String",
        },
        "summarySuggestion": {
          "summarySections": [
            {
              "section": "A String",
              "summary": "A String",
            },
          ],
        },
        "toolCallInfo": [
          {
            "toolCall": {
              "action": "A String",
              "answerRecord": "A String",
              "createTime": "A String",
              "inputParameters": {
                "a_key": "", # Properties of the object.
              },
              "state": "A String",
              "tool": "A String",
              "toolDisplayDetails": "A String",
              "toolDisplayName": "A String",
            },
            "toolCallResult": {
              "action": "A String",
              "answerRecord": "A String",
              "content": "A String",
              "createTime": "A String",
              "error": {
                "message": "A String",
              },
              "rawContent": "A String",
              "tool": "A String",
            },
          },
        ],
      },
      "sourceGenerator": "A String",
    },
  ],
  "latestMessage": "A String",
}
searchKnowledge(conversation, body=None, x__xgafv=None)

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

{
  "conversation": "A String",
  "conversationProfile": "A String",
  "endUserMetadata": {
    "a_key": "", # Properties of the object.
  },
  "exactSearch": True or False,
  "latestMessage": "A String",
  "parent": "A String",
  "query": {
    "languageCode": "A String",
    "text": "A String",
  },
  "querySource": "A String",
  "searchConfig": {
    "boostSpecs": [
      {
        "dataStores": [
          "A String",
        ],
        "spec": [
          {
            "conditionBoostSpecs": [
              {
                "boost": 3.14,
                "boostControlSpec": {
                  "attributeType": "A String",
                  "controlPoints": [
                    {
                      "attributeValue": "A String",
                      "boostAmount": 3.14,
                    },
                  ],
                  "fieldName": "A String",
                  "interpolationType": "A String",
                },
                "condition": "A String",
              },
            ],
          },
        ],
      },
    ],
    "filterSpecs": [
      {
        "dataStores": [
          "A String",
        ],
        "filter": "A String",
      },
    ],
  },
  "sessionId": "A String",
}

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

Returns:
  An object of the form:

    {
  "answers": [
    {
      "answer": "A String",
      "answerRecord": "A String",
      "answerSources": [
        {
          "metadata": {
            "a_key": "", # Properties of the object.
          },
          "snippet": "A String",
          "title": "A String",
          "uri": "A String",
        },
      ],
      "answerType": "A String",
    },
  ],
  "rewrittenQuery": "A String",
  "searchKnowledgeDebugInfo": {
    "datastoreResponseReason": "A String",
    "ingestedContextReferenceDebugInfo": {
      "contextReferenceRetrieved": True or False,
      "ingestedParametersDebugInfo": [
        {
          "ingestionStatus": "A String",
          "parameter": "A String",
        },
      ],
      "projectNotAllowlisted": True or False,
    },
    "searchKnowledgeBehavior": {
      "answerGenerationRewriterOn": True or False,
      "endUserMetadataIncluded": True or False,
      "thirdPartyConnectorAllowed": True or False,
    },
    "serviceLatency": {
      "internalServiceLatencies": [
        {
          "completeTime": "A String",
          "latencyMs": 3.14,
          "startTime": "A String",
          "step": "A String",
        },
      ],
    },
  },
}
suggestConversationSummary(conversation, body=None, x__xgafv=None)

Args:
  conversation: 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,
  "latestMessage": "A String",
  "summary": {
    "answerRecord": "A String",
    "baselineModelVersion": "A String",
    "sortedTextSections": [
      {
        "section": "A String",
        "summary": "A String",
      },
    ],
    "text": "A String",
    "textSections": {
      "a_key": "A String",
    },
  },
}