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_compare_order(
    name="Example Alignment Order",
    instruction="Which image matches the description better?",
    contexts=["A small blue book sitting on a large red book."],
    datapoints=[["https://assets.rapidata.ai/midjourney-5.2_37_3.jpg", 
                "https://assets.rapidata.ai/flux-1-pro_37_0.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