Voxco · Example Payload

Post Aicoder_Analyze Request

Survey SoftwareMarket ResearchCATIOmnichannelText AnalyticsData CollectionPanel Management

Post Aicoder_Analyze Request is an example object payload from Voxco, with 12 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

questionKeysexistingCodebookKeyexistingCodebookSuggestNewCodesexistingCodebookOptionscodebookgenerativeAIOptionsnonGenerativeAIOptionsuseGenerativeAIwordsToIgnoreincludeCodedResponsesuseEnhancedThemeExtractorenhancedThemeExtractor

Example Payload

Raw ↑ 
{
  "questionKeys": [
    100,
    101,
    102,
    103
  ],
  "existingCodebookKey": -1,
  "existingCodebookSuggestNewCodes": false,
  "existingCodebookOptions": null,
  "codebook": {
    "initial": {
      "minProximity": 75,
      "minSegmentsPerCode": 3,
      "approxMaxCodes": 100
    },
    "mergeSimilar": {
      "enabled": true,
      "minProximity": 85
    },
    "assignSegmentSiblings": {
      "enabled": true,
      "minProximity": 75,
      "minSiblings": 3
    },
    "assignTopSegments": {
      "enabled": true,
      "minProximity": 75,
      "topSegments": 10
    }
  },
  "generativeAIOptions": {
    "dataIsAbout": null,
    "codebookLanguage": "en"
  },
  "nonGenerativeAIOptions": {
    "splitCharacters": ".!?|",
    "splitWords": [
      "but",
      "however",
      "nevertheless",
      "nonetheless",
      "yet",
      "thus",
      "also",
      "additionally",
      "nor",
      "and"
    ],
    "responsesAreAllEnglish": true
  },
  "useGenerativeAI": false,
  "wordsToIgnore": [
    "some",
    "words",
    "to",
    "ignore"
  ],
  "includeCodedResponses": false,
  "useEnhancedThemeExtractor": false,
  "enhancedThemeExtractor": {
    "maxNumberOfNets": 10,
    "maxNumberOfCodes": 100,
    "codebookBuilderPrompt": null,
    "analyzeByClosedEnd": null,
    "codebookGranularity": null
  }
}