Ottenere risultati di ricerca da StreamAssist

Nella tua app web, puoi ricevere risposte alle tue domande sotto forma di risposte in streaming. Questo documento mostra come utilizzare l'API REST per ottenere risposte. Se vuoi utilizzare l'app web Gemini Enterprise, consulta Chattare con l'assistente.

Panoramica di StreamAssist

StreamAssist offre un modo potente e interattivo per gestire le query degli utenti. Funziona in streaming, consentendo interazioni in tempo reale.

Le funzionalità principali dell'API includono:

• Mantenimento del contesto conversazionale: utilizza le sessioni per mantenere il contesto conversazionale, assicurandosi di comprendere le query successive nell'ambito delle interazioni precedenti.

• Incorporazione dei file forniti: include i file allegati come contesto per risposte più informate e pertinenti.

• Integrazione perfetta: si integra con vari agenti e strumenti per soddisfare un'ampia gamma di richieste degli utenti.

Prima di iniziare

Assicurati di disporre di quanto segue:

• L'API Discovery Engine abilitata per il tuo Google Cloud. Puoi abilitarla nella pagina API Discovery Engine della console Google Cloud .

  Vai all'API Discovery Engine

• Un ruolo Discovery Engine a cui è assegnata l'autorizzazione discoveryengine.assistants.assist.

• Un'app Gemini Enterprise esistente. Per creare un'app, vedi Crea un'app.

Ottenere risultati di ricerca

Puoi utilizzare il metodo streamAssist per eseguire query e ottenere risposte da Gemini Enterprise. Il seguente comando curl elenca i campi obbligatori.

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

Sostituisci quanto segue:

• ENDPOINT_LOCATION-: la multiregione per la tua richiesta API. Assegna uno dei seguenti valori:
  • us- per la multiregione Stati Uniti
  • eu- per la multiregione EU
  • global- per la località globale
  Per saperne di più, consulta Specifica una regione multipla per il datastore.
• PROJECT_ID: l'ID del tuo Google Cloud progetto.
• APP_ID: l'identificatore univoco dell'app Gemini Enterprise.
• LOCATION: la multiregione del datastore: global, us o eu
• QUERY_TEXT_1: il testo della query di ricerca.

Esempio di comando e risultato

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

Per ulteriori informazioni sui campi e su ciò che viene restituito, consulta Corpo della risposta.

Nota :per continuare la conversazione nella stessa sessione, salva il valore di session dalla risposta e includilo nella query successiva.

Ottenere risultati di ricerca utilizzando la stessa sessione

Per continuare una conversazione e ricevere risposte da Gemini Enterprise all'interno di una sessione esistente, utilizza il metodo streamAssist. Il seguente esempio di codice mostra i campi obbligatori:

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

Sostituisci quanto segue:

• ENDPOINT_LOCATION-: la multiregione per la tua richiesta API. Assegna uno dei seguenti valori:
  • us- per la multiregione Stati Uniti
  • eu- per la multiregione EU
  • global- per la località globale
  Per saperne di più, consulta Specifica una regione multipla per il datastore.
• PROJECT_ID: l'ID del tuo Google Cloud progetto.
• APP_ID: l'identificatore univoco dell'app Gemini Enterprise.
• LOCATION: la multiregione del datastore: global, us o eu
• QUERY_TEXT_2: il testo della query di ricerca.
• SESSION_ID: l'ID di una sessione di una conversazione o query precedente.

Esempio di comando e risultato

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

Per ulteriori informazioni sui campi e su ciò che viene restituito, consulta Corpo della risposta.

Nota :per continuare la conversazione nella stessa sessione, salva il valore di session dalla risposta e includilo nella query successiva.

Caricare un file e ottenere risultati di ricerca (anteprima)

Anteprima

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini di servizio generali dei Termini di servizio specifici. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per ulteriori informazioni, consulta le descrizioni delle fasi di lancio.

Per fornire più contesto all'assistente, carica un file in una sessione e poi interroga i suoi contenuti. Segui questi passaggi:

1. Carica un file in una sessione utilizzando il metodo 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"
   }'
   
   

   Sostituisci quanto segue:

   • ENDPOINT_LOCATION-: la multiregione per la tua richiesta API. Assegna uno dei seguenti valori:
     • us- per la multiregione Stati Uniti
     • eu- per la multiregione EU
     • global- per la località globale
     Per saperne di più, consulta Specifica una regione multipla per il datastore.
   • PROJECT_ID: l'ID del tuo Google Cloud progetto.
   • LOCATION: la multiregione del datastore: global, us o eu
   • APP_ID: l'identificatore univoco dell'app Gemini Enterprise.
   • SESSION_ID: l'ID di una sessione di una conversazione o query precedente.
   • FILE_NAME: il nome del file.
   • MIME_TYPE: il tipo MIME del file, ad esempio text/plain o application/pdf. Per saperne di più sui diversi tipi di contenuti multimediali, consulta Tipi di contenuti multimediali.
   • BASE64_ENCODED_FILE: la rappresentazione codificata in base64 del file.

   Esempio di comando e risultato

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

   Per ulteriori informazioni sui campi e su ciò che viene restituito, consulta Corpo della risposta.

   Nota: per continuare la conversazione nella stessa sessione, salva i valori session e fileId della risposta e includili nella query successiva.

2. Utilizza la stessa sessione per porre una domanda sul file che hai caricato utilizzando il metodo 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"
     }
   }'
   
   

   Sostituisci quanto segue:

   • ENDPOINT_LOCATION-: la multiregione per la tua richiesta API. Assegna uno dei seguenti valori:
     • us- per la multiregione Stati Uniti
     • eu- per la multiregione EU
     • global- per la località globale
     Per saperne di più, consulta Specifica una regione multipla per il datastore.
   • PROJECT_ID: l'ID del tuo Google Cloud progetto.
   • APP_ID: l'identificatore univoco dell'app Gemini Enterprise.
   • LOCATION: la multiregione del datastore: global, us o eu
   • QUERY_TEXT_3: il testo della query di ricerca.
   • SESSION_ID: l'ID di una sessione di una conversazione o query precedente.
   • FILE_ID: l'ID del file che hai caricato nell'assistente.

   Esempio di comando e risultato

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

   Per ulteriori informazioni sui campi e su ciò che viene restituito, consulta Corpo della risposta.