Voxco · Schema

AICoderCodeStudyRequest

Contains parameters for study analyzing task

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Properties

Name	Type	Description
codebook	object
generativeAIOptions	object
nonGenerativeAIOptions	object
useGenerativeAI	boolean	Use or not generative AI for analysis
wordsToIgnore	array	Set of words to ignore
includeCodedResponses	boolean	Should coded responses be included into analysis
useEnhancedThemeExtractor	boolean	Enable/disable using of enhanced theme extractor. When the enhancedThemeExtractor is used, then the codebook options are ignored.
enhancedThemeExtractor	object
questionKeys	array	Set of questions to analyze
existingCodebookKey	integer	Key of existing codebook. By default it creates a new codebook.
existingCodebookSuggestNewCodes	boolean	Should suggest new codes for existing codebook? It is false by default.
existingCodebookOptions	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AICoderCodeStudyRequest",
  "required": [
    "questionKeys"
  ],
  "type": "object",
  "properties": {
    "codebook": {
      "$ref": "#/components/schemas/CodebookAIOptions"
    },
    "generativeAIOptions": {
      "$ref": "#/components/schemas/GenerativeAIOptions"
    },
    "nonGenerativeAIOptions": {
      "$ref": "#/components/schemas/NonGenerativeAIOptions"
    },
    "useGenerativeAI": {
      "type": "boolean",
      "description": "Use or not generative AI for analysis"
    },
    "wordsToIgnore": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Set of words to ignore",
      "nullable": true
    },
    "includeCodedResponses": {
      "type": "boolean",
      "description": "Should coded responses be included into analysis"
    },
    "useEnhancedThemeExtractor": {
      "type": "boolean",
      "description": "Enable/disable using of enhanced theme extractor.\r\nWhen the enhancedThemeExtractor is used, then the codebook options are ignored."
    },
    "enhancedThemeExtractor": {
      "$ref": "#/components/schemas/EnhancedThemeExtractorOptions"
    },
    "questionKeys": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Set of questions to analyze",
      "nullable": true
    },
    "existingCodebookKey": {
      "type": "integer",
      "description": "Key of existing codebook. By default it creates a new codebook.",
      "format": "int32"
    },
    "existingCodebookSuggestNewCodes": {
      "type": "boolean",
      "description": "Should suggest new codes for existing codebook? It is false by default."
    },
    "existingCodebookOptions": {
      "$ref": "#/components/schemas/ExistingCodebookOptions"
    }
  },
  "additionalProperties": false,
  "description": "Contains parameters for study analyzing task"
}