Cortex Search Serviceにクエリする¶

Snowflake Python APIs ライブラリのインストール¶

まず、最新版の Snowflake Python APIs パッケージを PyPI からインストールします。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は2つのマッチング演算子をサポートしています。

• 文字列の等質性: @eq

• 配列が含まれる: @contains

これらのマッチング演算子は、さまざまな論理演算子と組み合わせることができます。

• @and

• @or

• @not

これらの演算子は1つのフィルターオブジェクトにまとめることができます。以下に例を挙げます。

• 文字列のような列 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 とキーペア認証を使用してサービスをクエリするには:

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;