From f62255e5cd356565ff942bf0dbdd8a32523fb8c6 Mon Sep 17 00:00:00 2001 From: Alwyn van Wyk Date: Fri, 13 Dec 2024 13:50:35 +0200 Subject: [PATCH] Modified 4 files --- API-Reference-Overview.md | 1 - SDKs/AI-Companion-SDK.md | 7 ----- SDKs/Oracle-AI-SDK.md | 60 +++++++++++++++++++++++++++++++++++++++ SDKs/SDKs-Overview.md | 2 +- 4 files changed, 61 insertions(+), 9 deletions(-) delete mode 100644 SDKs/AI-Companion-SDK.md create mode 100644 SDKs/Oracle-AI-SDK.md diff --git a/API-Reference-Overview.md b/API-Reference-Overview.md index 985b819..5a81927 100644 --- a/API-Reference-Overview.md +++ b/API-Reference-Overview.md @@ -11,7 +11,6 @@ The IXO Spatial Web API is comprehensive and spans multiple domains, providing v - [**IXO Protocol Blockchain gRPC Gateway API**](gRPC-Gateway/gRPC-Gateway-Overview.md): Provides a gRPC REST interface for direct blockchain queries. - [**IXO Blocksync GraphQL API**](Blocksync-GraphQL-API/Blocksync-GraphQL-API-Overview.md): Provides a GraphQL interface for efficient and flexible querying of indexed blockchain data. - [**IXO Matrix State Bot API**](Matrix-REST-API/Matrix-REST-API-Overview.md): An interface to the private and secure data vaults stored in Matrix. -- [**AI Companion REST API**](AI-Companion-REST-API/AI-Companion-REST-API-Overview.md): Offers artificial intelligence features and services to enhance the user experience. Each system contributes a specific part of the overall API, allowing users to leverage their functionalities to build and interact with impactful applications. diff --git a/SDKs/AI-Companion-SDK.md b/SDKs/AI-Companion-SDK.md deleted file mode 100644 index f009a1f..0000000 --- a/SDKs/AI-Companion-SDK.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -stoplight-id: 1yx5ws0ns7kyn ---- - -# AI Companion SDK - -The beginning of an awesome article... diff --git a/SDKs/Oracle-AI-SDK.md b/SDKs/Oracle-AI-SDK.md new file mode 100644 index 0000000..573aa58 --- /dev/null +++ b/SDKs/Oracle-AI-SDK.md @@ -0,0 +1,60 @@ +--- +stoplight-id: 1yx5ws0ns7kyn +--- + +# IXO Oracles UI SDK + +The **IXO Oracles UI SDK** is a comprehensive toolkit designed to seamlessly integrate conversational AI capabilities, such as Guru AI, into web and mobile applications. By providing React hooks and utilities, this SDK empowers developers to manage AI interactions dynamically while maintaining a rich and interactive user experience. + +## Key Features + +### 1. Conversational AI Integration + +The SDK enables applications to interface with conversational AI models, offering features like real-time message streaming and dynamic responses. Developers can: + +- Create and manage multiple AI chat sessions. +- Send and receive AI-generated responses in real-time. +- Seamlessly switch between active AI sessions. + +### 2. Dynamic UI Components + +One of the standout features of the **IXO Oracles UI SDK** is its ability to dynamically render custom UI components based on AI output. These components, such as cards or forms, are dynamically resolved and displayed in response to specific AI events. + +- **Tool Call Integration**: Automatically map AI-generated events to React components. +- **Custom Components**: Easily register and render application-specific components. +- **Loading States**: Indicate progress or waiting states dynamically while the AI processes requests. + +### 3. Platform Versatility + +The SDK is platform-agnostic, supporting both React DOM for web and React Native for mobile applications. This ensures a consistent development experience across environments. + +- **Web Compatibility**: Use standard web components like `
`, `