Mengonfigurasi perlengkapan otomatis

Halaman ini menjelaskan fitur pelengkapan otomatis dasar Vertex AI Search. Pelengkapan otomatis menghasilkan saran kueri berdasarkan beberapa karakter pertama yang dimasukkan untuk kueri.

Saran yang dihasilkan pelengkapan otomatis bervariasi bergantung pada jenis data yang digunakan aplikasi penelusuran:

• Data terstruktur dan tidak terstruktur. Secara default, pelengkapan otomatis akan menghasilkan saran berdasarkan konten dokumen di penyimpanan data. Setelah impor dokumen, secara default, pelengkapan otomatis tidak mulai menghasilkan saran hingga ada data berkualitas yang memadai, biasanya beberapa hari. Jika Anda membuat permintaan pelengkapan otomatis melalui API, pelengkapan otomatis dapat membuat saran yang didasarkan pada histori penelusuran atau peristiwa pengguna.

• Data situs. Secara default, pelengkapan otomatis menghasilkan saran dari histori penelusuran. Pelengkapan otomatis memerlukan traffic penelusuran yang sebenarnya. Setelah traffic penelusuran dimulai, pelengkapan otomatis memerlukan waktu satu atau dua hari sebelum menghasilkan saran. Saran dapat dihasilkan dari data yang di-crawl web dari situs publik dengan model data dokumen lanjutan eksperimental.

• Data perawatan kesehatan. Secara default, sumber data medis kanonis digunakan untuk membuat saran pelengkapan otomatis untuk penyimpanan data layanan kesehatan. Untuk penelusuran layanan kesehatan, pelengkapan otomatis adalah fitur Pratinjau.

Model data pelengkapan otomatis menentukan jenis data yang digunakan pelengkapan otomatis untuk membuat saran. Ada empat model pelengkapan otomatis:

• Document. Model dokumen menghasilkan saran dari dokumen yang diimpor pengguna. Model ini tidak tersedia untuk data situs atau data layanan kesehatan.

• Kolom yang Dapat Diisi. Model kolom yang dapat diselesaikan menyarankan teks yang diambil langsung dari kolom data terstruktur. Hanya kolom yang dianotasi dengan completable yang digunakan untuk saran pelengkapan otomatis. Model ini hanya tersedia untuk data terstruktur.

• Histori penelusuran. Model histori penelusuran menghasilkan saran dari histori panggilan API SearchService.search. Jangan gunakan model ini jika tidak ada traffic yang tersedia untuk metode servingConfigs.search. Model ini tidak tersedia untuk data layanan kesehatan.

• Peristiwa pengguna. Model peristiwa pengguna menghasilkan saran dari peristiwa penelusuran yang diimpor pengguna. Model ini tidak tersedia untuk data layanan kesehatan.

Permintaan Autocomplete dikirim menggunakan metode dataStores.completeQuery.

Tabel berikut menunjukkan jenis model pelengkapan otomatis yang tersedia untuk setiap jenis data.

* : Skema dokumen harus berisi kolom title atau description, atau harus ada kolom yang telah ditentukan sebagai properti kunci title atau description. Lihat artikel Memperbarui skema untuk data terstruktur.

^† : Konten yang di-crawl web hanya dapat digunakan sebagai sumber data jika model data dokumen lanjutan eksperimental untuk pelengkapan otomatis diaktifkan. Lihat Model data dokumen lanjutan.

Jika tidak ingin menggunakan model default untuk jenis data, Anda dapat menentukan model lain saat mengirim permintaan pelengkapan otomatis. Permintaan Autocomplete dikirim menggunakan metode dataStores.completeQuery. Untuk mengetahui informasinya, lihat Petunjuk API: Mengirim permintaan pelengkapan otomatis untuk memilih model yang berbeda.

Fitur pelengkapan otomatis

Vertex AI Search mendukung fitur pelengkapan otomatis berikut untuk menampilkan prediksi yang paling membantu saat melakukan penelusuran:

Saran pencocokan akhir

Saran pencocokan akhir dibuat menggunakan pencocokan awalan persis dengan kata terakhir dalam string kueri.

Misalnya, kueri "lagu dengan dia" dikirim dalam permintaan pelengkapan otomatis. Jika pencocokan akhir diaktifkan, pelengkapan otomatis mungkin menemukan bahwa awalan lengkap "songs with he" tidak memiliki kecocokan. Namun, kata terakhir dalam kueri, "he", memiliki pencocokan awalan yang sama persis dengan "hello world" dan "hello kitty". Dalam hal tersebut, saran yang ditampilkan adalah "lagu dengan hello world" dan "lagu dengan hello kitty" karena tidak ada saran kecocokan penuh.

Anda dapat menggunakan fitur ini untuk mengurangi hasil saran kosong dan meningkatkan keanekaragaman saran, sehingga fitur ini sangat berguna jika sumber data (jumlah peristiwa pengguna, histori penelusuran, dan cakupan topik dokumen) terbatas. Namun, mengaktifkan saran pencocokan akhir dapat mengurangi kualitas saran secara keseluruhan. Karena pencocokan akhir hanya cocok dengan kata akhir dari awalan, beberapa saran yang ditampilkan mungkin tidak masuk akal. Misalnya, kueri seperti "songs with he" mungkin mendapatkan saran pencocokan akhir seperti "songs with helpers guides".

Saran kecocokan akhir hanya ditampilkan jika:

1. include_tail_suggestions disetel ke true dalam permintaan dataStores.completeQuery.

2. Tidak ada saran kecocokan awalan lengkap untuk kueri.

Mengaktifkan atau menonaktifkan pelengkapan otomatis untuk widget

Untuk mengaktifkan atau menonaktifkan pelengkapan otomatis untuk widget, ikuti langkah-langkah berikut:

Memperbarui setelan pelengkapan otomatis

Untuk mengonfigurasi setelan pelengkapan otomatis, ikuti langkah-langkah berikut:

Memperbarui anotasi kolom yang dapat diselesaikan dalam skema

Untuk mengaktifkan pelengkapan otomatis untuk kolom dalam skema data terstruktur, ikuti langkah-langkah berikut:

Mengirim permintaan pelengkapan otomatis

Contoh berikut menunjukkan cara mengirim permintaan pelengkapan otomatis.

using Google.Cloud.DiscoveryEngine.V1;

public sealed partial class GeneratedCompletionServiceClientSnippets
{
    /// <summary>Snippet for CompleteQuery</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 CompleteQueryRequestObject()
    {
        // Create client
        CompletionServiceClient completionServiceClient = CompletionServiceClient.Create();
        // Initialize request argument(s)
        CompleteQueryRequest request = new CompleteQueryRequest
        {
            DataStoreAsDataStoreName = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]"),
            Query = "",
            QueryModel = "",
            UserPseudoId = "",
            IncludeTailSuggestions = false,
        };
        // Make the request
        CompleteQueryResponse response = completionServiceClient.CompleteQuery(request);
    }
}

package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewCompletionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &discoveryenginepb.CompleteQueryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb#CompleteQueryRequest.
	}
	resp, err := c.CompleteQuery(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

import com.google.cloud.discoveryengine.v1.CompleteQueryRequest;
import com.google.cloud.discoveryengine.v1.CompleteQueryResponse;
import com.google.cloud.discoveryengine.v1.CompletionServiceClient;
import com.google.cloud.discoveryengine.v1.DataStoreName;

public class SyncCompleteQuery {

  public static void main(String[] args) throws Exception {
    syncCompleteQuery();
  }

  public static void syncCompleteQuery() throws Exception {
    // 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/java/docs/setup#configure_endpoints_for_the_client_library
    try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
      CompleteQueryRequest request =
          CompleteQueryRequest.newBuilder()
              .setDataStore(
                  DataStoreName.ofProjectLocationDataStoreName(
                          "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                      .toString())
              .setQuery("query107944136")
              .setQueryModel("queryModel-184930495")
              .setUserPseudoId("userPseudoId-1155274652")
              .setIncludeTailSuggestions(true)
              .build();
      CompleteQueryResponse response = completionServiceClient.completeQuery(request);
    }
  }
}

/**
 * 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.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent data store resource name for which the completion is
 *  performed, such as
 *  `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
 */
// const dataStore = 'abc123'
/**
 *  Required. The typeahead input used to fetch suggestions. Maximum length is
 *  128 characters.
 */
// const query = 'abc123'
/**
 *  Specifies the autocomplete data model. This overrides any model specified
 *  in the Configuration > Autocomplete section of the Cloud console. Currently
 *  supported values:
 *  * `document` - Using suggestions generated from user-imported documents.
 *  * `search-history` - Using suggestions generated from the past history of
 *  SearchService.Search google.cloud.discoveryengine.v1.SearchService.Search 
 *  API calls. Do not use it when there is no traffic for Search API.
 *  * `user-event` - Using suggestions generated from user-imported search
 *  events.
 *  * `document-completable` - Using suggestions taken directly from
 *  user-imported document fields marked as completable.
 *  Default values:
 *  * `document` is the default model for regular dataStores.
 *  * `search-history` is the default model for site search dataStores.
 */
// const queryModel = 'abc123'
/**
 *  A unique identifier for tracking visitors. For example, this could be
 *  implemented with an HTTP cookie, which should be able to uniquely identify
 *  a visitor on a single device. This unique identifier should not change if
 *  the visitor logs in or out of the website.
 *  This field should NOT have a fixed value such as `unknown_visitor`.
 *  This should be the same identifier as
 *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id 
 *  and
 *  SearchRequest.user_pseudo_id google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id.
 *  The field must be a UTF-8 encoded string with a length limit of 128
 *  characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 */
// const userPseudoId = 'abc123'
/**
 *  Indicates if tail suggestions should be returned if there are no
 *  suggestions that match the full query. Even if set to true, if there are
 *  suggestions that match the full query, those are returned and no
 *  tail suggestions are returned.
 */
// const includeTailSuggestions = true

// Imports the Discoveryengine library
const {CompletionServiceClient} = require('@google-cloud/discoveryengine').v1;

// Instantiates a client
const discoveryengineClient = new CompletionServiceClient();

async function callCompleteQuery() {
  // Construct request
  const request = {
    dataStore,
    query,
  };

  // Run request
  const response = await discoveryengineClient.completeQuery(request);
  console.log(response);
}

callCompleteQuery();

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1


def sample_complete_query():
    # Create a client
    client = discoveryengine_v1.CompletionServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.CompleteQueryRequest(
        data_store="data_store_value",
        query="query_value",
    )

    # Make the request
    response = client.complete_query(request=request)

    # Handle the response
    print(response)

require "google/cloud/discovery_engine/v1"

##
# Snippet for the complete_query call in the CompletionService 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::V1::CompletionService::Client#complete_query.
#
def complete_query
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Client.new

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

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

  # The returned object is of type Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse.
  p result
end

Menggunakan daftar tolak pelengkapan otomatis

Anda dapat menggunakan daftar tolak untuk mencegah istilah tertentu muncul sebagai sugesti pelengkapan otomatis.

Misalnya, perusahaan farmasi. Jika obat tidak lagi disetujui FDA, tetapi disebutkan dalam dokumen di penyimpanan datanya, mereka mungkin ingin mencegah obat tersebut muncul sebagai kueri yang disarankan. Perusahaan dapat menambahkan nama obat tersebut ke daftar tolak untuk mencegahnya disarankan.

Batasan berikut berlaku:

• Satu daftar tolak per penyimpanan data
• Mengupload daftar tolak akan menimpa daftar tolak yang ada untuk penyimpanan data tersebut
• Maksimal 1.000 istilah per daftar yang ditolak
• Istilah tidak peka huruf besar/kecil
• Setelah mengimpor daftar tolak, perlu waktu 1-2 hari agar perubahan diterapkan

Setiap entri daftar tolak Anda terdiri dari blockPhrase dan matchOperator:

• blockPhrase: Masukkan string sebagai istilah daftar tolak Anda. Istilah tidak peka huruf besar/kecil.
• matchOperator: Menerima nilai berikut:
  • EXACT_MATCH: Mencegah kecocokan persis dengan istilah daftar tolak agar tidak muncul sebagai kueri yang disarankan.
  • CONTAINS: Mencegah saran yang berisi istilah daftar yang ditolak agar tidak muncul.

Berikut adalah contoh daftar tolak dengan empat entri:

{
    "entries": [
        {"blockPhrase":"Oranges","matchOperator":"CONTAINS"},
        {"blockPhrase":"bAd apples","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"Cool as A Cucumber","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"cherry pick","matchOperator":"CONTAINS"}
    ]
}

Sebelum mengimpor daftar tolak, pastikan kontrol akses yang diperlukan ditetapkan untuk akses editor Discovery Engine.

Daftar tolak dapat diimpor dari data JSON lokal atau dari Cloud Storage. Untuk menghapus daftar tolak dari penyimpanan data, hapus daftar tolak.

Mengimpor daftar tolak dari data JSON lokal

Untuk mengimpor daftar tolak dari file JSON lokal yang berisi daftar tolak Anda, lakukan hal berikut:

1. Buat daftar tolak di file JSON lokal dengan format berikut. Pastikan setiap entri daftar tolak berada di baris baru tanpa jeda baris.

   {
       "inlineSource": {
           "entries": [
               { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" },
               { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }
           ]
       }
   }

2. Buat permintaan POST ke metode suggestionDenyListEntries:import, dengan memberikan nama file JSON Anda.

   curl -X POST \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "Content-Type: application/json; charset=utf-8" \
       --data @DENYLIST_FILE \
     "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
   

   • DENYLIST_FILE: Jalur lokal file JSON yang berisi istilah daftar tolak.
   • PROJECT_ID: Nomor atau ID project Google Cloud Anda.
   • DATA_STORE_ID: ID penyimpanan data yang terkait dengan aplikasi Anda.

Setelah mengimpor daftar tolak, perlu waktu 1-2 hari untuk mulai memfilter saran.

Mengimpor daftar tolak dari Cloud Storage

Untuk mengimpor daftar tolak dari file JSON di Cloud Storage, lakukan hal berikut:

1. Buat daftar tolak dalam file JSON dengan format berikut dan impor ke bucket Cloud Storage. Pastikan setiap entri daftar tolak berada di baris baru tanpa jeda baris.

   { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" }
   { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }

2. Buat file JSON lokal yang berisi objek gcsSource. Gunakan ini untuk mengarah ke lokasi file daftar tolak di bucket Cloud Storage.

   {
       "gcsSource": {
           "inputUris": [ "DENYLIST_STORAGE_LOCATION" ]
       }
   }

   • DENYLIST_STORAGE_LOCATION: Lokasi daftar tolak Anda di Cloud Storage. Anda hanya dapat memasukkan satu URI. URI harus dimasukkan dalam format ini: gs://BUCKET/FILE_PATH.

3. Buat permintaan POST ke metode suggestionDenyListEntries:import, termasuk objek gcsSource.

   curl -X POST \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "Content-Type: application/json; charset=utf-8" \
       --data @GCS_SOURCE_FILE \
      "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
   

   • GCS_SOURCE_FILE: Jalur lokal file yang berisi objek gcsSource yang mengarah ke daftar tolak Anda.
   • PROJECT_ID: Nomor atau ID project Google Cloud Anda.
   • DATA_STORE_ID: ID penyimpanan data yang terkait dengan aplikasi Anda.

Setelah mengimpor daftar tolak, perlu waktu 1-2 hari untuk mulai memfilter saran.

Menghapus daftar tolak

Untuk menghapus daftar tolak dari penyimpanan data, lakukan hal berikut:

1. Buat permintaan POST ke metode suggestionDenyListEntries:purge.

   curl -X POST \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:purge"
   

   • PROJECT_ID: Nomor atau ID project Google Cloud Anda.
   • DATA_STORE_ID: ID penyimpanan data yang terkait dengan aplikasi Anda.

Model data dokumen lanjutan

Vertex AI Agent Builder menyediakan model data lanjutan untuk pelengkapan otomatis. Berdasarkan dokumen yang Anda impor, model data ini menghasilkan saran pelengkapan otomatis berkualitas tinggi dengan memanfaatkan model bahasa besar (LLM) Google.

Fitur ini bersifat eksperimental. Jika Anda tertarik untuk menggunakan fitur ini, hubungi tim akun Google Cloud Anda dan minta untuk ditambahkan ke daftar yang diizinkan.

Fitur ini tidak tersedia untuk penelusuran layanan kesehatan atau di multi-region Amerika Serikat dan Uni Eropa.