client.transcripts

list()

client.transcripts.list(
    study_id,
    *,
    completed: bool | None = None,
    include_simulated: bool | None = None,
    include_test_runs: bool | None = None,
    external_participant_id: str | None = None,
    limit: int | None = None,
    offset: int | None = None,
) -> TranscriptsBulkOut

Full transcripts in bulk, newest interview first, paginated by interview.

bool

Filter by completion status.

bool

default:"False"

Include simulated interviews.

bool

default:"False"

Include test runs.

str

Only interviews that arrived with this ID of yours.

int

default:"20"

Interviews per page.

int

Page offset.

Returns TranscriptsBulkOut. Use total_interviews to paginate.

search()

client.transcripts.search(study_id, *, q: str, mode=None, **filters) -> SearchOut

Search participant answers.

str

required

The search query.

str | SearchMode

default:"hybrid"

string (full-text and fuzzy), semantic (embedding similarity) or hybrid (rank fusion of both).

str

Restrict to one question: a question ID for linear studies, or the step ID for flow studies.

bool

Only completed interviews.

bool

Include simulated interviews.

bool

default:"False"

Include test runs.

str

Restrict to one person’s interviews, by your ID for them.

bool

In hybrid mode, fail with a 503 instead of quietly falling back to string search when semantic search is unavailable.

int

default:"20"

Maximum hits.

Returns SearchOut, with hits holding a list of SearchHit.

hits = client.transcripts.search(study.id, q="pricing is confusing", mode="semantic")
for hit in hits.hits:
    print(f"{hit.score:.2f}  {hit.participant_name}: {hit.content}")

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

list()

search()

​list()

​search()

list()

search()