API de stockage en fonction du contenu (CAS)

Liste de toutes les références API REST pour le service CAS.

Autoriser pour les API REST

Pour l'authentification des API REST, assurez-vous d'avoir un jeton de porteur valide dans l'en-tête Authorization OpenShift® Container Platform valide dans l'en-tête Authorization :

Récupérer le jeton :
1. Allez sur la console OpenShift.
2. Dans la page qui s'affiche, cliquez sur le lien Afficher le jeton.
3. Dans la page Votre jeton API est, copiez la valeur du jeton de la section Se connecter avec ce jeton.
  Note : Pour l'authentification des API REST lorsqu'un fournisseur d'identité externe est configuré, assurez-vous que vous avez un jeton de porteur de fournisseur d'identité valide dans l'en-tête d' autorisation.
Dans votre navigateur, allez à swagger - https://<fusion url>/api/v1/querysearch/docs.
Le document Swagger spécifie la liste des ressources disponibles dans l'API REST et les opérations qui peuvent être appelées sur ces ressources. Le document Swagger spécifie également la liste des paramètres d'une opération, y compris le nom et le type des paramètres et des informations sur les valeurs acceptables pour ces paramètres.
Dans la page FastAPI cliquez sur Autoriser.
Dans la fenêtre Autorisations disponibles, entrez une valeur pour HTTPBearer.
Cliquez sur Autoriser.

Essayer des API à partir de Swagger

Pour plus d'informations sur les documents Swagger, voir https://fusionconsoleurl/api/v1/querysearch/docs# ou dans l'interface utilisateur, allez dans Domaines > Voir les API de recherche.

Dans Swagger, développez l'API et cliquez sur Try it out.

/tables

Descriptif: Il renvoie une requête "tables" du processeur de documents à laquelle vous avez accès.

Méthode: GET

Utilisation: Vérifier Swagger.

/semantic_search

Descriptif: Il fait correspondre les mots exacts et utilise le traitement du langage naturel (NLP) et l'apprentissage automatique pour trouver des résultats pertinents d'un point de vue sémantique. Si vous n'avez pas accès à un domaine spécifique, l'API génère une erreur 403 (accès non valide). Si la sécurité au niveau des fichiers est activée, les résultats de la recherche sémantique sont limités aux seuls fichiers que l'utilisateur de la requête CAS est autorisé à lire dans le système de fichiers IBM Scale.

Méthode: POST

Paramètres

Paramètre : Type	Descriptif
"query" : chaîne de caractères	La question en langage naturel utilisée par le modèle d'intégration pour renvoyer une liste d'extraits de texte pertinents à partir des documents ingérés.
"table" : chaîne	Nom d'un processeur de documents particulier qui a ingéré des documents d'un domaine donné.
"limite" : int	Nombre maximum de résultats renvoyés, par défaut 5.
"enable_source" : booléen	Si c'est le cas, toutes les informations sur la source du document sont renvoyées.
"enable_content_metadata" : booléen	Si c'est le cas, toutes les métadonnées relatives au document concerné sont renvoyées.

Utilisation: Vérifier l'assurance.

Exemple de chatbot CLI pour l'utilisateur final: Le chatbot alimenté par le CLI permet un accès sécurisé et authentifié au stockage de contenu par le biais d'un CLI conversationnel, alimenté par des LLM tels que IBM watsonx Granite, Open AI, NVIDIA NIM, et Ollama. Il utilise les API sémantiques de CAS pour fournir des informations efficaces et basées sur l'IA, accélérant les flux de travail RAG avec une performance, une sécurité et une efficacité améliorées.; Pour plus d'informations, suivez l'exemple de référence dans GitHub.