Example Select Words Order

This example builds on what was introduced in the Quickstart as well as the Improve Quality guide.

Order description

Text-to-speech is becoming increasingly important in the world of AI. With the select words order, we can test how understandable the AI-generated speech is. We do that by asking the user to click on the words they hear in the audio. This can be done on a language basis, where we can target even uncommon languages and make sure the AI is pronouncing the words correctly.

'''
SelectWords order with validation set
'''

from rapidata import RapidataClient

def create_validation_set(rapi: RapidataClient):
    validation_set = rapi.validation.create_select_words_set(
        name="Example SelectWords Validation Set",
        instruction="Select the words you hear in the audio",
        datapoints=["https://assets.rapidata.ai/where_did_you__today.mp3"],
        sentences=["Where did you go today?"],
        truths=[[0, 1, 2, 4]],
        strict_grading=True
    )
    return validation_set

def new_select_words_order(rapi: RapidataClient, validation_set_id: str):
    order = rapi.order.create_select_words_order(
        name="Example SelectWords Order",
        instruction="Select the words you hear in the audio",
        datapoints=["https://assets.rapidata.ai/openai_tts_demo.mp3"],
        sentences=["Hello, welcome to OpenAI's Text-to-Speech demo!"],
        validation_set_id=validation_set_id,
        responses_per_datapoint=25,
        filters=[
            rapi.order.filters.language(["en"])
        ]
    ).run()

    return order

if __name__ == "__main__":
    rapi = RapidataClient()
    validation_set = create_validation_set(rapi) # only call this once
    validation_set = rapi.validation.find_validation_sets(name="Example SelectWords Validation Set")[0]
    order = new_select_words_order(rapi, validation_set.id)
    order.display_progress_bar()
    result = order.get_results()
    print(result)

The resulting rapids for the users look like this: