syllable-sdk 0.1.0-alpha.46 → 0.1.0-alpha.47
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/README.md +34 -0
- package/docs/sdks/insights/README.md +6 -0
- package/docs/sdks/summary/README.md +85 -0
- package/docs/sdks/syllablesdktools/README.md +411 -0
- package/docs/sdks/workflows/README.md +429 -0
- package/funcs/insightsToolsCreate.d.ts +16 -0
- package/funcs/insightsToolsCreate.d.ts.map +1 -0
- package/funcs/insightsToolsCreate.js +102 -0
- package/funcs/insightsToolsCreate.js.map +1 -0
- package/funcs/insightsToolsGetById.d.ts +17 -0
- package/funcs/insightsToolsGetById.d.ts.map +1 -0
- package/funcs/insightsToolsGetById.js +108 -0
- package/funcs/insightsToolsGetById.js.map +1 -0
- package/funcs/insightsToolsInsightToolGetDefinitions.d.ts +15 -0
- package/funcs/insightsToolsInsightToolGetDefinitions.d.ts.map +1 -0
- package/funcs/insightsToolsInsightToolGetDefinitions.js +89 -0
- package/funcs/insightsToolsInsightToolGetDefinitions.js.map +1 -0
- package/funcs/insightsToolsList.d.ts +17 -0
- package/funcs/insightsToolsList.d.ts.map +1 -0
- package/funcs/insightsToolsList.js +114 -0
- package/funcs/insightsToolsList.js.map +1 -0
- package/funcs/insightsToolsUpdate.d.ts +17 -0
- package/funcs/insightsToolsUpdate.d.ts.map +1 -0
- package/funcs/insightsToolsUpdate.js +109 -0
- package/funcs/insightsToolsUpdate.js.map +1 -0
- package/funcs/insightsWorkflowsCreate.d.ts +16 -0
- package/funcs/insightsWorkflowsCreate.d.ts.map +1 -0
- package/funcs/insightsWorkflowsCreate.js +102 -0
- package/funcs/insightsWorkflowsCreate.js.map +1 -0
- package/funcs/insightsWorkflowsDelete.d.ts +16 -0
- package/funcs/insightsWorkflowsDelete.d.ts.map +1 -0
- package/funcs/insightsWorkflowsDelete.js +108 -0
- package/funcs/insightsWorkflowsDelete.js.map +1 -0
- package/funcs/insightsWorkflowsGetById.d.ts +17 -0
- package/funcs/insightsWorkflowsGetById.d.ts.map +1 -0
- package/funcs/insightsWorkflowsGetById.js +108 -0
- package/funcs/insightsWorkflowsGetById.js.map +1 -0
- package/funcs/insightsWorkflowsList.d.ts +17 -0
- package/funcs/insightsWorkflowsList.d.ts.map +1 -0
- package/funcs/insightsWorkflowsList.js +114 -0
- package/funcs/insightsWorkflowsList.js.map +1 -0
- package/funcs/insightsWorkflowsUpdate.d.ts +17 -0
- package/funcs/insightsWorkflowsUpdate.d.ts.map +1 -0
- package/funcs/insightsWorkflowsUpdate.js +111 -0
- package/funcs/insightsWorkflowsUpdate.js.map +1 -0
- package/funcs/sessionsSummaryGetById.d.ts +13 -0
- package/funcs/sessionsSummaryGetById.d.ts.map +1 -0
- package/funcs/sessionsSummaryGetById.js +105 -0
- package/funcs/sessionsSummaryGetById.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/mintlify/mint.json +4 -2
- package/models/components/index.d.ts +9 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +9 -0
- package/models/components/index.js.map +1 -1
- package/models/components/insighttooldefinition.d.ts +105 -0
- package/models/components/insighttooldefinition.d.ts.map +1 -0
- package/models/components/insighttooldefinition.js +126 -0
- package/models/components/insighttooldefinition.js.map +1 -0
- package/models/components/insighttoolinput.d.ts +76 -0
- package/models/components/insighttoolinput.d.ts.map +1 -0
- package/models/components/insighttoolinput.js +101 -0
- package/models/components/insighttoolinput.js.map +1 -0
- package/models/components/insighttooloutput.d.ts +102 -0
- package/models/components/insighttooloutput.d.ts.map +1 -0
- package/models/components/insighttooloutput.js +124 -0
- package/models/components/insighttooloutput.js.map +1 -0
- package/models/components/insighttoolproperties.d.ts +40 -0
- package/models/components/insighttoolproperties.d.ts.map +1 -0
- package/models/components/insighttoolproperties.js +54 -0
- package/models/components/insighttoolproperties.js.map +1 -0
- package/models/components/insightworkflowinput.d.ts +76 -0
- package/models/components/insightworkflowinput.d.ts.map +1 -0
- package/models/components/insightworkflowinput.js +99 -0
- package/models/components/insightworkflowinput.js.map +1 -0
- package/models/components/insightworkflowoutput.d.ts +102 -0
- package/models/components/insightworkflowoutput.d.ts.map +1 -0
- package/models/components/insightworkflowoutput.js +120 -0
- package/models/components/insightworkflowoutput.js.map +1 -0
- package/models/components/insightworkflowproperties.d.ts +43 -0
- package/models/components/insightworkflowproperties.d.ts.map +1 -0
- package/models/components/insightworkflowproperties.js +55 -0
- package/models/components/insightworkflowproperties.js.map +1 -0
- package/models/components/listresponseinsighttooloutput.d.ts +38 -0
- package/models/components/listresponseinsighttooloutput.d.ts.map +1 -0
- package/models/components/listresponseinsighttooloutput.js +81 -0
- package/models/components/listresponseinsighttooloutput.js.map +1 -0
- package/models/components/listresponseinsightworkflowoutput.d.ts +38 -0
- package/models/components/listresponseinsightworkflowoutput.d.ts.map +1 -0
- package/models/components/listresponseinsightworkflowoutput.js +81 -0
- package/models/components/listresponseinsightworkflowoutput.js.map +1 -0
- package/models/operations/directoryworkflowdelete.d.ts +29 -0
- package/models/operations/directoryworkflowdelete.d.ts.map +1 -0
- package/models/operations/directoryworkflowdelete.js +68 -0
- package/models/operations/directoryworkflowdelete.js.map +1 -0
- package/models/operations/index.d.ts +8 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +8 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/insightstoolupdate.d.ts +32 -0
- package/models/operations/insightstoolupdate.d.ts.map +1 -0
- package/models/operations/insightstoolupdate.js +73 -0
- package/models/operations/insightstoolupdate.js.map +1 -0
- package/models/operations/insightsworkflowgetbyid.d.ts +29 -0
- package/models/operations/insightsworkflowgetbyid.d.ts.map +1 -0
- package/models/operations/insightsworkflowgetbyid.js +68 -0
- package/models/operations/insightsworkflowgetbyid.js.map +1 -0
- package/models/operations/insightsworkflowlist.d.ts +46 -0
- package/models/operations/insightsworkflowlist.d.ts.map +1 -0
- package/models/operations/insightsworkflowlist.js +101 -0
- package/models/operations/insightsworkflowlist.js.map +1 -0
- package/models/operations/insightsworkflowupdate.d.ts +32 -0
- package/models/operations/insightsworkflowupdate.d.ts.map +1 -0
- package/models/operations/insightsworkflowupdate.js +73 -0
- package/models/operations/insightsworkflowupdate.js.map +1 -0
- package/models/operations/insighttoolgetbyid.d.ts +29 -0
- package/models/operations/insighttoolgetbyid.d.ts.map +1 -0
- package/models/operations/insighttoolgetbyid.js +68 -0
- package/models/operations/insighttoolgetbyid.js.map +1 -0
- package/models/operations/insighttoollist.d.ts +46 -0
- package/models/operations/insighttoollist.d.ts.map +1 -0
- package/models/operations/insighttoollist.js +103 -0
- package/models/operations/insighttoollist.js.map +1 -0
- package/models/operations/sessionsummarygetbyid.d.ts +29 -0
- package/models/operations/sessionsummarygetbyid.d.ts.map +1 -0
- package/models/operations/sessionsummarygetbyid.js +68 -0
- package/models/operations/sessionsummarygetbyid.js.map +1 -0
- package/openapi.json +1255 -35
- package/package.json +1 -1
- package/sdk/insights.d.ts +10 -0
- package/sdk/insights.d.ts.map +1 -0
- package/sdk/insights.js +19 -0
- package/sdk/insights.js.map +1 -0
- package/sdk/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/sessions.d.ts +3 -0
- package/sdk/sessions.d.ts.map +1 -1
- package/sdk/sessions.js +4 -0
- package/sdk/sessions.js.map +1 -1
- package/sdk/summary.d.ts +9 -0
- package/sdk/summary.d.ts.map +1 -0
- package/sdk/summary.js +19 -0
- package/sdk/summary.js.map +1 -0
- package/sdk/syllablesdktools.d.ts +41 -0
- package/sdk/syllablesdktools.d.ts.map +1 -0
- package/sdk/syllablesdktools.js +62 -0
- package/sdk/syllablesdktools.js.map +1 -0
- package/sdk/workflows.d.ts +41 -0
- package/sdk/workflows.d.ts.map +1 -0
- package/sdk/workflows.js +62 -0
- package/sdk/workflows.js.map +1 -0
- package/src/funcs/insightsToolsCreate.ts +135 -0
- package/src/funcs/insightsToolsGetById.ts +142 -0
- package/src/funcs/insightsToolsInsightToolGetDefinitions.ts +112 -0
- package/src/funcs/insightsToolsList.ts +148 -0
- package/src/funcs/insightsToolsUpdate.ts +143 -0
- package/src/funcs/insightsWorkflowsCreate.ts +135 -0
- package/src/funcs/insightsWorkflowsDelete.ts +145 -0
- package/src/funcs/insightsWorkflowsGetById.ts +145 -0
- package/src/funcs/insightsWorkflowsList.ts +149 -0
- package/src/funcs/insightsWorkflowsUpdate.ts +148 -0
- package/src/funcs/sessionsSummaryGetById.ts +140 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/index.ts +9 -0
- package/src/models/components/insighttooldefinition.ts +213 -0
- package/src/models/components/insighttoolinput.ts +163 -0
- package/src/models/components/insighttooloutput.ts +210 -0
- package/src/models/components/insighttoolproperties.ts +37 -0
- package/src/models/components/insightworkflowinput.ts +161 -0
- package/src/models/components/insightworkflowoutput.ts +206 -0
- package/src/models/components/insightworkflowproperties.ts +40 -0
- package/src/models/components/listresponseinsighttooloutput.ts +103 -0
- package/src/models/components/listresponseinsightworkflowoutput.ts +104 -0
- package/src/models/operations/directoryworkflowdelete.ts +77 -0
- package/src/models/operations/index.ts +8 -0
- package/src/models/operations/insightstoolupdate.ts +82 -0
- package/src/models/operations/insightsworkflowgetbyid.ts +77 -0
- package/src/models/operations/insightsworkflowlist.ts +130 -0
- package/src/models/operations/insightsworkflowupdate.ts +84 -0
- package/src/models/operations/insighttoolgetbyid.ts +75 -0
- package/src/models/operations/insighttoollist.ts +126 -0
- package/src/models/operations/sessionsummarygetbyid.ts +77 -0
- package/src/sdk/insights.ts +19 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/sessions.ts +6 -0
- package/src/sdk/summary.ts +24 -0
- package/src/sdk/syllablesdktools.ts +98 -0
- package/src/sdk/workflows.ts +100 -0
package/openapi.json
CHANGED
|
@@ -1397,6 +1397,778 @@
|
|
|
1397
1397
|
}
|
|
1398
1398
|
}
|
|
1399
1399
|
},
|
|
1400
|
+
"/api/v1/insights/workflows/": {
|
|
1401
|
+
"get": {
|
|
1402
|
+
"tags": [
|
|
1403
|
+
"insights.workflows",
|
|
1404
|
+
"V1"
|
|
1405
|
+
],
|
|
1406
|
+
"summary": "Insight Workflow List",
|
|
1407
|
+
"description": "List the existing insight_workflows",
|
|
1408
|
+
"operationId": "insights_workflow_list",
|
|
1409
|
+
"security": [
|
|
1410
|
+
{
|
|
1411
|
+
"APIKeyHeader": []
|
|
1412
|
+
}
|
|
1413
|
+
],
|
|
1414
|
+
"parameters": [
|
|
1415
|
+
{
|
|
1416
|
+
"name": "page",
|
|
1417
|
+
"in": "query",
|
|
1418
|
+
"required": false,
|
|
1419
|
+
"schema": {
|
|
1420
|
+
"anyOf": [
|
|
1421
|
+
{
|
|
1422
|
+
"type": "integer",
|
|
1423
|
+
"minimum": 0
|
|
1424
|
+
},
|
|
1425
|
+
{
|
|
1426
|
+
"type": "null"
|
|
1427
|
+
}
|
|
1428
|
+
],
|
|
1429
|
+
"default": 0,
|
|
1430
|
+
"title": "Page"
|
|
1431
|
+
}
|
|
1432
|
+
},
|
|
1433
|
+
{
|
|
1434
|
+
"name": "limit",
|
|
1435
|
+
"in": "query",
|
|
1436
|
+
"required": false,
|
|
1437
|
+
"schema": {
|
|
1438
|
+
"type": "integer",
|
|
1439
|
+
"minimum": 0,
|
|
1440
|
+
"default": 25,
|
|
1441
|
+
"title": "Limit"
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
{
|
|
1445
|
+
"name": "search_fields",
|
|
1446
|
+
"in": "query",
|
|
1447
|
+
"required": false,
|
|
1448
|
+
"schema": {
|
|
1449
|
+
"type": "array",
|
|
1450
|
+
"items": {
|
|
1451
|
+
"$ref": "#/components/schemas/InsightWorkflowProperties"
|
|
1452
|
+
},
|
|
1453
|
+
"default": [],
|
|
1454
|
+
"title": "Search Fields"
|
|
1455
|
+
}
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"name": "search_field_values",
|
|
1459
|
+
"in": "query",
|
|
1460
|
+
"required": false,
|
|
1461
|
+
"schema": {
|
|
1462
|
+
"type": "array",
|
|
1463
|
+
"items": {
|
|
1464
|
+
"type": "string"
|
|
1465
|
+
},
|
|
1466
|
+
"default": [],
|
|
1467
|
+
"title": "Search Field Values"
|
|
1468
|
+
}
|
|
1469
|
+
},
|
|
1470
|
+
{
|
|
1471
|
+
"name": "order_by",
|
|
1472
|
+
"in": "query",
|
|
1473
|
+
"required": false,
|
|
1474
|
+
"schema": {
|
|
1475
|
+
"anyOf": [
|
|
1476
|
+
{
|
|
1477
|
+
"$ref": "#/components/schemas/InsightWorkflowProperties"
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"type": "null"
|
|
1481
|
+
}
|
|
1482
|
+
],
|
|
1483
|
+
"title": "Order By"
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
{
|
|
1487
|
+
"name": "order_by_direction",
|
|
1488
|
+
"in": "query",
|
|
1489
|
+
"required": false,
|
|
1490
|
+
"schema": {
|
|
1491
|
+
"anyOf": [
|
|
1492
|
+
{
|
|
1493
|
+
"$ref": "#/components/schemas/OrderByDirection"
|
|
1494
|
+
},
|
|
1495
|
+
{
|
|
1496
|
+
"type": "null"
|
|
1497
|
+
}
|
|
1498
|
+
],
|
|
1499
|
+
"title": "Order By Direction"
|
|
1500
|
+
}
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
"name": "fields",
|
|
1504
|
+
"in": "query",
|
|
1505
|
+
"required": false,
|
|
1506
|
+
"schema": {
|
|
1507
|
+
"anyOf": [
|
|
1508
|
+
{
|
|
1509
|
+
"type": "array",
|
|
1510
|
+
"items": {
|
|
1511
|
+
"$ref": "#/components/schemas/InsightWorkflowProperties"
|
|
1512
|
+
}
|
|
1513
|
+
},
|
|
1514
|
+
{
|
|
1515
|
+
"type": "null"
|
|
1516
|
+
}
|
|
1517
|
+
],
|
|
1518
|
+
"default": [],
|
|
1519
|
+
"title": "Fields"
|
|
1520
|
+
}
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"name": "start_datetime",
|
|
1524
|
+
"in": "query",
|
|
1525
|
+
"required": false,
|
|
1526
|
+
"schema": {
|
|
1527
|
+
"anyOf": [
|
|
1528
|
+
{
|
|
1529
|
+
"type": "string"
|
|
1530
|
+
},
|
|
1531
|
+
{
|
|
1532
|
+
"type": "null"
|
|
1533
|
+
}
|
|
1534
|
+
],
|
|
1535
|
+
"title": "Start Datetime"
|
|
1536
|
+
}
|
|
1537
|
+
},
|
|
1538
|
+
{
|
|
1539
|
+
"name": "end_datetime",
|
|
1540
|
+
"in": "query",
|
|
1541
|
+
"required": false,
|
|
1542
|
+
"schema": {
|
|
1543
|
+
"anyOf": [
|
|
1544
|
+
{
|
|
1545
|
+
"type": "string"
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
"type": "null"
|
|
1549
|
+
}
|
|
1550
|
+
],
|
|
1551
|
+
"title": "End Datetime"
|
|
1552
|
+
}
|
|
1553
|
+
}
|
|
1554
|
+
],
|
|
1555
|
+
"responses": {
|
|
1556
|
+
"200": {
|
|
1557
|
+
"description": "Successful Response",
|
|
1558
|
+
"content": {
|
|
1559
|
+
"application/json": {
|
|
1560
|
+
"schema": {
|
|
1561
|
+
"$ref": "#/components/schemas/ListResponse_InsightWorkflowOutput_"
|
|
1562
|
+
}
|
|
1563
|
+
}
|
|
1564
|
+
}
|
|
1565
|
+
},
|
|
1566
|
+
"422": {
|
|
1567
|
+
"description": "Validation Error",
|
|
1568
|
+
"content": {
|
|
1569
|
+
"application/json": {
|
|
1570
|
+
"schema": {
|
|
1571
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1572
|
+
}
|
|
1573
|
+
}
|
|
1574
|
+
}
|
|
1575
|
+
}
|
|
1576
|
+
}
|
|
1577
|
+
},
|
|
1578
|
+
"post": {
|
|
1579
|
+
"tags": [
|
|
1580
|
+
"insights.workflows",
|
|
1581
|
+
"V1"
|
|
1582
|
+
],
|
|
1583
|
+
"summary": "Create Insight Workflow",
|
|
1584
|
+
"description": "Create a new tool in the insights",
|
|
1585
|
+
"operationId": "insights_workflow_create",
|
|
1586
|
+
"security": [
|
|
1587
|
+
{
|
|
1588
|
+
"APIKeyHeader": []
|
|
1589
|
+
}
|
|
1590
|
+
],
|
|
1591
|
+
"requestBody": {
|
|
1592
|
+
"required": true,
|
|
1593
|
+
"content": {
|
|
1594
|
+
"application/json": {
|
|
1595
|
+
"schema": {
|
|
1596
|
+
"$ref": "#/components/schemas/InsightWorkflowInput"
|
|
1597
|
+
}
|
|
1598
|
+
}
|
|
1599
|
+
}
|
|
1600
|
+
},
|
|
1601
|
+
"responses": {
|
|
1602
|
+
"200": {
|
|
1603
|
+
"description": "Successful Response",
|
|
1604
|
+
"content": {
|
|
1605
|
+
"application/json": {
|
|
1606
|
+
"schema": {
|
|
1607
|
+
"$ref": "#/components/schemas/InsightWorkflowOutput"
|
|
1608
|
+
}
|
|
1609
|
+
}
|
|
1610
|
+
}
|
|
1611
|
+
},
|
|
1612
|
+
"422": {
|
|
1613
|
+
"description": "Validation Error",
|
|
1614
|
+
"content": {
|
|
1615
|
+
"application/json": {
|
|
1616
|
+
"schema": {
|
|
1617
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1618
|
+
}
|
|
1619
|
+
}
|
|
1620
|
+
}
|
|
1621
|
+
}
|
|
1622
|
+
}
|
|
1623
|
+
}
|
|
1624
|
+
},
|
|
1625
|
+
"/api/v1/insights/workflows/{workflow_id}": {
|
|
1626
|
+
"get": {
|
|
1627
|
+
"tags": [
|
|
1628
|
+
"insights.workflows",
|
|
1629
|
+
"V1"
|
|
1630
|
+
],
|
|
1631
|
+
"summary": "Get Insight Workflow By Id",
|
|
1632
|
+
"description": "Get a InsightWorkflow by ID.",
|
|
1633
|
+
"operationId": "insights_workflow_get_by_id",
|
|
1634
|
+
"security": [
|
|
1635
|
+
{
|
|
1636
|
+
"APIKeyHeader": []
|
|
1637
|
+
}
|
|
1638
|
+
],
|
|
1639
|
+
"parameters": [
|
|
1640
|
+
{
|
|
1641
|
+
"name": "workflow_id",
|
|
1642
|
+
"in": "path",
|
|
1643
|
+
"required": true,
|
|
1644
|
+
"schema": {
|
|
1645
|
+
"type": "integer",
|
|
1646
|
+
"title": "Workflow Id"
|
|
1647
|
+
}
|
|
1648
|
+
}
|
|
1649
|
+
],
|
|
1650
|
+
"responses": {
|
|
1651
|
+
"200": {
|
|
1652
|
+
"description": "Successful Response",
|
|
1653
|
+
"content": {
|
|
1654
|
+
"application/json": {
|
|
1655
|
+
"schema": {
|
|
1656
|
+
"$ref": "#/components/schemas/InsightWorkflowOutput"
|
|
1657
|
+
}
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
},
|
|
1661
|
+
"422": {
|
|
1662
|
+
"description": "Validation Error",
|
|
1663
|
+
"content": {
|
|
1664
|
+
"application/json": {
|
|
1665
|
+
"schema": {
|
|
1666
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1667
|
+
}
|
|
1668
|
+
}
|
|
1669
|
+
}
|
|
1670
|
+
}
|
|
1671
|
+
}
|
|
1672
|
+
},
|
|
1673
|
+
"put": {
|
|
1674
|
+
"tags": [
|
|
1675
|
+
"insights.workflows",
|
|
1676
|
+
"V1"
|
|
1677
|
+
],
|
|
1678
|
+
"summary": "Update Insights Workflow",
|
|
1679
|
+
"description": "Update a InsightWorkflow.",
|
|
1680
|
+
"operationId": "insights_workflow_update",
|
|
1681
|
+
"security": [
|
|
1682
|
+
{
|
|
1683
|
+
"APIKeyHeader": []
|
|
1684
|
+
}
|
|
1685
|
+
],
|
|
1686
|
+
"parameters": [
|
|
1687
|
+
{
|
|
1688
|
+
"name": "workflow_id",
|
|
1689
|
+
"in": "path",
|
|
1690
|
+
"required": true,
|
|
1691
|
+
"schema": {
|
|
1692
|
+
"type": "integer",
|
|
1693
|
+
"title": "Workflow Id"
|
|
1694
|
+
}
|
|
1695
|
+
}
|
|
1696
|
+
],
|
|
1697
|
+
"requestBody": {
|
|
1698
|
+
"required": true,
|
|
1699
|
+
"content": {
|
|
1700
|
+
"application/json": {
|
|
1701
|
+
"schema": {
|
|
1702
|
+
"$ref": "#/components/schemas/InsightWorkflowInput"
|
|
1703
|
+
}
|
|
1704
|
+
}
|
|
1705
|
+
}
|
|
1706
|
+
},
|
|
1707
|
+
"responses": {
|
|
1708
|
+
"200": {
|
|
1709
|
+
"description": "Successful Response",
|
|
1710
|
+
"content": {
|
|
1711
|
+
"application/json": {
|
|
1712
|
+
"schema": {
|
|
1713
|
+
"$ref": "#/components/schemas/InsightWorkflowOutput"
|
|
1714
|
+
}
|
|
1715
|
+
}
|
|
1716
|
+
}
|
|
1717
|
+
},
|
|
1718
|
+
"400": {
|
|
1719
|
+
"description": "Bad Request"
|
|
1720
|
+
},
|
|
1721
|
+
"404": {
|
|
1722
|
+
"description": "Not Found"
|
|
1723
|
+
},
|
|
1724
|
+
"412": {
|
|
1725
|
+
"description": "Precondition Failed"
|
|
1726
|
+
},
|
|
1727
|
+
"500": {
|
|
1728
|
+
"description": "Internal Server Error"
|
|
1729
|
+
},
|
|
1730
|
+
"422": {
|
|
1731
|
+
"description": "Validation Error",
|
|
1732
|
+
"content": {
|
|
1733
|
+
"application/json": {
|
|
1734
|
+
"schema": {
|
|
1735
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1736
|
+
}
|
|
1737
|
+
}
|
|
1738
|
+
}
|
|
1739
|
+
}
|
|
1740
|
+
}
|
|
1741
|
+
},
|
|
1742
|
+
"delete": {
|
|
1743
|
+
"tags": [
|
|
1744
|
+
"insights.workflows",
|
|
1745
|
+
"V1"
|
|
1746
|
+
],
|
|
1747
|
+
"summary": "Delete Insights Workflow",
|
|
1748
|
+
"description": "Delete a Insights workflow.",
|
|
1749
|
+
"operationId": "directory_workflow_delete",
|
|
1750
|
+
"security": [
|
|
1751
|
+
{
|
|
1752
|
+
"APIKeyHeader": []
|
|
1753
|
+
}
|
|
1754
|
+
],
|
|
1755
|
+
"parameters": [
|
|
1756
|
+
{
|
|
1757
|
+
"name": "workflow_id",
|
|
1758
|
+
"in": "path",
|
|
1759
|
+
"required": true,
|
|
1760
|
+
"schema": {
|
|
1761
|
+
"type": "integer",
|
|
1762
|
+
"title": "Workflow Id"
|
|
1763
|
+
}
|
|
1764
|
+
}
|
|
1765
|
+
],
|
|
1766
|
+
"responses": {
|
|
1767
|
+
"200": {
|
|
1768
|
+
"description": "Successful Response",
|
|
1769
|
+
"content": {
|
|
1770
|
+
"application/json": {
|
|
1771
|
+
"schema": {}
|
|
1772
|
+
}
|
|
1773
|
+
}
|
|
1774
|
+
},
|
|
1775
|
+
"400": {
|
|
1776
|
+
"description": "Bad Request"
|
|
1777
|
+
},
|
|
1778
|
+
"404": {
|
|
1779
|
+
"description": "Not Found"
|
|
1780
|
+
},
|
|
1781
|
+
"500": {
|
|
1782
|
+
"description": "Internal Server Error"
|
|
1783
|
+
},
|
|
1784
|
+
"422": {
|
|
1785
|
+
"description": "Validation Error",
|
|
1786
|
+
"content": {
|
|
1787
|
+
"application/json": {
|
|
1788
|
+
"schema": {
|
|
1789
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1790
|
+
}
|
|
1791
|
+
}
|
|
1792
|
+
}
|
|
1793
|
+
}
|
|
1794
|
+
}
|
|
1795
|
+
}
|
|
1796
|
+
},
|
|
1797
|
+
"/api/v1/insights/tools": {
|
|
1798
|
+
"get": {
|
|
1799
|
+
"tags": [
|
|
1800
|
+
"insights.tools",
|
|
1801
|
+
"V1"
|
|
1802
|
+
],
|
|
1803
|
+
"summary": "Insight Tool List",
|
|
1804
|
+
"description": "List the existing insight_tools",
|
|
1805
|
+
"operationId": "insight_tool_list",
|
|
1806
|
+
"security": [
|
|
1807
|
+
{
|
|
1808
|
+
"APIKeyHeader": []
|
|
1809
|
+
}
|
|
1810
|
+
],
|
|
1811
|
+
"parameters": [
|
|
1812
|
+
{
|
|
1813
|
+
"name": "page",
|
|
1814
|
+
"in": "query",
|
|
1815
|
+
"required": false,
|
|
1816
|
+
"schema": {
|
|
1817
|
+
"anyOf": [
|
|
1818
|
+
{
|
|
1819
|
+
"type": "integer",
|
|
1820
|
+
"minimum": 0
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"type": "null"
|
|
1824
|
+
}
|
|
1825
|
+
],
|
|
1826
|
+
"default": 0,
|
|
1827
|
+
"title": "Page"
|
|
1828
|
+
}
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"name": "limit",
|
|
1832
|
+
"in": "query",
|
|
1833
|
+
"required": false,
|
|
1834
|
+
"schema": {
|
|
1835
|
+
"type": "integer",
|
|
1836
|
+
"minimum": 0,
|
|
1837
|
+
"default": 25,
|
|
1838
|
+
"title": "Limit"
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "search_fields",
|
|
1843
|
+
"in": "query",
|
|
1844
|
+
"required": false,
|
|
1845
|
+
"schema": {
|
|
1846
|
+
"type": "array",
|
|
1847
|
+
"items": {
|
|
1848
|
+
"$ref": "#/components/schemas/InsightToolProperties"
|
|
1849
|
+
},
|
|
1850
|
+
"default": [],
|
|
1851
|
+
"title": "Search Fields"
|
|
1852
|
+
}
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "search_field_values",
|
|
1856
|
+
"in": "query",
|
|
1857
|
+
"required": false,
|
|
1858
|
+
"schema": {
|
|
1859
|
+
"type": "array",
|
|
1860
|
+
"items": {
|
|
1861
|
+
"type": "string"
|
|
1862
|
+
},
|
|
1863
|
+
"default": [],
|
|
1864
|
+
"title": "Search Field Values"
|
|
1865
|
+
}
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "order_by",
|
|
1869
|
+
"in": "query",
|
|
1870
|
+
"required": false,
|
|
1871
|
+
"schema": {
|
|
1872
|
+
"anyOf": [
|
|
1873
|
+
{
|
|
1874
|
+
"$ref": "#/components/schemas/InsightToolProperties"
|
|
1875
|
+
},
|
|
1876
|
+
{
|
|
1877
|
+
"type": "null"
|
|
1878
|
+
}
|
|
1879
|
+
],
|
|
1880
|
+
"title": "Order By"
|
|
1881
|
+
}
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"name": "order_by_direction",
|
|
1885
|
+
"in": "query",
|
|
1886
|
+
"required": false,
|
|
1887
|
+
"schema": {
|
|
1888
|
+
"anyOf": [
|
|
1889
|
+
{
|
|
1890
|
+
"$ref": "#/components/schemas/OrderByDirection"
|
|
1891
|
+
},
|
|
1892
|
+
{
|
|
1893
|
+
"type": "null"
|
|
1894
|
+
}
|
|
1895
|
+
],
|
|
1896
|
+
"title": "Order By Direction"
|
|
1897
|
+
}
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
"name": "fields",
|
|
1901
|
+
"in": "query",
|
|
1902
|
+
"required": false,
|
|
1903
|
+
"schema": {
|
|
1904
|
+
"anyOf": [
|
|
1905
|
+
{
|
|
1906
|
+
"type": "array",
|
|
1907
|
+
"items": {
|
|
1908
|
+
"$ref": "#/components/schemas/InsightToolProperties"
|
|
1909
|
+
}
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"type": "null"
|
|
1913
|
+
}
|
|
1914
|
+
],
|
|
1915
|
+
"default": [],
|
|
1916
|
+
"title": "Fields"
|
|
1917
|
+
}
|
|
1918
|
+
},
|
|
1919
|
+
{
|
|
1920
|
+
"name": "start_datetime",
|
|
1921
|
+
"in": "query",
|
|
1922
|
+
"required": false,
|
|
1923
|
+
"schema": {
|
|
1924
|
+
"anyOf": [
|
|
1925
|
+
{
|
|
1926
|
+
"type": "string"
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"type": "null"
|
|
1930
|
+
}
|
|
1931
|
+
],
|
|
1932
|
+
"title": "Start Datetime"
|
|
1933
|
+
}
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"name": "end_datetime",
|
|
1937
|
+
"in": "query",
|
|
1938
|
+
"required": false,
|
|
1939
|
+
"schema": {
|
|
1940
|
+
"anyOf": [
|
|
1941
|
+
{
|
|
1942
|
+
"type": "string"
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"type": "null"
|
|
1946
|
+
}
|
|
1947
|
+
],
|
|
1948
|
+
"title": "End Datetime"
|
|
1949
|
+
}
|
|
1950
|
+
}
|
|
1951
|
+
],
|
|
1952
|
+
"responses": {
|
|
1953
|
+
"200": {
|
|
1954
|
+
"description": "Successful Response",
|
|
1955
|
+
"content": {
|
|
1956
|
+
"application/json": {
|
|
1957
|
+
"schema": {
|
|
1958
|
+
"$ref": "#/components/schemas/ListResponse_InsightToolOutput_"
|
|
1959
|
+
}
|
|
1960
|
+
}
|
|
1961
|
+
}
|
|
1962
|
+
},
|
|
1963
|
+
"422": {
|
|
1964
|
+
"description": "Validation Error",
|
|
1965
|
+
"content": {
|
|
1966
|
+
"application/json": {
|
|
1967
|
+
"schema": {
|
|
1968
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1969
|
+
}
|
|
1970
|
+
}
|
|
1971
|
+
}
|
|
1972
|
+
}
|
|
1973
|
+
}
|
|
1974
|
+
},
|
|
1975
|
+
"post": {
|
|
1976
|
+
"tags": [
|
|
1977
|
+
"insights.tools",
|
|
1978
|
+
"V1"
|
|
1979
|
+
],
|
|
1980
|
+
"summary": "Create Insight Tool",
|
|
1981
|
+
"description": "Create a new tool in the insights",
|
|
1982
|
+
"operationId": "insights_tool_create",
|
|
1983
|
+
"security": [
|
|
1984
|
+
{
|
|
1985
|
+
"APIKeyHeader": []
|
|
1986
|
+
}
|
|
1987
|
+
],
|
|
1988
|
+
"requestBody": {
|
|
1989
|
+
"required": true,
|
|
1990
|
+
"content": {
|
|
1991
|
+
"application/json": {
|
|
1992
|
+
"schema": {
|
|
1993
|
+
"$ref": "#/components/schemas/InsightToolInput"
|
|
1994
|
+
}
|
|
1995
|
+
}
|
|
1996
|
+
}
|
|
1997
|
+
},
|
|
1998
|
+
"responses": {
|
|
1999
|
+
"200": {
|
|
2000
|
+
"description": "Successful Response",
|
|
2001
|
+
"content": {
|
|
2002
|
+
"application/json": {
|
|
2003
|
+
"schema": {
|
|
2004
|
+
"$ref": "#/components/schemas/InsightToolOutput"
|
|
2005
|
+
}
|
|
2006
|
+
}
|
|
2007
|
+
}
|
|
2008
|
+
},
|
|
2009
|
+
"422": {
|
|
2010
|
+
"description": "Validation Error",
|
|
2011
|
+
"content": {
|
|
2012
|
+
"application/json": {
|
|
2013
|
+
"schema": {
|
|
2014
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
2015
|
+
}
|
|
2016
|
+
}
|
|
2017
|
+
}
|
|
2018
|
+
}
|
|
2019
|
+
}
|
|
2020
|
+
}
|
|
2021
|
+
},
|
|
2022
|
+
"/api/v1/insights/tools/{tool_id}": {
|
|
2023
|
+
"get": {
|
|
2024
|
+
"tags": [
|
|
2025
|
+
"insights.tools",
|
|
2026
|
+
"V1"
|
|
2027
|
+
],
|
|
2028
|
+
"summary": "Get Insight Tool By Id",
|
|
2029
|
+
"description": "Get a InsightTool by Name.",
|
|
2030
|
+
"operationId": "insight_tool_get_by_id",
|
|
2031
|
+
"security": [
|
|
2032
|
+
{
|
|
2033
|
+
"APIKeyHeader": []
|
|
2034
|
+
}
|
|
2035
|
+
],
|
|
2036
|
+
"parameters": [
|
|
2037
|
+
{
|
|
2038
|
+
"name": "tool_id",
|
|
2039
|
+
"in": "path",
|
|
2040
|
+
"required": true,
|
|
2041
|
+
"schema": {
|
|
2042
|
+
"type": "string",
|
|
2043
|
+
"title": "Tool Id"
|
|
2044
|
+
}
|
|
2045
|
+
}
|
|
2046
|
+
],
|
|
2047
|
+
"responses": {
|
|
2048
|
+
"200": {
|
|
2049
|
+
"description": "Successful Response",
|
|
2050
|
+
"content": {
|
|
2051
|
+
"application/json": {
|
|
2052
|
+
"schema": {
|
|
2053
|
+
"$ref": "#/components/schemas/InsightToolOutput"
|
|
2054
|
+
}
|
|
2055
|
+
}
|
|
2056
|
+
}
|
|
2057
|
+
},
|
|
2058
|
+
"422": {
|
|
2059
|
+
"description": "Validation Error",
|
|
2060
|
+
"content": {
|
|
2061
|
+
"application/json": {
|
|
2062
|
+
"schema": {
|
|
2063
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
2064
|
+
}
|
|
2065
|
+
}
|
|
2066
|
+
}
|
|
2067
|
+
}
|
|
2068
|
+
}
|
|
2069
|
+
},
|
|
2070
|
+
"put": {
|
|
2071
|
+
"tags": [
|
|
2072
|
+
"insights.tools",
|
|
2073
|
+
"V1"
|
|
2074
|
+
],
|
|
2075
|
+
"summary": "Update Insights Tool",
|
|
2076
|
+
"description": "Update a InsightTool.",
|
|
2077
|
+
"operationId": "insights_tool_update",
|
|
2078
|
+
"security": [
|
|
2079
|
+
{
|
|
2080
|
+
"APIKeyHeader": []
|
|
2081
|
+
}
|
|
2082
|
+
],
|
|
2083
|
+
"parameters": [
|
|
2084
|
+
{
|
|
2085
|
+
"name": "tool_id",
|
|
2086
|
+
"in": "path",
|
|
2087
|
+
"required": true,
|
|
2088
|
+
"schema": {
|
|
2089
|
+
"type": "integer",
|
|
2090
|
+
"title": "Tool Id"
|
|
2091
|
+
}
|
|
2092
|
+
}
|
|
2093
|
+
],
|
|
2094
|
+
"requestBody": {
|
|
2095
|
+
"required": true,
|
|
2096
|
+
"content": {
|
|
2097
|
+
"application/json": {
|
|
2098
|
+
"schema": {
|
|
2099
|
+
"$ref": "#/components/schemas/InsightToolInput"
|
|
2100
|
+
}
|
|
2101
|
+
}
|
|
2102
|
+
}
|
|
2103
|
+
},
|
|
2104
|
+
"responses": {
|
|
2105
|
+
"200": {
|
|
2106
|
+
"description": "Successful Response",
|
|
2107
|
+
"content": {
|
|
2108
|
+
"application/json": {
|
|
2109
|
+
"schema": {
|
|
2110
|
+
"$ref": "#/components/schemas/InsightToolOutput"
|
|
2111
|
+
}
|
|
2112
|
+
}
|
|
2113
|
+
}
|
|
2114
|
+
},
|
|
2115
|
+
"400": {
|
|
2116
|
+
"description": "Bad Request"
|
|
2117
|
+
},
|
|
2118
|
+
"404": {
|
|
2119
|
+
"description": "Not Found"
|
|
2120
|
+
},
|
|
2121
|
+
"412": {
|
|
2122
|
+
"description": "Precondition Failed"
|
|
2123
|
+
},
|
|
2124
|
+
"500": {
|
|
2125
|
+
"description": "Internal Server Error"
|
|
2126
|
+
},
|
|
2127
|
+
"422": {
|
|
2128
|
+
"description": "Validation Error",
|
|
2129
|
+
"content": {
|
|
2130
|
+
"application/json": {
|
|
2131
|
+
"schema": {
|
|
2132
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
2133
|
+
}
|
|
2134
|
+
}
|
|
2135
|
+
}
|
|
2136
|
+
}
|
|
2137
|
+
}
|
|
2138
|
+
}
|
|
2139
|
+
},
|
|
2140
|
+
"/api/v1/insights/tool-definitions": {
|
|
2141
|
+
"get": {
|
|
2142
|
+
"tags": [
|
|
2143
|
+
"insights.tools",
|
|
2144
|
+
"V1"
|
|
2145
|
+
],
|
|
2146
|
+
"summary": "Get Insight Tool Definitions",
|
|
2147
|
+
"description": "Get a InsightTool by Name.",
|
|
2148
|
+
"operationId": "insight_tool_get_definitions",
|
|
2149
|
+
"responses": {
|
|
2150
|
+
"200": {
|
|
2151
|
+
"description": "Successful Response",
|
|
2152
|
+
"content": {
|
|
2153
|
+
"application/json": {
|
|
2154
|
+
"schema": {
|
|
2155
|
+
"items": {
|
|
2156
|
+
"$ref": "#/components/schemas/InsightToolDefinition"
|
|
2157
|
+
},
|
|
2158
|
+
"type": "array",
|
|
2159
|
+
"title": "Response Insight Tool Get Definitions"
|
|
2160
|
+
}
|
|
2161
|
+
}
|
|
2162
|
+
}
|
|
2163
|
+
}
|
|
2164
|
+
},
|
|
2165
|
+
"security": [
|
|
2166
|
+
{
|
|
2167
|
+
"APIKeyHeader": []
|
|
2168
|
+
}
|
|
2169
|
+
]
|
|
2170
|
+
}
|
|
2171
|
+
},
|
|
1400
2172
|
"/api/v1/custom_messages/": {
|
|
1401
2173
|
"get": {
|
|
1402
2174
|
"tags": [
|
|
@@ -3070,6 +3842,55 @@
|
|
|
3070
3842
|
}
|
|
3071
3843
|
}
|
|
3072
3844
|
},
|
|
3845
|
+
"/api/v1/sessions/summary/{session_id}": {
|
|
3846
|
+
"get": {
|
|
3847
|
+
"tags": [
|
|
3848
|
+
"sessions",
|
|
3849
|
+
"V1"
|
|
3850
|
+
],
|
|
3851
|
+
"summary": "Get Session Summary By Id",
|
|
3852
|
+
"operationId": "session_summary_get_by_id",
|
|
3853
|
+
"security": [
|
|
3854
|
+
{
|
|
3855
|
+
"APIKeyHeader": []
|
|
3856
|
+
}
|
|
3857
|
+
],
|
|
3858
|
+
"parameters": [
|
|
3859
|
+
{
|
|
3860
|
+
"name": "session_id",
|
|
3861
|
+
"in": "path",
|
|
3862
|
+
"required": true,
|
|
3863
|
+
"schema": {
|
|
3864
|
+
"type": "string",
|
|
3865
|
+
"title": "Session Id"
|
|
3866
|
+
}
|
|
3867
|
+
}
|
|
3868
|
+
],
|
|
3869
|
+
"responses": {
|
|
3870
|
+
"200": {
|
|
3871
|
+
"description": "Successful Response",
|
|
3872
|
+
"content": {
|
|
3873
|
+
"application/json": {
|
|
3874
|
+
"schema": {
|
|
3875
|
+
"type": "string",
|
|
3876
|
+
"title": "Response Session Summary Get By Id"
|
|
3877
|
+
}
|
|
3878
|
+
}
|
|
3879
|
+
}
|
|
3880
|
+
},
|
|
3881
|
+
"422": {
|
|
3882
|
+
"description": "Validation Error",
|
|
3883
|
+
"content": {
|
|
3884
|
+
"application/json": {
|
|
3885
|
+
"schema": {
|
|
3886
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
3887
|
+
}
|
|
3888
|
+
}
|
|
3889
|
+
}
|
|
3890
|
+
}
|
|
3891
|
+
}
|
|
3892
|
+
}
|
|
3893
|
+
},
|
|
3073
3894
|
"/api/v1/sessions/{session_id}": {
|
|
3074
3895
|
"get": {
|
|
3075
3896
|
"tags": [
|
|
@@ -8544,68 +9365,363 @@
|
|
|
8544
9365
|
]
|
|
8545
9366
|
},
|
|
8546
9367
|
"description": {
|
|
8547
|
-
"anyOf": [
|
|
8548
|
-
{
|
|
8549
|
-
"type": "string"
|
|
8550
|
-
},
|
|
8551
|
-
{
|
|
8552
|
-
"type": "null"
|
|
8553
|
-
}
|
|
8554
|
-
],
|
|
9368
|
+
"anyOf": [
|
|
9369
|
+
{
|
|
9370
|
+
"type": "string"
|
|
9371
|
+
},
|
|
9372
|
+
{
|
|
9373
|
+
"type": "null"
|
|
9374
|
+
}
|
|
9375
|
+
],
|
|
9376
|
+
"title": "Description",
|
|
9377
|
+
"description": "Human-readable description of the event",
|
|
9378
|
+
"examples": [
|
|
9379
|
+
"Transfer to phone number +18042221111"
|
|
9380
|
+
]
|
|
9381
|
+
},
|
|
9382
|
+
"attributes": {
|
|
9383
|
+
"anyOf": [
|
|
9384
|
+
{
|
|
9385
|
+
"type": "object"
|
|
9386
|
+
},
|
|
9387
|
+
{
|
|
9388
|
+
"type": "null"
|
|
9389
|
+
}
|
|
9390
|
+
],
|
|
9391
|
+
"title": "Attributes",
|
|
9392
|
+
"description": "Arbitrary additional metadata for the event"
|
|
9393
|
+
}
|
|
9394
|
+
},
|
|
9395
|
+
"type": "object",
|
|
9396
|
+
"required": [
|
|
9397
|
+
"timestamp"
|
|
9398
|
+
],
|
|
9399
|
+
"title": "Event",
|
|
9400
|
+
"description": "An event represents a specific occurrence during a session."
|
|
9401
|
+
},
|
|
9402
|
+
"EventProperties": {
|
|
9403
|
+
"type": "string",
|
|
9404
|
+
"enum": [
|
|
9405
|
+
"timestamp",
|
|
9406
|
+
"session_id",
|
|
9407
|
+
"conversation_id",
|
|
9408
|
+
"source",
|
|
9409
|
+
"source_id",
|
|
9410
|
+
"category",
|
|
9411
|
+
"type",
|
|
9412
|
+
"user_id",
|
|
9413
|
+
"description",
|
|
9414
|
+
"attributes"
|
|
9415
|
+
],
|
|
9416
|
+
"title": "EventProperties"
|
|
9417
|
+
},
|
|
9418
|
+
"HTTPValidationError": {
|
|
9419
|
+
"properties": {
|
|
9420
|
+
"detail": {
|
|
9421
|
+
"items": {
|
|
9422
|
+
"$ref": "#/components/schemas/ValidationError"
|
|
9423
|
+
},
|
|
9424
|
+
"type": "array",
|
|
9425
|
+
"title": "Detail"
|
|
9426
|
+
}
|
|
9427
|
+
},
|
|
9428
|
+
"type": "object",
|
|
9429
|
+
"title": "HTTPValidationError"
|
|
9430
|
+
},
|
|
9431
|
+
"InsightToolDefinition": {
|
|
9432
|
+
"properties": {
|
|
9433
|
+
"id": {
|
|
9434
|
+
"type": "integer",
|
|
9435
|
+
"title": "Id",
|
|
9436
|
+
"description": "Unique ID for Insight Tool Definition"
|
|
9437
|
+
},
|
|
9438
|
+
"name": {
|
|
9439
|
+
"type": "string",
|
|
9440
|
+
"title": "Name",
|
|
9441
|
+
"description": "Human readable name of Insight Tool Definition"
|
|
9442
|
+
},
|
|
9443
|
+
"type": {
|
|
9444
|
+
"type": "string",
|
|
9445
|
+
"title": "Type",
|
|
9446
|
+
"description": "Type of Insight Tool Definition"
|
|
9447
|
+
},
|
|
9448
|
+
"description": {
|
|
9449
|
+
"type": "string",
|
|
9450
|
+
"title": "Description",
|
|
9451
|
+
"description": "Text description of Insight Tool Definition"
|
|
9452
|
+
},
|
|
9453
|
+
"tool_parameters": {
|
|
9454
|
+
"type": "object",
|
|
9455
|
+
"title": "Tool Parameters",
|
|
9456
|
+
"description": "Parameters for Insight Tool Definition"
|
|
9457
|
+
},
|
|
9458
|
+
"tool_result_set": {
|
|
9459
|
+
"type": "object",
|
|
9460
|
+
"title": "Tool Result Set",
|
|
9461
|
+
"description": "Result key/types for Insight Tool Definition"
|
|
9462
|
+
}
|
|
9463
|
+
},
|
|
9464
|
+
"type": "object",
|
|
9465
|
+
"required": [
|
|
9466
|
+
"id",
|
|
9467
|
+
"name",
|
|
9468
|
+
"type",
|
|
9469
|
+
"description",
|
|
9470
|
+
"tool_parameters",
|
|
9471
|
+
"tool_result_set"
|
|
9472
|
+
],
|
|
9473
|
+
"title": "InsightToolDefinition"
|
|
9474
|
+
},
|
|
9475
|
+
"InsightToolInput": {
|
|
9476
|
+
"properties": {
|
|
9477
|
+
"name": {
|
|
9478
|
+
"type": "string",
|
|
9479
|
+
"title": "Name",
|
|
9480
|
+
"description": "Human readable name of Insight Tool"
|
|
9481
|
+
},
|
|
9482
|
+
"description": {
|
|
9483
|
+
"type": "string",
|
|
9484
|
+
"title": "Description",
|
|
9485
|
+
"description": "Text description of Insight Tool"
|
|
9486
|
+
},
|
|
9487
|
+
"version": {
|
|
9488
|
+
"type": "integer",
|
|
9489
|
+
"title": "Version",
|
|
9490
|
+
"description": "Version number of Insight Tool"
|
|
9491
|
+
},
|
|
9492
|
+
"tool_arguments": {
|
|
9493
|
+
"type": "object",
|
|
9494
|
+
"title": "Tool Arguments",
|
|
9495
|
+
"description": "Arguments for Insight Tool"
|
|
9496
|
+
},
|
|
9497
|
+
"insight_tool_definition_id": {
|
|
9498
|
+
"type": "integer",
|
|
9499
|
+
"title": "Insight Tool Definition Id",
|
|
9500
|
+
"description": "Unique ID for Insight Tool Definition"
|
|
9501
|
+
}
|
|
9502
|
+
},
|
|
9503
|
+
"type": "object",
|
|
9504
|
+
"required": [
|
|
9505
|
+
"name",
|
|
9506
|
+
"description",
|
|
9507
|
+
"version",
|
|
9508
|
+
"tool_arguments",
|
|
9509
|
+
"insight_tool_definition_id"
|
|
9510
|
+
],
|
|
9511
|
+
"title": "InsightToolInput"
|
|
9512
|
+
},
|
|
9513
|
+
"InsightToolOutput": {
|
|
9514
|
+
"properties": {
|
|
9515
|
+
"name": {
|
|
9516
|
+
"type": "string",
|
|
9517
|
+
"title": "Name",
|
|
9518
|
+
"description": "Human readable name of Insight Tool"
|
|
9519
|
+
},
|
|
9520
|
+
"description": {
|
|
9521
|
+
"type": "string",
|
|
8555
9522
|
"title": "Description",
|
|
8556
|
-
"description": "
|
|
8557
|
-
"examples": [
|
|
8558
|
-
"Transfer to phone number +18042221111"
|
|
8559
|
-
]
|
|
9523
|
+
"description": "Text description of Insight Tool"
|
|
8560
9524
|
},
|
|
8561
|
-
"
|
|
9525
|
+
"version": {
|
|
9526
|
+
"type": "integer",
|
|
9527
|
+
"title": "Version",
|
|
9528
|
+
"description": "Version of Insight Tool"
|
|
9529
|
+
},
|
|
9530
|
+
"tool_arguments": {
|
|
9531
|
+
"type": "object",
|
|
9532
|
+
"title": "Tool Arguments",
|
|
9533
|
+
"description": "Arguments for Insight Tool"
|
|
9534
|
+
},
|
|
9535
|
+
"insight_tool_definition_id": {
|
|
9536
|
+
"type": "integer",
|
|
9537
|
+
"title": "Insight Tool Definition Id",
|
|
9538
|
+
"description": "Unique ID for Insight Tool Definition"
|
|
9539
|
+
},
|
|
9540
|
+
"id": {
|
|
9541
|
+
"type": "integer",
|
|
9542
|
+
"title": "Id",
|
|
9543
|
+
"description": "Unique ID for Insight Tool"
|
|
9544
|
+
},
|
|
9545
|
+
"insight_tool_definition": {
|
|
8562
9546
|
"anyOf": [
|
|
8563
9547
|
{
|
|
8564
|
-
"
|
|
9548
|
+
"$ref": "#/components/schemas/InsightToolDefinition"
|
|
8565
9549
|
},
|
|
8566
9550
|
{
|
|
8567
9551
|
"type": "null"
|
|
8568
9552
|
}
|
|
8569
9553
|
],
|
|
8570
|
-
"
|
|
8571
|
-
|
|
9554
|
+
"description": "Insight Tool Definition"
|
|
9555
|
+
},
|
|
9556
|
+
"created_at": {
|
|
9557
|
+
"type": "string",
|
|
9558
|
+
"format": "date-time",
|
|
9559
|
+
"title": "Created At",
|
|
9560
|
+
"description": "Timestamp of Insight Tool creation"
|
|
9561
|
+
},
|
|
9562
|
+
"updated_at": {
|
|
9563
|
+
"type": "string",
|
|
9564
|
+
"format": "date-time",
|
|
9565
|
+
"title": "Updated At",
|
|
9566
|
+
"description": "Timestamp of Insight Tool update"
|
|
9567
|
+
},
|
|
9568
|
+
"last_updated_by": {
|
|
9569
|
+
"type": "string",
|
|
9570
|
+
"title": "Last Updated By",
|
|
9571
|
+
"description": "User who last updated Insight Tool"
|
|
8572
9572
|
}
|
|
8573
9573
|
},
|
|
8574
9574
|
"type": "object",
|
|
8575
9575
|
"required": [
|
|
8576
|
-
"
|
|
9576
|
+
"name",
|
|
9577
|
+
"description",
|
|
9578
|
+
"version",
|
|
9579
|
+
"tool_arguments",
|
|
9580
|
+
"insight_tool_definition_id",
|
|
9581
|
+
"id",
|
|
9582
|
+
"last_updated_by"
|
|
8577
9583
|
],
|
|
8578
|
-
"title": "
|
|
8579
|
-
"description": "An event represents a specific occurrence during a session."
|
|
9584
|
+
"title": "InsightToolOutput"
|
|
8580
9585
|
},
|
|
8581
|
-
"
|
|
9586
|
+
"InsightToolProperties": {
|
|
8582
9587
|
"type": "string",
|
|
8583
9588
|
"enum": [
|
|
8584
|
-
"
|
|
8585
|
-
"
|
|
8586
|
-
"conversation_id",
|
|
8587
|
-
"source",
|
|
8588
|
-
"source_id",
|
|
8589
|
-
"category",
|
|
8590
|
-
"type",
|
|
8591
|
-
"user_id",
|
|
9589
|
+
"id",
|
|
9590
|
+
"name",
|
|
8592
9591
|
"description",
|
|
8593
|
-
"
|
|
9592
|
+
"tool_arguments",
|
|
9593
|
+
"insight_tool_definition_id",
|
|
9594
|
+
"updated_at"
|
|
8594
9595
|
],
|
|
8595
|
-
"title": "
|
|
9596
|
+
"title": "InsightToolProperties"
|
|
8596
9597
|
},
|
|
8597
|
-
"
|
|
9598
|
+
"InsightWorkflowInput": {
|
|
8598
9599
|
"properties": {
|
|
8599
|
-
"
|
|
9600
|
+
"name": {
|
|
9601
|
+
"type": "string",
|
|
9602
|
+
"title": "Name",
|
|
9603
|
+
"description": "Human readable name of Insight Workflow"
|
|
9604
|
+
},
|
|
9605
|
+
"description": {
|
|
9606
|
+
"type": "string",
|
|
9607
|
+
"title": "Description",
|
|
9608
|
+
"description": "Text description of Insight Workflow"
|
|
9609
|
+
},
|
|
9610
|
+
"insight_tool_ids": {
|
|
8600
9611
|
"items": {
|
|
8601
|
-
"
|
|
9612
|
+
"type": "integer"
|
|
8602
9613
|
},
|
|
8603
9614
|
"type": "array",
|
|
8604
|
-
"title": "
|
|
9615
|
+
"title": "Insight Tool Ids",
|
|
9616
|
+
"description": "List of Insight Tool IDs"
|
|
9617
|
+
},
|
|
9618
|
+
"conditions": {
|
|
9619
|
+
"type": "object",
|
|
9620
|
+
"title": "Conditions",
|
|
9621
|
+
"description": "Conditions for Insight Workflow"
|
|
9622
|
+
},
|
|
9623
|
+
"status": {
|
|
9624
|
+
"type": "string",
|
|
9625
|
+
"title": "Status",
|
|
9626
|
+
"description": "Status of the Insight Workflow"
|
|
8605
9627
|
}
|
|
8606
9628
|
},
|
|
8607
9629
|
"type": "object",
|
|
8608
|
-
"
|
|
9630
|
+
"required": [
|
|
9631
|
+
"name",
|
|
9632
|
+
"description",
|
|
9633
|
+
"insight_tool_ids",
|
|
9634
|
+
"conditions",
|
|
9635
|
+
"status"
|
|
9636
|
+
],
|
|
9637
|
+
"title": "InsightWorkflowInput"
|
|
9638
|
+
},
|
|
9639
|
+
"InsightWorkflowOutput": {
|
|
9640
|
+
"properties": {
|
|
9641
|
+
"name": {
|
|
9642
|
+
"type": "string",
|
|
9643
|
+
"title": "Name",
|
|
9644
|
+
"description": "Human readable name of Insight Workflow"
|
|
9645
|
+
},
|
|
9646
|
+
"description": {
|
|
9647
|
+
"type": "string",
|
|
9648
|
+
"title": "Description",
|
|
9649
|
+
"description": "Text description of Insight Workflow"
|
|
9650
|
+
},
|
|
9651
|
+
"insight_tool_ids": {
|
|
9652
|
+
"items": {
|
|
9653
|
+
"type": "integer"
|
|
9654
|
+
},
|
|
9655
|
+
"type": "array",
|
|
9656
|
+
"title": "Insight Tool Ids",
|
|
9657
|
+
"description": "List of Insight Tool IDs"
|
|
9658
|
+
},
|
|
9659
|
+
"conditions": {
|
|
9660
|
+
"type": "object",
|
|
9661
|
+
"title": "Conditions",
|
|
9662
|
+
"description": "Conditions for Insight Workflow"
|
|
9663
|
+
},
|
|
9664
|
+
"status": {
|
|
9665
|
+
"type": "string",
|
|
9666
|
+
"title": "Status",
|
|
9667
|
+
"description": "Status of the Insight Workflow"
|
|
9668
|
+
},
|
|
9669
|
+
"id": {
|
|
9670
|
+
"type": "integer",
|
|
9671
|
+
"title": "Id",
|
|
9672
|
+
"description": "Unique ID for Insight Workflow"
|
|
9673
|
+
},
|
|
9674
|
+
"insight_tools": {
|
|
9675
|
+
"items": {
|
|
9676
|
+
"$ref": "#/components/schemas/InsightToolOutput"
|
|
9677
|
+
},
|
|
9678
|
+
"type": "array",
|
|
9679
|
+
"title": "Insight Tools",
|
|
9680
|
+
"description": "List of Insight Tools"
|
|
9681
|
+
},
|
|
9682
|
+
"created_at": {
|
|
9683
|
+
"type": "string",
|
|
9684
|
+
"format": "date-time",
|
|
9685
|
+
"title": "Created At",
|
|
9686
|
+
"description": "Timestamp of Insight Workflow creation"
|
|
9687
|
+
},
|
|
9688
|
+
"updated_at": {
|
|
9689
|
+
"type": "string",
|
|
9690
|
+
"format": "date-time",
|
|
9691
|
+
"title": "Updated At",
|
|
9692
|
+
"description": "Timestamp of Insight Workflow update"
|
|
9693
|
+
},
|
|
9694
|
+
"last_updated_by": {
|
|
9695
|
+
"type": "string",
|
|
9696
|
+
"title": "Last Updated By",
|
|
9697
|
+
"description": "User who last updated Insight Workflow"
|
|
9698
|
+
}
|
|
9699
|
+
},
|
|
9700
|
+
"type": "object",
|
|
9701
|
+
"required": [
|
|
9702
|
+
"name",
|
|
9703
|
+
"description",
|
|
9704
|
+
"insight_tool_ids",
|
|
9705
|
+
"conditions",
|
|
9706
|
+
"status",
|
|
9707
|
+
"id",
|
|
9708
|
+
"insight_tools",
|
|
9709
|
+
"last_updated_by"
|
|
9710
|
+
],
|
|
9711
|
+
"title": "InsightWorkflowOutput"
|
|
9712
|
+
},
|
|
9713
|
+
"InsightWorkflowProperties": {
|
|
9714
|
+
"type": "string",
|
|
9715
|
+
"enum": [
|
|
9716
|
+
"id",
|
|
9717
|
+
"name",
|
|
9718
|
+
"description",
|
|
9719
|
+
"status",
|
|
9720
|
+
"conditions",
|
|
9721
|
+
"insight_tool_ids",
|
|
9722
|
+
"updated_at"
|
|
9723
|
+
],
|
|
9724
|
+
"title": "InsightWorkflowProperties"
|
|
8609
9725
|
},
|
|
8610
9726
|
"InternalTool": {
|
|
8611
9727
|
"properties": {
|
|
@@ -9108,6 +10224,102 @@
|
|
|
9108
10224
|
],
|
|
9109
10225
|
"title": "ListResponse[Event]"
|
|
9110
10226
|
},
|
|
10227
|
+
"ListResponse_InsightToolOutput_": {
|
|
10228
|
+
"properties": {
|
|
10229
|
+
"items": {
|
|
10230
|
+
"items": {
|
|
10231
|
+
"$ref": "#/components/schemas/InsightToolOutput"
|
|
10232
|
+
},
|
|
10233
|
+
"type": "array",
|
|
10234
|
+
"title": "Items"
|
|
10235
|
+
},
|
|
10236
|
+
"page": {
|
|
10237
|
+
"type": "integer",
|
|
10238
|
+
"title": "Page"
|
|
10239
|
+
},
|
|
10240
|
+
"page_size": {
|
|
10241
|
+
"type": "integer",
|
|
10242
|
+
"title": "Page Size"
|
|
10243
|
+
},
|
|
10244
|
+
"total_pages": {
|
|
10245
|
+
"anyOf": [
|
|
10246
|
+
{
|
|
10247
|
+
"type": "integer"
|
|
10248
|
+
},
|
|
10249
|
+
{
|
|
10250
|
+
"type": "null"
|
|
10251
|
+
}
|
|
10252
|
+
],
|
|
10253
|
+
"title": "Total Pages"
|
|
10254
|
+
},
|
|
10255
|
+
"total_count": {
|
|
10256
|
+
"anyOf": [
|
|
10257
|
+
{
|
|
10258
|
+
"type": "integer"
|
|
10259
|
+
},
|
|
10260
|
+
{
|
|
10261
|
+
"type": "null"
|
|
10262
|
+
}
|
|
10263
|
+
],
|
|
10264
|
+
"title": "Total Count"
|
|
10265
|
+
}
|
|
10266
|
+
},
|
|
10267
|
+
"type": "object",
|
|
10268
|
+
"required": [
|
|
10269
|
+
"items",
|
|
10270
|
+
"page",
|
|
10271
|
+
"page_size"
|
|
10272
|
+
],
|
|
10273
|
+
"title": "ListResponse[InsightToolOutput]"
|
|
10274
|
+
},
|
|
10275
|
+
"ListResponse_InsightWorkflowOutput_": {
|
|
10276
|
+
"properties": {
|
|
10277
|
+
"items": {
|
|
10278
|
+
"items": {
|
|
10279
|
+
"$ref": "#/components/schemas/InsightWorkflowOutput"
|
|
10280
|
+
},
|
|
10281
|
+
"type": "array",
|
|
10282
|
+
"title": "Items"
|
|
10283
|
+
},
|
|
10284
|
+
"page": {
|
|
10285
|
+
"type": "integer",
|
|
10286
|
+
"title": "Page"
|
|
10287
|
+
},
|
|
10288
|
+
"page_size": {
|
|
10289
|
+
"type": "integer",
|
|
10290
|
+
"title": "Page Size"
|
|
10291
|
+
},
|
|
10292
|
+
"total_pages": {
|
|
10293
|
+
"anyOf": [
|
|
10294
|
+
{
|
|
10295
|
+
"type": "integer"
|
|
10296
|
+
},
|
|
10297
|
+
{
|
|
10298
|
+
"type": "null"
|
|
10299
|
+
}
|
|
10300
|
+
],
|
|
10301
|
+
"title": "Total Pages"
|
|
10302
|
+
},
|
|
10303
|
+
"total_count": {
|
|
10304
|
+
"anyOf": [
|
|
10305
|
+
{
|
|
10306
|
+
"type": "integer"
|
|
10307
|
+
},
|
|
10308
|
+
{
|
|
10309
|
+
"type": "null"
|
|
10310
|
+
}
|
|
10311
|
+
],
|
|
10312
|
+
"title": "Total Count"
|
|
10313
|
+
}
|
|
10314
|
+
},
|
|
10315
|
+
"type": "object",
|
|
10316
|
+
"required": [
|
|
10317
|
+
"items",
|
|
10318
|
+
"page",
|
|
10319
|
+
"page_size"
|
|
10320
|
+
],
|
|
10321
|
+
"title": "ListResponse[InsightWorkflowOutput]"
|
|
10322
|
+
},
|
|
9111
10323
|
"ListResponse_PromptResponse_": {
|
|
9112
10324
|
"properties": {
|
|
9113
10325
|
"items": {
|
|
@@ -11563,6 +12775,14 @@
|
|
|
11563
12775
|
"name": "events",
|
|
11564
12776
|
"description": "Operations related to events. An event represents a specific occurrence during a session. Currently the API/SDK only supports fetching logged events."
|
|
11565
12777
|
},
|
|
12778
|
+
{
|
|
12779
|
+
"name": "insights.tools",
|
|
12780
|
+
"description": "Operations related to insights tools. An insight is a tool that processes conversation data to extract information and generate reports."
|
|
12781
|
+
},
|
|
12782
|
+
{
|
|
12783
|
+
"name": "insights.workflows",
|
|
12784
|
+
"description": "Operations related to insights workflows. An workflow is series of tool invocations that processes conversation data to extract information and generate reports."
|
|
12785
|
+
},
|
|
11566
12786
|
{
|
|
11567
12787
|
"name": "outbound.campaigns",
|
|
11568
12788
|
"description": "Operations related to outbound message campaigns"
|