Detailed Documentation

You can find the full documentation here.

• QSTN
  • Prompt Generation
    • BaseModelPromptTemplate
      • BaseModelPromptTemplate.assistant_prefix
      • BaseModelPromptTemplate.separator
      • BaseModelPromptTemplate.system_prefix
      • BaseModelPromptTemplate.user_prefix
    • LLMPrompt
      • LLMPrompt.DEFAULT_JSON_STRUCTURE
      • LLMPrompt.DEFAULT_PROMPT_STRUCTURE
      • LLMPrompt.DEFAULT_QUESTIONNAIRE_ID
      • LLMPrompt.DEFAULT_SYSTEM_PROMPT
      • LLMPrompt.DEFAULT_TASK_INSTRUCTION
      • LLMPrompt.base_model_prompt_template
      • LLMPrompt.calculate_input_token_estimate()
      • LLMPrompt.duplicate()
      • LLMPrompt.generate_question_prompt()
      • LLMPrompt.get_prompt_for_questionnaire_type()
      • LLMPrompt.get_question()
      • LLMPrompt.get_question_item_id()
      • LLMPrompt.get_questions()
      • LLMPrompt.insert_questions()
      • LLMPrompt.load_questionnaire_format()
      • LLMPrompt.prepare_prompt()
      • LLMPrompt.prompt
      • LLMPrompt.questionnaire_name
      • LLMPrompt.questions
      • LLMPrompt.remove_question()
      • LLMPrompt.render_base_model_prompt()
      • LLMPrompt.replace_question()
      • LLMPrompt.set_base_model_prompt_template()
      • LLMPrompt.system_prompt
      • LLMPrompt.verbose
    • ResponseGenerationPreset
      • ResponseGenerationPreset.CHOICE
      • ResponseGenerationPreset.JSON_DISTRIBUTION
      • ResponseGenerationPreset.JSON_REASONING
      • ResponseGenerationPreset.JSON_SINGLE
      • ResponseGenerationPreset.LOGPROB
      • ResponseGenerationPreset.NONE
    • generate_likert_options()
    • messages_to_base_model_prompt()
  • Survey Manager
    • Usage example:
    • SurveyCreator
      • SurveyCreator.from_dataframe()
      • SurveyCreator.from_path()
    • conduct_survey_battery()
    • conduct_survey_sequential()
    • conduct_survey_single_item()
  • Subpackages
    • Inference & Guided Decoding
      • Dynamic Pydantic
      • Response Generation Methods
      • Inference
    • Parser
      • parse_json()
      • parse_json_battery()
      • parse_json_str()
      • parse_logprobs()
      • parse_with_llm()
      • parse_with_llm_battery()
      • raw_responses()
    • Utilities
      • Constants
      • Placeholder
      • Prompt Perturbation
      • Prompt Templates
      • Survey Objects
      • Util Functions