Reference

execute

Will execute a given natural language instruction. Please refer to our Prompt Guide for best practices.

// simple instructions
gd.execute("tap on the login button")

// more abstract instructions
gd.execute("Navigate to the settings screen")

// complex instructions
gd.execute("Check that you see a list of hotel room options, if so tap on the cheapest room option")

// with cachingMode specified for this particular step
// cachingMode options: "FULL_SCREEN", "INTERACTION_REGION", "NONE"
gd.execute("Navigate to the Main screen", cachingMode = "FULL_SCREEN")

// with native composeHandler - if provided, composeHandler code will be executed first
// GptDriver will perform an AI fallback if the code fails
gd.execute("Navigate to home screen") { rule ->
    rule.onNodeWithText("Go to Home screen").performClick()
}

assert

Verify something without taking any action. The function will pass or throw an error

// simple assertion
gd.assert("The total price is $price");

// with specified retry parameters
// default values are: maxRetries = 2, retryDelayMs = 1000
gd.assert("Player screen is displayed", maxRetries = 5, retryDelayMs = 2000)

// with native composeHandler - if provided, composeHandler code will be executed first
// GptDriver will perform an AI fallback if the code fails
gd.assert("Profile screen is displayed") {
    it.onNodeWithText("Edit Your Profile").assertExists()
}

assertBulk

Check multiple conditions are met in one go. The function will throw an error if any of the assertions is not true.

// simple instructions
gd.assertBulk(listOf(
    "The total price is $price",
    "The VAT is calculated correctly",
    "The delivery date is shown in the format dd.mm.YYYY"
));

// with specified retry parameters
// default values are: maxRetries = 2, retryDelayMs = 1000
gd.assertBulk(
    listOf("Settings button is visible", "Go to Profile button is visible",),
    maxRetries = 5,
    retryDelayMs = 2000
)

// with native composeHandler - if provided, composeHandler code will be executed first
// GptDriver will perform an AI fallback if the code fails
gd.assert("Profile screen is displayed") {
    it.onNodeWithText("Edit Your Profile").assertExists()
}

checkBulk

Check multiple conditions are met in one go. The function will return a object with true and false values for each conditions.

val assertResults = gd.checkBulk(listOf(
    "The total price is $price",
    "The VAT is calculated correctly",
    "The delivery date is shown in the format dd.mm.YYYY"
));

// with retry parameters specified
// default values are: maxRetries = 2, retryDelayMs = 1000
val assertResults = gd.checkBulk(
    listOf("Settings button is visible", "Go to Profile button is visible",),
    maxRetries = 5,
    retryDelayMs = 2000
)

extract

Extract information from current screen. Returns an object with the extracted values.

// example to extract flight informationn from a screen
val flightInformation = gd.extract(listOf(
    "departureAirportCode",
    "destinationAirportCode",
    "departureTime",
    "destinationTime",
    "travelTime"
));

// Using the extracted information in assertions
gd.assertBulk(listOf(
    "departure airport is " + flightInformation.get("departureAirportCode"),
    "destination airport is " + flightInformation.get("destinationAirportCode")
));