PureText Open-ended (OE) check (V3)

Description

This API checks for the Open-Ended (OE) survey responses to ensure data quality. It performs language comparison, AI-generated answer detection, exclusion list checks, and response deduplication. Implement the API endpoint after every open-ended question into your survey.

PureText Deduplication: Ensures the OE response is unique through deduplication.

Language Mismatch: Compares the language of the OE response with the survey language determined from the transaction ID.

AI Detection: Detects patterns to flag if the OE response is AI-generated content.

Incoherent Response: Flags the obviously unacceptable responses such as gibberish, curse words, etc.

PureText can be effectively used:

For expected responses with at least one meaningful sentence (unlike categorical responses such as brand names, people and place names, etc)

Expected responses are in the same language as survey language (if the survey is in French, response should be only in French)

The API call can be made in two ways:

Individual response: after every open-ended question , or

Bulk processing: at the end of the survey for ALL open-ended responses

In either case, the API response shows you the result for each answer separately.

Up to 20 open-ended responses that can be processed in bulk at a time.

This endpoint is using the V3 version of the Buyers API.
Staging: https://staging.spectrumsurveys.com/buyers/v3/transactions
Production: https://api.spectrumsurveys.com/buyers/v3/transactions

Request

Authorization

Add parameter in header

access-token

Example:

access-token: ********************

Body Params application/json

Examples

1 OEMultiple OE's

{
    "transaction_id": "4mWpY50Z5ZpovKkXjt7Liw",
    "questions": [
        {
            "question_id": "Q1",
            "text": "OE text goes here, e.g. As an AI language model I don't have a personal opinion."
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

PHP

Python

Ruby

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

1 OEMultiple OE's

{
    "transaction_id": "4mWpY50Z5ZpovKkXjt7Liw",
    "data": [
        {
            "puretext_api_fail": 0,
            "ai_generated_response": 0,
            "incoherent_response": 0,
            "duplicate_response": 0,
            "language_mismatch": 0,
            "question_id": "Q1"
        }
    ]
}

🟠400Bad Request

🟠422Parameter Error

PureText Open-ended (OE) check (V3)

Description#

Request

Request Code Samples

Responses

Description