Obtenha resultados da pesquisa do StreamAssist

Na app Web, pode receber respostas às suas perguntas sob a forma de respostas em streaming. Este documento mostra como usar a API REST para obter respostas. Se quiser usar a app Web Gemini Enterprise, consulte o artigo Converse com o assistente.

Vista geral do StreamAssist

O StreamAssist oferece uma forma poderosa e interativa de processar as consultas dos utilizadores. Funciona em streaming, o que permite interações em tempo real e bidirecionais.

As principais capacidades da API incluem o seguinte:

• Manter o contexto da conversa: usa sessões para manter o contexto da conversa, garantindo que compreende as consultas de seguimento no âmbito das interações anteriores.

• Incorporar ficheiros fornecidos: inclui os ficheiros anexados como contexto para respostas mais informadas e relevantes.

• Integração perfeita: integra-se com vários agentes e ferramentas para satisfazer uma vasta gama de pedidos dos utilizadores.

Antes de começar

Certifique-se de que tem o seguinte:

• A API Discovery Engine está ativada para o seu Google Cloud. Pode ativá-la na página Discovery Engine API na Google Cloud consola.

  Aceder à API Discovery Engine

• Uma função do motor Discovery com a autorização discoveryengine.assistants.assist atribuída.

• Uma app Gemini Enterprise existente. Para criar uma app, consulte o artigo Crie uma app.

Obtenha resultados da pesquisa

Pode usar o método streamAssist para consultar e receber respostas do Gemini Enterprise. O seguinte comando curl lista os campos obrigatórios.

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"
  }
}'

Substitua o seguinte:

• ENDPOINT_LOCATION-: a multirregião para o seu pedido de API. Atribua um dos seguintes valores:
  • us- para a multirregião dos EUA
  • eu- para a multirregião da UE
  • global- para a localização global
  Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
• PROJECT_ID: o ID do seu projeto Google Cloud .
• APP_ID: o identificador exclusivo da app Gemini Enterprise.
• LOCATION: a multirregião do seu repositório de dados: global, us ou eu
• QUERY_TEXT_1: o texto da consulta de pesquisa.

Exemplo de comando e resultado

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"
}

Para mais informações sobre os campos e o que é devolvido, consulte a secção Corpo da resposta.

Nota: para continuar a conversa na mesma sessão, guarde o valor session da resposta e inclua-o na sua próxima consulta.

Obtenha resultados da pesquisa usando a mesma sessão

Para continuar uma conversa e receber respostas do Gemini Enterprise numa sessão existente, use o método streamAssist. O exemplo de código seguinte mostra os campos obrigatórios:

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"
  }
}'

Substitua o seguinte:

• ENDPOINT_LOCATION-: a multirregião para o seu pedido de API. Atribua um dos seguintes valores:
  • us- para a multirregião dos EUA
  • eu- para a multirregião da UE
  • global- para a localização global
  Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
• PROJECT_ID: o ID do seu projeto Google Cloud .
• APP_ID: o identificador exclusivo da app Gemini Enterprise.
• LOCATION: a multirregião do seu repositório de dados: global, us ou eu
• QUERY_TEXT_2: o texto da consulta de pesquisa.
• SESSION_ID: o ID de uma sessão de uma conversa ou uma consulta anterior.

Exemplo de comando e resultado

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"
}

Para mais informações sobre os campos e o que é devolvido, consulte a secção Corpo da resposta.

Nota: para continuar a conversa na mesma sessão, guarde o valor session da resposta e inclua-o na sua próxima consulta.

Carregue um ficheiro e receba resultados da pesquisa (pré-visualização)

Pré-visualização

Esta funcionalidade está sujeita aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. As funcionalidades de pré-DG estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Para dar mais contexto ao assistente, carregue um ficheiro para uma sessão e, em seguida, consulte o respetivo conteúdo. Siga estes passos:

1. Carregue um ficheiro para uma sessão através do método 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"
   }'
   
   

   Substitua o seguinte:

   • ENDPOINT_LOCATION-: a multirregião para o seu pedido de API. Atribua um dos seguintes valores:
     • us- para a multirregião dos EUA
     • eu- para a multirregião da UE
     • global- para a localização global
     Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
   • PROJECT_ID: o ID do seu projeto Google Cloud .
   • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
   • APP_ID: o identificador exclusivo da app Gemini Enterprise.
   • SESSION_ID: o ID de uma sessão de uma conversa ou uma consulta anterior.
   • FILE_NAME: o nome do ficheiro.
   • MIME_TYPE: o tipo MIME do ficheiro, por exemplo, text/plain ou application/pdf. Para mais informações sobre os diferentes tipos de suportes, consulte Tipos de suportes.
   • BASE64_ENCODED_FILE: a representação do ficheiro com codificação base64.

   Exemplo de comando e resultado

   # 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"
   }
   
   
   

   Para mais informações sobre os campos e o que é devolvido, consulte a secção Corpo da resposta.

   Nota: para continuar a conversa na mesma sessão, guarde os valores session e fileId da resposta e inclua-os na sua próxima consulta.

2. Use a mesma sessão para fazer uma pergunta sobre o ficheiro que carregou através do método 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"
     }
   }'
   
   

   Substitua o seguinte:

   • ENDPOINT_LOCATION-: a multirregião para o seu pedido de API. Atribua um dos seguintes valores:
     • us- para a multirregião dos EUA
     • eu- para a multirregião da UE
     • global- para a localização global
     Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
   • PROJECT_ID: o ID do seu projeto Google Cloud .
   • APP_ID: o identificador exclusivo da app Gemini Enterprise.
   • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
   • QUERY_TEXT_3: o texto da consulta de pesquisa.
   • SESSION_ID: o ID de uma sessão de uma conversa ou uma consulta anterior.
   • FILE_ID: o ID do ficheiro que carregou para o assistente.

   Exemplo de comando e resultado

   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"
   }
   

   Para mais informações sobre os campos e o que é devolvido, consulte a secção Corpo da resposta.