此页面由 Cloud Translation API 翻译。

获取 StreamAssist 的搜索结果

在 Web 应用中，您可以获得流式响应形式的问题解答。本文档介绍了如何使用 REST API 获取答案。如果您想使用 Gemini Enterprise Web 应用，请参阅与助理对话。

StreamAssist 概览

StreamAssist 提供了一种强大的互动方式来处理用户查询。它以流式方式运行，支持实时来回互动。

该 API 的主要功能包括：

保持对话上下文：它使用会话来保持对话上下文，确保它能理解之前互动范围内的后续查询。
纳入提供的文件：将附加文件作为上下文，以便生成更明智、更相关的回答。
无缝集成：可与各种代理和工具集成，以满足各种用户请求。

准备工作

确保您具有以下各项：

为您的 Google Cloud启用了 Discovery Engine API。您可以在Google Cloud 控制台中的 Discovery Engine API 页面上启用该 API。

前往 Discovery Engine API
已分配 discoveryengine.assistants.assist 权限的 Discovery Engine 角色。
现有的 Gemini Enterprise 应用。如需创建应用，请参阅创建应用。

获取搜索结果

您可以使用 streamAssist 方法向 Gemini Enterprise 提问并获取回答。以下 curl 命令列出了必填字段。

REST

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant:streamAssist" \
  -d '
{
  "query": {
    "text": "QUERY_TEXT_1"
  }
}'

替换以下内容：

ENDPOINT_LOCATION-：API 请求的多区域。分配以下值之一：
- us-（表示美国多区域）
- eu-（表示欧盟多区域）
- global-（表示全球位置）
如需了解详情，请参阅为数据存储区指定多区域。
PROJECT_ID：您的 Google Cloud 项目的 ID。
APP_ID：Gemini Enterprise 应用的唯一标识符。
LOCATION：数据存储区的多区域：global、us 或 eu
QUERY_TEXT_1：搜索查询文本。

命令和结果示例

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://global-discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant:streamAssist" \
  -d '
{
  "query": {
    "text": "By when do corporations need to file taxes?"
  }
}'

{
  "answer": {
    "name": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013/assistAnswers/123456789019",
    "state": "SUCCEEDED",
    "replies": [
      {
        "groundedContent": {},
        "replyId": "123456789050"
      },
      {
        "groundedContent": {},
        "replyId": "123456789050"
      }
    ],
    "diagnosticInfo": {
      "plannerSteps": [
        {
          "createTime": "2025-11-24T22:21:13.958569117Z",
          "queryStep": {
            "parts": [
              {
                "text": "By when do corporations need to file taxes?"
              }
            ]
          }
        },
        {
          "createTime": "2025-11-24T22:21:17.218914056Z",
          "planStep": {
            "parts": [
              {
                "text": "**Formulating the Query**\n"
              }
            ],
            "planStepId": "123456789050",
            "role": "MODEL"
          }
        },
        {
          "planStep": {
            "parts": [
              {
                "text": "**Refining the Response**\n"
              }
            ],
            "role": "MODEL",
            "planStepId": "123456789050"
          },
          "createTime": "2025-11-24T22:21:19.734447578Z"
        },
        {
          "createTime": "2025-11-24T22:21:21.940682307Z",
          "planStep": {
            "planStepId": "123456789050",
            "role": "MODEL",
            "parts": [
              {
                "text": "**Processing the Results**\n"
              }
            ]
          }
        },
        {
          "planStep": {
            "role": "MODEL",
            "parts": [
              {
                "text": "**Querying and Analyzing**\n**Structuring the Answer**\n"
              }
            ],
            "planStepId": "123456789050"
          },
          "createTime": "2025-11-24T22:21:25.058155923Z"
        },
        {
          "createTime": "2025-11-24T22:21:25.955761161Z",
          "planStep": {
            "planStepId": "123456789050",
            "role": "MODEL",
            "parts": [
              {
                "text": "**Refining the Details**\n"
              }
            ]
          }
        },
        {
          "createTime": "2025-11-24T22:21:25.967576803Z",
          "planStep": {
            "role": "MODEL",
            "parts": [
              {
                "text": "Of course, I can help with that. The deadline for corporations to file their federal income tax returns depends on the type of corporation.\n\n### **Corporate Tax Filing Deadlines**\n\n| Corporation Type | Deadline | For Calendar Year-End (Dec. 31) |\n| :--- | :--- | :--- |"
              }
            ],
            "planStepId": "123456789050"
          }
        },
        {
          "createTime": "2025-11-24T22:21:25.988820408Z",
          "planStep": {
            "planStepId": "123456789050",
            "role": "MODEL",
            "parts": [
              {
                "text": "\n| **C Corporations** | 15th day of the fourth month after the end of their fiscal year. | April 15 |\n| **S Corporations** | 15th day of the third month after the end of their fiscal year. | March 15 |\n\n---\n\n###"
              }
            ]
          }
        },
        {
          "createTime": "2025-11-24T22:21:26.016095651Z",
          "planStep": {
            "planStepId": "123456789050",
            "role": "MODEL",
            "parts": [
              {
                "text": " **Extensions**\n\nIf a corporation needs more time to file, it can request a six-month extension by filing the appropriate form with the IRS. It's important to note that an extension to file is not an extension to pay. Taxes are still due by the original deadline.\n\nWould you like to know about"
              }
            ]
          }
        },
        {
          "planStep": {
            "parts": [
              {
                "text": " the deadlines for any other types of business entities?"
              }
            ],
            "planStepId": "123456789050",
            "role": "MODEL"
          },
          "createTime": "2025-11-24T22:21:26.070810455Z"
        }
      ]
    }
  },
  "sessionInfo": {
    "session": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013",
    "queryId": "123456789078",
    "turnId": "123456789013_123456789029"
  },
  "assistToken": "1234567890123456789012345678901234567890"
}

如需详细了解这些字段以及返回的内容，请参阅响应正文。

使用同一会话获取搜索结果

如需在现有会话中继续对话并从 Gemini Enterprise 获取回答，请使用 streamAssist 方法。以下代码示例展示了必需字段：

REST

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant:streamAssist" \
  -d '
{
  "session": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/sessions/SESSION_ID",
  "query": {
    "text": "QUERY_TEXT_2"
  }
}'

替换以下内容：

ENDPOINT_LOCATION-：API 请求的多区域。分配以下值之一：
- us-（表示美国多区域）
- eu-（表示欧盟多区域）
- global-（表示全球位置）
如需了解详情，请参阅为数据存储区指定多区域。
PROJECT_ID：您的 Google Cloud 项目的 ID。
APP_ID：Gemini Enterprise 应用的唯一标识符。
LOCATION：数据存储区的多区域：global、us 或 eu
QUERY_TEXT_2：搜索查询文本。
SESSION_ID：之前对话或查询中的会话 ID。

命令和结果示例

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://global-discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant:streamAssist" \
  -d '
{
  "session": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013",
  "query": {
    "text": "what are the documents you need to file taxes?"
  }
}'

{
  "answer": {
    "name": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013/assistAnswers/15195007515750046778",
    "state": "SUCCEEDED",
    "replies": [
      {
        "groundedContent": {},
        "replyId": "123456789051"
      },
      {
        "groundedContent": {},
        "replyId": "123456789051"
      }
    ],
    "diagnosticInfo": {
      "plannerSteps": [
        {
          "queryStep": {
            "parts": [
              {
                "text": "what are the documents you need to file taxes?"
              }
            ]
          },
          "createTime": "2025-11-24T23:06:45.101296577Z"
        },
        {
          "planStep": {
            "role": "MODEL",
            "parts": [
              {
                "text": "**Identifying Tax Documents**\n"
              }
            ],
            "planStepId": "123456789051"
          },
          "createTime": "2025-11-24T23:06:48.201642404Z"
        },
        {
          "planStep": {
            "parts": [
              {
                "text": "**Formulating the Search Strategy**\n"
              }
            ],
            "role": "MODEL",
            "planStepId": "123456789051"
          },
          "createTime": "2025-11-24T23:06:51.081693248Z"
        },
        {
          "createTime": "2025-11-24T23:06:53.884827627Z",
          "planStep": {
            "parts": [
              {
                "text": "**Searching for Information**\n"
              }
            ],
            "role": "MODEL",
            "planStepId": "123456789051"
          }
        },
        {
          "createTime": "2025-11-24T23:06:55.663545003Z",
          "planStep": {
            "role": "MODEL",
            "parts": [
              {
                "text": "**Planning the Response Structure**\n"
              }
            ],
            "planStepId": "123456789051"
          }
        },
        {
          "planStep": {
            "planStepId": "123456789051",
            "parts": [
              {
                "text": "Of course, I can provide a list of the common documents and information you'll need to file your personal income taxes. Having these ready can make the process much smoother.\n\n### **Documents for Filing Personal Taxes**\n\n| Category | Document/Information | Purpose |\n| :--- | :--- | :--- |"
              }
            ],
            "role": "MODEL"
          },
          "createTime": "2025-11-24T23:06:55.687661122Z"
        },
        {
          "planStep": {
            "planStepId": "123456789051",
            "parts": [
              {
                "text": "\n| **Personal Information** | \u003cul\u003e\u003cli\u003eYour Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN)\u003c/li\u003e\u003cli\u003eSSNs or ITINs for your spouse and any dependents\u003c/li\u003e\u003c/ul\u003e | To identify you and your family members to the IRS. |\n| **Income Information** | \u003cul\u003e\u003cli\u003e**"
              }
            ],
            "role": "MODEL"
          },
          "createTime": "2025-11-24T23:06:55.713426005Z"
        },
        {
          "planStep": {
            "role": "MODEL",
            "parts": [
              {
                "text": "W-2 forms** from all employers.\u003c/li\u003e\u003cli\u003e**1099 forms** such as 1099-NEC, 1099-DIV, 1099-INT, 1099-G.\u003c/li\u003e\u003cli\u003eRecords of any other income (business, rental, etc.).\u003c/li\u003e\u003c/ul\u003e | To"
              }
            ],
            "planStepId": "123456789051"
          },
          "createTime": "2025-11-24T23:06:56.158732383Z"
        },
        {
          "createTime": "2025-11-24T23:06:56.700143436Z",
          "planStep": {
            "role": "MODEL",
            "parts": [
              {
                "text": " report all of your income from various sources. |\n| **Deductions & Credits** | \u003cul\u003e\u003cli\u003eReceipts for charitable donations.\u003c/li\u003e\u003cli\u003eMedical expense records.\u003c/li\u003e\u003cli\u003e**Form 1098** (mortgage interest) & **1098-T** (tuition).\u003c/li\u003e\u003cli\u003eChild"
              }
            ],
            "planStepId": "123456789051"
          }
        },
        {
          "planStep": {
            "planStepId": "123456789051",
            "role": "MODEL",
            "parts": [
              {
                "text": "care expense records.\u003c/li\u003e\u003c/ul\u003e | To reduce your taxable income and take advantage of tax credits. |\n| **Other Documents** | \u003cul\u003e\u003cli\u003eLast year's tax return.\u003c/li\u003e\u003cli\u003eBank account and routing numbers.\u003c/li\u003e\u003c/ul\u003e | For reference and to receive a direct deposit refund or make a payment. |\n\n---\n\nThis"
              }
            ]
          },
          "createTime": "2025-11-24T23:06:57.410549380Z"
        },
        {
          "planStep": {
            "planStepId": "123456789051",
            "parts": [
              {
                "text": " list covers the most common items, but your specific needs may vary depending on your financial situation. It's always a good idea to keep your tax-related documents organized throughout the year.\n\nIs there a specific type of income or deduction you would like to know more about?"
              }
            ],
            "role": "MODEL"
          },
          "createTime": "2025-11-24T23:06:57.960883085Z"
        }
      ]
    }
  },
  "sessionInfo": {
    "session": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013",
    "queryId": "123456789057",
    "turnId": "123456789013_123456789072"
  },
  "assistToken": "1234567890123456789012345678901234567890"
}

如需详细了解这些字段以及返回的内容，请参阅响应正文。

上传文件并获取搜索结果（预览版）

如需为助理提供更多相关信息，请将文件上传到会话，然后查询其内容。请按照以下步骤操作：

使用 addContextFile 方法将文件上传到会话。

REST

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/sessions/SESSION_ID:addContextFile" \
  -d '
{
  "fileName": "FILE_NAME",
  "mimeType": "MIME_TYPE",
  "fileContents": "BASE64_ENCODED_FILE"
}'

替换以下内容：

ENDPOINT_LOCATION-：API 请求的多区域。分配以下值之一：
- us-（表示美国多区域）
- eu-（表示欧盟多区域）
- global-（表示全球位置）
如需了解详情，请参阅为数据存储区指定多区域。
PROJECT_ID：您的 Google Cloud 项目的 ID。
LOCATION：数据存储区的多区域：global、us 或 eu
APP_ID：Gemini Enterprise 应用的唯一标识符。
SESSION_ID：之前对话或查询中的会话 ID。
FILE_NAME：文件的名称。
MIME_TYPE：文件的 MIME 类型，例如 text/plain 或 application/pdf。如需详细了解不同的媒体类型，请参阅媒体类型。
BASE64_ENCODED_FILE：文件的 base64 编码表示形式。

命令和结果示例

# Create a sample file to upload
export FILE_NAME="my_test_file.txt"
export FILE_PATH="/tmp/${FILE_NAME}"
echo "This is a sample text file to upload for the Gemini Enterprise assistant." > "${FILE_PATH}"
echo "It contains a few lines of text." >> "${FILE_PATH}"

# Base64 encode the file content
export BASE64_ENCODED_FILE=$(base64 -w 0 "${FILE_PATH}")


#Upload the file to the session using the curl command

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://global-discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013:addContextFile" \
  -d '
{
  "fileName": "my_test_file.txt",
  "mimeType": "text/plain",
  "fileContents": "'"$BASE64_ENCODED_FILE"'"
}'

# Response

{
  "session": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013",
  "fileId": "123456789012345",
  "tokenCount": "24"
}

如需详细了解这些字段以及返回的内容，请参阅响应正文。

使用同一会话询问有关您使用 streamAssist 方法上传的文件的相关问题。

REST

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant:streamAssist" \
  -d '
{
  "session": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/sessions/SESSION_ID",
  "fileIds": ["FILE_ID"],
  "query": {
    "text": "QUERY_TEXT_3"
  }
}'

替换以下内容：

ENDPOINT_LOCATION-：API 请求的多区域。分配以下值之一：
- us-（表示美国多区域）
- eu-（表示欧盟多区域）
- global-（表示全球位置）
如需了解详情，请参阅为数据存储区指定多区域。
PROJECT_ID：您的 Google Cloud 项目的 ID。
APP_ID：Gemini Enterprise 应用的唯一标识符。
LOCATION：数据存储区的多区域：global、us 或 eu
QUERY_TEXT_3：搜索查询文本。
SESSION_ID：之前对话或查询中的会话 ID。
FILE_ID：您上传到助理的文件的 ID。

命令和结果示例

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://global-discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant:streamAssist" \
  -d '
{
  "session": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013",
  "fileIds": ["123456789012345"],
  "query": {
    "text": "Repeat the text in the file"
  }
}'

{
  "answer": {
    "name": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/123456789013/assistAnswers/123456789065",
    "state": "SUCCEEDED",
    "replies": [
      {
        "groundedContent": {},
        "replyId": "123456789009"
      },
      {
        "groundedContent": {},
        "replyId": "717422098702389109"
      }
    ],
    "diagnosticInfo": {
      "plannerSteps": [
        {
          "createTime": "2025-11-26T03:56:30.270018719Z",
          "queryStep": {
            "parts": [
              {
                "text": "repeat the text in the file"
              },
              {}
            ]
          }
        },
        {
          "createTime": "2025-11-26T03:56:32.976071976Z",
          "planStep": {
            "role": "MODEL",
            "planStepId": "717422098702389109",
            "parts": [
              {
                "text": "**Addressing the Repetition**\n"
              }
            ]
          }
        },
        {
          "createTime": "2025-11-26T03:56:35.390573666Z",
          "planStep": {
            "planStepId": "717422098702389109",
            "parts": [
              {
                "text": "**Identifying User Intent**\n"
              }
            ],
            "role": "MODEL"
          }
        },
        {
          "createTime": "2025-11-26T03:56:37.586889807Z",
          "planStep": {
            "planStepId": "717422098702389109",
            "parts": [
              {
                "text": "**Analyzing the Repetition**\n"
              }
            ],
            "role": "MODEL"
          }
        },
        {
          "createTime": "2025-11-26T03:56:37.611172643Z",
          "planStep": {
            "parts": [
              {
                "text": "Of course. The text in the file `my_test_file.txt` is:\n\nThis is a sample text file to upload for the Gemini Enterprise assistant.\nIt contains a few lines of text.\n\nIs there anything else I can assist you with?"
              }
            ],
            "role": "MODEL",
            "planStepId": "717422098702389109"
          }
        }
      ]
    }
  },
  "sessionInfo": {
    "session": "projects/my-project-123/locations/global/collections/default_collection/engines/my-app/sessions/8715627784376195363",
    "queryId": "2129985467851228910",
    "turnId": "8715627784376195363_2129985467851230549"
  },
  "assistToken": "NMwKDAjt9JnJBhCGypGkARIkNjkyMWQzZjktMDAwMC0yM2UyLWJlMjAtNTgyNDI5YTdhOTYw"
}

如需详细了解这些字段以及返回的内容，请参阅响应正文。

获取 StreamAssist 的搜索结果 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

StreamAssist 概览

准备工作

获取搜索结果

REST

命令和结果示例

使用同一会话获取搜索结果

REST

命令和结果示例

上传文件并获取搜索结果（预览版）

REST

命令和结果示例

REST

命令和结果示例

获取 StreamAssist 的搜索结果