Discovery Engine API . projects . locations . dataStores . conversations

Instance Methods

close()

Close httplib2 connections.

converse(name, body=None, x__xgafv=None)

Converses a conversation.

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

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.

get(name, x__xgafv=None)

Gets a Conversation.

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

Lists all Conversations by their parent DataStore.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Method Details

close()
Close httplib2 connections.
converse(name, body=None, x__xgafv=None)
Converses a conversation.

Args:
  name: string, Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ConversationalSearchService.ConverseConversation method.
  "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
    "endTime": "A String", # Output only. The time the conversation finished.
    "messages": [ # Conversation messages.
      { # Defines a conversation message.
        "createTime": "A String", # Output only. Message creation timestamp.
        "reply": { # Defines a reply message to user. # Search reply.
          "references": [ # References in the reply.
            { # Defines reference in reply.
              "anchorText": "A String", # Anchor text.
              "end": 42, # Anchor text end index.
              "start": 42, # Anchor text start index.
              "uri": "A String", # URI link reference.
            },
          ],
          "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
          "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
            "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
              "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
                "A String",
              ],
              "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
                3.14,
              ],
            },
            "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
              "A String",
            ],
            "summaryText": "A String", # The summary content.
          },
        },
        "userInput": { # Defines text input. # User text input.
          "context": { # Defines context of the conversation # Conversation context of the input.
            "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
            "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
              "A String",
            ],
          },
          "input": "A String", # Text input.
        },
      },
    ],
    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
    "startTime": "A String", # Output only. The time the conversation started.
    "state": "A String", # The state of the Conversation.
    "userPseudoId": "A String", # A unique identifier for tracking users.
  },
  "name": "A String", # Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
  "query": { # Defines text input. # Required. Current user input.
    "context": { # Defines context of the conversation # Conversation context of the input.
      "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
      "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
        "A String",
      ],
    },
    "input": "A String", # Text input.
  },
  "safeSearch": True or False, # Whether to turn on safe search.
  "servingConfig": "A String", # The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.
  "summarySpec": { # A specification for configuring a summary returned in a search response. # A specification for configuring the summary returned in the response.
    "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
    "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
    "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
    "languageCode": "A String", # Language code for Summary. Use language tags defined by BCP47.
    "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.
  },
  "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
    "a_key": "A String",
  },
}

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

Returns:
  An object of the form:

    { # Response message for ConversationalSearchService.ConverseConversation method.
  "conversation": { # External conversation proto definition. # Updated conversation including the answer.
    "endTime": "A String", # Output only. The time the conversation finished.
    "messages": [ # Conversation messages.
      { # Defines a conversation message.
        "createTime": "A String", # Output only. Message creation timestamp.
        "reply": { # Defines a reply message to user. # Search reply.
          "references": [ # References in the reply.
            { # Defines reference in reply.
              "anchorText": "A String", # Anchor text.
              "end": 42, # Anchor text end index.
              "start": 42, # Anchor text start index.
              "uri": "A String", # URI link reference.
            },
          ],
          "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
          "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
            "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
              "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
                "A String",
              ],
              "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
                3.14,
              ],
            },
            "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
              "A String",
            ],
            "summaryText": "A String", # The summary content.
          },
        },
        "userInput": { # Defines text input. # User text input.
          "context": { # Defines context of the conversation # Conversation context of the input.
            "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
            "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
              "A String",
            ],
          },
          "input": "A String", # Text input.
        },
      },
    ],
    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
    "startTime": "A String", # Output only. The time the conversation started.
    "state": "A String", # The state of the Conversation.
    "userPseudoId": "A String", # A unique identifier for tracking users.
  },
  "relatedQuestions": [ # Suggested related questions.
    "A String",
  ],
  "reply": { # Defines a reply message to user. # Answer to the current query.
    "references": [ # References in the reply.
      { # Defines reference in reply.
        "anchorText": "A String", # Anchor text.
        "end": 42, # Anchor text end index.
        "start": 42, # Anchor text start index.
        "uri": "A String", # URI link reference.
      },
    ],
    "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
    "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
      "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
        "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
          "A String",
        ],
        "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
          3.14,
        ],
      },
      "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
        "A String",
      ],
      "summaryText": "A String", # The summary content.
    },
  },
  "searchResults": [ # Search Results.
    { # Represents the search results.
      "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
        "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
          "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
          "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
          "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 100 MB.
        },
        "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
          "a_key": "", # Properties of the object.
        },
        "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
        "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
        "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
        "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
        "schemaId": "A String", # The identifier of the schema located in the same data store.
        "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
          "a_key": "", # Properties of the object.
        },
      },
      "id": "A String", # Document.id of the searched Document.
      "modelScores": { # Google provided available scores.
        "a_key": { # Double list.
          "values": [ # Double values.
            3.14,
          ],
        },
      },
    },
  ],
}
create(parent, body=None, x__xgafv=None)
Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.

Args:
  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # External conversation proto definition.
  "endTime": "A String", # Output only. The time the conversation finished.
  "messages": [ # Conversation messages.
    { # Defines a conversation message.
      "createTime": "A String", # Output only. Message creation timestamp.
      "reply": { # Defines a reply message to user. # Search reply.
        "references": [ # References in the reply.
          { # Defines reference in reply.
            "anchorText": "A String", # Anchor text.
            "end": 42, # Anchor text end index.
            "start": 42, # Anchor text start index.
            "uri": "A String", # URI link reference.
          },
        ],
        "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
        "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
          "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
            "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
              "A String",
            ],
            "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
              3.14,
            ],
          },
          "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
            "A String",
          ],
          "summaryText": "A String", # The summary content.
        },
      },
      "userInput": { # Defines text input. # User text input.
        "context": { # Defines context of the conversation # Conversation context of the input.
          "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
          "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
            "A String",
          ],
        },
        "input": "A String", # Text input.
      },
    },
  ],
  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
  "startTime": "A String", # Output only. The time the conversation started.
  "state": "A String", # The state of the Conversation.
  "userPseudoId": "A String", # A unique identifier for tracking users.
}

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

Returns:
  An object of the form:

    { # External conversation proto definition.
  "endTime": "A String", # Output only. The time the conversation finished.
  "messages": [ # Conversation messages.
    { # Defines a conversation message.
      "createTime": "A String", # Output only. Message creation timestamp.
      "reply": { # Defines a reply message to user. # Search reply.
        "references": [ # References in the reply.
          { # Defines reference in reply.
            "anchorText": "A String", # Anchor text.
            "end": 42, # Anchor text end index.
            "start": 42, # Anchor text start index.
            "uri": "A String", # URI link reference.
          },
        ],
        "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
        "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
          "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
            "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
              "A String",
            ],
            "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
              3.14,
            ],
          },
          "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
            "A String",
          ],
          "summaryText": "A String", # The summary content.
        },
      },
      "userInput": { # Defines text input. # User text input.
        "context": { # Defines context of the conversation # Conversation context of the input.
          "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
          "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
            "A String",
          ],
        },
        "input": "A String", # Text input.
      },
    },
  ],
  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
  "startTime": "A String", # Output only. The time the conversation started.
  "state": "A String", # The state of the Conversation.
  "userPseudoId": "A String", # A unique identifier for tracking users.
}
delete(name, x__xgafv=None)
Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.

Args:
  name: string, Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets a Conversation.

Args:
  name: string, Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # External conversation proto definition.
  "endTime": "A String", # Output only. The time the conversation finished.
  "messages": [ # Conversation messages.
    { # Defines a conversation message.
      "createTime": "A String", # Output only. Message creation timestamp.
      "reply": { # Defines a reply message to user. # Search reply.
        "references": [ # References in the reply.
          { # Defines reference in reply.
            "anchorText": "A String", # Anchor text.
            "end": 42, # Anchor text end index.
            "start": 42, # Anchor text start index.
            "uri": "A String", # URI link reference.
          },
        ],
        "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
        "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
          "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
            "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
              "A String",
            ],
            "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
              3.14,
            ],
          },
          "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
            "A String",
          ],
          "summaryText": "A String", # The summary content.
        },
      },
      "userInput": { # Defines text input. # User text input.
        "context": { # Defines context of the conversation # Conversation context of the input.
          "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
          "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
            "A String",
          ],
        },
        "input": "A String", # Text input.
      },
    },
  ],
  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
  "startTime": "A String", # Output only. The time the conversation started.
  "state": "A String", # The state of the Conversation.
  "userPseudoId": "A String", # A unique identifier for tracking users.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Conversations by their parent DataStore.

Args:
  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
  orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
  pageToken: string, A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListConversations method.
  "conversations": [ # All the Conversations for a given data store.
    { # External conversation proto definition.
      "endTime": "A String", # Output only. The time the conversation finished.
      "messages": [ # Conversation messages.
        { # Defines a conversation message.
          "createTime": "A String", # Output only. Message creation timestamp.
          "reply": { # Defines a reply message to user. # Search reply.
            "references": [ # References in the reply.
              { # Defines reference in reply.
                "anchorText": "A String", # Anchor text.
                "end": 42, # Anchor text end index.
                "start": 42, # Anchor text start index.
                "uri": "A String", # URI link reference.
              },
            ],
            "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
            "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
              "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
                "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
                  "A String",
                ],
                "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
                  3.14,
                ],
              },
              "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
                "A String",
              ],
              "summaryText": "A String", # The summary content.
            },
          },
          "userInput": { # Defines text input. # User text input.
            "context": { # Defines context of the conversation # Conversation context of the input.
              "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
              "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
                "A String",
              ],
            },
            "input": "A String", # Text input.
          },
        },
      ],
      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
      "startTime": "A String", # Output only. The time the conversation started.
      "state": "A String", # The state of the Conversation.
      "userPseudoId": "A String", # A unique identifier for tracking users.
    },
  ],
  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
}
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.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.

Args:
  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` (required)
  body: object, The request body.
    The object takes the form of:

{ # External conversation proto definition.
  "endTime": "A String", # Output only. The time the conversation finished.
  "messages": [ # Conversation messages.
    { # Defines a conversation message.
      "createTime": "A String", # Output only. Message creation timestamp.
      "reply": { # Defines a reply message to user. # Search reply.
        "references": [ # References in the reply.
          { # Defines reference in reply.
            "anchorText": "A String", # Anchor text.
            "end": 42, # Anchor text end index.
            "start": 42, # Anchor text start index.
            "uri": "A String", # URI link reference.
          },
        ],
        "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
        "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
          "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
            "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
              "A String",
            ],
            "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
              3.14,
            ],
          },
          "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
            "A String",
          ],
          "summaryText": "A String", # The summary content.
        },
      },
      "userInput": { # Defines text input. # User text input.
        "context": { # Defines context of the conversation # Conversation context of the input.
          "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
          "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
            "A String",
          ],
        },
        "input": "A String", # Text input.
      },
    },
  ],
  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
  "startTime": "A String", # Output only. The time the conversation started.
  "state": "A String", # The state of the Conversation.
  "userPseudoId": "A String", # A unique identifier for tracking users.
}

  updateMask: string, Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # External conversation proto definition.
  "endTime": "A String", # Output only. The time the conversation finished.
  "messages": [ # Conversation messages.
    { # Defines a conversation message.
      "createTime": "A String", # Output only. Message creation timestamp.
      "reply": { # Defines a reply message to user. # Search reply.
        "references": [ # References in the reply.
          { # Defines reference in reply.
            "anchorText": "A String", # Anchor text.
            "end": 42, # Anchor text end index.
            "start": 42, # Anchor text start index.
            "uri": "A String", # URI link reference.
          },
        ],
        "reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
        "summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
          "safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
            "categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
              "A String",
            ],
            "scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
              3.14,
            ],
          },
          "summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
            "A String",
          ],
          "summaryText": "A String", # The summary content.
        },
      },
      "userInput": { # Defines text input. # User text input.
        "context": { # Defines context of the conversation # Conversation context of the input.
          "activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
          "contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
            "A String",
          ],
        },
        "input": "A String", # Text input.
      },
    },
  ],
  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
  "startTime": "A String", # Output only. The time the conversation started.
  "state": "A String", # The state of the Conversation.
  "userPseudoId": "A String", # A unique identifier for tracking users.
}