config.yaml

# moral-kg-workshop config
#
# NOTE: See moral-kg-workshop-listener config for updates!

# File Paths Configuration
paths:
  users_csv: "users/users_testing.csv"
  users_info: "users/users_info.json"  # Filepath for logging user info. Does not log if set to null
  oauth_config: ".oauth.yaml"

# HuggingFace Dataset Configuration
datasets:
  sample: "RIET-lab/moral-kg-sample"
  labels: "RIET-lab/moral-kg-sample-labels"
  maps: "RIET-lab/moral-kg-sample-maps"

# Argilla Webhook Events to Monitor
webhooks:
  events:
    - "dataset.published"
    - "response.created"
    - "response.updated"
    - "response.deleted"

# Argilla Phase 1 Dataset Configuration
phase1:
  dataset_name: "Phase 1"
  guidelines: |
    MERe Workshop annotation process - Phase 1:
    
    [TODO - Overall description here]
    
    Instructions:
    [TODO]
    
    [TODO - Notes]

    If you encounter any issues, please message the workshop organizers.
  
  # Field configurations
  fields:
    title_info:
      name: "title_info"
      title: "Current Paper"
      use_markdown: true
    
    text:
      name: "text"
      title: "Paper Text"
      use_markdown: true
  
  # Metadata configurations
  metadata:
    # Paper identifier
    id:
      name: "id"
      title: "Paper ID"
      visible_for_annotators: true

    # List of paper categories
    categories:
      name: "fields"
      title: "Paper Fields"
      visible_for_annotators: true
  
  # Questions configurations
  questions:
    claims:
      type: "TextQuestion"
      name: "claims"
      title: "TODO - FINALIZE QUESTION: List the claims/premises which best represent the argument proposed in this paper."
      description: "TODO - FINALIZE DESCRIPTION: List the claims/premises which best represent the argument proposed in this paper."
      required: true
      use_markdown: true

    comments:
      type: "TextQuestion"
      name: "comments"
      title: "(Optional) Comment on this step and your selected claims."
      description: "An optional space to provide any comments you wish to make about this response."
      required: false
      use_markdown: true

# Logging Configuration
logging:
  level: "INFO"
  format: "[%(asctime)s] [%(name)s] [%(levelname)s] - %(message)s"
  
# Error Handling Configuration  
error_handling:
  log_data_not_slack: true # set false in prod - equates to sending logs anywhere 
                            # but the slack channel (i.e. printing them in the 
                            # space console)
  slack_notifications: true
  force_slack_notifications: false # overrides script parameters to send logs to 
                                  # slack, sending everything to the slack.

# Users Configuration
users:
  default_role: "annotator"
  create_workspaces: true # must be true for valid annotation pipeline setup
                          # just here for testing purposes.