Interroger un Cortex Search Service¶

Installez la bibliothèque Snowflake Python APIs.¶

Tout d’abord, installez la dernière version du paquet Snowflake Python APIs depuis PyPI. Consultez Installez la bibliothèque Snowflake Python APIs. pour obtenir des instructions sur l’installation de ce paquet à partir de PyPI.

pip install snowflake -U

Se connecter à Snowflake¶

Connectez-vous à Snowflake en utilisant une Session Snowpark ou une Connection Python Connector et créez un objet Root. Consultez Connexion à Snowflake avec Snowflake Python APIs pour plus d’instructions sur la connexion à Snowflake. L’exemple suivant utilise l’objet de la Session Snowpark et un dictionnaire Python pour la configuration.

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)

Interroger le service¶

Interrogez le service en utilisant la syntaxe suivante :

# 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())

Paramètres¶

Syntaxe de filtre¶

Cortex Search prend en charge le filtrage sur les colonnes ATTRIBUTES spécifiées dans la commande CREATE CORTEX SEARCH SERVICE.

Cortex Search prend en charge deux opérateurs de correspondance :

• Égalité des chaînes : @eq

• La table contient : @contains

Ces opérateurs de correspondance peuvent être composés de différents opérateurs logiques :

• @and

• @or

• @not

Ces opérateurs peuvent être combinés en un seul objet filtre. Voici quelques exemples :

• Le filtrage sur les lignes où se trouve une colonne de type chaîne string_col est égal à la valeur value.

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

  Copy

• Filtrage sur les lignes où la colonne ARRAY array_col contient de la valeur value.

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

  Copy

• Composition de filtres avec des opérateurs logiques :

  // 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

Configurer l’authentification REST API¶

Les REST APIs Snowflake prennent actuellement en charge l’authentification via l’authentification par paire de clés et OAuth. Pour plus de détails, voir Authentification d”Snowflake REST APIs avec Snowflake.

Exemple d’interrogation du service¶

Pour interroger le service en utilisant curl et une authentification par paire de clés :

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>
}'

Exemple¶

L’exemple suivant prévisualise le service avec la chaîne de requête preview query et analyse les résultats dans un objet 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;