Skip to content

Commit

Permalink
Modified 4 files
Browse files Browse the repository at this point in the history
  • Loading branch information
alwyn-ixo committed Dec 13, 2024
1 parent dd1a5db commit f62255e
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 9 deletions.
1 change: 0 additions & 1 deletion API-Reference-Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 0 additions & 7 deletions SDKs/AI-Companion-SDK.md

This file was deleted.

60 changes: 60 additions & 0 deletions SDKs/Oracle-AI-SDK.md
Original file line number Diff line number Diff line change
@@ -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 `<div>`, `<button>`, and `<input>`.
- **Mobile Compatibility**: Integrate seamlessly with React Native/Expo components such as `<View>`, `<Text>`, and `<TextInput>`.

### 4. Real-Time Messaging Support

Through hooks like `useListMessages`, the SDK enables applications to:

- Fetch, maintain, and update message lists in real-time.
- Handle WebSocket connections for live updates.
- Dynamically resolve and display AI-generated messages as either text or React components.

## Use Cases

The **IXO Oracles UI SDK** is versatile and can be used in a variety of applications:

- **AI-Powered Chat Interfaces**: Build interactive chat UIs with real-time AI-driven responses.
- **Dynamic Content Rendering**: Create dynamic, data-driven UI components that respond to AI commands.
- **Custom AI Tools**: Develop AI-assisted tools and workflows tailored to specific user needs.

## Additional Resources

For detailed documentation, code examples, and implementation guides, visit the GitHub repository:

- **GitHub Repository**: [IXO Oracles UI SDK GitHub](https://github.com/ixoworld/ixo-ai-oracles)

<!-- theme: info -->
> This repository is private. [Reach out to us](https://linktr.ee/ixo_world) to be added as a contributor.
The **IXO Oracles UI SDK** enables developers to create immersive, AI-driven applications that combine the power of conversational AI with dynamic and responsive user interfaces.

2 changes: 1 addition & 1 deletion SDKs/SDKs-Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The IXO SDK overview includes the following components:
- [**IXO Spatial Web Multiclient SDK**](IXO-Spatial-Web-Multiclient-SDK.md): The core SDK for interacting with the IXO blockchain, providing access to key functionalities such as transaction management and blockchain queries.
- [**SignX SDK**](SignX-SDK.md): A cryptographic signature tool that simplifies the process of signing multiple blockchain transactions.
- [**Matrix Client SDK**](Matrix-Client-SDK.md): Enables seamless interaction with Matrix, IXO’s encrypted messaging and data storage infrastructure.
- [**AI Companion SDK**](AI-Companion-SDK.md): Leverages AI capabilities to enhance the development of decentralised applications by providing intelligent insights and automation.
- [**Oracle AI SDK**](Oracle-AI-SDK.md): Leverages AI capabilities to enhance the development of decentralised applications by providing intelligent insights and automation.
- [**JAMBO Wallet SDK**](JAMBO-Wallet-SDK.md): Provides integration capabilities for the Jambo wallet, allowing developers to easily build digital wallet functionalities into their applications.
- [**DID Provider SDK**](DID-Provider-SDK.md): Manages decentralised identifiers (DIDs), enabling secure and verifiable digital identities for users.

Expand Down

0 comments on commit f62255e

Please sign in to comment.