获取媒体应用的搜索结果

本页面介绍了如何使用Google Cloud 控制台预览媒体应用的搜索结果，以及如何使用 API 获取搜索结果。

如需实现搜索应用，您可以创建搜索 widget 并将其添加到网页中，也可以发起 API 调用并将这些调用集成到网页或应用中。

搜索模式简介

媒体应用有多种搜索查询模式：

  • 完整查询：当最终用户希望搜索整个搜索字词或短语时。例如，在音乐在线播放应用中，用户可以一次性输入歌曲的完整标题并进行搜索。如果使用允许用户一次性搜索的输入界面（例如音频输入或键盘输入），这种搜索方式是首选方式。

    在完整查询中，如果条目包含拼写错误，用户希望系统更正该错误。

    此行为与搜索非媒体（自定义）应用的行为相同。请参阅获取包含结构化或非结构化数据的应用的搜索结果。

  • 部分查询（或边输入边搜索）：当最终用户每输入一个字母时，都会动态收到一组新的搜索结果。例如，在音乐在线播放应用中，用户开始输入要搜索的歌曲的名称，并且随着用户输入的每个字母，搜索结果会动态更新并缩小范围。

  • 自动模式：自动模式是完全模式和部分模式的混合模式。在自动模式下，您可以让媒体搜索决定是返回部分查询结果还是完整查询结果。

    为了确定最终用户的可能意图，媒体搜索会分析并加权各种信号，例如输入的字母数、输入速度以及输入内容是否为可识别的实体（例如演员或电影的名称）。

使用哪种模式

媒体搜索查询的默认模式为自动模式。不过，在某些情况下，您可能需要替换默认模式，并指定完整或部分查询模式。以下是一些用例示例：

场景 模式
您非常确信最终用户的查询是完整查询。例如，您有一个搜索框，其中包含一个 Enter 功能，用于标记查询完成，并且用户按下了 Enter 键。 完整查询
您非常确信最终用户的查询是部分查询，也就是说，他们希望在输入每个字母后，结果列表都会更新。 部分查询
上述两种情形均不适用。让媒体搜索决定是返回部分查询结果还是完整查询结果。 自动

您可以在 Google Cloud 控制台中预览搜索结果，也可以使用 API 获取搜索结果。如需获取媒体应用的搜索结果，请执行以下操作：

控制台

如需使用 Google Cloud 控制台预览媒体搜索并配置微件，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 AI Applications 页面。

    AI Applications

  2. 点击媒体搜索应用的名称。

  3. 点击配置。

  4. 点击 UI 标签页。

  5. 在界面标签页中，设置常规配置和数据展示选项。

  6. 在预览窗格中，开始输入查询。

  7. 如需保存配置并使其可在集成标签页中使用，请点击保存并发布。

REST

使用 engines.servingConfigs.search 方法获取媒体应用的搜索结果：

  1. 查找应用 ID。如果您已拥有应用 ID，请跳到下一步。

    1. 在 Google Cloud 控制台中，前往 AI Applications 页面。

      前往“应用”

    2. 在应用页面上，找到应用的名称，并从 ID 列获取应用的 ID。

  2. 运行以下 curl 命令可获取输入即搜结果。

    除 contentSearchSpec 之外的所有字段均可与 searchAsYouTypeSpec 字段搭配使用。为清楚起见，curl 命令中省略了可选字段。如需了解可选字段，请参阅获取包含结构化数据或非结构化数据的应用的搜索结果。

    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",
"searchAsYouTypeSpec": {"condition": "SPEC_CONDITION"}
}'

    替换以下内容：

    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • APP_ID：要查询的 Vertex AI Search 应用的 ID。
    • QUERY：要搜索的查询文本。

    • SPEC_CONDITION：边输入边搜索规范可以具有以下值之一：

      • ENABLED：针对部分查询
      • DISABLED：用于完整查询
      • AUTO：部分或全部（视情况而定）。如果您将 SPEC_CONDITION 字段留空或未指定该字段，则默认搜索模式为 AUTO。

    命令和部分结果示例

    curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search:search" \
-d '{
"query": "Mission Impossible",
"searchAsYouTypeSpec": {"condition": "DISABLED"}
}'

    
{
  "results": [
    {
      "id": "189333",
      "document": {
      "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/189333",
        "id": "189333",
        "structData": {
          "uri": "http://mytestdomain.movie/content/189333",
          "title": "Mission: Impossible - Fallout (2018)",
          "categories": [
            "Action",
            "Adventure",
            "Thriller"
          ],
          "available_time": "2023-01-01T00:00:00Z",
          "media_type": "movie",
          "expire_time": "2033-01-01T00:00:00Z"
        }
      }
    },
    {
      "id": "111781",
      "document": {
      "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/111781",
        "id": "111781",
        "structData": {
          "media_type": "movie",
          "available_time": "2023-01-01T00:00:00Z",
          "uri": "http://mytestdomain.movie/content/111781",
          "title": "Mission: Impossible - Rogue Nation (2015)",
          "categories": [
            "Action",
            "Adventure",
            "Thriller"
          ],
          "expire_time": "2033-01-01T00:00:00Z"
        }
      }
    },
    ...
    {
      "id": "116507",
      "document": {
      "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/116507",
        "id": "116507",
        "structData": {
          "uri": "http://mytestdomain.movie/content/116507",
          "categories": [
            "Comedy"
          ],
          "media_type": "movie",
          "available_time": "2023-01-01T00:00:00Z",
          "title": "Mission London (2010)",
          "expire_time": "2033-01-01T00:00:00Z"
        }
      }
    }
  ],
  "totalSize": 5628,
  "attributionToken": "vgL0PQEKDAiZxMbCBhD2koiqAxIkNjg1MWM3OTUtMDAwMC0yOWVmLThhNzUtZDQzYTJjYzdiYmNmIgVNRURJQSpUtreMLa_WoTGs1qExwvCeFaOAlyKrtZwxxcvzF-7r6TGotZwxkPeyMI6RyTDPv-Iw1L_iMJvWty2Ovp0V1LKdFfHr6THs4K8tkvGsMJXxrDCY1rctMAFKEjB4OTYzYjdjNGE0ZGYwN2FhZlKUAXByb2plY3RzLzc1NjIwNjYwODQ3OS9sb2NhdGlvbnMvZ2xvYmFsL2NvbGxlY3Rpb25zL2RlZmF1bHRfY29sbGVjdGlvbi9lbmdpbmVzL3F1aWNrc3RhcnQtbWVkaWEtcmVjb21tZW5kXzE3NDUwMjUyMjYwNDMvc2VydmluZ0NvbmZpZ3MvZGVmYXVsdF9zZWFyY2g",
  "nextPageToken": "Y2YiJ2NjNmMhNDNk1SN3EGOtYWZ5ITLwADMw0CN5czYxUDO2QiGDI9kgzIEGIs1tmJCMIBM1IgC",
  "summary": {},
  "queryExpansionInfo": {}
}

后续步骤