查询 Cortex Search 服务¶

安装 Snowflake Python APIs 库¶

首先，从 PyPI 安装最新版本的 Snowflake Python APIs 包。有关从 PyPI 安装该包的说明，请参阅 安装 Snowflake Python APIs 库。

pip install snowflake -U

连接到 Snowflake¶

使用 Snowpark Session 或 Python Connector Connection 连接到 Snowflake，并创建 Root 对象。有关连接到 Snowflake 的更多说明，请参阅 使用 Snowflake Python APIs 连接到 Snowflake。下面的示例使用 Snowpark Session 对象和 Python 字典进行配置。

import os
from snowflake.core import Root
from snowflake.snowpark import Session

CONNECTION_PARAMETERS = {
    "account": os.environ["snowflake_account_demo"],
    "user": os.environ["snowflake_user_demo"],
    "password": os.environ["snowflake_password_demo"],
    "role": "test_role",
    "database": "test_database",
    "warehouse": "test_warehouse",
    "schema": "test_schema",
}

session = Session.builder.configs(CONNECTION_PARAMETERS).create()
root = Root(session)

查询服务¶

使用以下语法查询服务：

# fetch service
my_service = (root
  .databases["<service_database>"]
  .schemas["<service_schema>"]
  .cortex_search_services["<service_name>"]
)

# query service
resp = my_service.search(
  query="<query>",
  columns=["<col1>", "<col2>"],
  filter={"@eq": {"<column>": "<value>"} },
  limit=5
)
print(resp.to_json())

参数¶

筛选器语法¶

Cortex Search 支持对 CREATE CORTEX SEARCH SERVICE 命令中指定的 ATTRIBUTES 列进行筛选。

Cortex Search 支持两种匹配运算符：

• 字符串相等：@eq

• 数组包含：@contains

这些匹配运算符可以由各种逻辑运算符组成：

• @and

• @or

• @not

这些运算符可以组合成一个筛选器对象。示例如下：

• 筛选字符串类列 string_col 等于值 value 的行。

  { "@eq": { "string_col": "value" } }
  

  Copy

• 筛选 ARRAY 列 array_col 包含值 value 的行。

  { "@contains": { "array_col": "arr_value" } }
  

  Copy

• 用逻辑运算符组成筛选器：

  // Rows where the "array_col" column contains "arr_value" and the "string_col" column equals "value":
  {
      "@and": [
        { "@contains": { "array_col": "arr_value" } },
        { "@eq": { "string_col": "value" } }
      ]
  }
  
  // Rows where the "string_col" column does not equal "value"
  {
    "@not": { "@eq": { "string_col": "value" } }
  }
  
  // Rows where the "array_col" column contains at least one of "val1", "val2", or "val3"
  {
    "@or": [
        { "@contains": { "array_col": "val1" } },
        { "@contains": { "array_col": "val1" } },
        { "@contains": { "array_col": "val1" } }
    ]
  }
  

  Copy

配置 REST API 身份验证¶

目前，Snowflake REST APIs 支持通过密钥对身份验证和 OAuth 进行身份验证。有关详细信息，请参阅 使用 Snowflake 对 Snowflake REST APIs 进行身份验证。

查询服务示例¶

要使用 curl (https://curl.se/) 和密钥对身份验证查询服务，请执行以下操作：

curl --location https://<ACCOUNT_URL>/api/v2/databases/<DB_NAME>/schemas/<SCHEMA_NAME>/cortex-search-services/<SERVICE_NAME>\:query \
--header 'X-Snowflake-Authorization-Token-Type: KEYPAIR_JWT' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $CORTEX_SEARCH_JWT" \
--data '{
  "query": "<search_query>",
  "columns": ["col1", "col2"],
  "filter": <filter>
  "limit": <limit>
}'

示例¶

下面的示例使用 preview query 查询字符串预览服务，并将结果解析为 VARIANT 对象。

SELECT PARSE_JSON(
  SNOWFLAKE.CORTEX.SEARCH_PREVIEW(
      'my_search_service',
      '{
         "query": "preview query",
         "columns":[
            "col1",
            "col2"
         ],
         "filter": {"@eq": {"col1": "filter value"} },
         "limit":10
      }'
  )
)['results'] as results;