Discovery Engine API . projects . locations . collections . engines . sessions . answers

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a Answer.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets a Answer.

Args:
  name: string, Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines an answer.
  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
    "A String",
  ],
  "answerText": "A String", # The textual answer.
  "citations": [ # Citations.
    { # Citation info for a segment.
      "endIndex": "A String", # End of the attributed segment, exclusive.
      "sources": [ # Citation sources for the attributed segment.
        { # Citation source.
          "referenceId": "A String", # ID of the citation source.
        },
      ],
      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
    },
  ],
  "completeTime": "A String", # Output only. Answer completed timestamp.
  "createTime": "A String", # Output only. Answer creation timestamp.
  "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
    "queryClassificationInfo": [ # Query classification information.
      { # Query classification information.
        "positive": True or False, # Classification output.
        "type": "A String", # Query classification type.
      },
    ],
  },
  "references": [ # References.
    { # Reference.
      "chunkInfo": { # Chunk information. # Chunk information.
        "chunk": "A String", # Chunk resource name.
        "content": "A String", # Chunk textual content.
        "documentMetadata": { # Document metadata. # Document metadata.
          "document": "A String", # Document resource name.
          "pageIdentifier": "A String", # Page identifier.
          "structData": { # The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.
            "a_key": "", # Properties of the object.
          },
          "title": "A String", # Title.
          "uri": "A String", # URI for the document.
        },
        "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
      },
      "structuredDocumentInfo": { # Structured search information. # Structured document information.
        "document": "A String", # Document resource name.
        "structData": { # Structured search data.
          "a_key": "", # Properties of the object.
        },
      },
      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
        "chunkContents": [ # List of cited chunk contents derived from document content.
          { # Chunk content.
            "content": "A String", # Chunk textual content.
            "pageIdentifier": "A String", # Page identifier.
            "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
          },
        ],
        "document": "A String", # Document resource name.
        "structData": { # The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.
          "a_key": "", # Properties of the object.
        },
        "title": "A String", # Title.
        "uri": "A String", # URI for the document.
      },
    },
  ],
  "relatedQuestions": [ # Suggested related questions.
    "A String",
  ],
  "state": "A String", # The state of the answer generation.
  "steps": [ # Answer generation steps.
    { # Step information.
      "actions": [ # Actions.
        { # Action.
          "observation": { # Observation. # Observation.
            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
              {
                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
                  { # Chunk information.
                    "chunk": "A String", # Chunk resource name.
                    "content": "A String", # Chunk textual content.
                    "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
                  },
                ],
                "document": "A String", # Document resource name.
                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
                  { # Snippet information.
                    "snippet": "A String", # Snippet content.
                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
                  },
                ],
                "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.
                  "a_key": "", # Properties of the object.
                },
                "title": "A String", # Title.
                "uri": "A String", # URI for the document.
              },
            ],
          },
          "searchAction": { # Search action. # Search action.
            "query": "A String", # The query to search.
          },
        },
      ],
      "description": "A String", # The description of the step.
      "state": "A String", # The state of the step.
      "thought": "A String", # The thought of the step.
    },
  ],
}