bayesline.api.equity.ReportAccessorSettings

pydantic model bayesline.api.equity.ReportAccessorSettings

Show JSON schema

{
   "title": "ReportAccessorSettings",
   "type": "object",
   "properties": {
      "axes": {
         "additionalProperties": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "title": "Axes",
         "type": "object"
      },
      "metric_cols": {
         "items": {
            "type": "string"
         },
         "title": "Metric Cols",
         "type": "array"
      },
      "pivot_cols": {
         "items": {
            "type": "string"
         },
         "title": "Pivot Cols",
         "type": "array"
      },
      "extra_paths": {
         "items": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "title": "Extra Paths",
         "type": "array"
      },
      "extra_cols": {
         "items": {
            "type": "string"
         },
         "title": "Extra Cols",
         "type": "array"
      },
      "linked_reports": {
         "items": {
            "type": "integer"
         },
         "title": "Linked Reports",
         "type": "array"
      },
      "tags": {
         "items": {
            "type": "string"
         },
         "title": "Tags",
         "type": "array"
      }
   },
   "additionalProperties": false,
   "required": [
      "axes",
      "metric_cols",
      "pivot_cols"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• axes (dict[str, list[str]])

• extra_cols (list[str])

• extra_paths (list[list[str]])

• linked_reports (list[int])

• metric_cols (list[str])

• pivot_cols (list[str])

• tags (list[str])

field axes: dict[str, list[str]] [Required]

field metric_cols: list[str] [Required]

field pivot_cols: list[str] [Required]

field extra_paths: list[list[str]] [Optional]

field extra_cols: list[str] [Optional]

field linked_reports: list[int] [Optional]

field tags: list[str] [Optional]