SDK .NET (bureau et serveurs)
ORYKSA pour applications .NET sur Windows, Linux et macOS, et pour backends .NET : client, assistants serveur et vérification de webhook.
Ce que fait le SDK et à quoi il sert
Il intègre la bulle de chat ORYKSA et la voix dans votre application, pour servir les clients de votre entreprise: ils posent des questions, achètent et réservent. L'IA répond avec votre Brain, vos produits et vos services, avec le nom, la photo et la voix que vous avez choisis dans Votre IA, et enregistre les leads, réservations et ventes dans les Activités de votre compte ORYKSA, comme WhatsApp ou le chat du site web.
Ce n'est pas une interface pour le propriétaire : via le SDK, personne ne modifie vos paramètres, ne lit vos Activités ou ne donne d'ordres à ORYKSA, même s'il se présente comme le propriétaire. Le chat où le propriétaire parle à ORYKSA existe uniquement dans l'application officielle ORYKSA, le tableau de bord et l'extension navigateur.
La voix depuis la version 1.1 (Android, iOS, Flutter et React Native), avec le même comportement que l'application ORYKSA. Les SDK JavaScript et .NET sont uniquement textuels.
Les gros mots saisis par le client apparaissent sous forme d'astérisques dans le chat (la même liste que tous les chats ORYKSA, depuis GET https://app.oryksa.com/widget/profanity.json) ; les réponses de l'IA sont déjà filtrées.
En savoir plus dans le Centre d'aide
| Package | Version | Plateformes | Licence |
|---|---|---|---|
Oryksa (GitHub) | 1.0.0 | netstandard2.0, net8.0 | MIT |
Installer
Le package NuGet Oryksa est en cours de publication ; en attendant sa mise en ligne, ajoutez le projet depuis GitHub (git submodule ou référence de projet).
dotnet add package Oryksa
Exemple minimal
Côté client (application de bureau) : discutez avec l’employé IA sans interface propre. Pour une fenêtre de chat prête sur le bureau, affichez le chat du site dans un WebView2, ou utilisez le JavaScript SDK dans Electron ou Tauri.
using Oryksa;
// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
var client = new OryksaClient(getToken: async ct => await MyBackend.FetchOryksaTokenAsync(ct));
var agent = await client.AgentAsync(); // name and photo of the AI
var reply = await client.SendAndWaitAsync("Are you open on Saturday?"); // one question, one answer
Console.WriteLine($"{agent.Name}: {reply.Text}");
Côté serveur (backend .NET) : gardez la clé API sur le serveur, créez des jetons de session pour vos applications, enseignez l’entreprise et vérifiez les webhooks.
using Oryksa;
var oryksa = new OryksaServer(Environment.GetEnvironmentVariable("ORYKSA_API_KEY")!);
var session = await oryksa.CreateSessionAsync(visitor: "user_42", lang: "pt"); // -> oryk_cs_...
await oryksa.SetPagesAsync(pages); // teaches the business (Knowledge API)
await oryksa.AddFaqAsync(question, answer);
var ok = OryksaWebhook.Verify(rawBody, signatureHeader, secret);
Éléments
| Élément | Ce qu'il fait |
|---|---|
OryksaClient: AgentAsync(), SendAndWaitAsync(text), MessagesAsync() | Détails de l’agent (nom, photo), envoi d’un message et attente de la réponse, historique des messages. |
OryksaServer: CreateSessionAsync(), SetPagesAsync(), AddFaqAsync() | Jetons de session, pages et FAQ pour le Brain. |
OryksaWebhook.Verify() | Vérification de la signature du webhook. |
getToken pour récupérer un jeton oryk_cs_... temporaire depuis votre backend ; le SDK le renouvelle à expiration. Créez les jetons avec l' API Sessions depuis n'importe quel langage serveur.
