Suchergebnisse abrufen

Auf dieser Seite erfahren Sie, wie Sie eine Vorschau der Suchergebnisse mit der Google Cloud Console aufrufen und Suchergebnisse mit der API abrufen.

Statt ein Such-Widget zu erstellen und Ihrer Webseite hinzuzufügen, können Sie API-Aufrufe ausführen und sie in Ihren Server oder Ihre Anwendung einbinden. Auf dieser Seite finden Sie Codebeispiele für die Ausführung von Suchanfragen mit den gRPC-Clientbibliotheken mit einem Dienstkonto.

„Genau passend“ mit doppelten Anführungszeichen

Sie können eine Suchanfrage in doppelte Anführungszeichen ("") setzen, um eine genaue Übereinstimmung zu erzwingen. Eine solche Suche wird oft als Suche mit Anführungszeichen bezeichnet.

Wenn Sie die Suchanfrage nicht in doppelte Anführungszeichen setzen, wird eine Teilübereinstimmung gesucht. Eine solche Suche wird auch als Suche ohne Anführungszeichen bezeichnet.

Wenn Ihre Suchanfrage beispielsweise "query": "\"Mary had a little lamb\"" lautet, sucht Vertex AI Search genau nach diesem Begriff. Es werden keine Suchergebnisse zurückgegeben, die Mary had lamb (mit fehlenden Wörtern) oder a little lamb had Mary (mit Wörtern in einer anderen Reihenfolge) enthalten.

Sie können die Suche nach genau passenden Begriffen mit logischen Operatoren kombinieren, um die Suchergebnisse einzugrenzen. Weitere Informationen finden Sie unter Suchanfrageszenarien.

Logische Operatoren

Wenn Sie strukturierte und unstrukturierte Daten mit Metadaten durchsuchen, können Sie logische Operatoren in eine Suche einfügen. Sie können OR und AND in die Suchanfrage zwischen mehreren Begriffen oder Formulierungen einfügen. Der logische Operator NOT wird nicht unterstützt.

Die Art und Weise, wie Sie Ihre Suchbegriffe verknüpfen, bestimmt die Genauigkeit der Ergebnisse:

UND
Jeder Begriff in der Anfrage muss in den Ergebnissen enthalten sein. Wenn Sie beispielsweise nach jazz AND piano suchen, werden Ergebnisse angezeigt, die sowohl die Wörter jazz als auch piano enthalten.
ODER
Mindestens einer der abgefragten Begriffe muss in den Ergebnissen enthalten sein. Wenn Sie beispielsweise nach rock OR pop suchen, werden Ergebnisse zurückgegeben, die entweder rock, pop oder beides enthalten.

Sie können die verschiedenen logischen Operatoren miteinander oder mit der Suche nach genau passenden Begriffen kombinieren, um die Suchergebnisse einzugrenzen.

Szenarien für Suchanfragen

In der folgenden Tabelle finden Sie einige Szenarien, die bei der Suche mit „Genau passend“ oder „Teilweise passend“ auftreten können.

Szenario Beschreibung Beispiel
Teilweise übereinstimmende Suche ohne logische Operatoren Wenn Suchbegriffe nicht in doppelte Anführungszeichen gesetzt werden und keine logischen Operatoren zwischen ihnen stehen, wird die Suche so ausgeführt, als ob der Operator AND zwischen den Begriffen steht. Die Ergebnisse können auch andere Dokumente enthalten, die Vertex AI Search aufgrund der semantischen Suche als relevant für die Anfrage erachtet. 
       "query": "Mary little lamb"

Bei dieser Anfrage enthalten die relevantesten Dokumente in der Antwort alle Begriffe Mary, little und lamb. Die Antwort kann auch andere Dokumente enthalten, die semantisch relevante Begriffe enthalten.
Suche nach genau passenden Begriffen ohne logische Operatoren Wenn mehrere einzelne Suchbegriffe oder Wortgruppen in doppelte Anführungszeichen gesetzt sind und keine logischen Operatoren zwischen ihnen stehen, wird die Suche so ausgeführt, als ob ein AND-Operator zwischen den Wortgruppen vorhanden wäre. Wenn Sie mindestens einen Suchbegriff in der Anfrage in doppelte Anführungszeichen setzen, wird die semantische Suche für die gesamte Anfrage deaktiviert. 
       "query": "\"Mary\" \"little lamb\""

Bei dieser Suche werden Ergebnisse zurückgegeben, die sowohl die Begriffe Mary als auch little lamb enthalten.
Suche nach genauer und teilweiser Übereinstimmung Wenn Sie mindestens einen Suchbegriff in der Anfrage in doppelte Anführungszeichen setzen, wird die semantische Suche für die gesamte Anfrage deaktiviert. Wenn logische Operatoren angegeben sind, werden sie wie angegeben berücksichtigt. Wenn in der Abfrage keine logischen Operatoren angegeben sind, wird die Suche so ausgeführt, als ob zwischen den Begriffen ein AND-Operator stünde. 
       "query": "Mary \"little lamb\""

Bei dieser Anfrage wird die Suche so ausgeführt, als ob zwischen den Begriffen ein AND-Operator stünde. Da das Wort Mary nicht in Anführungszeichen gesetzt ist, wird es nicht exakt abgeglichen.

Suchergebnisse für eine App mit Websitedaten abrufen

Console

So verwenden Sie die Google Cloud Console, um eine Vorschau der Suchergebnisse für eine App mit Websitedaten zu sehen:

  1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

    KI-Anwendungen

  2. Klicken Sie auf den Namen der App, die Sie bearbeiten möchten.

  3. Klicken Sie auf Vorschau.

  4. Öffnen Sie in der Console die Seite Vorschau.

  5. Optional: Wenn Sie mehrere Datenspeicher mit Ihrer App verbunden haben, aber nur Ergebnisse aus einem bestimmten Datenspeicher erhalten möchten, wählen Sie den entsprechenden Datenspeicher aus.

  6. Geben Sie eine Suchanfrage ein.

    Wenn Sie die automatische Vervollständigung aktiviert haben, wird während der Eingabe eine Liste mit Vorschlägen unter der Suchleiste angezeigt.

  7. Drücken Sie die Eingabetaste, um die Anfrage zu senden.

    • Unter der Suchleiste wird eine Liste mit Suchergebnissen angezeigt.
    • Jedes Ergebnis enthält einen Titel, ein Snippet und eine URL.
    • Wenn Sie auf ein Ergebnis klicken, wird die entsprechende URL geöffnet.
    • Wenn erweiterte LLM-Features für die App aktiviert sind, wird möglicherweise auch eine generierte Antwort angezeigt.

REST

Wenn Sie die API verwenden möchten, um Suchergebnisse für eine App mit Websitedaten abzurufen, verwenden Sie die Methode engines.servingConfigs.search:

  1. App-ID suchen. Wenn Sie Ihre App-ID bereits haben, fahren Sie mit dem nächsten Schritt fort.

    1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

      Gehen Sie zu Apps

    2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und entnehmen Sie die App-ID der Spalte ID.

  2. Suchergebnisse abrufen

    curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"query": "QUERY",
"pageSize": "PAGE_SIZE",
"offset": "OFFSET",
"orderBy": "ORDER_BY",
"params": {"user_country_code": "USER_COUNTRY_CODE",
"searchType": "SEARCH_TYPE"},
"filter": "FILTER",
"boostSpec": "BOOST_SPEC",
"contentSearchSpec": {
   "searchResultMode": "RESULT_MODE"
 },
 "userPseudoId": "USER_PSEUDO_ID",
 "dataStoreSpecs": [{"DATA_STORE_SPEC"}]
}'

    Ersetzen Sie Folgendes:

    • PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
    • APP_ID: die ID der Vertex AI Search-App, die Sie abfragen möchten.
    • QUERY: der Abfragetext für die Suche.

    • PAGE_SIZE: Die Anzahl der von der Suche zurückgegebenen Ergebnisse. Die maximal zulässige Seitengröße hängt vom Datentyp ab. Seiten, die größer als der Höchstwert sind, werden auf den Höchstwert gesetzt.

      • Websites mit grundlegender Indexierung: Standard 10, Maximalwert 25
      • Websites mit erweiterter Indexierung: Standard 25, Maximalwert 50
      • Andere: Standard 50, Maximum 100

    • OFFSET: Der Startindex der Ergebnisse. Der Standardwert ist 0.

      Wenn das Offset beispielsweise 2, die Seitengröße 10 und die Anzahl der zurückzugebenden Ergebnisse 15 ist, werden auf der ersten Seite die Ergebnisse 2 bis 12 zurückgegeben.

    • ORDER_BY: die Reihenfolge, in der die Ergebnisse angeordnet sind. Das Attribut, nach dem sortiert werden soll, muss eine numerische Interpretation haben, z. B. date. Weitere Informationen finden Sie unter Web-Suchergebnisse sortieren.

    • USER_COUNTRY_CODE: Der Standort des Nutzers. Dieses Schlüssel/Wert-Paar ist der einzige unterstützte Eintrag für das Kartenfeld params. Der Standardwert ist leer. Zulässige Werte finden Sie in der Referenzdokumentation zur Programmable Search Engine JSON API unter Ländercodes.

    • SEARCH_TYPE: Der Typ der auszuführenden Suche. Der Standardwert für die Dokumentsuche ist 0. Der andere unterstützte Wert ist 1 für die Bildsuche.

    • FILTER: ein Textfeld zum Filtern der Suche mit einem Filterausdruck. Der Standardwert ist ein leerer String. Weitere Informationen zur Verwendung des Felds filter finden Sie unter Website-Suche filtern.

    • BOOST_SPEC: optional. Eine Spezifikation zum Hoch- bzw. Herabstufen von Dokumenten. Werte:

      • BOOST: eine Gleitkommazahl im Bereich [-1,1]. Wenn der Wert negativ ist, werden die Ergebnisse herabgestuft (sie werden weiter unten in den Ergebnissen angezeigt). Wenn der Wert positiv ist, werden die Ergebnisse höher eingestuft.
      • CONDITION: ein Textfilterausdruck zum Auswählen der Dokumente, auf die die Hochstufung angewendet wird. Der Filter muss in einen booleschen Wert aufgelöst werden. Weitere Informationen zum Optimieren der strukturierten Suche finden Sie unter Suchergebnisse optimieren.

    • RESULT_MODE: Legt fest, ob Suchergebnisse als vollständige Dokumente oder in Blöcken zurückgegeben werden sollen. Damit Sie Blöcke erhalten, muss für den Datenspeicher die Dokumentaufteilung aktiviert sein. Zulässige Werte sind documents und chunks. Wenn die Aufteilung für einen Datenspeicher aktiviert ist, lautet der Standardwert chunks. Andernfalls ist der Standardwert documents. Informationen zum Aufteilen von Dokumenten in Blöcke finden Sie unter Dokumente parsen und in Blöcke aufteilen. Dieses Feld ist in der öffentlichen Vorschau. Wenn Sie es verwenden möchten, ändern Sie v1 im curl-Befehl in v1alpha.

    • USER_PSEUDO_ID: ein UTF-8-codierter String, der als eindeutige pseudonymisierte Kennung zur Nachverfolgung der Nutzer dient. Er darf maximal 128 Zeichen lang sein. Google empfiehlt dringend, dieses Feld zu verwenden, da es die Modellleistung und die Qualität der Personalisierung verbessert. Sie können für dieses Feld ein HTTP-Cookie verwenden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert wird. Hier einige wichtige Überlegungen:

      • Diese Kennung ändert sich nicht, wenn sich der Besucher auf einer Website an- oder abmeldet.
      • Dieses Feld darf nicht für mehrere Nutzer auf dieselbe Kennung festgelegt werden. Andernfalls kann die Verwendung derselben Nutzer-ID für mehrere Nutzer dazu führen, dass Ereignisverläufe verschiedener Nutzer zusammengeführt werden, was die Modellqualität beeinträchtigen kann.
      • Dieses Feld darf keine personenidentifizierbaren Informationen enthalten.
      • Für eine bestimmte Such- oder Browseranfrage muss dieses Feld dem entsprechenden userPseudoId-Feld in den Nutzerereignissen zugeordnet werden.

      Weitere Informationen finden Sie unter userPseudoId.

    • DATA_STORE_SPEC: Filtert nach einem bestimmten Datenspeicher, in dem gesucht werden soll. Verwenden Sie dataStoreSpecs, wenn Ihre Suchanwendung mit mehreren Datenspeichern verbunden ist, Sie aber Ergebnisse aus einem bestimmten Datenspeicher erhalten möchten. Weitere Informationen finden Sie unter DataStoreSpec.

C#

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search C# API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

using Google.Api.Gax;
using Google.Cloud.DiscoveryEngine.V1Beta;
using Google.Protobuf.WellKnownTypes;
using System;

public sealed partial class GeneratedSearchServiceClientSnippets
{
    /// <summary>Snippet for Search</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void SearchRequestObject()
    {
        // Create client
        SearchServiceClient searchServiceClient = SearchServiceClient.Create();
        // Initialize request argument(s)
        SearchRequest request = new SearchRequest
        {
            ServingConfigAsServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
            BranchAsBranchName = BranchName.FromProjectLocationDataStoreBranch("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]"),
            Query = "",
            Offset = 0,
            Filter = "",
            OrderBy = "",
            FacetSpecs =
            {
                new SearchRequest.Types.FacetSpec(),
            },
            BoostSpec = new SearchRequest.Types.BoostSpec(),
            Params = { { "", new Value() }, },
            QueryExpansionSpec = new SearchRequest.Types.QueryExpansionSpec(),
            SpellCorrectionSpec = new SearchRequest.Types.SpellCorrectionSpec(),
            UserPseudoId = "",
            ImageQuery = new SearchRequest.Types.ImageQuery(),
            SafeSearch = false,
            UserInfo = new UserInfo(),
            UserLabels = { { "", "" }, },
            EmbeddingSpec = new SearchRequest.Types.EmbeddingSpec(),
            ContentSearchSpec = new SearchRequest.Types.ContentSearchSpec(),
            RankingExpression = "",
            NaturalLanguageQueryUnderstandingSpec = new SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec(),
            CanonicalFilter = "",
            SearchAsYouTypeSpec = new SearchRequest.Types.SearchAsYouTypeSpec(),
            DataStoreSpecs =
            {
                new SearchRequest.Types.DataStoreSpec(),
            },
            LanguageCode = "",
            RegionCode = "",
            SessionAsSessionName = SessionName.FromProjectLocationDataStoreSession("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]"),
            SessionSpec = new SearchRequest.Types.SessionSpec(),
            RelevanceThreshold = SearchRequest.Types.RelevanceThreshold.Unspecified,
            PersonalizationSpec = new SearchRequest.Types.PersonalizationSpec(),
            OneBoxPageSize = 0,
            RankingExpressionBackend = SearchRequest.Types.RankingExpressionBackend.Unspecified,
        };
        // Make the request
        PagedEnumerable<SearchResponse, SearchResponse.Types.SearchResult> response = searchServiceClient.Search(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (SearchResponse.Types.SearchResult item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (SearchResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (SearchResponse.Types.SearchResult item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<SearchResponse.Types.SearchResult> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (SearchResponse.Types.SearchResult item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Java

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Java API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 


import com.google.cloud.discoveryengine.v1.SearchRequest;
import com.google.cloud.discoveryengine.v1.SearchResponse;
import com.google.cloud.discoveryengine.v1.SearchServiceClient;
import com.google.cloud.discoveryengine.v1.SearchServiceSettings;
import com.google.cloud.discoveryengine.v1.ServingConfigName;
import java.io.IOException;
import java.util.concurrent.ExecutionException;

public class Search {
  public static void main() throws IOException, ExecutionException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "PROJECT_ID";
    // Location of the data store. Options: "global", "us", "eu"
    String location = "global";
    // Collection containing the data store.
    String collectionId = "default_collection";
    // Data store ID.
    String dataStoreId = "DATA_STORE_ID";
    // Serving configuration. Options: "default_search"
    String servingConfigId = "default_search";
    // Search Query for the data store.
    String searchQuery = "Google";
    search(projectId, location, collectionId, dataStoreId, servingConfigId, searchQuery);
  }

  /** Performs a search on a given datastore. */
  public static void search(
      String projectId,
      String location,
      String collectionId,
      String dataStoreId,
      String servingConfigId,
      String searchQuery)
      throws IOException, ExecutionException {
    // For more information, refer to:
    // https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
    String endpoint = (location.equals("global")) 
        ? String.format("discoveryengine.googleapis.com:443", location) 
        : String.format("%s-discoveryengine.googleapis.com:443", location);
    SearchServiceSettings settings =
        SearchServiceSettings.newBuilder().setEndpoint(endpoint).build();
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `searchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (SearchServiceClient searchServiceClient = SearchServiceClient.create(settings)) {
      SearchRequest request =
          SearchRequest.newBuilder()
              .setServingConfig(
                  ServingConfigName.formatProjectLocationCollectionDataStoreServingConfigName(
                      projectId, location, collectionId, dataStoreId, servingConfigId))
              .setQuery(searchQuery)
              .setPageSize(10)
              .build();
      SearchResponse response = searchServiceClient.search(request).getPage().getResponse();
      for (SearchResponse.SearchResult element : response.getResultsList()) {
        System.out.println("Response content: " + element);
      }
    }
  }
}

Node.js

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Node.js API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
// const location = 'YOUR_LOCATION';              // Options: 'global', 'us', 'eu'
// const collectionId = 'default_collection';     // Options: 'default_collection'
// const dataStoreId = 'YOUR_DATA_STORE_ID'       // Create in Cloud Console
// const servingConfigId = 'default_config';      // Options: 'default_config'
// const searchQuery = 'Google';

const {SearchServiceClient} = require('@google-cloud/discoveryengine').v1beta;

// For more information, refer to:
// https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
const apiEndpoint =
  location === 'global'
    ? 'discoveryengine.googleapis.com'
    : `${location}-discoveryengine.googleapis.com`;

// Instantiates a client
const client = new SearchServiceClient({apiEndpoint: apiEndpoint});

async function search() {
  // The full resource name of the search engine serving configuration.
  // Example: projects/{projectId}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}
  // You must create a search engine in the Cloud Console first.
  const name = client.projectLocationCollectionDataStoreServingConfigPath(
    projectId,
    location,
    collectionId,
    dataStoreId,
    servingConfigId
  );

  const request = {
    pageSize: 10,
    query: searchQuery,
    servingConfig: name,
  };

  const IResponseParams = {
    ISearchResult: 0,
    ISearchRequest: 1,
    ISearchResponse: 2,
  };

  // Perform search request
  const response = await client.search(request, {
    // Warning: Should always disable autoPaginate to avoid iterate through all pages.
    //
    // By default NodeJS SDK returns an iterable where you can iterate through all
    // search results instead of only the limited number of results requested on
    // pageSize, by sending multiple sequential search requests page-by-page while
    // iterating, until it exhausts all the search results. This will be unexpected and
    // may cause high Search API usage and long wait time, especially when the matched
    // document numbers are huge.
    autoPaginate: false,
  });
  const results = response[IResponseParams.ISearchResponse].results;

  for (const result of results) {
    console.log(result);
  }
}

PHP

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search PHP API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\SearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\SearchRequest;
use Google\Cloud\DiscoveryEngine\V1beta\SearchResponse\SearchResult;

/**
 * Performs a search.
 *
 * @param string $formattedServingConfig The resource name of the Search serving config, such as
 *                                       `projects/&#42;/locations/global/collections/default_collection/engines/&#42;/servingConfigs/default_serving_config`,
 *                                       or
 *                                       `projects/&#42;/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 *                                       This field is used to identify the serving configuration name, set
 *                                       of models used to make the search. Please see
 *                                       {@see SearchServiceClient::servingConfigName()} for help formatting this field.
 */
function search_sample(string $formattedServingConfig): void
{
    // Create a client.
    $searchServiceClient = new SearchServiceClient();

    // Prepare the request message.
    $request = (new SearchRequest())
        ->setServingConfig($formattedServingConfig);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $searchServiceClient->search($request);

        /** @var SearchResult $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedServingConfig = SearchServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[SERVING_CONFIG]'
    );

    search_sample($formattedServingConfig);
}

Python

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Python API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

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

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_LOCATION"          # Values: "global", "us", "eu"
# engine_id = "YOUR_APP_ID"
# search_query = "YOUR_SEARCH_QUERY"


def search_sample(
    project_id: str,
    location: str,
    engine_id: str,
    search_query: str,
) -> discoveryengine.services.search_service.pagers.SearchPager:
    #  For more information, refer to:
    # https://cloud.google.com/generative-ai-app-builder/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
    )

    # Create a client
    client = discoveryengine.SearchServiceClient(client_options=client_options)

    # The full resource name of the search app serving config
    serving_config = f"projects/{project_id}/locations/{location}/collections/default_collection/engines/{engine_id}/servingConfigs/default_config"

    # Optional - only supported for unstructured data: Configuration options for search.
    # Refer to the `ContentSearchSpec` reference for all supported fields:
    # https://cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec
    content_search_spec = discoveryengine.SearchRequest.ContentSearchSpec(
        # For information about snippets, refer to:
        # https://cloud.google.com/generative-ai-app-builder/docs/snippets
        snippet_spec=discoveryengine.SearchRequest.ContentSearchSpec.SnippetSpec(
            return_snippet=True
        ),
        # For information about search summaries, refer to:
        # https://cloud.google.com/generative-ai-app-builder/docs/get-search-summaries
        summary_spec=discoveryengine.SearchRequest.ContentSearchSpec.SummarySpec(
            summary_result_count=5,
            include_citations=True,
            ignore_adversarial_query=True,
            ignore_non_summary_seeking_query=True,
            model_prompt_spec=discoveryengine.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec(
                preamble="YOUR_CUSTOM_PROMPT"
            ),
            model_spec=discoveryengine.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec(
                version="stable",
            ),
        ),
    )

    # Refer to the `SearchRequest` reference for all supported fields:
    # https://cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.SearchRequest
    request = discoveryengine.SearchRequest(
        serving_config=serving_config,
        query=search_query,
        page_size=10,
        content_search_spec=content_search_spec,
        query_expansion_spec=discoveryengine.SearchRequest.QueryExpansionSpec(
            condition=discoveryengine.SearchRequest.QueryExpansionSpec.Condition.AUTO,
        ),
        spell_correction_spec=discoveryengine.SearchRequest.SpellCorrectionSpec(
            mode=discoveryengine.SearchRequest.SpellCorrectionSpec.Mode.AUTO
        ),
        # Optional: Use fine-tuned model for this request
        # custom_fine_tuning_spec=discoveryengine.CustomFineTuningSpec(
        #     enable_search_adaptor=True
        # ),
    )

    page_result = client.search(request)

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

    return page_result

Ruby

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Ruby API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

require "google/cloud/discovery_engine/v1beta"

##
# Snippet for the search call in the SearchService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search.
#
def search
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1beta::SearchRequest.new

  # Call the search method.
  result = client.search request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult.
    p item
  end
end

Suchergebnisse für eine App mit Websitedaten abrufen (API-Schlüssel)

Wenn Sie den Aufruf der Suchmethode mit einem API-Schlüssel anstelle von OAuth 2.0 über ein Dienstkonto oder ein Nutzerkonto authentifizieren möchten, folgen Sie dieser Anleitung, in der die Methode searchLite verwendet wird. Die Methode searchLite hat dieselben Funktionen wie die Methode search, kann aber nur für die Suche auf öffentlichen Websites verwendet werden.

Die searchLite-Methode eignet sich besonders unter den folgenden Bedingungen:

  • Sie haben eine statische Website, für die die Einrichtung von OAuth 2.0 über ein Dienstkonto oder ein Nutzerkonto nicht praktikabel ist.

  • Sie haben die Custom Search Site Restricted JSON API der Programmable Search Engine auf Vertex AI Search migriert.

  • Sie möchten das Such-Widget nicht verwenden.

Hinweise

Bevor Sie die Methode servingConfigs.searchLite aufrufen können, benötigen Sie einen API-Schlüssel. Wenn Sie noch keinen API-Schlüssel haben, führen Sie Schritt 1 unter Such-App bereitstellen (API-Schlüssel) aus.

Prozedur

REST

Wenn Sie die API verwenden möchten, um Suchergebnisse für eine App mit öffentlichen Websitedaten abzurufen, die mit einem API-Schlüssel authentifiziert wurden, verwenden Sie die Methode engines.servingConfigs.searchLite:

  1. App-ID suchen. Wenn Sie Ihre App-ID bereits haben, fahren Sie mit dem nächsten Schritt fort.

    1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

      Gehen Sie zu Apps

    2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und entnehmen Sie die App-ID der Spalte ID.

  2. Führen Sie den folgenden curl-Befehl aus, um Suchergebnisse zu erhalten:

    curl -X POST -H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:searchLite?key=API_KEY" \
-d '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"query": "QUERY",
"userPseudoId": "USER_PSEUDO_ID"
}'

    Ersetzen Sie Folgendes:

    • PROJECT_ID: Die ID Ihres Projekts in Google Cloud .

    • API_KEY: Ihr API-Schlüsselstring.

    • PROJECT_ID: Die ID Ihres Projekts in Google Cloud .

    • APP_ID: die ID der Vertex AI Search-App, die Sie abfragen möchten.

    • QUERY: der Abfragetext für die Suche.

    • USER_PSEUDO_ID: ein UTF-8-codierter String, der als eindeutige pseudonymisierte Kennung zur Nachverfolgung der Nutzer dient. Er darf maximal 128 Zeichen lang sein. Google empfiehlt dringend, dieses Feld zu verwenden, da es die Modellleistung und die Qualität der Personalisierung verbessert. Sie können für dieses Feld ein HTTP-Cookie verwenden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert wird. Hier einige wichtige Überlegungen:

      • Diese Kennung ändert sich nicht, wenn sich der Besucher auf einer Website an- oder abmeldet.
      • Dieses Feld darf nicht für mehrere Nutzer auf dieselbe Kennung festgelegt werden. Andernfalls kann die Verwendung derselben Nutzer-ID für mehrere Nutzer dazu führen, dass Ereignisverläufe verschiedener Nutzer zusammengeführt werden, was die Modellqualität beeinträchtigen kann.
      • Dieses Feld darf keine personenidentifizierbaren Informationen enthalten.
      • Für eine bestimmte Such- oder Browseranfrage muss dieses Feld dem entsprechenden userPseudoId-Feld in den Nutzerereignissen zugeordnet werden.

      Weitere Informationen finden Sie unter userPseudoId.

Python

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Python API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 


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

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_LOCATION"          # Values: "global", "us", "eu"
# engine_id = "YOUR_APP_ID"
# api_key = "YOUR_API_KEY"
# search_query = "YOUR_SEARCH_QUERY"


def search_lite_sample(
    project_id: str,
    location: str,
    engine_id: str,
    api_key: str,
    search_query: str,
) -> discoveryengine.services.search_service.pagers.SearchLitePager:

    client_options = ClientOptions(
        # For information on API Keys, refer to:
        # https://cloud.google.com/generative-ai-app-builder/docs/migrate-from-cse#api-key-deploy
        api_key=api_key,
        #  For more information, refer to:
        # https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
        api_endpoint=(
            f"{location}-discoveryengine.googleapis.com"
            if location != "global"
            else None
        ),
    )

    # Create a client
    client = discoveryengine.SearchServiceClient(client_options=client_options)

    # The full resource name of the search app serving config
    serving_config = f"projects/{project_id}/locations/{location}/collections/default_collection/engines/{engine_id}/servingConfigs/default_config"

    # Refer to the `SearchRequest` reference for all supported fields:
    # https://cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.SearchRequest
    request = discoveryengine.SearchRequest(
        serving_config=serving_config,
        query=search_query,
    )

    page_result = client.search_lite(request)

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

    return page_result

Suchergebnisse für eine App mit strukturierten oder unstrukturierten Daten abrufen

Sie können sich eine Vorschau der Suchergebnisse in der Google Cloud Console ansehen oder Suchergebnisse über die API abrufen.

Console

So verwenden Sie die Google Cloud Console, um eine Vorschau der Suchergebnisse für eine App mit strukturierten oder unstrukturierten Daten zu sehen:

  1. Öffnen Sie in der Console die Seite Vorschau.

  2. Geben Sie eine Suchanfrage ein.

    Wenn Sie die automatische Vervollständigung aktiviert haben, wird während der Eingabe eine Liste mit Vorschlägen unter der Suchleiste angezeigt.

  3. Optional: Wenn Sie mehrere Datenspeicher mit Ihrer App verbunden haben, aber nur Ergebnisse aus einem bestimmten Datenspeicher erhalten möchten, wählen Sie den entsprechenden Datenspeicher aus.

  4. Drücken Sie die Eingabetaste, um die Anfrage zu senden.

    Unter der Suchleiste wird eine Liste mit Suchergebnissen angezeigt.

    Für strukturierte Daten gilt Folgendes:

    • Wenn keine Attributzuordnungen unter Konfigurationen > Felder in Ergebnissen konfigurieren definiert sind, werden die Suchergebnisse als Liste mit Rohattributnamen und -werten angezeigt.

    • Wenn unter Konfigurationen > Felder in Ergebnissen konfigurieren Attributzuordnungen gespeichert wurden, werden die Suchergebnisse auf dieselbe Weise angezeigt wie in der Vorschau auf der Seite Konfigurationen.

    • Wenn unter Konfigurationen > Facetteneinstellungen Facetten angegeben wurden, werden sie auf dieselbe Weise angezeigt.

REST

Wenn Sie die API verwenden möchten, um Suchergebnisse für eine App mit strukturierten oder unstrukturierten Daten abzurufen, verwenden Sie die Methode engines.servingConfigs.search:

  1. App-ID suchen. Wenn Sie Ihre App-ID bereits haben, fahren Sie mit dem nächsten Schritt fort.

    1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

      Gehen Sie zu Apps

    2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und entnehmen Sie die App-ID der Spalte ID.

  2. Suchergebnisse abrufen

    curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
"query": "QUERY",
"userPseudoId": "USER_PSEUDO_ID",
"pageSize": "PAGE_SIZE",
"offset": "OFFSET",
"orderBy": "ORDER_BY",
"filter": "FILTER",
"boostSpec": "BOOST_SPEC",
"facetSpec": "FACET_SPEC",
"queryExpansionSpec": "QUERY_EXPANSION_SPEC",
"spellCorrectionSpec": "SPELL_CORRECTION_SPEC",
"contentSearchSpec": "CONTENT_SEARCH_SPEC",
"dataStoreSpecs": [{"DATA_STORE_SPEC"}],
}'

    Ersetzen Sie Folgendes:

    • PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
    • APP_ID: die ID der Vertex AI Search-App, die Sie abfragen möchten.
    • QUERY: der Abfragetext für die Suche.

    • USER_PSEUDO_ID: ein UTF-8-codierter String, der als eindeutige pseudonymisierte Kennung zur Nachverfolgung der Nutzer dient. Er darf maximal 128 Zeichen lang sein. Google empfiehlt dringend, dieses Feld zu verwenden, da es die Modellleistung und die Qualität der Personalisierung verbessert. Sie können für dieses Feld ein HTTP-Cookie verwenden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert wird. Hier einige wichtige Überlegungen:

      • Diese Kennung ändert sich nicht, wenn sich der Besucher auf einer Website an- oder abmeldet.
      • Dieses Feld darf nicht für mehrere Nutzer auf dieselbe Kennung festgelegt werden. Andernfalls kann die Verwendung derselben Nutzer-ID für mehrere Nutzer dazu führen, dass Ereignisverläufe verschiedener Nutzer zusammengeführt werden, was die Modellqualität beeinträchtigen kann.
      • Dieses Feld darf keine personenidentifizierbaren Informationen enthalten.
      • Für eine bestimmte Such- oder Browseranfrage muss dieses Feld dem entsprechenden userPseudoId-Feld in den Nutzerereignissen zugeordnet werden.

      Weitere Informationen finden Sie unter userPseudoId.

    • PAGE_SIZE: Die Anzahl der von der Suche zurückgegebenen Ergebnisse. Die maximal zulässige Seitengröße hängt vom Datentyp ab. Seiten, die größer als der Höchstwert sind, werden auf den Höchstwert gesetzt.

      • Websites mit grundlegender Indexierung: Standard 10, Maximalwert 25
      • Websites mit erweiterter Indexierung: Standard 25, Maximalwert 50
      • Andere: Standard 50, Maximum 100

    • OFFSET: optional. Der Startindex der Ergebnisse. Der Standardwert ist 0.

      Wenn das Offset beispielsweise 2, die Seitengröße 10 und die Anzahl der zurückzugebenden Ergebnisse 15 ist, werden auf der ersten Seite die Ergebnisse 2 bis 11 zurückgegeben.

    • ORDER_BY: optional. Die Reihenfolge, in der die Ergebnisse angeordnet sind.

    • FILTER: optional. Ein Textfeld zum Filtern Ihrer Suche mit einem Filterausdruck. Der Standardwert ist ein leerer String. Das bedeutet, dass kein Filter angewendet wird.

      Beispiel: color: ANY("red", "blue") AND score: IN(*, 100.0e)

      Weitere Informationen finden Sie unter Suche nach strukturierten oder unstrukturierten Daten filtern.

    • BOOST_SPEC: optional. Eine Spezifikation zum Hoch- bzw. Herabstufen von Dokumenten. Werte:

      • BOOST: eine Gleitkommazahl im Bereich [-1,1]. Wenn der Wert negativ ist, werden die Ergebnisse herabgestuft (sie werden weiter unten in den Ergebnissen angezeigt). Wenn der Wert positiv ist, werden die Ergebnisse höher eingestuft.
      • CONDITION: ein Textfilterausdruck zum Auswählen der Dokumente, auf die die Hochstufung angewendet wird. Der Filter muss in einen booleschen Wert aufgelöst werden.

      Weitere Informationen zum Optimieren der strukturierten Suche finden Sie unter Suchergebnisse optimieren.

    • FACET_SPEC: optional. Eine Facettenspezifikation für die Attributsuche.

    • QUERY_EXPANSION_SPEC: optional. Eine Spezifikation, die festlegt, unter welchen Bedingungen eine Suchanfragenerweiterung erfolgen soll. Der Standardwert ist DISABLED.

    • SPELL_CORRECTION_SPEC: optional. Eine Spezifikation, die festlegt, unter welchen Bedingungen eine Rechtschreibkorrektur erfolgen soll. Der Standardwert ist AUTO.

    • CONTENT_SEARCH_SPEC: optional. Für Snippets, extrahierte Antworten, extrahierte Segmente und Suchzusammenfassungen. Nur für unstrukturierte Daten. Weitere Informationen finden Sie unter:

    • DATA_STORE_SPEC: Filtert nach einem bestimmten Datenspeicher, in dem gesucht werden soll. Dies kann verwendet werden, wenn Ihre Suchanwendung mit mehreren Datenspeichern verbunden ist.

    • Geführte Suchergebnisse in der Antwort auf die Suchanfrage ansehen:

      Geführte Suchergebnisse werden mit Suchantworten für strukturierte und unstrukturierte Suchanfragen zurückgegeben. Das Ergebnis der geführten Suche enthält eine Liste von extrahierten Schlüssel/Wert-Paaren für Attribute, die auf Dokumenten mit Suchergebnissen basieren. So können Nutzer ihre Suchergebnisse mithilfe von Attributschlüsseln und ‑werten als Filter verfeinern.

      In diesem Beispiel wurde die Farbe „Grün“ verwendet, um die Suchergebnisse zu verfeinern. Dazu wurde eine neue Suchanfrage mit dem Filterfeld _gs.color: ANY("green") gesendet:

      {
"guidedSearchResult": {
  "refinementAttributes": [
    {
      "attributeKey": "_gs.color",
      "attributeValue": "green"
    },
    {
      "attributeKey": "_gs.category",
      "attributeValue": "shoe"
    }
  ]
}
}

C#

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search C# API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

using Google.Api.Gax;
using Google.Cloud.DiscoveryEngine.V1Beta;
using Google.Protobuf.WellKnownTypes;
using System;

public sealed partial class GeneratedSearchServiceClientSnippets
{
    /// <summary>Snippet for Search</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void SearchRequestObject()
    {
        // Create client
        SearchServiceClient searchServiceClient = SearchServiceClient.Create();
        // Initialize request argument(s)
        SearchRequest request = new SearchRequest
        {
            ServingConfigAsServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
            BranchAsBranchName = BranchName.FromProjectLocationDataStoreBranch("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]"),
            Query = "",
            Offset = 0,
            Filter = "",
            OrderBy = "",
            FacetSpecs =
            {
                new SearchRequest.Types.FacetSpec(),
            },
            BoostSpec = new SearchRequest.Types.BoostSpec(),
            Params = { { "", new Value() }, },
            QueryExpansionSpec = new SearchRequest.Types.QueryExpansionSpec(),
            SpellCorrectionSpec = new SearchRequest.Types.SpellCorrectionSpec(),
            UserPseudoId = "",
            ImageQuery = new SearchRequest.Types.ImageQuery(),
            SafeSearch = false,
            UserInfo = new UserInfo(),
            UserLabels = { { "", "" }, },
            EmbeddingSpec = new SearchRequest.Types.EmbeddingSpec(),
            ContentSearchSpec = new SearchRequest.Types.ContentSearchSpec(),
            RankingExpression = "",
            NaturalLanguageQueryUnderstandingSpec = new SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec(),
            CanonicalFilter = "",
            SearchAsYouTypeSpec = new SearchRequest.Types.SearchAsYouTypeSpec(),
            DataStoreSpecs =
            {
                new SearchRequest.Types.DataStoreSpec(),
            },
            LanguageCode = "",
            RegionCode = "",
            SessionAsSessionName = SessionName.FromProjectLocationDataStoreSession("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]"),
            SessionSpec = new SearchRequest.Types.SessionSpec(),
            RelevanceThreshold = SearchRequest.Types.RelevanceThreshold.Unspecified,
            PersonalizationSpec = new SearchRequest.Types.PersonalizationSpec(),
            OneBoxPageSize = 0,
            RankingExpressionBackend = SearchRequest.Types.RankingExpressionBackend.Unspecified,
        };
        // Make the request
        PagedEnumerable<SearchResponse, SearchResponse.Types.SearchResult> response = searchServiceClient.Search(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (SearchResponse.Types.SearchResult item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (SearchResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (SearchResponse.Types.SearchResult item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<SearchResponse.Types.SearchResult> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (SearchResponse.Types.SearchResult item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Java

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Java API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 


import com.google.cloud.discoveryengine.v1.SearchRequest;
import com.google.cloud.discoveryengine.v1.SearchResponse;
import com.google.cloud.discoveryengine.v1.SearchServiceClient;
import com.google.cloud.discoveryengine.v1.SearchServiceSettings;
import com.google.cloud.discoveryengine.v1.ServingConfigName;
import java.io.IOException;
import java.util.concurrent.ExecutionException;

public class Search {
  public static void main() throws IOException, ExecutionException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "PROJECT_ID";
    // Location of the data store. Options: "global", "us", "eu"
    String location = "global";
    // Collection containing the data store.
    String collectionId = "default_collection";
    // Data store ID.
    String dataStoreId = "DATA_STORE_ID";
    // Serving configuration. Options: "default_search"
    String servingConfigId = "default_search";
    // Search Query for the data store.
    String searchQuery = "Google";
    search(projectId, location, collectionId, dataStoreId, servingConfigId, searchQuery);
  }

  /** Performs a search on a given datastore. */
  public static void search(
      String projectId,
      String location,
      String collectionId,
      String dataStoreId,
      String servingConfigId,
      String searchQuery)
      throws IOException, ExecutionException {
    // For more information, refer to:
    // https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
    String endpoint = (location.equals("global")) 
        ? String.format("discoveryengine.googleapis.com:443", location) 
        : String.format("%s-discoveryengine.googleapis.com:443", location);
    SearchServiceSettings settings =
        SearchServiceSettings.newBuilder().setEndpoint(endpoint).build();
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `searchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (SearchServiceClient searchServiceClient = SearchServiceClient.create(settings)) {
      SearchRequest request =
          SearchRequest.newBuilder()
              .setServingConfig(
                  ServingConfigName.formatProjectLocationCollectionDataStoreServingConfigName(
                      projectId, location, collectionId, dataStoreId, servingConfigId))
              .setQuery(searchQuery)
              .setPageSize(10)
              .build();
      SearchResponse response = searchServiceClient.search(request).getPage().getResponse();
      for (SearchResponse.SearchResult element : response.getResultsList()) {
        System.out.println("Response content: " + element);
      }
    }
  }
}

Node.js

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Node.js API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
// const location = 'YOUR_LOCATION';              // Options: 'global', 'us', 'eu'
// const collectionId = 'default_collection';     // Options: 'default_collection'
// const dataStoreId = 'YOUR_DATA_STORE_ID'       // Create in Cloud Console
// const servingConfigId = 'default_config';      // Options: 'default_config'
// const searchQuery = 'Google';

const {SearchServiceClient} = require('@google-cloud/discoveryengine').v1beta;

// For more information, refer to:
// https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
const apiEndpoint =
  location === 'global'
    ? 'discoveryengine.googleapis.com'
    : `${location}-discoveryengine.googleapis.com`;

// Instantiates a client
const client = new SearchServiceClient({apiEndpoint: apiEndpoint});

async function search() {
  // The full resource name of the search engine serving configuration.
  // Example: projects/{projectId}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId}
  // You must create a search engine in the Cloud Console first.
  const name = client.projectLocationCollectionDataStoreServingConfigPath(
    projectId,
    location,
    collectionId,
    dataStoreId,
    servingConfigId
  );

  const request = {
    pageSize: 10,
    query: searchQuery,
    servingConfig: name,
  };

  const IResponseParams = {
    ISearchResult: 0,
    ISearchRequest: 1,
    ISearchResponse: 2,
  };

  // Perform search request
  const response = await client.search(request, {
    // Warning: Should always disable autoPaginate to avoid iterate through all pages.
    //
    // By default NodeJS SDK returns an iterable where you can iterate through all
    // search results instead of only the limited number of results requested on
    // pageSize, by sending multiple sequential search requests page-by-page while
    // iterating, until it exhausts all the search results. This will be unexpected and
    // may cause high Search API usage and long wait time, especially when the matched
    // document numbers are huge.
    autoPaginate: false,
  });
  const results = response[IResponseParams.ISearchResponse].results;

  for (const result of results) {
    console.log(result);
  }
}

PHP

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search PHP API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\SearchServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\SearchRequest;
use Google\Cloud\DiscoveryEngine\V1beta\SearchResponse\SearchResult;

/**
 * Performs a search.
 *
 * @param string $formattedServingConfig The resource name of the Search serving config, such as
 *                                       `projects/&#42;/locations/global/collections/default_collection/engines/&#42;/servingConfigs/default_serving_config`,
 *                                       or
 *                                       `projects/&#42;/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 *                                       This field is used to identify the serving configuration name, set
 *                                       of models used to make the search. Please see
 *                                       {@see SearchServiceClient::servingConfigName()} for help formatting this field.
 */
function search_sample(string $formattedServingConfig): void
{
    // Create a client.
    $searchServiceClient = new SearchServiceClient();

    // Prepare the request message.
    $request = (new SearchRequest())
        ->setServingConfig($formattedServingConfig);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $searchServiceClient->search($request);

        /** @var SearchResult $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedServingConfig = SearchServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[SERVING_CONFIG]'
    );

    search_sample($formattedServingConfig);
}

Python

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Python API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

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

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_LOCATION"          # Values: "global", "us", "eu"
# engine_id = "YOUR_APP_ID"
# search_query = "YOUR_SEARCH_QUERY"


def search_sample(
    project_id: str,
    location: str,
    engine_id: str,
    search_query: str,
) -> discoveryengine.services.search_service.pagers.SearchPager:
    #  For more information, refer to:
    # https://cloud.google.com/generative-ai-app-builder/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
    )

    # Create a client
    client = discoveryengine.SearchServiceClient(client_options=client_options)

    # The full resource name of the search app serving config
    serving_config = f"projects/{project_id}/locations/{location}/collections/default_collection/engines/{engine_id}/servingConfigs/default_config"

    # Optional - only supported for unstructured data: Configuration options for search.
    # Refer to the `ContentSearchSpec` reference for all supported fields:
    # https://cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec
    content_search_spec = discoveryengine.SearchRequest.ContentSearchSpec(
        # For information about snippets, refer to:
        # https://cloud.google.com/generative-ai-app-builder/docs/snippets
        snippet_spec=discoveryengine.SearchRequest.ContentSearchSpec.SnippetSpec(
            return_snippet=True
        ),
        # For information about search summaries, refer to:
        # https://cloud.google.com/generative-ai-app-builder/docs/get-search-summaries
        summary_spec=discoveryengine.SearchRequest.ContentSearchSpec.SummarySpec(
            summary_result_count=5,
            include_citations=True,
            ignore_adversarial_query=True,
            ignore_non_summary_seeking_query=True,
            model_prompt_spec=discoveryengine.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec(
                preamble="YOUR_CUSTOM_PROMPT"
            ),
            model_spec=discoveryengine.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec(
                version="stable",
            ),
        ),
    )

    # Refer to the `SearchRequest` reference for all supported fields:
    # https://cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.SearchRequest
    request = discoveryengine.SearchRequest(
        serving_config=serving_config,
        query=search_query,
        page_size=10,
        content_search_spec=content_search_spec,
        query_expansion_spec=discoveryengine.SearchRequest.QueryExpansionSpec(
            condition=discoveryengine.SearchRequest.QueryExpansionSpec.Condition.AUTO,
        ),
        spell_correction_spec=discoveryengine.SearchRequest.SpellCorrectionSpec(
            mode=discoveryengine.SearchRequest.SpellCorrectionSpec.Mode.AUTO
        ),
        # Optional: Use fine-tuned model for this request
        # custom_fine_tuning_spec=discoveryengine.CustomFineTuningSpec(
        #     enable_search_adaptor=True
        # ),
    )

    page_result = client.search(request)

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

    return page_result

Ruby

Weitere Informationen finden Sie in der Referenzdokumentation zur Vertex AI Search Ruby API.

Richten Sie zur Authentifizierung bei Vertex AI Search Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

require "google/cloud/discovery_engine/v1beta"

##
# Snippet for the search call in the SearchService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search.
#
def search
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1beta::SearchRequest.new

  # Call the search method.
  result = client.search request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult.
    p item
  end
end

Relevanzbewertungen für Dokumente in Suchergebnissen abrufen

Die Dokumentrelevanzwerte basieren auf der Ähnlichkeit der Anfrage zum Dokument. Die Werte werden in 11 Buckets im Bereich von 0, 0,1, 0,2 … bis 1,0 eingeteilt. Je höher der Wert, desto relevanter das Dokument.

Berücksichtigen Sie die Dokumentrelevanzwerte für diese Anwendungsfälle:

  • Nach der Suche werden irrelevante Ergebnisse anhand des Relevanzwerts herausgefiltert.

  • Ranking nach der Suche oder als Eingabe für andere Anwendungen.

  • Fehlerbehebung: Relevanzbewertungen können Aufschluss darüber geben, warum bestimmte Suchergebnisse zurückgegeben werden.

Für jedes Suchergebnis kann ein Relevanzwert zurückgegeben werden:

  "results": [
    {
      "id": "DOCUMENT_ID",
      "document": {
      ...
      },
      "modelScores": {
        "relevance_score": {
          "values": [
            DOCUMENT-RELEVANCE-SCORE
          ]
        }
      }
    },
  ...
  ]

Sehen Sie sich auch den Beispielbefehl im folgenden Verfahren an.

Vorbereitung: Die Such-App muss mit einem strukturierten oder unstrukturierten Datenspeicher verknüpft sein. Das bedeutet, dass für eine Website-Such-App keine Relevanzwerte für Dokumente zurückgegeben werden können.

REST

Wenn Sie anfordern möchten, dass mit den Suchergebnissen auch die Relevanzwerte für Dokumente zurückgegeben werden, verwenden Sie die Methode engines.servingConfigs.search so:

  1. App-ID suchen. Wenn Sie Ihre App-ID bereits haben, fahren Sie mit dem nächsten Schritt fort.

    1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

      Gehen Sie zu Apps

    2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und entnehmen Sie die App-ID der Spalte ID.

  2. Führen Sie den folgenden curl-Befehl aus, um mit Suchergebnissen zurückgegebene Werte abzurufen.

    curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
-d '{
     "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
     "query": "QUERY",
     "relevanceScoreSpec": {
       "returnRelevanceScore": true
     }
}'
    • PROJECT_ID: Die ID Ihres Projekts in Google Cloud .
    • APP_ID: die ID der Vertex AI Search-App, die Sie abfragen möchten.
    • QUERY: der Abfragetext für die Suche.

Zusammenfassungen von Suchanfragen unterscheiden sich je nach Modell

Wenn Sie Suchzusammenfassungen für Ihre Anfragen generieren, stellen Sie möglicherweise fest, dass sich die Zusammenfassungen zwischen den Ergebnissen in der Console und den API-Ergebnissen unterscheiden. Wenn Sie diese Meldung sehen, liegt das wahrscheinlich daran, dass in der Console ein anderes LLM-Modell als in der API verwendet wird. In den curl- und Codebeispielen auf dieser Seite wird das stabile LLM-Modell verwendet.

  • Wenn Sie das LLM-Modell ändern oder ansehen möchten, das auf der Seite Vorschau der Benutzeroberfläche verwendet wird (nur für erweiterte Suchanwendungen und Gesundheitsanwendungen unterstützt).

    1. Rufen Sie die Seite Konfigurationen Ihrer App > Tab Benutzeroberfläche auf.

    2. Wählen Sie einen Suchtyp aus:

      • Wählen Sie Mit Antwort suchen aus, um eine generative Zusammenfassung über den Suchergebnissen anzeigen zu lassen.
      • Wählen Sie Mit weiterführenden Fragen suchen aus, um die dialogbasierte Suche mit generativen Zusammenfassungen und weiterführenden Fragen zu aktivieren.

    3. Wählen Sie im Abschnitt Large Language Models für die Zusammenfassung ein Modell aus.

  • Bei Methodenaufrufen ist das stabile Modell das Standardmodell. Wenn Sie ein anderes LLM-Modell als das stabile Modell verwenden möchten, lesen Sie die Informationen unter Zusammenfassungsmodell angeben und Antwortmodell angeben.

    Nächste Schritte

  • Such-Widget auf einer Webseite einfügen

  • Mit der Search API können Sie Daten in Ihren allgemeinen Such-Apps durchsuchen.