@stream-io/node-sdk 0.9.0 → 0.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/dist/index.cjs.js +162 -60
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.mjs +161 -58
- package/dist/index.es.mjs.map +1 -1
- package/dist/src/ApiClient.d.ts +1 -1
- package/dist/src/StreamVideoClient.d.ts +7 -0
- package/dist/src/gen/chat/ChannelApi.d.ts +1 -0
- package/dist/src/gen/chat/ChatApi.d.ts +3 -1
- package/dist/src/gen/common/CommonApi.d.ts +4 -1
- package/dist/src/gen/feeds/FeedsApi.d.ts +1 -0
- package/dist/src/gen/models/index.d.ts +683 -17
- package/dist/src/gen/moderation/ModerationApi.d.ts +23 -1
- package/dist/src/types.d.ts +14 -1
- package/package.json +11 -11
- package/src/ApiClient.ts +6 -2
- package/src/StreamVideoClient.ts +7 -0
- package/src/gen/chat/ChannelApi.ts +1 -0
- package/src/gen/chat/ChatApi.ts +27 -0
- package/src/gen/common/CommonApi.ts +11 -2
- package/src/gen/feeds/FeedsApi.ts +2 -0
- package/src/gen/models/index.ts +772 -17
- package/src/gen/moderation/ModerationApi.ts +222 -0
- package/src/types.ts +8 -0
|
@@ -228,7 +228,7 @@ export interface ActionLogResponse {
|
|
|
228
228
|
*/
|
|
229
229
|
reason: string;
|
|
230
230
|
/**
|
|
231
|
-
* Classification of who triggered the action (e.g. user, moderator, automod, api_integration)
|
|
231
|
+
* Classification of who triggered the action (e.g. user, moderator, automod, agent_reviewer, api_integration)
|
|
232
232
|
*/
|
|
233
233
|
reporter_type: string;
|
|
234
234
|
/**
|
|
@@ -245,9 +245,10 @@ export interface ActionLogResponse {
|
|
|
245
245
|
user_id: string;
|
|
246
246
|
ai_providers: Array<string>;
|
|
247
247
|
/**
|
|
248
|
-
* Additional metadata about the action
|
|
248
|
+
* Additional metadata about the action. An agent_recommendation log keeps the suggested action under recommended_action
|
|
249
249
|
*/
|
|
250
250
|
custom: Record<string, any>;
|
|
251
|
+
agent_recommendation?: AgentRecommendationResponse;
|
|
251
252
|
review_queue_item?: ReviewQueueItemResponse;
|
|
252
253
|
/**
|
|
253
254
|
* User response object
|
|
@@ -903,7 +904,7 @@ export interface ActivityRestoredEvent {
|
|
|
903
904
|
}
|
|
904
905
|
export interface ActivitySelectorConfig {
|
|
905
906
|
/**
|
|
906
|
-
* Type of selector. One of: popular, proximity, following, current_feed, query, interest, follow_suggestion
|
|
907
|
+
* Type of selector. One of: popular, proximity, following, current_feed, query, interest, follow_suggestion, friends_engaged
|
|
907
908
|
*/
|
|
908
909
|
type: ActivitySelectorType;
|
|
909
910
|
/**
|
|
@@ -914,6 +915,18 @@ export interface ActivitySelectorConfig {
|
|
|
914
915
|
* Flexible relative time window for activity selection (e.g., '1h', '3d', '1y'). Activities older than this duration will be filtered out. Cannot be used together with cutoff_time
|
|
915
916
|
*/
|
|
916
917
|
cutoff_window?: string;
|
|
918
|
+
/**
|
|
919
|
+
* Who counts as a friend for the friends_engaged selector: 'mutual' (default, users the viewer and they follow each other) or 'following' (users the viewer follows). Only supported on the friends_engaged selector
|
|
920
|
+
*/
|
|
921
|
+
friend_type?: 'mutual' | 'following';
|
|
922
|
+
/**
|
|
923
|
+
* Maximum number of close friends the friends_engaged selector reads reactions from (1-50, default 10). Only supported on the friends_engaged selector
|
|
924
|
+
*/
|
|
925
|
+
max_friends?: number;
|
|
926
|
+
/**
|
|
927
|
+
* Minimum number of distinct close friends that must have reacted to an activity for friends_engaged to select it (1-10, default 1, not above max_friends). Only supported on the friends_engaged selector
|
|
928
|
+
*/
|
|
929
|
+
min_friends?: number;
|
|
917
930
|
/**
|
|
918
931
|
* Minimum popularity threshold. For the 'popular' selector, omit to use the default (5); values below 1 are rejected
|
|
919
932
|
*/
|
|
@@ -930,6 +943,10 @@ export interface ActivitySelectorConfig {
|
|
|
930
943
|
* Radius in kilometers the proximity selector searches around the viewer's location (the request's viewer_location, else the user's custom.location) when its filter has no near or within_bounds. Greater than 0 and at most 250. Omit to use the default (10). Only supported on the proximity selector
|
|
931
944
|
*/
|
|
932
945
|
viewer_location_radius_km?: number;
|
|
946
|
+
/**
|
|
947
|
+
* Reaction types that count for the friends_engaged selector (at most 10, default all types). Only supported on the friends_engaged selector
|
|
948
|
+
*/
|
|
949
|
+
reaction_types?: Array<string>;
|
|
933
950
|
/**
|
|
934
951
|
* Sort parameters for activity selection
|
|
935
952
|
*/
|
|
@@ -954,6 +971,18 @@ export interface ActivitySelectorConfigResponse {
|
|
|
954
971
|
* Flexible relative time window for activity selection (e.g., '1h', '3d', '1y')
|
|
955
972
|
*/
|
|
956
973
|
cutoff_window?: string;
|
|
974
|
+
/**
|
|
975
|
+
* Who counts as a friend for the friends_engaged selector
|
|
976
|
+
*/
|
|
977
|
+
friend_type?: 'mutual' | 'following';
|
|
978
|
+
/**
|
|
979
|
+
* Maximum number of close friends the friends_engaged selector reads reactions from
|
|
980
|
+
*/
|
|
981
|
+
max_friends?: number;
|
|
982
|
+
/**
|
|
983
|
+
* Minimum number of distinct close friends that must have reacted for friends_engaged to select an activity
|
|
984
|
+
*/
|
|
985
|
+
min_friends?: number;
|
|
957
986
|
/**
|
|
958
987
|
* Minimum popularity threshold. For the 'popular' selector, values below 1 are normalized to the default (5) at read time.
|
|
959
988
|
*/
|
|
@@ -970,6 +999,10 @@ export interface ActivitySelectorConfigResponse {
|
|
|
970
999
|
* Radius in kilometers the proximity selector searches around the viewer's location
|
|
971
1000
|
*/
|
|
972
1001
|
viewer_location_radius_km?: number;
|
|
1002
|
+
/**
|
|
1003
|
+
* Reaction types that count for the friends_engaged selector
|
|
1004
|
+
*/
|
|
1005
|
+
reaction_types?: Array<string>;
|
|
973
1006
|
/**
|
|
974
1007
|
* Sort parameters for activity selection
|
|
975
1008
|
*/
|
|
@@ -984,7 +1017,7 @@ export interface ActivitySelectorConfigResponse {
|
|
|
984
1017
|
*/
|
|
985
1018
|
params?: Record<string, any>;
|
|
986
1019
|
}
|
|
987
|
-
export type ActivitySelectorType = 'popular' | 'proximity' | 'following' | 'current_feed' | 'query' | 'interest' | 'follow_suggestion';
|
|
1020
|
+
export type ActivitySelectorType = 'popular' | 'proximity' | 'following' | 'current_feed' | 'query' | 'interest' | 'follow_suggestion' | 'friends_engaged';
|
|
988
1021
|
export interface ActivityUnpinnedEvent {
|
|
989
1022
|
/**
|
|
990
1023
|
* Date/time of creation
|
|
@@ -1427,6 +1460,216 @@ export interface AddUserGroupMembersResponse {
|
|
|
1427
1460
|
duration: string;
|
|
1428
1461
|
user_group?: UserGroupResponse;
|
|
1429
1462
|
}
|
|
1463
|
+
export interface AgentFeedbackResponse {
|
|
1464
|
+
/**
|
|
1465
|
+
* Nora review this correction is about
|
|
1466
|
+
*/
|
|
1467
|
+
agent_review_id: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Text of the item when the correction was saved
|
|
1470
|
+
*/
|
|
1471
|
+
content_excerpt: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* When the correction was first saved
|
|
1474
|
+
*/
|
|
1475
|
+
created_at: TimestampNS;
|
|
1476
|
+
/**
|
|
1477
|
+
* Moderator who submitted the correction
|
|
1478
|
+
*/
|
|
1479
|
+
created_by: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* Entity type of the queue item
|
|
1482
|
+
*/
|
|
1483
|
+
entity_type: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* Feedback row id
|
|
1486
|
+
*/
|
|
1487
|
+
id: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* How similar cases should be judged
|
|
1490
|
+
*/
|
|
1491
|
+
improvement: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* Review queue item the correction is about
|
|
1494
|
+
*/
|
|
1495
|
+
item_id: string;
|
|
1496
|
+
/**
|
|
1497
|
+
* Action the moderator took
|
|
1498
|
+
*/
|
|
1499
|
+
moderator_action: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* Policy action Nora recommended
|
|
1502
|
+
*/
|
|
1503
|
+
nora_action: 'keep' | 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
1504
|
+
/**
|
|
1505
|
+
* Why the moderator disagreed
|
|
1506
|
+
*/
|
|
1507
|
+
reason: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* When the correction was last saved
|
|
1510
|
+
*/
|
|
1511
|
+
updated_at: TimestampNS;
|
|
1512
|
+
/**
|
|
1513
|
+
* Labels Nora matched on this review
|
|
1514
|
+
*/
|
|
1515
|
+
labels: Array<string>;
|
|
1516
|
+
}
|
|
1517
|
+
export interface AgentRecommendationPayload {
|
|
1518
|
+
/**
|
|
1519
|
+
* Why Nora suggests this action. Stored on the action log, cut to 500 bytes
|
|
1520
|
+
*/
|
|
1521
|
+
reason: string;
|
|
1522
|
+
/**
|
|
1523
|
+
* Action Nora suggests for the item
|
|
1524
|
+
*/
|
|
1525
|
+
recommended_action: 'keep' | 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove' | 'review';
|
|
1526
|
+
}
|
|
1527
|
+
export interface AgentRecommendationResponse {
|
|
1528
|
+
/**
|
|
1529
|
+
* Why Nora suggested this action
|
|
1530
|
+
*/
|
|
1531
|
+
reason: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* Action Nora suggested for the item
|
|
1534
|
+
*/
|
|
1535
|
+
recommended_action: 'keep' | 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove' | 'review';
|
|
1536
|
+
}
|
|
1537
|
+
export interface AgentReviewJudgmentResponse {
|
|
1538
|
+
/**
|
|
1539
|
+
* Why the agent matched this label
|
|
1540
|
+
*/
|
|
1541
|
+
explanation?: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* Moderation label this judgment is about
|
|
1544
|
+
*/
|
|
1545
|
+
label?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* The agent's verdict for this label
|
|
1548
|
+
*/
|
|
1549
|
+
verdict?: string;
|
|
1550
|
+
/**
|
|
1551
|
+
* Quotes from the content that support the verdict
|
|
1552
|
+
*/
|
|
1553
|
+
evidence?: Array<string>;
|
|
1554
|
+
}
|
|
1555
|
+
export interface AgentReviewResponse {
|
|
1556
|
+
/**
|
|
1557
|
+
* True when the agent did not have the full context it needed
|
|
1558
|
+
*/
|
|
1559
|
+
context_incomplete: boolean;
|
|
1560
|
+
/**
|
|
1561
|
+
* When this review was recorded
|
|
1562
|
+
*/
|
|
1563
|
+
created_at: TimestampNS;
|
|
1564
|
+
/**
|
|
1565
|
+
* Lifecycle status of the review
|
|
1566
|
+
*/
|
|
1567
|
+
status: 'pending' | 'processing' | 'done' | 'failed' | 'skipped';
|
|
1568
|
+
/**
|
|
1569
|
+
* Session id of the agent run that produced this review
|
|
1570
|
+
*/
|
|
1571
|
+
agent_session_id?: string;
|
|
1572
|
+
/**
|
|
1573
|
+
* The agent's confidence in its recommended action, from 0 to 1
|
|
1574
|
+
*/
|
|
1575
|
+
confidence?: number;
|
|
1576
|
+
/**
|
|
1577
|
+
* Whether the flag is supported, a likely false positive, or uncertain
|
|
1578
|
+
*/
|
|
1579
|
+
flag_assessment?: 'supported' | 'likely_false_positive' | 'uncertain';
|
|
1580
|
+
/**
|
|
1581
|
+
* Model route that produced this review
|
|
1582
|
+
*/
|
|
1583
|
+
model_route?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Why Nora chose the recommended action
|
|
1586
|
+
*/
|
|
1587
|
+
reason?: string;
|
|
1588
|
+
/**
|
|
1589
|
+
* Action the agent recommends for the item
|
|
1590
|
+
*/
|
|
1591
|
+
recommended_action?: 'keep' | 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove' | 'review';
|
|
1592
|
+
/**
|
|
1593
|
+
* Why the review was skipped or failed. Set when status is skipped or failed
|
|
1594
|
+
*/
|
|
1595
|
+
skip_reason?: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* Short summary of the review
|
|
1598
|
+
*/
|
|
1599
|
+
summary?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* Per-label judgments, with the evidence the agent quoted
|
|
1602
|
+
*/
|
|
1603
|
+
judgments?: Array<AgentReviewJudgmentResponse>;
|
|
1604
|
+
/**
|
|
1605
|
+
* Token usage reported for this review
|
|
1606
|
+
*/
|
|
1607
|
+
usage?: Record<string, any>;
|
|
1608
|
+
}
|
|
1609
|
+
export interface AgentReviewSettingsPayload {
|
|
1610
|
+
/**
|
|
1611
|
+
* The app's Accelerate agent config with role agent_moderator.
|
|
1612
|
+
*/
|
|
1613
|
+
agent_config_id?: string;
|
|
1614
|
+
/**
|
|
1615
|
+
* Minimum verdict confidence (0-1) for auto_act to apply an action. Defaults to 0.9.
|
|
1616
|
+
*/
|
|
1617
|
+
auto_act_min_confidence?: number;
|
|
1618
|
+
/**
|
|
1619
|
+
* Days of the user's moderation history given to the agent. Defaults to 7, at most 30.
|
|
1620
|
+
*/
|
|
1621
|
+
context_days?: number;
|
|
1622
|
+
/**
|
|
1623
|
+
* Surrounding items given to the agent on each side of the reviewed one: chat messages, Feeds comments, or the author's other Feeds activities. Defaults to 20, at most 100.
|
|
1624
|
+
*/
|
|
1625
|
+
context_messages?: number;
|
|
1626
|
+
/**
|
|
1627
|
+
* Turns the agent reviewer on. It only runs when agent_config_id is set too.
|
|
1628
|
+
*/
|
|
1629
|
+
enabled?: boolean;
|
|
1630
|
+
/**
|
|
1631
|
+
* Maximum reviews in flight for the app. Defaults to 10, at most 100.
|
|
1632
|
+
*/
|
|
1633
|
+
max_concurrency?: number;
|
|
1634
|
+
/**
|
|
1635
|
+
* approve_first records the verdict for a moderator to approve; auto_act applies it when its confidence reaches auto_act_min_confidence; export_only changes nothing on the review queue and only exports each verdict for evaluation. Defaults to approve_first.
|
|
1636
|
+
*/
|
|
1637
|
+
mode?: 'approve_first' | 'auto_act' | 'export_only';
|
|
1638
|
+
/**
|
|
1639
|
+
* Sends the images of the content under review to the agent, so it can judge them alongside the text. The agent config must run on a model that sees images. Defaults to false.
|
|
1640
|
+
*/
|
|
1641
|
+
review_images?: boolean;
|
|
1642
|
+
/**
|
|
1643
|
+
* Fraction (0-1) of checks reviewed with scope all_checks. Defaults to 1.
|
|
1644
|
+
*/
|
|
1645
|
+
sample_rate?: number;
|
|
1646
|
+
/**
|
|
1647
|
+
* Which checks are reviewed: flagged ones only, or all_checks sampled by sample_rate. Defaults to flagged.
|
|
1648
|
+
*/
|
|
1649
|
+
scope?: 'flagged' | 'all_checks';
|
|
1650
|
+
/**
|
|
1651
|
+
* Moderation rule IDs: only items flagged by one of these rules are reviewed, and items flagged only by other sources are left to moderators. Empty reviews every flagged item. Only used with scope flagged; at most 100.
|
|
1652
|
+
*/
|
|
1653
|
+
rule_ids?: Array<string>;
|
|
1654
|
+
}
|
|
1655
|
+
export interface AgentReviewSummaryResponse {
|
|
1656
|
+
/**
|
|
1657
|
+
* Verdict confidence from 0 to 1
|
|
1658
|
+
*/
|
|
1659
|
+
confidence: number;
|
|
1660
|
+
/**
|
|
1661
|
+
* pending, processing, done, failed, or skipped
|
|
1662
|
+
*/
|
|
1663
|
+
status: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* Whether the flag matches the content. Set once the review is done
|
|
1666
|
+
*/
|
|
1667
|
+
flag_assessment?: string;
|
|
1668
|
+
/**
|
|
1669
|
+
* The action Nora recommends. Set once the review is done
|
|
1670
|
+
*/
|
|
1671
|
+
recommended_action?: string;
|
|
1672
|
+
}
|
|
1430
1673
|
export interface AggregatedActivityResponse {
|
|
1431
1674
|
/**
|
|
1432
1675
|
* Number of activities in this aggregation
|
|
@@ -1737,7 +1980,15 @@ export interface AppResponseFields {
|
|
|
1737
1980
|
geofences?: Array<GeofenceResponse>;
|
|
1738
1981
|
image_moderation_labels?: Array<string>;
|
|
1739
1982
|
activity_metrics_config?: Record<string, number>;
|
|
1983
|
+
/**
|
|
1984
|
+
* Settings for the moderation agent reviewer, which reviews moderation outcomes and proposes or applies an action.
|
|
1985
|
+
*/
|
|
1986
|
+
agent_review?: AgentReviewSettingsPayload;
|
|
1740
1987
|
datadog_info?: DataDogInfo;
|
|
1988
|
+
/**
|
|
1989
|
+
* Settings for the moderation agent reviewer, which reviews moderation outcomes and proposes or applies an action.
|
|
1990
|
+
*/
|
|
1991
|
+
effective_agent_review?: AgentReviewSettingsPayload;
|
|
1741
1992
|
moderation_dashboard_preferences?: ModerationDashboardPreferences;
|
|
1742
1993
|
}
|
|
1743
1994
|
export interface AppealAcceptedEvent {
|
|
@@ -1895,7 +2146,7 @@ export interface ArrangeConfig {
|
|
|
1895
2146
|
*/
|
|
1896
2147
|
key?: string;
|
|
1897
2148
|
/**
|
|
1898
|
-
* Arrangement mode.
|
|
2149
|
+
* Arrangement mode. 'blend' and 'diversify' are supported; 'slot' is reserved
|
|
1899
2150
|
*/
|
|
1900
2151
|
mode?: string;
|
|
1901
2152
|
/**
|
|
@@ -1903,6 +2154,7 @@ export interface ArrangeConfig {
|
|
|
1903
2154
|
*/
|
|
1904
2155
|
tail_below?: number;
|
|
1905
2156
|
blend?: BlendArrangeConfig;
|
|
2157
|
+
diversify?: DiversifyArrangeConfig;
|
|
1906
2158
|
}
|
|
1907
2159
|
export interface AsyncBulkImageModerationEvent {
|
|
1908
2160
|
created_at: TimestampNS;
|
|
@@ -2936,6 +3188,7 @@ export interface CallCreatedEvent {
|
|
|
2936
3188
|
type: string;
|
|
2937
3189
|
}
|
|
2938
3190
|
export interface CallCustomPropertyParameters {
|
|
3191
|
+
expected_value?: any;
|
|
2939
3192
|
operator?: string;
|
|
2940
3193
|
property_key?: string;
|
|
2941
3194
|
}
|
|
@@ -3399,7 +3652,7 @@ export interface CallRejectedEvent {
|
|
|
3399
3652
|
*/
|
|
3400
3653
|
type: string;
|
|
3401
3654
|
/**
|
|
3402
|
-
* Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values:
|
|
3655
|
+
* Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: decline, cancel, timeout and busy
|
|
3403
3656
|
*/
|
|
3404
3657
|
reason?: string;
|
|
3405
3658
|
}
|
|
@@ -6221,6 +6474,7 @@ export interface ClosedCaptionRuleParameters {
|
|
|
6221
6474
|
threshold?: number;
|
|
6222
6475
|
time_window?: string;
|
|
6223
6476
|
harm_labels?: Array<string>;
|
|
6477
|
+
severities?: Array<string>;
|
|
6224
6478
|
llm_harm_labels?: Record<string, string>;
|
|
6225
6479
|
}
|
|
6226
6480
|
export interface CollectUserFeedbackRequest {
|
|
@@ -6705,6 +6959,10 @@ export interface ConfigResponse {
|
|
|
6705
6959
|
*/
|
|
6706
6960
|
updated_at: TimestampNS;
|
|
6707
6961
|
supported_video_call_harm_types: Array<string>;
|
|
6962
|
+
/**
|
|
6963
|
+
* The version of this configuration moderation currently runs
|
|
6964
|
+
*/
|
|
6965
|
+
published_version?: number;
|
|
6708
6966
|
/**
|
|
6709
6967
|
* Configurable image moderation label definitions for dashboard rendering
|
|
6710
6968
|
*/
|
|
@@ -6732,6 +6990,24 @@ export interface ConfigResponse {
|
|
|
6732
6990
|
velocity_filter_config?: VelocityFilterConfig;
|
|
6733
6991
|
video_call_rule_config?: VideoCallRuleConfig;
|
|
6734
6992
|
}
|
|
6993
|
+
export interface ConfigVersionResponse {
|
|
6994
|
+
/**
|
|
6995
|
+
* When this version was saved
|
|
6996
|
+
*/
|
|
6997
|
+
created_at: TimestampNS;
|
|
6998
|
+
/**
|
|
6999
|
+
* ID of the user who saved this version, empty when saved without a user
|
|
7000
|
+
*/
|
|
7001
|
+
created_by: string;
|
|
7002
|
+
/**
|
|
7003
|
+
* Whether this is the version moderation currently runs
|
|
7004
|
+
*/
|
|
7005
|
+
published: boolean;
|
|
7006
|
+
/**
|
|
7007
|
+
* Sequential version number, per key and team
|
|
7008
|
+
*/
|
|
7009
|
+
version: number;
|
|
7010
|
+
}
|
|
6735
7011
|
export interface ContentCountRuleParameters {
|
|
6736
7012
|
threshold?: number;
|
|
6737
7013
|
time_window?: string;
|
|
@@ -6741,12 +7017,14 @@ export interface ContentCountryCodeParameters {
|
|
|
6741
7017
|
country_codes?: Array<string>;
|
|
6742
7018
|
}
|
|
6743
7019
|
export interface ContentCustomPropertyCountParameters {
|
|
7020
|
+
expected_value?: any;
|
|
6744
7021
|
operator?: string;
|
|
6745
7022
|
property_key?: string;
|
|
6746
7023
|
threshold?: number;
|
|
6747
7024
|
time_window?: string;
|
|
6748
7025
|
}
|
|
6749
7026
|
export interface ContentCustomPropertyParameters {
|
|
7027
|
+
expected_value?: any;
|
|
6750
7028
|
operator?: string;
|
|
6751
7029
|
property_key?: string;
|
|
6752
7030
|
}
|
|
@@ -6764,6 +7042,36 @@ export interface CountByMinuteResponse {
|
|
|
6764
7042
|
count: number;
|
|
6765
7043
|
start_ts: TimestampNS;
|
|
6766
7044
|
}
|
|
7045
|
+
export interface CountReviewQueueRequest {
|
|
7046
|
+
user_id?: string;
|
|
7047
|
+
/**
|
|
7048
|
+
* Filter conditions for review queue items, the same filter Query Review Queue takes. The count covers exactly the items that query lists for this filter, ignoring sort, paging and item locks.
|
|
7049
|
+
*/
|
|
7050
|
+
filter?: Record<string, any>;
|
|
7051
|
+
/**
|
|
7052
|
+
* User request object
|
|
7053
|
+
*/
|
|
7054
|
+
user?: UserRequest;
|
|
7055
|
+
}
|
|
7056
|
+
export interface CountReviewQueueResponse {
|
|
7057
|
+
/**
|
|
7058
|
+
* Whether more items match than are counted exactly (50,000), so total is a lower bound
|
|
7059
|
+
*/
|
|
7060
|
+
capped: boolean;
|
|
7061
|
+
duration: string;
|
|
7062
|
+
/**
|
|
7063
|
+
* Whether the count is missing or out of date because the queue changed since it was computed. A later request may return a fresher count.
|
|
7064
|
+
*/
|
|
7065
|
+
pending: boolean;
|
|
7066
|
+
/**
|
|
7067
|
+
* Number of review queue items matching the filter. When capped is true, at least this many items match.
|
|
7068
|
+
*/
|
|
7069
|
+
total: number;
|
|
7070
|
+
/**
|
|
7071
|
+
* When the count was computed. Counts are refreshed in the background as the review queue changes.
|
|
7072
|
+
*/
|
|
7073
|
+
computed_at?: TimestampNS;
|
|
7074
|
+
}
|
|
6767
7075
|
export interface Coverage {
|
|
6768
7076
|
publisher_encoding_profiles: number;
|
|
6769
7077
|
absent: Array<AbsentMetric>;
|
|
@@ -8477,6 +8785,28 @@ export interface DeviceResponse {
|
|
|
8477
8785
|
*/
|
|
8478
8786
|
voip?: boolean;
|
|
8479
8787
|
}
|
|
8788
|
+
export interface DiversifyArrangeConfig {
|
|
8789
|
+
/**
|
|
8790
|
+
* Decay strategy: per-repeat score multiplier, greater than 0 and less than 1. Defaults to 0.5
|
|
8791
|
+
*/
|
|
8792
|
+
decay?: number;
|
|
8793
|
+
/**
|
|
8794
|
+
* Decay strategy: the lowest multiplier a repeated key can reach, at least 0 and less than 1. Defaults to 0.25
|
|
8795
|
+
*/
|
|
8796
|
+
floor?: number;
|
|
8797
|
+
/**
|
|
8798
|
+
* Cap strategy: the most items of one key value allowed in any window of consecutive slots. At least 1
|
|
8799
|
+
*/
|
|
8800
|
+
max?: number;
|
|
8801
|
+
/**
|
|
8802
|
+
* Diversify strategy: 'cap' (default) or 'decay'
|
|
8803
|
+
*/
|
|
8804
|
+
strategy?: string;
|
|
8805
|
+
/**
|
|
8806
|
+
* Cap strategy: window size in slots, greater than max and at most 100. Defaults to max + 1
|
|
8807
|
+
*/
|
|
8808
|
+
window?: number;
|
|
8809
|
+
}
|
|
8480
8810
|
export interface DraftPayloadResponse {
|
|
8481
8811
|
/**
|
|
8482
8812
|
* Message ID is unique string identifier of the message
|
|
@@ -8858,6 +9188,10 @@ export interface EventHook {
|
|
|
8858
9188
|
sns_event_based_message_group_id_enabled?: boolean;
|
|
8859
9189
|
sns_key?: string;
|
|
8860
9190
|
sns_region?: string;
|
|
9191
|
+
/**
|
|
9192
|
+
* @deprecated
|
|
9193
|
+
* Deprecated: Role auth was never supported; use resource auth.
|
|
9194
|
+
*/
|
|
8861
9195
|
sns_role_arn?: string;
|
|
8862
9196
|
sns_secret?: string;
|
|
8863
9197
|
sns_topic_arn?: string;
|
|
@@ -8866,6 +9200,10 @@ export interface EventHook {
|
|
|
8866
9200
|
sqs_key?: string;
|
|
8867
9201
|
sqs_queue_url?: string;
|
|
8868
9202
|
sqs_region?: string;
|
|
9203
|
+
/**
|
|
9204
|
+
* @deprecated
|
|
9205
|
+
* Deprecated: Role auth was never supported; use resource auth.
|
|
9206
|
+
*/
|
|
8869
9207
|
sqs_role_arn?: string;
|
|
8870
9208
|
sqs_secret?: string;
|
|
8871
9209
|
timeout_ms?: number;
|
|
@@ -10598,6 +10936,25 @@ export interface GetActivityResponse {
|
|
|
10598
10936
|
duration: string;
|
|
10599
10937
|
activity: ActivityResponse;
|
|
10600
10938
|
}
|
|
10939
|
+
export interface GetAgentReviewStatusResponse {
|
|
10940
|
+
/**
|
|
10941
|
+
* Actions Nora took in the last 7 days
|
|
10942
|
+
*/
|
|
10943
|
+
applied: number;
|
|
10944
|
+
duration: string;
|
|
10945
|
+
/**
|
|
10946
|
+
* Items Nora escalated in the last 7 days
|
|
10947
|
+
*/
|
|
10948
|
+
escalated: number;
|
|
10949
|
+
/**
|
|
10950
|
+
* Reviews that finished in the last 7 days
|
|
10951
|
+
*/
|
|
10952
|
+
reviewed: number;
|
|
10953
|
+
/**
|
|
10954
|
+
* Why the latest review failed. Absent unless that review failed
|
|
10955
|
+
*/
|
|
10956
|
+
last_error?: string;
|
|
10957
|
+
}
|
|
10601
10958
|
export interface GetAppealResponse {
|
|
10602
10959
|
duration: string;
|
|
10603
10960
|
item?: AppealItemResponse;
|
|
@@ -10808,6 +11165,11 @@ export interface GetConfigResponse {
|
|
|
10808
11165
|
duration: string;
|
|
10809
11166
|
config?: ConfigResponse;
|
|
10810
11167
|
}
|
|
11168
|
+
export interface GetConfigVersionResponse {
|
|
11169
|
+
duration: string;
|
|
11170
|
+
version: ConfigVersionResponse;
|
|
11171
|
+
config?: ConfigResponse;
|
|
11172
|
+
}
|
|
10811
11173
|
export interface GetCustomPermissionResponse {
|
|
10812
11174
|
/**
|
|
10813
11175
|
* Duration of the request in milliseconds
|
|
@@ -11410,6 +11772,7 @@ export interface GetRetentionPolicyRunsResponse {
|
|
|
11410
11772
|
}
|
|
11411
11773
|
export interface GetReviewQueueItemResponse {
|
|
11412
11774
|
duration: string;
|
|
11775
|
+
agent_review?: AgentReviewResponse;
|
|
11413
11776
|
item?: ReviewQueueItemResponse;
|
|
11414
11777
|
}
|
|
11415
11778
|
export interface GetSegmentResponse {
|
|
@@ -11633,6 +11996,7 @@ export interface IPFlagCountRuleParameters {
|
|
|
11633
11996
|
threshold?: number;
|
|
11634
11997
|
time_window?: string;
|
|
11635
11998
|
harm_labels?: Array<string>;
|
|
11999
|
+
severities?: Array<string>;
|
|
11636
12000
|
}
|
|
11637
12001
|
export interface ImageContentParameters {
|
|
11638
12002
|
label_operator?: string;
|
|
@@ -11710,6 +12074,7 @@ export interface ImportBlockListResponse {
|
|
|
11710
12074
|
duration: string;
|
|
11711
12075
|
task_id: string;
|
|
11712
12076
|
}
|
|
12077
|
+
export type ImportCustomFormat = 'root' | 'nested';
|
|
11713
12078
|
export interface ImportTask {
|
|
11714
12079
|
created_at: TimestampNS;
|
|
11715
12080
|
id: string;
|
|
@@ -11736,6 +12101,10 @@ export interface ImportV2TaskItem {
|
|
|
11736
12101
|
result?: Record<string, any>;
|
|
11737
12102
|
}
|
|
11738
12103
|
export interface ImportV2TaskSettings {
|
|
12104
|
+
/**
|
|
12105
|
+
* How custom fields are read from imported items: root (default) takes unknown root keys as custom data, nested reads them from a custom object and is only supported for feeds imports.
|
|
12106
|
+
*/
|
|
12107
|
+
custom_format?: ImportCustomFormat;
|
|
11739
12108
|
merge_custom?: boolean;
|
|
11740
12109
|
mode?: string;
|
|
11741
12110
|
path?: string;
|
|
@@ -12327,13 +12696,13 @@ export interface LayoutSettingsResponse {
|
|
|
12327
12696
|
}
|
|
12328
12697
|
export interface LifecycleSettingsRequest {
|
|
12329
12698
|
/**
|
|
12330
|
-
* Call lifecycle mode. One of: reusable, single_use. A single_use call cannot be reused once it has ended; the server ends it when its ring settles without an answer
|
|
12699
|
+
* Call lifecycle mode. One of: reusable, single_use. A single_use call cannot be reused once it has ended; the server ends it when its ring settles without an answer: when the caller cancels the ring, or when the ring times out on the server (missed_call_timeout_ms) without anyone accepting or joining. Fixed at call creation
|
|
12331
12700
|
*/
|
|
12332
12701
|
mode?: CallLifecycleMode;
|
|
12333
12702
|
}
|
|
12334
12703
|
export interface LifecycleSettingsResponse {
|
|
12335
12704
|
/**
|
|
12336
|
-
* Call lifecycle mode. One of: reusable, single_use. A single_use call cannot be reused once it has ended; the server ends it when its ring settles without an answer
|
|
12705
|
+
* Call lifecycle mode. One of: reusable, single_use. A single_use call cannot be reused once it has ended; the server ends it when its ring settles without an answer: when the caller cancels the ring, or when the ring times out on the server (missed_call_timeout_ms) without anyone accepting or joining. Fixed at call creation
|
|
12337
12706
|
*/
|
|
12338
12707
|
mode: CallLifecycleMode;
|
|
12339
12708
|
}
|
|
@@ -12369,6 +12738,17 @@ export interface LimitsSettingsResponse {
|
|
|
12369
12738
|
max_participants?: number;
|
|
12370
12739
|
max_participants_exclude_owner?: boolean;
|
|
12371
12740
|
}
|
|
12741
|
+
export interface ListAgentFeedbackResponse {
|
|
12742
|
+
duration: string;
|
|
12743
|
+
/**
|
|
12744
|
+
* Corrections, newest first
|
|
12745
|
+
*/
|
|
12746
|
+
feedback: Array<AgentFeedbackResponse>;
|
|
12747
|
+
/**
|
|
12748
|
+
* Cursor for the next page. Absent when this is the last page
|
|
12749
|
+
*/
|
|
12750
|
+
next?: string;
|
|
12751
|
+
}
|
|
12372
12752
|
export interface ListBlockListResponse {
|
|
12373
12753
|
/**
|
|
12374
12754
|
* Duration of the request in milliseconds
|
|
@@ -12395,6 +12775,17 @@ export interface ListCommandsResponse {
|
|
|
12395
12775
|
*/
|
|
12396
12776
|
commands: Array<Command>;
|
|
12397
12777
|
}
|
|
12778
|
+
export interface ListConfigVersionsResponse {
|
|
12779
|
+
duration: string;
|
|
12780
|
+
/**
|
|
12781
|
+
* Retained versions of this configuration, newest first, including the published one
|
|
12782
|
+
*/
|
|
12783
|
+
versions: Array<ConfigVersionResponse>;
|
|
12784
|
+
/**
|
|
12785
|
+
* The version moderation currently runs
|
|
12786
|
+
*/
|
|
12787
|
+
published_version?: number;
|
|
12788
|
+
}
|
|
12398
12789
|
export interface ListDevicesResponse {
|
|
12399
12790
|
duration: string;
|
|
12400
12791
|
/**
|
|
@@ -12652,6 +13043,16 @@ export interface MarkUnreadRequest {
|
|
|
12652
13043
|
*/
|
|
12653
13044
|
user?: UserRequest;
|
|
12654
13045
|
}
|
|
13046
|
+
export interface MatchedBlocklist {
|
|
13047
|
+
/**
|
|
13048
|
+
* Blocklist name, as set on the rule condition.
|
|
13049
|
+
*/
|
|
13050
|
+
name: string;
|
|
13051
|
+
/**
|
|
13052
|
+
* Distinct text the blocklist matched in the content, at most 10 values of up to 256 bytes each. Word, email and domain blocklists report a single match, in the normalized form they compare, even when several words hit; regex lists and domain/email allowlists report every match, except that an allowlist with LLM domain validation enabled reports the one URL the check kept. Regex lists match on the text with invisible characters removed, except the built-in URL list, which reports the URL as it appears in the content. Can be empty when the blocklist hit but no value was recorded (for example a flag stored before this field existed).
|
|
13053
|
+
*/
|
|
13054
|
+
matches: Array<string>;
|
|
13055
|
+
}
|
|
12655
13056
|
export interface MatchedContent {
|
|
12656
13057
|
/**
|
|
12657
13058
|
* The `content_ids[label]` value supplied on the `/analyze` request that contributed this entry.
|
|
@@ -13981,11 +14382,16 @@ export interface ModerationCheckCompletedEvent {
|
|
|
13981
14382
|
custom: Record<string, any>;
|
|
13982
14383
|
type: string;
|
|
13983
14384
|
received_at?: TimestampNS;
|
|
14385
|
+
/**
|
|
14386
|
+
* Content payload for moderation
|
|
14387
|
+
*/
|
|
14388
|
+
moderation_payload?: ModerationPayloadResponse;
|
|
13984
14389
|
}
|
|
13985
14390
|
export interface ModerationConfig {
|
|
13986
14391
|
async?: boolean;
|
|
13987
14392
|
created_at?: Date;
|
|
13988
14393
|
key?: string;
|
|
14394
|
+
published_version?: number;
|
|
13989
14395
|
team?: string;
|
|
13990
14396
|
updated_at?: Date;
|
|
13991
14397
|
supported_video_call_harm_types?: Array<string>;
|
|
@@ -14044,23 +14450,39 @@ export interface ModerationDashboardPreferences {
|
|
|
14044
14450
|
}
|
|
14045
14451
|
export interface ModerationEngineConfigRequest {
|
|
14046
14452
|
/**
|
|
14047
|
-
* LLM model used when the provider resolves to llm. Not allowed with provider nlp. Empty uses the app's moderation settings
|
|
14453
|
+
* LLM model used when the provider resolves to llm, or a Stream model with provider stream (an alias, or a pinned version the server accepts). Not allowed with provider nlp. Empty uses the app's moderation settings, or the latest Stream model
|
|
14454
|
+
*/
|
|
14455
|
+
model?: 'gpt-4o-mini' | 'gpt-4o' | 'gpt-6-luna' | 'stream-mammoth-1' | 'stream-elephant-1';
|
|
14456
|
+
/**
|
|
14457
|
+
* llm, nlp or stream. Empty follows the app's LLM moderation setting
|
|
14048
14458
|
*/
|
|
14049
|
-
|
|
14459
|
+
provider?: 'llm' | 'nlp' | 'stream';
|
|
14050
14460
|
/**
|
|
14051
|
-
*
|
|
14461
|
+
* OpenAI reasoning effort for model. Requires model, and must be one the model accepts. Empty uses the model's default
|
|
14052
14462
|
*/
|
|
14053
|
-
|
|
14463
|
+
reasoning_effort?: string;
|
|
14464
|
+
/**
|
|
14465
|
+
* How sure a Stream model must be before it flags: relaxed, balanced or strict. Only with provider stream. Empty is balanced
|
|
14466
|
+
*/
|
|
14467
|
+
strictness?: 'relaxed' | 'balanced' | 'strict';
|
|
14054
14468
|
}
|
|
14055
14469
|
export interface ModerationEngineConfigResponse {
|
|
14056
14470
|
/**
|
|
14057
|
-
* LLM model used when the provider resolves to llm. Not allowed with provider nlp. Empty uses the app's moderation settings
|
|
14471
|
+
* LLM model used when the provider resolves to llm, or a Stream model with provider stream (an alias, or a pinned version the server accepts). Not allowed with provider nlp. Empty uses the app's moderation settings, or the latest Stream model
|
|
14058
14472
|
*/
|
|
14059
14473
|
model?: string;
|
|
14060
14474
|
/**
|
|
14061
|
-
* llm or
|
|
14475
|
+
* llm, nlp or stream. Empty follows the app's LLM moderation setting
|
|
14476
|
+
*/
|
|
14477
|
+
provider?: 'llm' | 'nlp' | 'stream';
|
|
14478
|
+
/**
|
|
14479
|
+
* OpenAI reasoning effort for model. Requires model, and must be one the model accepts. Empty uses the model's default
|
|
14480
|
+
*/
|
|
14481
|
+
reasoning_effort?: string;
|
|
14482
|
+
/**
|
|
14483
|
+
* How sure a Stream model must be before it flags: relaxed, balanced or strict. Only with provider stream. Empty is balanced
|
|
14062
14484
|
*/
|
|
14063
|
-
|
|
14485
|
+
strictness?: 'relaxed' | 'balanced' | 'strict';
|
|
14064
14486
|
}
|
|
14065
14487
|
export interface ModerationFeedbackItemResponse {
|
|
14066
14488
|
/**
|
|
@@ -14368,6 +14790,8 @@ export interface ModerationQueueResponse {
|
|
|
14368
14790
|
description: string;
|
|
14369
14791
|
id: string;
|
|
14370
14792
|
item_count: number;
|
|
14793
|
+
item_count_capped: boolean;
|
|
14794
|
+
item_count_pending: boolean;
|
|
14371
14795
|
name: string;
|
|
14372
14796
|
type: string;
|
|
14373
14797
|
updated_at: TimestampNS;
|
|
@@ -14469,6 +14893,10 @@ export interface ModerationRulesTriggeredEvent {
|
|
|
14469
14893
|
* The violation number for call rules (optional)
|
|
14470
14894
|
*/
|
|
14471
14895
|
violation_number?: number;
|
|
14896
|
+
/**
|
|
14897
|
+
* Blocklists that the rule's blocklist conditions (`text_content`, `text_rule`) matched, each with the text it matched in the content. Omitted when the rule has no such condition or none matched.
|
|
14898
|
+
*/
|
|
14899
|
+
matched_blocklists?: Array<MatchedBlocklist>;
|
|
14472
14900
|
/**
|
|
14473
14901
|
* Ordered list of contents whose verdicts contributed to an aggregation rule's threshold. Populated only for aggregation rules when callers supplied `content_ids`.
|
|
14474
14902
|
*/
|
|
@@ -14922,6 +15350,7 @@ export interface OCRContentParameters {
|
|
|
14922
15350
|
label_operator?: string;
|
|
14923
15351
|
severity?: string;
|
|
14924
15352
|
harm_labels?: Array<string>;
|
|
15353
|
+
severities?: Array<string>;
|
|
14925
15354
|
}
|
|
14926
15355
|
export interface OCRRule {
|
|
14927
15356
|
/**
|
|
@@ -15761,6 +16190,24 @@ export interface PrivacySettingsResponse {
|
|
|
15761
16190
|
*/
|
|
15762
16191
|
typing_indicators?: TypingIndicatorsResponse;
|
|
15763
16192
|
}
|
|
16193
|
+
export interface PublishConfigVersionRequest {
|
|
16194
|
+
/**
|
|
16195
|
+
* Team associated with the configuration
|
|
16196
|
+
*/
|
|
16197
|
+
team?: string;
|
|
16198
|
+
/**
|
|
16199
|
+
* Optional user ID to associate with the audit log entry
|
|
16200
|
+
*/
|
|
16201
|
+
user_id?: string;
|
|
16202
|
+
/**
|
|
16203
|
+
* User request object
|
|
16204
|
+
*/
|
|
16205
|
+
user?: UserRequest;
|
|
16206
|
+
}
|
|
16207
|
+
export interface PublishConfigVersionResponse {
|
|
16208
|
+
duration: string;
|
|
16209
|
+
config?: ConfigResponse;
|
|
16210
|
+
}
|
|
15764
16211
|
export interface PublishedTrackFlags {
|
|
15765
16212
|
audio: boolean;
|
|
15766
16213
|
screenshare: boolean;
|
|
@@ -18728,6 +19175,7 @@ export interface ReviewQueueItemResponse {
|
|
|
18728
19175
|
*/
|
|
18729
19176
|
teams?: Array<string>;
|
|
18730
19177
|
activity?: EnrichedActivity;
|
|
19178
|
+
agent_review?: AgentReviewSummaryResponse;
|
|
18731
19179
|
appeal?: AppealItemResponse;
|
|
18732
19180
|
/**
|
|
18733
19181
|
* User response object
|
|
@@ -19434,6 +19882,58 @@ export interface SIPTrunkResponse {
|
|
|
19434
19882
|
export interface SRTIngress {
|
|
19435
19883
|
address: string;
|
|
19436
19884
|
}
|
|
19885
|
+
export interface SaveConfigVersionRequest {
|
|
19886
|
+
/**
|
|
19887
|
+
* Latest version the edit was based on, 0 for a policy without versions. The save is rejected when a newer version exists
|
|
19888
|
+
*/
|
|
19889
|
+
base_version: number;
|
|
19890
|
+
/**
|
|
19891
|
+
* Unique identifier for the moderation configuration
|
|
19892
|
+
*/
|
|
19893
|
+
key: string;
|
|
19894
|
+
/**
|
|
19895
|
+
* Whether moderation should be performed asynchronously
|
|
19896
|
+
*/
|
|
19897
|
+
async?: boolean;
|
|
19898
|
+
/**
|
|
19899
|
+
* Team associated with the configuration
|
|
19900
|
+
*/
|
|
19901
|
+
team?: string;
|
|
19902
|
+
/**
|
|
19903
|
+
* Optional user ID to associate with the audit log entry
|
|
19904
|
+
*/
|
|
19905
|
+
user_id?: string;
|
|
19906
|
+
ai_audio_config?: AIAudioConfigRequest;
|
|
19907
|
+
ai_image_config?: AIImageConfig;
|
|
19908
|
+
ai_text_config?: AITextConfig;
|
|
19909
|
+
ai_video_config?: AIVideoConfigRequest;
|
|
19910
|
+
automod_platform_circumvention_config?: AutomodPlatformCircumventionConfig;
|
|
19911
|
+
automod_semantic_filters_config?: AutomodSemanticFiltersConfig;
|
|
19912
|
+
automod_toxicity_config?: AutomodToxicityConfig;
|
|
19913
|
+
aws_rekognition_config?: AIImageConfig;
|
|
19914
|
+
block_list_config?: BlockListConfig;
|
|
19915
|
+
bodyguard_config?: AITextConfig;
|
|
19916
|
+
engine?: ModerationEngineConfigRequest;
|
|
19917
|
+
flood_config?: FloodConfig;
|
|
19918
|
+
google_vision_config?: GoogleVisionConfig;
|
|
19919
|
+
intent_config?: IntentConfigRequest;
|
|
19920
|
+
llm_config?: LLMConfig;
|
|
19921
|
+
rule_builder_config?: RuleBuilderConfig;
|
|
19922
|
+
/**
|
|
19923
|
+
* User request object
|
|
19924
|
+
*/
|
|
19925
|
+
user?: UserRequest;
|
|
19926
|
+
velocity_filter_config?: VelocityFilterConfig;
|
|
19927
|
+
video_call_rule_config?: VideoCallRuleConfig;
|
|
19928
|
+
}
|
|
19929
|
+
export interface SaveConfigVersionResponse {
|
|
19930
|
+
duration: string;
|
|
19931
|
+
version: ConfigVersionResponse;
|
|
19932
|
+
/**
|
|
19933
|
+
* The version moderation currently runs
|
|
19934
|
+
*/
|
|
19935
|
+
published_version?: number;
|
|
19936
|
+
}
|
|
19437
19937
|
export interface ScheduledMessageChannelResponse {
|
|
19438
19938
|
/**
|
|
19439
19939
|
* Channel CID (<type>:<id>)
|
|
@@ -19672,6 +20172,86 @@ export interface ScreensharingSettingsResponse {
|
|
|
19672
20172
|
enabled: boolean;
|
|
19673
20173
|
target_resolution?: TargetResolution;
|
|
19674
20174
|
}
|
|
20175
|
+
export interface SearchAllChannelsSection {
|
|
20176
|
+
/**
|
|
20177
|
+
* Opaque cursor for the next page of this section, present only when more results exist. Pass it back under next.channels with the same query
|
|
20178
|
+
*/
|
|
20179
|
+
next?: string;
|
|
20180
|
+
/**
|
|
20181
|
+
* Channels the caller is a member of whose name starts with the query, in the same shape as the query channels endpoint's results but without messages or members
|
|
20182
|
+
*/
|
|
20183
|
+
channels?: Array<ChannelStateResponseFields>;
|
|
20184
|
+
error?: SearchAllSectionError;
|
|
20185
|
+
warning?: SearchAllWarning;
|
|
20186
|
+
}
|
|
20187
|
+
export interface SearchAllMessagesSection {
|
|
20188
|
+
/**
|
|
20189
|
+
* Opaque cursor for the next page of this section, present only when more results exist. Pass it back under next.messages with the same query
|
|
20190
|
+
*/
|
|
20191
|
+
next?: string;
|
|
20192
|
+
/**
|
|
20193
|
+
* Matching messages, newest first, in the same shape as the search endpoint's results
|
|
20194
|
+
*/
|
|
20195
|
+
results?: Array<SearchResult>;
|
|
20196
|
+
error?: SearchAllSectionError;
|
|
20197
|
+
results_warning?: SearchWarning;
|
|
20198
|
+
warning?: SearchAllWarning;
|
|
20199
|
+
}
|
|
20200
|
+
export interface SearchAllRequest {
|
|
20201
|
+
/**
|
|
20202
|
+
* Number of results per section, 1-30. Defaults to 10. Applies to every requested section; there is no per-section limit
|
|
20203
|
+
*/
|
|
20204
|
+
limit?: number;
|
|
20205
|
+
/**
|
|
20206
|
+
* Free-text search phrase, 1-80 characters after trimming whitespace. Required. Matched as a prefix of a user's name or username and of a channel's name, and as full-text against message text
|
|
20207
|
+
*/
|
|
20208
|
+
query?: string;
|
|
20209
|
+
/**
|
|
20210
|
+
* Which sections to search: any subset of messages, users and channels. Defaults to all three when omitted; must not be empty when provided. Response sections always appear in the order messages, users, channels
|
|
20211
|
+
*/
|
|
20212
|
+
entities?: Array<string>;
|
|
20213
|
+
/**
|
|
20214
|
+
* Opaque pagination cursors from a previous response, keyed by entity. A cursor that fails to decode restarts that section from page 1 with a cursor_rejected warning; the request fails with 400 only when every cursor supplied for a requested entity is invalid. Cursors for entities not in entities are ignored
|
|
20215
|
+
*/
|
|
20216
|
+
next?: Record<string, string>;
|
|
20217
|
+
}
|
|
20218
|
+
export interface SearchAllResponse {
|
|
20219
|
+
/**
|
|
20220
|
+
* Duration of the request in milliseconds
|
|
20221
|
+
*/
|
|
20222
|
+
duration: string;
|
|
20223
|
+
channels?: SearchAllChannelsSection;
|
|
20224
|
+
messages?: SearchAllMessagesSection;
|
|
20225
|
+
users?: SearchAllUsersSection;
|
|
20226
|
+
}
|
|
20227
|
+
export interface SearchAllSectionError {
|
|
20228
|
+
/**
|
|
20229
|
+
* Error code. backend_timeout and backend_unavailable are retryable; unsupported (the app's configuration cannot serve this section) and internal_error are not
|
|
20230
|
+
*/
|
|
20231
|
+
code: 'backend_unavailable' | 'backend_timeout' | 'unsupported' | 'internal_error';
|
|
20232
|
+
/**
|
|
20233
|
+
* Human-readable description of the failure
|
|
20234
|
+
*/
|
|
20235
|
+
message: string;
|
|
20236
|
+
}
|
|
20237
|
+
export interface SearchAllUsersSection {
|
|
20238
|
+
/**
|
|
20239
|
+
* Opaque cursor for the next page of this section, present only when more results exist. Pass it back under next.users with the same query
|
|
20240
|
+
*/
|
|
20241
|
+
next?: string;
|
|
20242
|
+
/**
|
|
20243
|
+
* Users whose name or username starts with the query, in the same shape as the query users endpoint's results
|
|
20244
|
+
*/
|
|
20245
|
+
users?: Array<FullUserResponse>;
|
|
20246
|
+
error?: SearchAllSectionError;
|
|
20247
|
+
warning?: SearchAllWarning;
|
|
20248
|
+
}
|
|
20249
|
+
export interface SearchAllWarning {
|
|
20250
|
+
/**
|
|
20251
|
+
* Warning code. cursor_rejected: the cursor supplied for this section failed to decode, so the section restarted from page 1
|
|
20252
|
+
*/
|
|
20253
|
+
code: 'cursor_rejected';
|
|
20254
|
+
}
|
|
19675
20255
|
export interface SearchPayload {
|
|
19676
20256
|
/**
|
|
19677
20257
|
* Channel filter conditions
|
|
@@ -20485,9 +21065,9 @@ export interface StoriesFeedUpdatedEvent {
|
|
|
20485
21065
|
}
|
|
20486
21066
|
export interface SubmitActionRequest {
|
|
20487
21067
|
/**
|
|
20488
|
-
* Type of moderation action to perform. One of: mark_reviewed, delete_message, delete_activity, delete_comment, delete_reaction, delete_poll, delete_poll_option, delete_poll_answer, ban, custom, unban, restore, delete_user, delete_user_messages, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate
|
|
21068
|
+
* Type of moderation action to perform. One of: mark_reviewed, delete_message, delete_activity, delete_comment, delete_reaction, delete_poll, delete_poll_option, delete_poll_answer, ban, custom, unban, restore, delete_user, delete_user_messages, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate, agent_recommendation
|
|
20489
21069
|
*/
|
|
20490
|
-
action_type: 'flag' | 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_comment' | 'delete_reaction' | 'delete_poll' | 'delete_poll_option' | 'delete_poll_answer' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'delete_user_messages' | 'unblock' | 'block' | 'shadow_block' | 'unmask' | 'kick_user' | 'end_call' | 'reject_appeal' | 'escalate' | 'de_escalate' | 'bypass';
|
|
21070
|
+
action_type: 'flag' | 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_comment' | 'delete_reaction' | 'delete_poll' | 'delete_poll_option' | 'delete_poll_answer' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'delete_user_messages' | 'unblock' | 'block' | 'shadow_block' | 'unmask' | 'kick_user' | 'end_call' | 'reject_appeal' | 'escalate' | 'de_escalate' | 'bypass' | 'agent_recommendation';
|
|
20491
21071
|
/**
|
|
20492
21072
|
* UUID of the appeal to act on (required for reject_appeal, optional for other actions)
|
|
20493
21073
|
*/
|
|
@@ -20497,6 +21077,7 @@ export interface SubmitActionRequest {
|
|
|
20497
21077
|
*/
|
|
20498
21078
|
item_id?: string;
|
|
20499
21079
|
user_id?: string;
|
|
21080
|
+
agent_recommendation?: AgentRecommendationPayload;
|
|
20500
21081
|
/**
|
|
20501
21082
|
* Configuration for ban moderation action
|
|
20502
21083
|
*/
|
|
@@ -20590,6 +21171,84 @@ export interface SubmitActionResponse {
|
|
|
20590
21171
|
appeal_item?: AppealItemResponse;
|
|
20591
21172
|
item?: ReviewQueueItemResponse;
|
|
20592
21173
|
}
|
|
21174
|
+
export interface SubmitAgentFeedbackRequest {
|
|
21175
|
+
/**
|
|
21176
|
+
* Review queue item Nora reviewed
|
|
21177
|
+
*/
|
|
21178
|
+
item_id: string;
|
|
21179
|
+
/**
|
|
21180
|
+
* Action the moderator took
|
|
21181
|
+
*/
|
|
21182
|
+
moderator_action: string;
|
|
21183
|
+
/**
|
|
21184
|
+
* How similar cases should be judged, up to 2000 characters
|
|
21185
|
+
*/
|
|
21186
|
+
improvement?: string;
|
|
21187
|
+
/**
|
|
21188
|
+
* Why the moderator disagreed, up to 2000 characters
|
|
21189
|
+
*/
|
|
21190
|
+
reason?: string;
|
|
21191
|
+
user_id?: string;
|
|
21192
|
+
/**
|
|
21193
|
+
* User request object
|
|
21194
|
+
*/
|
|
21195
|
+
user?: UserRequest;
|
|
21196
|
+
}
|
|
21197
|
+
export interface SubmitAgentFeedbackResponse {
|
|
21198
|
+
/**
|
|
21199
|
+
* Nora review this correction is about
|
|
21200
|
+
*/
|
|
21201
|
+
agent_review_id: string;
|
|
21202
|
+
/**
|
|
21203
|
+
* Text of the item when the correction was saved
|
|
21204
|
+
*/
|
|
21205
|
+
content_excerpt: string;
|
|
21206
|
+
/**
|
|
21207
|
+
* When the correction was first saved
|
|
21208
|
+
*/
|
|
21209
|
+
created_at: TimestampNS;
|
|
21210
|
+
/**
|
|
21211
|
+
* Moderator who submitted the correction
|
|
21212
|
+
*/
|
|
21213
|
+
created_by: string;
|
|
21214
|
+
duration: string;
|
|
21215
|
+
/**
|
|
21216
|
+
* Entity type of the queue item
|
|
21217
|
+
*/
|
|
21218
|
+
entity_type: string;
|
|
21219
|
+
/**
|
|
21220
|
+
* Feedback row id
|
|
21221
|
+
*/
|
|
21222
|
+
id: string;
|
|
21223
|
+
/**
|
|
21224
|
+
* How similar cases should be judged
|
|
21225
|
+
*/
|
|
21226
|
+
improvement: string;
|
|
21227
|
+
/**
|
|
21228
|
+
* Review queue item the correction is about
|
|
21229
|
+
*/
|
|
21230
|
+
item_id: string;
|
|
21231
|
+
/**
|
|
21232
|
+
* Action the moderator took
|
|
21233
|
+
*/
|
|
21234
|
+
moderator_action: string;
|
|
21235
|
+
/**
|
|
21236
|
+
* Policy action Nora recommended
|
|
21237
|
+
*/
|
|
21238
|
+
nora_action: 'keep' | 'flag' | 'mask' | 'mask_flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
|
|
21239
|
+
/**
|
|
21240
|
+
* Why the moderator disagreed
|
|
21241
|
+
*/
|
|
21242
|
+
reason: string;
|
|
21243
|
+
/**
|
|
21244
|
+
* When the correction was last saved
|
|
21245
|
+
*/
|
|
21246
|
+
updated_at: TimestampNS;
|
|
21247
|
+
/**
|
|
21248
|
+
* Labels Nora matched on this review
|
|
21249
|
+
*/
|
|
21250
|
+
labels: Array<string>;
|
|
21251
|
+
}
|
|
20593
21252
|
export interface SubmitModerationFeedbackItem {
|
|
20594
21253
|
/**
|
|
20595
21254
|
* Action originally produced for this item
|
|
@@ -20825,6 +21484,7 @@ export interface TextContentParameters {
|
|
|
20825
21484
|
text_length_operator?: string;
|
|
20826
21485
|
blocklist_match?: Array<string>;
|
|
20827
21486
|
harm_labels?: Array<string>;
|
|
21487
|
+
severities?: Array<string>;
|
|
20828
21488
|
llm_harm_labels?: Record<string, string>;
|
|
20829
21489
|
}
|
|
20830
21490
|
export interface TextRuleParameters {
|
|
@@ -20836,6 +21496,7 @@ export interface TextRuleParameters {
|
|
|
20836
21496
|
blocklist_match?: Array<string>;
|
|
20837
21497
|
harm_labels?: Array<string>;
|
|
20838
21498
|
semantic_filter_names?: Array<string>;
|
|
21499
|
+
severities?: Array<string>;
|
|
20839
21500
|
llm_harm_labels?: Record<string, string>;
|
|
20840
21501
|
}
|
|
20841
21502
|
export interface ThreadParticipant {
|
|
@@ -21808,6 +22469,10 @@ export interface UpdateAppRequest {
|
|
|
21808
22469
|
user_search_disallowed_roles?: Array<string>;
|
|
21809
22470
|
webhook_events?: Array<string>;
|
|
21810
22471
|
activity_metrics_config?: Record<string, number>;
|
|
22472
|
+
/**
|
|
22473
|
+
* Settings for the moderation agent reviewer, which reviews moderation outcomes and proposes or applies an action.
|
|
22474
|
+
*/
|
|
22475
|
+
agent_review?: AgentReviewSettingsPayload;
|
|
21811
22476
|
apn_config?: APNConfig;
|
|
21812
22477
|
async_moderation_config?: AsyncModerationConfiguration;
|
|
21813
22478
|
datadog_info?: DataDogInfo;
|
|
@@ -23539,6 +24204,7 @@ export interface UserCustomEventRequest {
|
|
|
23539
24204
|
custom?: Record<string, any>;
|
|
23540
24205
|
}
|
|
23541
24206
|
export interface UserCustomPropertyParameters {
|
|
24207
|
+
expected_value?: any;
|
|
23542
24208
|
operator?: string;
|
|
23543
24209
|
property_key?: string;
|
|
23544
24210
|
}
|