ultron-ai-sdk 1.0.0

package/README.md

@@ -0,0 +1,226 @@
+
+
+```markdown
+# Ultron AI SDK
+
+```
+
+## Installation
+
+```bash
+npm install ultron-ai-sdk
+
+```
+
+## Quick Start
+
+```javascript
+// Import the SDK
+import {SceneCanvas, Character} from './dist/index.mjs';
+        
+        let devices  = await navigator.mediaDevices.enumerateDevices();
+        console.log(devices)
+        let sceneCanvas
+        let character
+        
+        const init = async() => {
+            sceneCanvas = new SceneCanvas('target-html-element')
+            const initializationSetting= {
+                avatarId: "AVATAR_ID/REQUEST_ID",
+                config:{
+                    accessToken : "ACCESS_TOKEN",
+                    refreshToken : "REFRESH_TOKEN",
+                    // sessionId : "426536db-25a4-4682-9bb4-4e93530f84a0",
+                    apiKey: "YOUR_ULTRON_API_KEY"
+                },
+                options:{
+                    alwaysListen: false // For Push to talk conversation
+                }
+            }
+            await sceneCanvas.init(initializationSetting)
+            character = sceneCanvas.character
+                      
+        }
+        init()
+
+```
+
+---
+
+## Target HTML Element
+
+```html
+
+<div id="target-html-element"></div>
+
+```
+
+## API Reference
+
+### Initialization
+
+```javascript
+const sceneCanvas = new SceneCanvas('target-html-element')
+
+ultronSDK.init(config)
+```
+
+---
+
+### Configuration Options
+
+| Option      | Description |
+|-------------|--------------|
+| `accessToken` | Token recieved on successfull authentication |
+| `refreshToken` |Token recieved on successfull refreshing of existing access token |
+| `sessionId` (optional) | Session Id obtained using API key |
+| `apiKey` | You ultron key which can be found in your profile in Ultron App |
+
+---
+
+## Core Methods
+
+### loadAvatar(avatarId)
+
+Loads a specific avatar into the container.
+
+- `avatarId`: **String** - The unique identifier for the avatar
+
+---
+
+
+## Audio Input Device Settings
+
+```javascript
+
+// to get all microphone input devices
+const devices = ultronSDK.getAudioInputDevices()
+
+// You can also use the devices to allow user to choose from the list
+
+let myDevice = devices.find(device=> device.label.includes("My_preffered_device_name"))
+
+// to set the desired Audio input device
+if(myDevice)
+ultronSDK.setAudioInputDevice(myDevice.deviceId)
+
+
+```
+
+
+
+
+## Browser Support
+
+✅ Chrome (latest)  
+✅ Firefox (latest)  
+✅ Safari (latest)  
+✅ Edge (latest)
+
+---
+
+## Requirements
+
+- WebGL-enabled browser
+- JavaScript enabled
+- Minimum screen resolution: 800x600
+
+---
+
+## Best Practices
+
+- Always initialize the SDK with a valid API key
+- Implement error handling for load failures
+- Clean up resources when removing the avatar
+- Optimize container size for better performance
+- Test across different browsers and devices
+
+---
+
+## Examples
+
+### Basic Implementation
+
+```javascript
+import CharacterCompanionSDK from './dist/index.mjs';
+
+init=()=>{
+    let sdk = new CharacterCompanionSDK('ultron-model')
+    ultronSDK.init({
+        accessToken : 'YOUR_ACCESS_TOKEN',
+        refreshToken : 'YOUR_REFRESH_TOKEN',
+        sessionId : "SESSIOON_ID", // If you have backend or it will create session from apiKey
+        apiKey: "YOUR_ULTRON_API_KEY"
+    })            
+    const avatarId = 'AVATAR_ID/REQUEST_ID'            
+    await ultronSDK.loadAvatarById(avatarId)
+    ultronSDK.initAudioListener()
+
+    // Load an avatar
+    await ultron.loadAvatar('avatar-id');
+}
+
+init()
+```
+
+---
+
+### Chat with character using AI
+
+```javascript
+ultronSDK.chat("your text query to AI")
+
+//This will generate a response from AI as per Avatar backstory and character will speak the response
+
+
+```
+
+### Make the character say
+
+```javascript
+ultronSDK.say("your text that character will speak")
+
+// This will simply make the character speak the text you provide
+
+```
+
+### Switch camera
+
+```javascript
+//Switch camera to potrait (closer to face)
+
+ultronSDK.switchCameraToPotrait()
+
+//Switch camera to normal position (full body view)
+
+ultronSDK.switchCameraToNormal()
+
+
+
+```
+
+### Support
+
+For technical support or questions, please contact our support team or visit our documentation portal.
+
+### License
+
+This SDK is provided under the terms of our software license agreement.
+
+
+
+This README.md provides comprehensive documentation for your Ultron AI SDK. You can save this content directly to your project's README.md file. The documentation includes:
+
+1. Basic introduction
+2. Feature list
+3. Installation instructions
+4. Quick start guide
+5. Detailed API reference
+6. Usage examples
+7. Browser support
+8. Requirements
+9. Best practices
+10. Support information
+11. License information
+
+Would you like me to modify any section or add more specific details about certain features?