aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/ProfilingConfig.md
blob: 22c2038e5f0959b5099454cb4effc3f1558e2670 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# ProfilingConfig


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **boolean** | If False, the harmonizer/profiling system is not used at all. This should never be False unless special circumstances | [optional] [default to true]
**grs_enabled** | **boolean** | If grs_enabled is False, and is_grs is passed in the          profiling-questions call, then don\'t actually return any questions.          This allows a client to hit the endpoint with no limit and still get          questions. In effect, this means that we\'ll redirect the user through          the GRS system but won\'t present them any questions. | [optional] [default to true]
**n_questions** | **number** |  | [optional] [default to undefined]
**max_questions** | **number** | The max number of questions we would ask in a session | [optional] [default to 10]
**avg_question_count** | **number** | The average number of questions to ask in a session | [optional] [default to 5]
**task_injection_freq_mult** | **number** | Scale how frequently we inject profiling questions,          relative to the default. 1 is default, 2 is twice as often. 10 means          always. 0.5 half as often | [optional] [default to 1]
**non_us_mult** | **number** | Non-us multiplier, used to increase freq and length of          profilers in all non-us countries. This value is multiplied by          task_injection_freq_mult and avg_question_count. | [optional] [default to 2]
**hidden_questions_expiration_hours** | **number** | How frequently we should refresh hidden questions | [optional] [default to 168]

## Example

```typescript
import { ProfilingConfig } from './api';

const instance: ProfilingConfig = {
    enabled,
    grs_enabled,
    n_questions,
    max_questions,
    avg_question_count,
    task_injection_freq_mult,
    non_us_mult,
    hidden_questions_expiration_hours,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)