Tutoriel 1 : Configuration et test d’une CKE par les fournisseurs

Introduction

Pour les fournisseurs, ce tutoriel décrit comment configurer et tester votre CKE.

Ce que vous apprendrez

Dans ce tutoriel, vous apprendrez à :

  • Créer des objets Snowflake

  • Charger vos données dans Snowflake

  • Découper vos documents

  • Créer le Cortex Search Service

  • Vérifier que le CKE fonctionne correctement

  • Partager et tester le CKE avec un compte consommateur

Conditions préalables

Les prérequis suivants sont nécessaires à la réalisation de ce tutoriel :

  • Vous disposez d’un compte Snowflake et d’un utilisateur avec un rôle qui accorde les privilèges nécessaires pour créer une base de données, des tables, des objets d’entrepôt virtuel, des Cortex Search Services et des applications Streamlit.

Consultez les Snowflake en 20 minutes pour obtenir des instructions afin de répondre à ces exigences.

Étape 1 : Créer des objets Snowflake

La première étape consiste à créer des objets Snowflake.

Utilisez le rôle accountadmin.

use role accountadmin;
Copy

Créez un entrepôt nommé xsmall_cke_getting_started pour la création et la mise à jour de l’index.

create warehouse xsmall_cke_getting_started warehouse_size=xsmall;
Copy

Créez un rôle distinct nommé cke_owner.

create role cke_owner;
grant role cke_owner to user admin;
grant usage on warehouse xsmall_cke_getting_started to role cke_owner;
Copy

Créez et utilisez une base de données nommée cke_getting_started.

grant create database on account to role cke_owner;
use role cke_owner;
create database cke_getting_started;
use database cke_getting_started;
Copy

Créez et utilisez un schéma appelé articles.

create schema articles;
use schema articles;
Copy

Étape 2 : Charger vos données dans Snowflake

L’étape suivante consiste à charger vos données dans Snowflake. Reportez-vous à Charger des données dans Snowflake pour plus d’informations.

L’exemple de code ci-dessous stocke les données dans une table Snowflake nommée cke_simple_article dans le format suivant :

Nom de la colonne

Type

Description

DOCUMENT_ID

VARCHAR

L’identifiant unique du document. Il s’agit de la clé primaire de la table.

DOCUMENT_TITLE

VARCHAR

Le titre du document.

SOURCE_URL

VARCHAR

Une URL pointant vers la source d’un document.

DOCUMENT_TEXT

VARCHAR

Le contenu du document, analysé sous forme de texte. C’est le contenu qui sera indexé et recherché.

Notez que vous pouvez inclure des métadonnées de documents supplémentaires dans votre jeu de données indexées. Dans l’exemple ci-dessous, nous n’incluons que SOURCE_URL et DOCUMENT_ID, mais vous pouvez ajouter d’autres colonnes en fonction de la source de votre document.

Créez une table simple.

create or replace table cke_simple_article (
    DOCUMENT_ID VARCHAR,
    DOCUMENT_TITLE VARCHAR,
    SOURCE_URL VARCHAR,
    text VARCHAR
);
Copy

Insérez maintenant des échantillons de données dans cette table.

INSERT INTO cke_simple_article (DOCUMENT_ID, DOCUMENT_TITLE, SOURCE_URL, TEXT)
VALUES
    ('DOC_001', 'Sample Article 1', 'https://example.com/article1', 'This is some sample text for the first article.'),
    ('DOC_002', 'Sample Article 2', 'https://example.com/article2', 'Another sample text entry for the second article.'),
    ('DOC_003', 'Sample Article 3', 'https://example.com/article3', 'Yet another piece of text for the third article.');

INSERT INTO cke_simple_article (
    DOCUMENT_ID,
    DOCUMENT_TITLE,
    SOURCE_URL,
    text
)
VALUES (
    'DOC-GREEN-001',
    'The Grand Opening of Greenfield Biosphere',
    'https://www.example.com/news/greenfield-biosphere',
    'Greenfield Biosphere, nestled in the heart of a once-industrial landscape, opened its doors to the public today amid great fanfare and curiosity. This ambitious environmental initiative, spanning over 120 acres of reclaimed land, has been designed to house thousands of diverse plant species and animals under one vast, transparent dome. Over the past decade, teams of botanists, engineers, and conservationists collaborated intensively to restore the soil quality, implement renewable energy solutions, and establish sustainable water sources. Their efforts have resulted in an oasis that stands as a testament to nature''s resilience and humanity''s unwavering determination to coexist with it.

    Upon entering the biosphere, visitors pass through a series of controlled airlocks that maintain precise temperature and humidity levels, ensuring the delicate balance required for each habitat. The moment they step inside, a multitude of colors and scents envelops them. Towering palm trees sway gently, nurtured by a carefully engineered irrigation system that recycles water across various sections of the dome. Exotic butterflies flutter past patches of vibrant orchids, while small reptiles scurry along the edge of meandering pathways. Every detail, from lighting angles to seed selection, has been meticulously planned to promote biodiversity in a space that once lay barren.

    Local officials and environmental organizations herald this project as a bold step toward reversing ecological decline. The region had suffered decades of industrial pollution, leaving the soil depleted and wildlife populations on the brink of collapse. Public interest soared once the Greenfield Biosphere project was announced, prompting unprecedented fundraising campaigns and private investments. Citizens volunteered their time to plant seedlings, build composting facilities, and educate children on the importance of ecological stewardship. Now, as thousands explore the dome on opening day, excitement mingles with a sense of responsibility, fueling hope that this initiative can serve as a catalyst for broader restoration efforts.

    Beyond merely a tourist attraction, the Greenfield Biosphere plays a crucial role in scientific research. Biologists and ecologists from universities around the globe have established research stations within the dome to study plant migration, cross-pollination, and microclimates. Through advanced sensor networks, they collect data on everything from soil moisture levels to carbon sequestration rates, aiming to develop cutting-edge conservation strategies. Already, preliminary findings suggest that certain flora species exhibit faster growth rates under partial shade, which could help inform future reforestation projects. This research extends to aquatic ecosystems as well, with scientists closely monitoring newly formed ponds and streams for indicators of ecosystem health.

    During the grand opening ceremony, Mayor Allison Pierce praised the community for its unwavering dedication to the biosphere''s development. She emphasized how interagency cooperation and community outreach were pivotal in transforming a polluted wasteland into a verdant sanctuary. In her address, she remarked on the significance of involving local youth, who contributed to the design through art projects and educational workshops. According to Mayor Pierce, the next phase of the project will include expanding the biosphere''s capacity for endangered species breeding programs. This could cement the region''s reputation as a global leader in ecological preservation and innovation.

    For many, the real highlight of the day was the unveiling of the arboretum wing, a temperature-controlled section featuring ancient tree species that have long faced threats from illegal logging and habitat loss. Towering redwoods, thought to be too large to grow under a dome, stand proudly after years of careful nurturing. Visitors stood in awe as the directors revealed that these trees'' root systems, painstakingly preserved and transplanted, are now thriving in custom-engineered soil mixtures. A sense of reverence filled the air, with many attendees describing the experience as spiritual. The seed of hope planted in the community has visibly taken root.

    The venture''s economic impact is another key talking point. Local shops and restaurants anticipate an influx of tourists, and hotels report reservations scheduled months in advance. Construction of new eco-lodges in the surrounding areas is already underway, promising a blend of comfortable accommodations with sustainable building practices. The city council has also approved additional funding to improve roads and public transportation to accommodate the expected rise in visitor numbers. Environmental advocates caution, however, that increased foot traffic could inadvertently strain the biosphere''s delicate ecosystems, calling for balanced planning and continued emphasis on conservation education.

    Inside the administrative office, a dedicated operations team monitors real-time data feeds, adjusting temperature, humidity, and nutrient levels to meet each species'' unique needs. Modular solar panels installed around the dome generate sufficient electricity to power the entire facility, showcasing how renewable energy can be integrated seamlessly with large-scale infrastructure. Outside, an innovative wastewater treatment plant recycles greywater for irrigation, minimizing resource consumption. The architects behind the biosphere believe these sustainable technologies can be replicated in other communities looking to rehabilitate degraded land, turning once-polluted sites into living laboratories for environmental stewardship.

    While the facility is only in its first phase, future expansions are already on the drawing board. There are plans to introduce a marine habitat zone featuring coral reef tanks that highlight threats to underwater ecosystems. Specially designed walkways will give visitors a close-up view of these aquatic wonders without disturbing the delicate organisms within. Meanwhile, education programs will be expanded to local schools, offering field trips where students can learn about biodiversity, climate change, and sustainable technologies. The hope is that exposure to this living exhibit will inspire the next generation of environmental scientists, engineers, and policymakers.

    As dusk settled over the glass dome, a soft, multi-colored illumination replaced the natural daylight, casting enchanting shadows across the tropical foliage. Families strolled slowly along the paths, pausing to read plaques about the origins of each plant or to marvel at the occasional flutter of nocturnal pollinators. Meanwhile, a gentle hum of conversation reverberated in the background, carrying sentiments of astonishment and gratitude. The first day at Greenfield Biosphere ended with a collective realization that, with mindful planning, community collaboration, and respect for nature''s inherent wisdom, it is indeed possible to transform a scarred landscape into a flourishing haven for life and innovation.'
);
Copy

Étape 3. Découper vos documents

Avant de créer un Cortex Search Service, nous devons nous assurer que chaque « morceau » de texte indexé ne comporte pas plus de 375 mots environ. Pour ce faire, nous pouvons appliquer un algorithme de découpage via Snowpark UDF qui importe LangChain. Tout d’abord, nous créons un UDF de découpage. Ensuite, nous appliquons cet UDF à la table cke_simple_article et stockons les morceaux dans une table cke_simple_article_chunks. Enfin, nous vérifions que les morceaux ont bien été créés.

Exécutez l’exemple ci-dessous pour découper les articles en morceaux pour le Cortex Search Service. Cette opération peut prendre plusieurs minutes.

CREATE OR REPLACE FUNCTION text_chunker(text STRING)
    RETURNS TABLE (chunk VARCHAR)
    LANGUAGE PYTHON
    RUNTIME_VERSION = '3.9'
    HANDLER = 'text_chunker'
    PACKAGES = ('snowflake-snowpark-python', 'langchain')
    AS
$$
from snowflake.snowpark.types import StringType, StructField, StructType
from langchain.text_splitter import RecursiveCharacterTextSplitter
from snowflake.snowpark.files import SnowflakeFile
import logging
import pandas as pd

class text_chunker:

    def process(self, text: str):
        text_splitter = RecursiveCharacterTextSplitter(
            chunk_size = 2000,  # Adjust this as needed
            chunk_overlap = 300,  # Overlap to keep chunks contextual
            length_function = len
        )

        chunks = text_splitter.split_text(text)
        df = pd.DataFrame(chunks, columns=['chunk'])

        yield from df.itertuples(index=False, name=None)
$$;
Copy

Exécutez l’exemple ci-dessous pour diviser les documents en morceaux en vue de l’indexation.

CREATE OR REPLACE TABLE cke_simple_article_chunks AS
    SELECT
        c.DOCUMENT_ID,
        c.DOCUMENT_TITLE,
        c.SOURCE_URL,
        t.chunk
    FROM cke_simple_article AS c, TABLE(text_chunker(CONCAT(c.DOCUMENT_TITLE, '\n', c.TEXT))) AS t;
Copy

Exécutez la procédure suivante pour vérifier que les morceaux ont été créés.

select * from cke_simple_article_chunks;
Copy

Étape 4. Créer le Cortex Search Service

Configurez maintenant un Cortex Search Service nommé cke_simple_cortex_search_service pour qu’il s’exécute sur l’entrepôt xsmall_cke_getting_started et qu’il fasse référence à la table de documents découpés cke_simple_article_chunks. Notez que cette étape peut prendre beaucoup de temps, en fonction de la taille de la base de données.

CREATE OR REPLACE CORTEX SEARCH SERVICE cke_simple_cortex_search_service
  ON chunk
  ATTRIBUTES document_title
  WAREHOUSE = xsmall_cke_getting_started
  TARGET_LAG = '1 hour'
  AS (
    SELECT
        chunk,
        document_title,
        source_url
      FROM cke_simple_article_chunks
  );
Copy

Étape 5. Test de l’CKE

Pour vérifier que le CKE fonctionne correctement, vous pouvez envoyer une simple requête au Cortex Search Service. Cela permettra de vérifier que le service a correctement indexé vos documents et que les requêtes renvoient des documents pertinents. Cette requête devrait renvoyer le premier morceau de l’article « The Greenfield Biosphere » avec un lien vers l’URL source.

select snowflake.cortex.search_preview(
 'cke_getting_started.articles.cke_simple_cortex_search_service',
 '{ "query": "whats happening with the greenfield biosphere?", "columns": ["chunk","document_title","source_url"] }');
Copy

Étape 6 : Partager le CKE en privé pour le tester

Une fois que le Cortex Search Service a été créé et qu’il répond correctement aux requêtes, vous pouvez le partager. Ce Cortex Search Service partagé est la Cortex Knowledge Extension. Dans cette étape, vous allez créer une annonce privée et la partager avec un autre compte pour la tester. Ensuite, vous testerez l’annonce dans le compte consommateur avec lequel vous avez partagé le CKE.

Créer le partage

  1. Connectez-vous à Snowsight et naviguez jusqu’à Data Products » Provider Studio.

  2. Sélectionnez Listing dans le coin supérieur droit et sélectionnez Specified Consumers.

  3. Donnez un titre à l’annonce, puis cliquez sur Next.

  4. Cliquez sur + Select pour What’s in the listing?.

  5. Sélectionnez CKE_GETTING_STARTED.

  6. Développez ARTICLES.

  7. Développez Cortex Search Service.

  8. Sélectionnez CKE_SIMPLE_CORTEX_SEARCH_SERVICE puis sélectionnez Done.

  9. Entrez une description pour l’annonce.

  10. Sous Add consumer accounts, ajoutez le compte Snowflake avec lequel vous souhaitez partager et tester la Cortex Knowledge Extension. Notez que vous devez être dans la même région que le fournisseur et que vous devez avoir accès à ce compte.

Tester le partage sur un compte consommateur

  1. Connectez-vous au compte consommateur Snowsight avec lequel vous avez partagé le CKE ci-dessus.

  2. Accédez à Data Products » Private Sharing.

  3. Ici, vous devriez voir l’annonce CKE_GETTING_STARTED que vous avez partagée ci-dessus. Sélectionnez Get.

  4. Ouvrez une nouvelle feuille de calcul et exécutez la commande SQL ci-dessous pour vérifier que le compte a accès aux données partagées.

    select
      snowflake.cortex.search_preview(
       'CKE_GETTING_STARTED_GUIDE__FAKE_ARTICLES.ARTICLES.CKE_SIMPLE_CORTEX_SEARCH_SERVICE',
       '{ "query": "whats happening with the biosphere?", "columns": ["chunk","document_title"] }'
      );
    
    Copy

    Note

    Si vous avez spécifié un nom autre que CKE_GETTING_STARTED dans la boîte de dialogue Get, vous devrez le modifier dans l’extrait ci-dessus.

À ce stade, vous disposez d’une Cortex Knowledge Extension fonctionnelle !