Recherche

Comment interagir avec l'IA privée pour la recherche dans SayMyData

Démarrer avec la recherche

Une fois que vos données sont indexées dans vos Bases de connaissances, vous pouvez les retrouver, les compiler ou les analyser en questionnant l'IA (LLM privé).

Pour explorer l'amplitude des capacités de recherche et d'analyse de votre LLM privé, le plus simple est de vous connecter à votre espace de travail sur notre l'Application Web et d'interroger vos données dans la section Assistant Intelligent.

Vous pouvez également questionner vos données via notre API en utilisant le point de terminaison (endpoints) dédié.

/ask - Recherche générative sur vos données

Cet endpoint effectue une recherche sémantique pour identifier les informations les plus pertinentes depuis votre Base de connaissances, puis les transmet à votre LLM privé pour générer une réponse.

Exemple : Interroger une Base de connaissances

curl --location --request POST 'https://api.saymydata.com/v1/kb/{id}/ask' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "question": "Comment faire du vélo",
    "prompt": "Génère une réponse concise qui explique comment apprendre à faire du vélo",
    "stream": "true",
    "search_type": "hybrid",
    "save_message": "true",
    "cache": "true",
    "with_context": "true"
}'

Désigner la Base de connaissances à interroger

L'URL doit désigner la Base de connaissances à interroger via{id}

https://api.saymydata.com/v1/kb/{id}/ask

Vous pouvez interroger directement une Ressource précise :

Vous pouvez restreindre la recherche aux données liées à une Ressource précise en appelant son URL :

https://api.saymydata.fr/v1/kb/{id}/resources/{resource_id}/ask

• La Base de connaissances : {id}

• La Ressource : {resource_id}

Explication des champs

Champ	Type	Description
question	String	Question à poser à la Base de connaissances.
prompt	String	Indications pour formuler la réponse générée.
stream	Boolean	Modalité d'affichage de la réponse : true : Affichage progressif. false : Affichage lorsque la réponse est intégralement générée.
search_type	Enum	Type de recherche : sparse : Recherche précise et factuelle. dense : Recherche créative et détaillée hybrid : Recherche hybride entre précision et créativité.
save_message	Boolean	Indique si la question doit être sauvegardée (true) ou non (false).
cache	Boolean	Indique si la réponse doit être mise en cache (true) ou non (false).
with_context	Boolean	Indique si la réponse doit se baser sur le contexte et les précédents échanges de la conversation (true) ou non (false).

Body :

{
    "question": "Comment faire du vélo",
    "prompt": "Génère une réponse concise qui explique comment apprendre à faire du vélo",
    "stream": true
}

Paramètres du body :

• question (obligatoire) : La requête textuelle à rechercher. Par exemple : "Comment faire du vélo".

• prompt (chaîne de caractères ou objet, optionnel) : Utilisé pour personnaliser les prompts donnés au modèle génératif. Si une chaîne est fournie, elle est interprétée comme le prompt utilisateur. Par exemple : "Génère une réponse concise qui explique comment apprendre à faire du vélo".

Cela retournera une réponse générée par l'IA à la question « Comment faire du vélo », basée sur vos données.