OpenAI’s ChatGPT is an synthetic intelligence (AI) chatbot that may generate human-like responses primarily based on textual content enter utilizing the Generative Pre-trained Transformer (GPT) massive language mannequin. OpenAI launched ChatGPT in December 2022, and in two months, it garnered over 100 million month-to-month lively customers, making it the fastest-growing client utility in historical past. Many individuals use ChatGPT for interactive schooling, mock interviews, language translation, automated customer support and extra.
ChatGPT is on the market as an utility programming interface (API) service, which suggests you may combine it into your Android utility. With ChatGPT, you may create an Android utility to right your typing grammar, as an example.
On this tutorial, you’ll discover ways to construct Chatty Bot, a ChatGPT-based chatbot Android utility. Within the utility, you may select a persona on your chatbot, reminiscent of a journey information.
Throughout the course of, you’ll study to:
- Design chat messages.
- Create typing animation.
- Combine the ChatGPT OpenAI API service.
- Perceive the parameters of the API name.
Be aware: This text assumes you’ve got earlier expertise with Kotlin and Jetpack Compose in Android. To know Kotlin, bounce into this Introduction to Kotlin for Android tutorial and the e-book Kotlin Apprentice. For studying Android growth, take a look at the e-book Android Apprentice. Lastly, to know Jetpack Compose, you can begin with Jetpack Compose by Tutorials.
And with that, it’s time to speak it up!
Getting Began
Obtain the starter undertaking by clicking the Obtain Supplies button on the high or backside of the tutorial. Open Android Studio Electrical Eel or import and open the starter undertaking later.
Browse the undertaking’s recordsdata to familiarize your self with the codebase. There are two principal folders below the com.kodeco.android.chattybot folder: the ui folder and the mannequin folder.
Six recordsdata are below the ui folder. The Settings.kt file is the Settings display, a kind for coming into the OpenAI API key. The TabScreen.kt file is a container for the chatting display, and the PersonaScreen.kt file permits customers to decide on the ChatGPT persona, reminiscent of a journey information. You’ll create the person interface (UI) for the chat message packing containers within the AIMessage.kt, UserMessage.kt and ChattingScreen.kt recordsdata.
The mannequin listing accommodates a number of recordsdata. The primary file, Persona.kt, shops the persona textual content for PersonaScreen.kt. Constants.kt shops undertaking constants. ChatModel.kt accommodates the info fashions for exchanging messages between the OpenAI API server with the Retrofit library. OpenAIService.kt is the interface for calling the OpenAI API server, and ChatRetriever.kt receives messages for ChattingScreen.kt and connects to the server utilizing the Retrofit library.
Opening the Starter Mission
Construct and run the starter undertaking. You’ll see the next display:
The app shows three tabs: Chat, Persona and Settings. The Chat tab is chosen by default. This tab display has a textual content subject with a button on the backside , like a chat window. On this tab, you’ll show message packing containers from the person and reply packing containers from the API service.
Click on the Persona tab. You’ll see 4 persona decisions. Personas are methods of characterizing the chatbot’s responses: A journey information presents the responses otherwise than, say, a motivational coach. If you happen to click on one in all them, the field border turns cyan to point that that is your chatbot persona:
Do you see the “Journey Information in Tokyo” persona? This feels like an journey ready to occur! :-]
The final tab is the Settings tab, the place you may enter your OpenAI key:
Making a Chat Messages Listing
Add some messages to the chat display to simulate a chatbot. Right here, you’ll create a UI resembling common chat purposes like WhatsApp, Telegram or Fb Messenger. A chatting window UI usually consists of an inventory of messages, a textual content subject for typing messages and a button to ship messages. The textual content subject and button have already been created. You’ll discover the container for the listing of chat messages within the ChattingScreen.kt file. Search for the road // TODO: Create dialog packing containers, which is inside an empty Field.
For every person message, create a Field that doesn’t take up the complete horizontal house and is aligned to the precise facet of the container. Then, add a Textual content contained in the Field. The Textual content will show the message the person varieties to ChatGPT. To point that this message comes from a person, add an icon on the precise facet of the message.
Add the next code beneath the road // TODO: Create dialog packing containers:
val content material = "Howdy, AI!"
Row(
modifier = Modifier.fillMaxWidth(),
horizontalArrangement = Association.Finish,
verticalAlignment = Alignment.Backside
) {
Field(
modifier = Modifier
.padding(16.dp)
.fillMaxWidth(0.8f)
.heightIn(120.dp)
.background(Shade.LightGray, RoundedCornerShape(16.dp))
) {
Textual content(
textual content = content material,
modifier = Modifier
.align(Alignment.Middle)
.padding(8.dp)
)
}
Icon(
imageVector = Icons.Default.Individual,
contentDescription = "Person Icon"
)
}
Construct and run the undertaking, and it’s best to see the next display:
It seems to be good! The chat message field is appropriately proper aligned. The Row takes up the total width, and the Field takes up solely 80 % of the width, as indicated by the .fillMaxWidth(0.8f) modifier. The one situation is that the chat message field is on the high, moderately than the underside, near the typing TextField. If you happen to’ve used a chat utility, you’re aware of message packing containers popping up from the underside, however you’ll cowl that later.
Displaying the Chat Response
For now, you’ll need to refactor the code. Delete the code, and transfer it to the UserMessage.kt file. Open the UserMessage.kt file and add the next code beneath the road // TODO: Create the person dialog field:
Row(
modifier = Modifier.fillMaxWidth(),
horizontalArrangement = Association.Finish,
verticalAlignment = Alignment.Backside
) {
Field(
modifier = Modifier
.padding(16.dp)
.fillMaxWidth(0.8f)
.heightIn(120.dp)
.background(Shade.LightGray, RoundedCornerShape(16.dp))
) {
Textual content(
textual content = content material,
modifier = Modifier
.align(Alignment.Middle)
.padding(8.dp)
)
}
Icon(
imageVector = Icons.Default.Individual,
contentDescription = "Person Icon"
)
}
Then, within the ChattingScreen.kt file, beneath the road // TODO: Create dialog packing containers, add the next code:
UserMessage("Howdy, AI!")
If you happen to construct and run the undertaking once more, you see the identical display. Now, you need to add a chat message from ChatGPT. This chat message field ought to be aligned to the left of the chatting container. Make sure the field shade is completely different so customers can differentiate the messages extra simply. Don’t neglect so as to add an Icon on the left of the message.
Open the AIMessage.kt file and add the next code beneath the road // TODO: Create the AI dialog field:
Row(
modifier = Modifier.fillMaxWidth(),
horizontalArrangement = Association.Begin,
verticalAlignment = Alignment.Backside
) {
Icon(
imageVector = Icons.Default.Face,
contentDescription = "AI Icon"
)
Field(
modifier = Modifier
.padding(16.dp)
.fillMaxWidth(0.8f)
.heightIn(120.dp)
.background(Shade.DarkGray, RoundedCornerShape(16.dp))
) {
Textual content(
textual content = content material,
modifier = Modifier
.align(Alignment.Middle)
.padding(8.dp),
shade = Shade.White
)
}
}