Suchergebnisse von StreamAssist erhalten

In Ihrer Web-App können Sie Antworten auf Ihre Fragen in Form von Streaming-Antworten erhalten. In diesem Dokument erfahren Sie, wie Sie mit der REST API Antworten erhalten. Wenn Sie die Gemini Enterprise Web-App verwenden möchten, lesen Sie den Hilfeartikel Mit dem Assistenten chatten.

StreamAssist-Übersicht

StreamAssist bietet eine leistungsstarke, interaktive Möglichkeit, Nutzeranfragen zu bearbeiten. Es funktioniert im Streaming-Modus und ermöglicht so Echtzeit-Interaktionen.

Zu den wichtigsten Funktionen der API gehören:

• Kontext der Unterhaltung beibehalten: Es verwendet Sitzungen, um den Kontext der Unterhaltung beizubehalten, damit Folgefragen im Rahmen früherer Interaktionen verstanden werden.

• Bereitgestellte Dateien einbeziehen: Die angehängten Dateien werden als Kontext für fundiertere und relevantere Antworten verwendet.

• Nahtlose Integration: Er lässt sich in verschiedene KI-Agenten und Tools einbinden, um eine Vielzahl von Nutzeranfragen zu erfüllen.

Hinweis

Die müssen Folgendes haben:

• Die Discovery Engine API ist für Ihr Google Cloudaktiviert. Sie können sie in derGoogle Cloud Console auf der Seite Discovery Engine API aktivieren.

  Zur Discovery Engine API

• Eine Discovery Engine-Rolle, der die Berechtigung discoveryengine.assistants.assist zugewiesen ist.

• Eine vorhandene Gemini Enterprise-App. Informationen zum Erstellen einer App finden Sie unter App erstellen.

Suchergebnisse abrufen

Mit der Methode streamAssist können Sie Gemini Enterprise abfragen und Antworten erhalten. Der folgende curl-Befehl listet die Pflichtfelder auf.

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

Ersetzen Sie Folgendes:

• ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Geben Sie einen der folgenden Werte an:
• us für die Multiregion „USA“
• eu für die Multiregion „EU“
• global für den Standort „Global“

Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.

PROJECT_ID: die ID Ihres Projekts in Google Cloud .

APP_ID: die eindeutige Kennung für die Gemini Enterprise-App.

LOCATION: die Multiregion Ihres Datenspeichers: global, us oder eu

QUERY_TEXT_1: der Text der Suchanfrage.

Beispielbefehl und -ergebnis

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

Weitere Informationen zu den Feldern und den zurückgegebenen Daten finden Sie unter Antworttext.

Hinweis: Wenn Sie die Unterhaltung in derselben Sitzung fortsetzen möchten, speichern Sie den Wert session aus der Antwort und fügen Sie ihn in Ihre nächste Abfrage ein.

Python

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Python in der Gemini Enterprise-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Gemini Enterprise Python API.

Richten Sie zur Authentifizierung bei Gemini Enterprise Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter ADC für eine lokale Entwicklungsumgebung einrichten.

from google.api_core.client_options import ClientOptions
from google.cloud import discoveryengine_v1 as discoveryengine

# TODO(developer): Update these variables before running the sample.
project_id = "YOUR_PROJECT_ID"
location = "YOUR_LOCATION"
engine_id = "YOUR_APP_ID"
query = "What is Gemini Enterprise?"


def stream_assist_sample(
    project_id: str,
    location: str,
    engine_id: str,
    query: str,
):
    # For more information, refer to:
    # https://docs.cloud.google.com/gemini/enterprise/docs/locations#specify_a_multi-region_for_your_data_store
    client_options = (
        ClientOptions(api_endpoint=f"{location}-discoveryengine.googleapis.com")
        if location != "global"
        else None
    )

    client = discoveryengine.AssistantServiceClient(client_options=client_options)

    request = discoveryengine.StreamAssistRequest(
        name=client.assistant_path(
            project=project_id,
            location=location,
            collection="default_collection",
            engine=engine_id,
            assistant="default_assistant",
        ),
        query=discoveryengine.Query(text=query),
    )

    # Make the request
    stream = client.stream_assist(request=request)

    # Handle the response
    for response in stream:
        print(response)

Suchergebnisse mit derselben Sitzung abrufen

Wenn Sie eine Unterhaltung fortsetzen und Antworten von Gemini Enterprise in einer vorhandenen Sitzung erhalten möchten, verwenden Sie die Methode streamAssist. Das folgende Codebeispiel zeigt die Pflichtfelder:

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

Ersetzen Sie Folgendes:

• ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Geben Sie einen der folgenden Werte an:
• us für die Multiregion „USA“
• eu für die Multiregion „EU“
• global für den Standort „Global“

Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.

PROJECT_ID: die ID Ihres Projekts in Google Cloud .

APP_ID: die eindeutige Kennung für die Gemini Enterprise-App.

LOCATION: die Multiregion Ihres Datenspeichers: global, us oder eu

QUERY_TEXT_2: der Text der Suchanfrage.

SESSION_ID: die ID einer Sitzung aus einer vorherigen Unterhaltung oder Anfrage.

Beispielbefehl und -ergebnis

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

Weitere Informationen zu den Feldern und den zurückgegebenen Daten finden Sie unter Antworttext.

Hinweis: Wenn Sie die Unterhaltung in derselben Sitzung fortsetzen möchten, speichern Sie den Wert session aus der Antwort und fügen Sie ihn in Ihre nächste Abfrage ein.

Python

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Python in der Gemini Enterprise-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Gemini Enterprise Python API.

Richten Sie zur Authentifizierung bei Gemini Enterprise Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter ADC für eine lokale Entwicklungsumgebung einrichten.

from google.api_core.client_options import ClientOptions
from google.cloud import discoveryengine_v1 as discoveryengine

# TODO(developer): Update these variables before running the sample.
project_id = "YOUR_PROJECT_ID"
location = "YOUR_LOCATION"
engine_id = "YOUR_APP_ID"
session = "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/sessions/SESSION_ID" # From previous session
query = "What is Gemini Enterprise?"


def stream_assist_session_sample(
    project_id: str,
    location: str,
    engine_id: str,
    session: str,
    query: str,
):
    # For more information, refer to:
    # https://docs.cloud.google.com/gemini/enterprise/docs/locations#specify_a_multi-region_for_your_data_store
    client_options = (
        ClientOptions(api_endpoint=f"{location}-discoveryengine.googleapis.com")
        if location != "global"
        else None
    )

    client = discoveryengine.AssistantServiceClient(client_options=client_options)

    request = discoveryengine.StreamAssistRequest(
        name=client.assistant_path(
            project=project_id,
            location=location,
            collection="default_collection",
            engine=engine_id,
            assistant="default_assistant",
        ),
        session=session,
        query=discoveryengine.Query(text=query),
    )

    # Make the request
    stream = client.stream_assist(request=request)

    # Handle the response
    for response in stream:
        print(response.answer)
        # Get Session ID
        print(response.session_info.session)

Datei hochladen und Suchergebnisse abrufen (Vorabversion)

Vorschau

Diese Funktion unterliegt den „Bedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Dienstbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA‑Funktionen stehen in der vorliegenden Form zur Verfügung und bieten möglicherweise nur eingeschränkten Support. Weitere Informationen finden Sie unter den Beschreibungen der Startphase.

Wenn Sie dem Assistenten mehr Kontext geben möchten, laden Sie eine Datei in eine Sitzung hoch und fragen Sie dann den Inhalt ab. Gehen Sie so vor:

1. Laden Sie eine Datei mit der Methode addContextFile in eine Sitzung hoch.

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

   Ersetzen Sie Folgendes:

   • ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Geben Sie einen der folgenden Werte an:
   • us für die Multiregion „USA“
   • eu für die Multiregion „EU“
   • global für den Standort „Global“

   Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
2. PROJECT_ID: die ID Ihres Projekts in Google Cloud .
3. LOCATION: Der multiregionale Standort Ihres Datenspeichers: global, us oder eu.
4. APP_ID: die eindeutige Kennung für die Gemini Enterprise-App.
5. SESSION_ID: die ID einer Sitzung aus einer vorherigen Unterhaltung oder Anfrage.
6. FILE_NAME: Der Name der Datei.
7. MIME_TYPE: Der MIME-Typ der Datei, z. B. text/plain oder application/pdf. Weitere Informationen zu den verschiedenen Medientypen finden Sie unter Medientypen.
8. BASE64_ENCODED_FILE: die base64-codierte Darstellung der Datei.

Beispielbefehl und -ergebnis

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

Weitere Informationen zu den Feldern und den zurückgegebenen Daten finden Sie unter Antworttext.

Hinweis: Wenn Sie die Unterhaltung in derselben Sitzung fortsetzen möchten, speichern Sie die Werte session und fileId aus der Antwort und fügen Sie sie in Ihre nächste Abfrage ein.