Voxco · Schema

AICoderCodeStudyV3Request

Parameters for study analysis using Codebook Builder via `POST /AICoder/Analyze/v3`.

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Properties

Name Type Description
questionKeys array Set of questions to analyze
codebookBuilder object
includeCodedResponses boolean Should coded responses be included into analysis
wordsToIgnore array Set of words to ignore during analysis
generativeAIOptions object
nonGenerativeAIOptions object
useGenerativeAI boolean Use or not generative AI for analysis
View JSON Schema on GitHub

JSON Schema

AICoderCodeStudyV3Request.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AICoderCodeStudyV3Request",
  "required": [
    "questionKeys"
  ],
  "type": "object",
  "properties": {
    "questionKeys": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Set of questions to analyze",
      "nullable": true
    },
    "codebookBuilder": {
      "$ref": "#/components/schemas/CodebookBuilderV3Options"
    },
    "includeCodedResponses": {
      "type": "boolean",
      "description": "Should coded responses be included into analysis"
    },
    "wordsToIgnore": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Set of words to ignore during analysis",
      "nullable": true
    },
    "generativeAIOptions": {
      "$ref": "#/components/schemas/GenerativeAIOptions"
    },
    "nonGenerativeAIOptions": {
      "$ref": "#/components/schemas/NonGenerativeAIOptions"
    },
    "useGenerativeAI": {
      "type": "boolean",
      "description": "Use or not generative AI for analysis"
    }
  },
  "additionalProperties": false,
  "description": "Parameters for study analysis using Codebook Builder via `POST /AICoder/Analyze/v3`."
}