API REST d’intégration vectorielle¶

Configuration de l’authentification¶

Pour vous authentifier auprès de l’API REST de Cortex , vous pouvez utiliser les méthodes décrites dans Authentification d”Snowflake REST APIs avec Snowflake.

Définissez l’en-tête Authorization pour inclure votre jeton (par exemple, un jeton Web JSON (JWT), un jeton OAuth ou un jeton d’accès programmatique).

Configuration de l’autorisation¶

Pour envoyer une demande d’API REST, votre rôle par défaut doit se voir accorder le rôle de base de données SNOWFLAKE.CORTEX_USER. Dans la plupart des cas, les utilisateurs disposent déjà de ce privilège, car SNOWFLAKE.CORTEX_USER est accordé au rôle PUBLIC automatiquement et tous les rôles héritent de PUBLIC.

Si votre administrateur Snowflake a révoqué cette autorisation, il doit la réaccorder :

GRANT DATABASE ROLE SNOWFLAKE.CORTEX_USER TO ROLE my_role;
GRANT ROLE my_role TO USER my_user;

ALTER USER my_user SET DEFAULT_ROLE=my_role

Format du point de terminaison¶

Vous pouvez adresser des requêtes au point de terminaison /api/v2/cortex/inference:embed afin de créer des éléments d’intégration pour votre texte. La requête se présente sous la forme suivante :

POST https://<account_identifier>.snowflakecomputing.com/api/v2/cortex/inference:embed

où account_identifier est le l’identificateur de compte que vous utilisez pour accéder à Snowsight.

Disponibilité du modèle¶

Le tableau suivant présente les modèles de fonction EMBED que vous pouvez solliciter à l’aide de l’API REST.

Le tableau suivant indique le nombre de dimensions que chaque modèle peut renvoyer.

Référence API¶

Exemple de requête CURL¶

L’exemple suivant utilise curl pour effectuer une requête EMBED vers le modèle e5-base-v2. Remplacez token et account_identifier avec les valeurs appropriées dans cette commande.

curl --location "<account_url>/api/v2/cortex/inference:embed" \
--header 'X-Snowflake-Authorization-Token-Type: KEYPAIR_JWT' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer <token>" \
--data '{
"text": ["foo", "bar"],
"model": "e5-base-v2"
}'

{
  "object" : "list",
  "data" : [ {
    "object" : "embedding",
    "embedding" : [ [ -0.02102863, 0.0051381723, -0.0071509206, -0.032512695, 0.056507032, ... ] ],
    "index" : 0
  }, {
    "object" : "embedding",
    "embedding" : [ [ -0.03859099, -0.0025452692, 0.002827513, -0.023107057, 0.039019972, ... ] ],
    "index" : 1
  } ],
  "model" : "e5-base-v2",
  "usage" : {
    "total_tokens" : 6
  }
}

Exemple de requête Python¶

L’exemple suivant utilise l’API de Python pour effectuer une requête EMBED vers le modèle e5-base-v2. Remplacez token et account_identifier avec les valeurs appropriées dans cette commande.

from snowflake.core import Root
from snowflake.snowpark.context import get_active_session

def embed_service():
    # Initialize Snowflake session and root
    session = get_active_session()
    root = Root(session)

    # Send embed_request request and process response
    response = root.cortex_embed_service.embed("e5-base-v2", ['foo', 'bar'])
    print(response)

if __name__ == "__main__":
    embed_service()

{
  "object" : "list",
  "data" : [ {
    "object" : "embedding",
    "embedding" : [ [ -0.02102863, 0.0051381723, -0.0071509206, -0.032512695, 0.056507032, ... ] ],
    "index" : 0
  }, {
    "object" : "embedding",
    "embedding" : [ [ -0.03859099, -0.0025452692, 0.002827513, -0.023107057, 0.039019972, ... ] ],
    "index" : 1
  } ],
  "model" : "e5-base-v2",
  "usage" : {
    "total_tokens" : 6
  }
}

Quotas d’utilisation¶

Le tableau suivant indique les quotas d’utilisation de la fonction EMBED.