Skip to content

Rapidata developer documentation#

Developer Quickstart#

Set up your environment and make your first API request in minutes.

  • Developer Quickstart


    The user is given mutliple answer options for the given question and image.

    Estimated time: 5 minutes

    pip install -U rapidata
    
    from rapidata import RapidataClient
    
    rapi = RapidataClient()
    
    order = rapi.order.create_classification_order(
        name="Example Classification Order",
        instruction="What is shown in the image?",
        answer_options=["Fish", "Cat", "Wallaby", "Airplane"],
        datapoints=["https://assets.rapidata.ai/wallaby.jpg"]
    ).run()
    
    order.display_progress_bar()
    
    results = order.get_results()
    print(results)
    

    Let's go

  • Classify Order


    The user is given mutliple answer options for the given question and image.

    Classify Example

    Let's go

  • Compare Order


    The user chooses between two images/videos/texts based on a criteria.

    Compare Example

    Let's go

  • Free Text Order


    The user has a keyboard pop up to freely answer anything.

    Freetext Example

    Let's go

  • SelectWords Order


    Have the users click on words in a text depending on a condition.

    SelectWords Example

    Let's go

  • Preference Data for RLHF


    Longer, more detailed blog post on how to use a compare-style setup to collect human preference data, e.g. for Reinforcement Learning from Human Feedback (RLHF).

    Preference Example

    Let's go