koah-react-native
v0.1.3
Published
React Native SDK to start monetizing your LLM applications with Koah
Downloads
99
Readme
Prerequisites
Before you begin, make sure you have:
- React Native >= 0.60.0
- A publisher ID from app.koah.ai
Installation
Expo Apps
npx expo install koah-react-native expo-file-system expo-application expo-device
React Native Apps
yarn add koah-react-native @react-native-async-storage/async-storage react-native-device-info
# or
npm i -s koah-react-native @react-native-async-storage/async-storage react-native-device-info
React Native Web and macOS
If you are using React Native Web or React Native macOS, do not use the expo-file-system package since the Web and macOS targets aren't supported. Instead, use the @react-native-async-storage/async-storage package instead.
Configuration
KoahProvider
The recommended way to initialize the SDK is to wrap your parent component with the KoahProvider
component. This utilizes the Context API to pass the Koah
client around.
To set up KoahProvider
, add it to your App.tsx
or App.js
file:
import { useKoah, KoahProvider } from "koah-react-native";
export default function App() {
return (
<KoahProvider publisherId="YOUR_PUBLISHER_ID" outputFormat="markdown">
<YourApp />
</KoahProvider>
);
}
Then you can access the Koah
client anywhere in your app using the useKoah
hook:
const koah = useKoah();
const responseWithAds = await koah.process({
question: "<USER_INPUT>",
response: "<LLM_RESPONSE>",
adFormat: "suffix",
});
setResponse(responseWithAds);
Demo Application
There are 2 demo applications available in this repository: one for Expo and one for React Native applications. Each demo application provides a comprehensive example of how to integrate and use the KOAH React Native SDK in different environments.
For more details on how to set up and run these demo applications, please refer to their respective README files:
Getting a Publisher ID
To use the Koah LLM Ad Network SDK, you'll need a publisher ID. Visit app.koah.ai to create an account and obtain your publisher ID.
License
This project is licensed under the Apache 2.0 - see the LICENSE file for details.