syllable-sdk 0.1.0-alpha.70 → 0.1.0-alpha.71
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 +17 -0
- package/docs/sdks/insights/README.md +97 -0
- package/docs/sdks/prompts/README.md +81 -5
- package/docs/sdks/takeouts/README.md +163 -0
- package/docs/sdks/v1/README.md +251 -1
- package/funcs/insightsList.d.ts +17 -0
- package/funcs/insightsList.d.ts.map +1 -0
- package/funcs/insightsList.js +114 -0
- package/funcs/insightsList.js.map +1 -0
- package/funcs/promptsPromptGetSupportedLlms.d.ts +15 -0
- package/funcs/promptsPromptGetSupportedLlms.d.ts.map +1 -0
- package/funcs/promptsPromptGetSupportedLlms.js +89 -0
- package/funcs/promptsPromptGetSupportedLlms.js.map +1 -0
- package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.d.ts +13 -0
- package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.d.ts.map +1 -0
- package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.js +99 -0
- package/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.js.map +1 -0
- package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.d.ts +14 -0
- package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.d.ts.map +1 -0
- package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.js +105 -0
- package/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.js.map +1 -0
- package/funcs/v1CreateTakeoutApiV1TakeoutsCreatePost.d.ts +13 -0
- package/funcs/v1CreateTakeoutApiV1TakeoutsCreatePost.d.ts.map +1 -0
- package/funcs/v1CreateTakeoutApiV1TakeoutsCreatePost.js +99 -0
- package/funcs/v1CreateTakeoutApiV1TakeoutsCreatePost.js.map +1 -0
- package/funcs/v1GetTakeoutApiV1TakeoutsGetJobIdGet.d.ts +14 -0
- package/funcs/v1GetTakeoutApiV1TakeoutsGetJobIdGet.d.ts.map +1 -0
- package/funcs/v1GetTakeoutApiV1TakeoutsGetJobIdGet.js +105 -0
- package/funcs/v1GetTakeoutApiV1TakeoutsGetJobIdGet.js.map +1 -0
- package/funcs/v1List.d.ts +17 -0
- package/funcs/v1List.d.ts.map +1 -0
- package/funcs/v1List.js +114 -0
- package/funcs/v1List.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/createtakeoutresponse.d.ts +31 -0
- package/models/components/createtakeoutresponse.d.ts.map +1 -0
- package/models/components/createtakeoutresponse.js +72 -0
- package/models/components/createtakeoutresponse.js.map +1 -0
- package/models/components/daotakeoutcreate.d.ts +31 -0
- package/models/components/daotakeoutcreate.d.ts.map +1 -0
- package/models/components/daotakeoutcreate.js +72 -0
- package/models/components/daotakeoutcreate.js.map +1 -0
- package/models/components/index.d.ts +8 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +8 -0
- package/models/components/index.js.map +1 -1
- package/models/components/insightsoutput.d.ts +104 -0
- package/models/components/insightsoutput.d.ts.map +1 -0
- package/models/components/insightsoutput.js +127 -0
- package/models/components/insightsoutput.js.map +1 -0
- package/models/components/insightsproperties.d.ts +34 -0
- package/models/components/insightsproperties.d.ts.map +1 -0
- package/models/components/insightsproperties.js +52 -0
- package/models/components/insightsproperties.js.map +1 -0
- package/models/components/listresponseinsightsoutput.d.ts +53 -0
- package/models/components/listresponseinsightsoutput.d.ts.map +1 -0
- package/models/components/listresponseinsightsoutput.js +81 -0
- package/models/components/listresponseinsightsoutput.js.map +1 -0
- package/models/components/promptllmconfig.d.ts +1 -1
- package/models/components/supportedllm.d.ts +61 -0
- package/models/components/supportedllm.d.ts.map +1 -0
- package/models/components/supportedllm.js +81 -0
- package/models/components/supportedllm.js.map +1 -0
- package/models/components/takeoutrequeststatus.d.ts +43 -0
- package/models/components/takeoutrequeststatus.d.ts.map +1 -0
- package/models/components/takeoutrequeststatus.js +56 -0
- package/models/components/takeoutrequeststatus.js.map +1 -0
- package/models/components/takeoutstatusresponse.d.ts +39 -0
- package/models/components/takeoutstatusresponse.d.ts.map +1 -0
- package/models/components/takeoutstatusresponse.js +79 -0
- package/models/components/takeoutstatusresponse.js.map +1 -0
- package/models/operations/gettakeoutapiv1takeoutsgetjobidget.d.ts +29 -0
- package/models/operations/gettakeoutapiv1takeoutsgetjobidget.d.ts.map +1 -0
- package/models/operations/gettakeoutapiv1takeoutsgetjobidget.js +68 -0
- package/models/operations/gettakeoutapiv1takeoutsgetjobidget.js.map +1 -0
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/insightslist.d.ts +73 -0
- package/models/operations/insightslist.d.ts.map +1 -0
- package/models/operations/insightslist.js +101 -0
- package/models/operations/insightslist.js.map +1 -0
- package/openapi.json +1080 -233
- package/package.json +1 -1
- package/sdk/insights.d.ts +10 -1
- package/sdk/insights.d.ts.map +1 -1
- package/sdk/insights.js +11 -0
- package/sdk/insights.js.map +1 -1
- package/sdk/prompts.d.ts +7 -0
- package/sdk/prompts.d.ts.map +1 -1
- package/sdk/prompts.js +10 -0
- package/sdk/prompts.js.map +1 -1
- package/sdk/sdk.d.ts +5 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +7 -3
- package/sdk/sdk.js.map +1 -1
- package/sdk/takeouts.d.ts +14 -0
- package/sdk/takeouts.d.ts.map +1 -0
- package/sdk/takeouts.js +26 -0
- package/sdk/takeouts.js.map +1 -0
- package/sdk/v1.d.ts +15 -0
- package/sdk/v1.d.ts.map +1 -1
- package/sdk/v1.js +24 -0
- package/sdk/v1.js.map +1 -1
- package/src/funcs/insightsList.ts +148 -0
- package/src/funcs/promptsPromptGetSupportedLlms.ts +112 -0
- package/src/funcs/takeoutsCreateTakeoutApiV1TakeoutsCreatePost.ts +132 -0
- package/src/funcs/takeoutsGetTakeoutApiV1TakeoutsGetJobIdGet.ts +142 -0
- package/src/funcs/v1CreateTakeoutApiV1TakeoutsCreatePost.ts +132 -0
- package/src/funcs/v1GetTakeoutApiV1TakeoutsGetJobIdGet.ts +142 -0
- package/src/funcs/v1List.ts +148 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/createtakeoutresponse.ts +81 -0
- package/src/models/components/daotakeoutcreate.ts +81 -0
- package/src/models/components/index.ts +8 -0
- package/src/models/components/insightsoutput.ts +207 -0
- package/src/models/components/insightsproperties.ts +35 -0
- package/src/models/components/listresponseinsightsoutput.ts +116 -0
- package/src/models/components/promptllmconfig.ts +1 -1
- package/src/models/components/supportedllm.ts +119 -0
- package/src/models/components/takeoutrequeststatus.ts +42 -0
- package/src/models/components/takeoutstatusresponse.ts +99 -0
- package/src/models/operations/gettakeoutapiv1takeoutsgetjobidget.ts +87 -0
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/insightslist.ts +151 -0
- package/src/sdk/insights.ts +22 -1
- package/src/sdk/prompts.ts +16 -0
- package/src/sdk/sdk.ts +11 -5
- package/src/sdk/takeouts.ts +40 -0
- package/src/sdk/v1.ts +48 -0
package/openapi.json
CHANGED
|
@@ -1592,6 +1592,224 @@
|
|
|
1592
1592
|
}
|
|
1593
1593
|
}
|
|
1594
1594
|
},
|
|
1595
|
+
"/api/v1/insights/": {
|
|
1596
|
+
"get": {
|
|
1597
|
+
"tags": [
|
|
1598
|
+
"insights",
|
|
1599
|
+
"V1"
|
|
1600
|
+
],
|
|
1601
|
+
"summary": "Insights List",
|
|
1602
|
+
"description": "List the existing insight_tools",
|
|
1603
|
+
"operationId": "insights_list",
|
|
1604
|
+
"security": [
|
|
1605
|
+
{
|
|
1606
|
+
"APIKeyHeader": []
|
|
1607
|
+
}
|
|
1608
|
+
],
|
|
1609
|
+
"parameters": [
|
|
1610
|
+
{
|
|
1611
|
+
"name": "page",
|
|
1612
|
+
"in": "query",
|
|
1613
|
+
"required": false,
|
|
1614
|
+
"schema": {
|
|
1615
|
+
"anyOf": [
|
|
1616
|
+
{
|
|
1617
|
+
"type": "integer",
|
|
1618
|
+
"minimum": 0
|
|
1619
|
+
},
|
|
1620
|
+
{
|
|
1621
|
+
"type": "null"
|
|
1622
|
+
}
|
|
1623
|
+
],
|
|
1624
|
+
"description": "The page number from which to start (0-based)",
|
|
1625
|
+
"examples": [
|
|
1626
|
+
0
|
|
1627
|
+
],
|
|
1628
|
+
"default": 0,
|
|
1629
|
+
"title": "Page"
|
|
1630
|
+
},
|
|
1631
|
+
"description": "The page number from which to start (0-based)"
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"name": "limit",
|
|
1635
|
+
"in": "query",
|
|
1636
|
+
"required": false,
|
|
1637
|
+
"schema": {
|
|
1638
|
+
"type": "integer",
|
|
1639
|
+
"minimum": 0,
|
|
1640
|
+
"description": "The maximum number of items to return",
|
|
1641
|
+
"examples": [
|
|
1642
|
+
25
|
|
1643
|
+
],
|
|
1644
|
+
"default": 25,
|
|
1645
|
+
"title": "Limit"
|
|
1646
|
+
},
|
|
1647
|
+
"description": "The maximum number of items to return"
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
"name": "search_fields",
|
|
1651
|
+
"in": "query",
|
|
1652
|
+
"required": false,
|
|
1653
|
+
"schema": {
|
|
1654
|
+
"type": "array",
|
|
1655
|
+
"items": {
|
|
1656
|
+
"$ref": "#/components/schemas/InsightsProperties"
|
|
1657
|
+
},
|
|
1658
|
+
"description": "String names of fields to search. Correspond by index to search field values",
|
|
1659
|
+
"examples": [
|
|
1660
|
+
"name"
|
|
1661
|
+
],
|
|
1662
|
+
"default": [],
|
|
1663
|
+
"title": "Search Fields"
|
|
1664
|
+
},
|
|
1665
|
+
"description": "String names of fields to search. Correspond by index to search field values"
|
|
1666
|
+
},
|
|
1667
|
+
{
|
|
1668
|
+
"name": "search_field_values",
|
|
1669
|
+
"in": "query",
|
|
1670
|
+
"required": false,
|
|
1671
|
+
"schema": {
|
|
1672
|
+
"type": "array",
|
|
1673
|
+
"items": {
|
|
1674
|
+
"type": "string"
|
|
1675
|
+
},
|
|
1676
|
+
"description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
|
|
1677
|
+
"examples": [
|
|
1678
|
+
"Some Object Name"
|
|
1679
|
+
],
|
|
1680
|
+
"default": [],
|
|
1681
|
+
"title": "Search Field Values"
|
|
1682
|
+
},
|
|
1683
|
+
"description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "order_by",
|
|
1687
|
+
"in": "query",
|
|
1688
|
+
"required": false,
|
|
1689
|
+
"schema": {
|
|
1690
|
+
"anyOf": [
|
|
1691
|
+
{
|
|
1692
|
+
"$ref": "#/components/schemas/InsightsProperties"
|
|
1693
|
+
},
|
|
1694
|
+
{
|
|
1695
|
+
"type": "null"
|
|
1696
|
+
}
|
|
1697
|
+
],
|
|
1698
|
+
"description": "The field whose value should be used to order the results",
|
|
1699
|
+
"examples": [
|
|
1700
|
+
"name"
|
|
1701
|
+
],
|
|
1702
|
+
"title": "Order By"
|
|
1703
|
+
},
|
|
1704
|
+
"description": "The field whose value should be used to order the results"
|
|
1705
|
+
},
|
|
1706
|
+
{
|
|
1707
|
+
"name": "order_by_direction",
|
|
1708
|
+
"in": "query",
|
|
1709
|
+
"required": false,
|
|
1710
|
+
"schema": {
|
|
1711
|
+
"anyOf": [
|
|
1712
|
+
{
|
|
1713
|
+
"$ref": "#/components/schemas/OrderByDirection"
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
"type": "null"
|
|
1717
|
+
}
|
|
1718
|
+
],
|
|
1719
|
+
"description": "The direction in which to order the results",
|
|
1720
|
+
"title": "Order By Direction"
|
|
1721
|
+
},
|
|
1722
|
+
"description": "The direction in which to order the results"
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"name": "fields",
|
|
1726
|
+
"in": "query",
|
|
1727
|
+
"required": false,
|
|
1728
|
+
"schema": {
|
|
1729
|
+
"anyOf": [
|
|
1730
|
+
{
|
|
1731
|
+
"type": "array",
|
|
1732
|
+
"items": {
|
|
1733
|
+
"$ref": "#/components/schemas/InsightsProperties"
|
|
1734
|
+
}
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"type": "null"
|
|
1738
|
+
}
|
|
1739
|
+
],
|
|
1740
|
+
"description": "The fields to include in the response",
|
|
1741
|
+
"default": [],
|
|
1742
|
+
"title": "Fields"
|
|
1743
|
+
},
|
|
1744
|
+
"description": "The fields to include in the response"
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"name": "start_datetime",
|
|
1748
|
+
"in": "query",
|
|
1749
|
+
"required": false,
|
|
1750
|
+
"schema": {
|
|
1751
|
+
"anyOf": [
|
|
1752
|
+
{
|
|
1753
|
+
"type": "string"
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"type": "null"
|
|
1757
|
+
}
|
|
1758
|
+
],
|
|
1759
|
+
"description": "The start datetime for filtering results",
|
|
1760
|
+
"examples": [
|
|
1761
|
+
"2023-01-01T00:00:00Z"
|
|
1762
|
+
],
|
|
1763
|
+
"title": "Start Datetime"
|
|
1764
|
+
},
|
|
1765
|
+
"description": "The start datetime for filtering results"
|
|
1766
|
+
},
|
|
1767
|
+
{
|
|
1768
|
+
"name": "end_datetime",
|
|
1769
|
+
"in": "query",
|
|
1770
|
+
"required": false,
|
|
1771
|
+
"schema": {
|
|
1772
|
+
"anyOf": [
|
|
1773
|
+
{
|
|
1774
|
+
"type": "string"
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"type": "null"
|
|
1778
|
+
}
|
|
1779
|
+
],
|
|
1780
|
+
"description": "The end datetime for filtering results",
|
|
1781
|
+
"examples": [
|
|
1782
|
+
"2024-01-01T00:00:00Z"
|
|
1783
|
+
],
|
|
1784
|
+
"title": "End Datetime"
|
|
1785
|
+
},
|
|
1786
|
+
"description": "The end datetime for filtering results"
|
|
1787
|
+
}
|
|
1788
|
+
],
|
|
1789
|
+
"responses": {
|
|
1790
|
+
"200": {
|
|
1791
|
+
"description": "Successful Response",
|
|
1792
|
+
"content": {
|
|
1793
|
+
"application/json": {
|
|
1794
|
+
"schema": {
|
|
1795
|
+
"$ref": "#/components/schemas/ListResponse_InsightsOutput_"
|
|
1796
|
+
}
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
"422": {
|
|
1801
|
+
"description": "Validation Error",
|
|
1802
|
+
"content": {
|
|
1803
|
+
"application/json": {
|
|
1804
|
+
"schema": {
|
|
1805
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1808
|
+
}
|
|
1809
|
+
}
|
|
1810
|
+
}
|
|
1811
|
+
}
|
|
1812
|
+
},
|
|
1595
1813
|
"/api/v1/insights/workflows/": {
|
|
1596
1814
|
"get": {
|
|
1597
1815
|
"tags": [
|
|
@@ -3321,6 +3539,38 @@
|
|
|
3321
3539
|
}
|
|
3322
3540
|
}
|
|
3323
3541
|
},
|
|
3542
|
+
"/api/v1/prompts/llms/supported": {
|
|
3543
|
+
"get": {
|
|
3544
|
+
"tags": [
|
|
3545
|
+
"prompts",
|
|
3546
|
+
"V1"
|
|
3547
|
+
],
|
|
3548
|
+
"summary": "Get Supported Llm Configs",
|
|
3549
|
+
"description": "Get supported LLM configs.",
|
|
3550
|
+
"operationId": "prompt_get_supported_llms",
|
|
3551
|
+
"responses": {
|
|
3552
|
+
"200": {
|
|
3553
|
+
"description": "Successful Response",
|
|
3554
|
+
"content": {
|
|
3555
|
+
"application/json": {
|
|
3556
|
+
"schema": {
|
|
3557
|
+
"items": {
|
|
3558
|
+
"$ref": "#/components/schemas/SupportedLlm"
|
|
3559
|
+
},
|
|
3560
|
+
"type": "array",
|
|
3561
|
+
"title": "Response Prompt Get Supported Llms"
|
|
3562
|
+
}
|
|
3563
|
+
}
|
|
3564
|
+
}
|
|
3565
|
+
}
|
|
3566
|
+
},
|
|
3567
|
+
"security": [
|
|
3568
|
+
{
|
|
3569
|
+
"APIKeyHeader": []
|
|
3570
|
+
}
|
|
3571
|
+
]
|
|
3572
|
+
}
|
|
3573
|
+
},
|
|
3324
3574
|
"/api/v1/services/": {
|
|
3325
3575
|
"get": {
|
|
3326
3576
|
"tags": [
|
|
@@ -6940,7 +7190,7 @@
|
|
|
6940
7190
|
},
|
|
6941
7191
|
"x-speakeasy-ignore": true
|
|
6942
7192
|
},
|
|
6943
|
-
"
|
|
7193
|
+
"post": {
|
|
6944
7194
|
"tags": [
|
|
6945
7195
|
"outbound.batches",
|
|
6946
7196
|
"V1"
|
|
@@ -7025,7 +7275,7 @@
|
|
|
7025
7275
|
"content": {
|
|
7026
7276
|
"application/json": {
|
|
7027
7277
|
"schema": {
|
|
7028
|
-
"$ref": "#/components/schemas/
|
|
7278
|
+
"$ref": "#/components/schemas/BatchDetails"
|
|
7029
7279
|
}
|
|
7030
7280
|
}
|
|
7031
7281
|
}
|
|
@@ -7043,13 +7293,13 @@
|
|
|
7043
7293
|
},
|
|
7044
7294
|
"x-speakeasy-ignore": true
|
|
7045
7295
|
},
|
|
7046
|
-
"
|
|
7296
|
+
"put": {
|
|
7047
7297
|
"tags": [
|
|
7048
7298
|
"outbound.batches",
|
|
7049
7299
|
"V1"
|
|
7050
7300
|
],
|
|
7051
|
-
"summary": "
|
|
7052
|
-
"operationId": "
|
|
7301
|
+
"summary": "Update Outbound Communication Batch",
|
|
7302
|
+
"operationId": "outbound_batch_update",
|
|
7053
7303
|
"security": [
|
|
7054
7304
|
{
|
|
7055
7305
|
"APIKeyHeader": []
|
|
@@ -7069,9 +7319,9 @@
|
|
|
7069
7319
|
"requestBody": {
|
|
7070
7320
|
"required": true,
|
|
7071
7321
|
"content": {
|
|
7072
|
-
"application/
|
|
7322
|
+
"application/json": {
|
|
7073
7323
|
"schema": {
|
|
7074
|
-
"$ref": "#/components/schemas/
|
|
7324
|
+
"$ref": "#/components/schemas/CommunicationBatch"
|
|
7075
7325
|
}
|
|
7076
7326
|
}
|
|
7077
7327
|
}
|
|
@@ -7081,7 +7331,9 @@
|
|
|
7081
7331
|
"description": "Successful Response",
|
|
7082
7332
|
"content": {
|
|
7083
7333
|
"application/json": {
|
|
7084
|
-
"schema": {
|
|
7334
|
+
"schema": {
|
|
7335
|
+
"$ref": "#/components/schemas/CommunicationBatch"
|
|
7336
|
+
}
|
|
7085
7337
|
}
|
|
7086
7338
|
}
|
|
7087
7339
|
},
|
|
@@ -7097,10 +7349,65 @@
|
|
|
7097
7349
|
}
|
|
7098
7350
|
},
|
|
7099
7351
|
"x-speakeasy-ignore": true
|
|
7100
|
-
}
|
|
7101
|
-
|
|
7102
|
-
|
|
7103
|
-
|
|
7352
|
+
},
|
|
7353
|
+
"delete": {
|
|
7354
|
+
"tags": [
|
|
7355
|
+
"outbound.batches",
|
|
7356
|
+
"V1"
|
|
7357
|
+
],
|
|
7358
|
+
"summary": "Delete Outbound Communication Batch",
|
|
7359
|
+
"operationId": "outbound_batch_delete",
|
|
7360
|
+
"security": [
|
|
7361
|
+
{
|
|
7362
|
+
"APIKeyHeader": []
|
|
7363
|
+
}
|
|
7364
|
+
],
|
|
7365
|
+
"parameters": [
|
|
7366
|
+
{
|
|
7367
|
+
"name": "batch_id",
|
|
7368
|
+
"in": "path",
|
|
7369
|
+
"required": true,
|
|
7370
|
+
"schema": {
|
|
7371
|
+
"type": "string",
|
|
7372
|
+
"title": "Batch Id"
|
|
7373
|
+
}
|
|
7374
|
+
}
|
|
7375
|
+
],
|
|
7376
|
+
"requestBody": {
|
|
7377
|
+
"required": true,
|
|
7378
|
+
"content": {
|
|
7379
|
+
"application/x-www-form-urlencoded": {
|
|
7380
|
+
"schema": {
|
|
7381
|
+
"$ref": "#/components/schemas/Body_outbound_batch_delete"
|
|
7382
|
+
}
|
|
7383
|
+
}
|
|
7384
|
+
}
|
|
7385
|
+
},
|
|
7386
|
+
"responses": {
|
|
7387
|
+
"200": {
|
|
7388
|
+
"description": "Successful Response",
|
|
7389
|
+
"content": {
|
|
7390
|
+
"application/json": {
|
|
7391
|
+
"schema": {}
|
|
7392
|
+
}
|
|
7393
|
+
}
|
|
7394
|
+
},
|
|
7395
|
+
"422": {
|
|
7396
|
+
"description": "Validation Error",
|
|
7397
|
+
"content": {
|
|
7398
|
+
"application/json": {
|
|
7399
|
+
"schema": {
|
|
7400
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
7401
|
+
}
|
|
7402
|
+
}
|
|
7403
|
+
}
|
|
7404
|
+
}
|
|
7405
|
+
},
|
|
7406
|
+
"x-speakeasy-ignore": true
|
|
7407
|
+
}
|
|
7408
|
+
},
|
|
7409
|
+
"/api/v1/outbound/batches/{batch_id}/upload_batch": {
|
|
7410
|
+
"post": {
|
|
7104
7411
|
"tags": [
|
|
7105
7412
|
"outbound.batches",
|
|
7106
7413
|
"V1"
|
|
@@ -8128,19 +8435,105 @@
|
|
|
8128
8435
|
}
|
|
8129
8436
|
}
|
|
8130
8437
|
}
|
|
8438
|
+
},
|
|
8439
|
+
"/api/v1/takeouts/create": {
|
|
8440
|
+
"post": {
|
|
8441
|
+
"tags": [
|
|
8442
|
+
"takeouts",
|
|
8443
|
+
"V1"
|
|
8444
|
+
],
|
|
8445
|
+
"summary": "Create Takeout",
|
|
8446
|
+
"operationId": "create_takeout_api_v1_takeouts_create_post",
|
|
8447
|
+
"requestBody": {
|
|
8448
|
+
"content": {
|
|
8449
|
+
"application/json": {
|
|
8450
|
+
"schema": {
|
|
8451
|
+
"$ref": "#/components/schemas/DaoTakeoutCreate"
|
|
8452
|
+
}
|
|
8453
|
+
}
|
|
8454
|
+
},
|
|
8455
|
+
"required": true
|
|
8456
|
+
},
|
|
8457
|
+
"responses": {
|
|
8458
|
+
"200": {
|
|
8459
|
+
"description": "Successful Response",
|
|
8460
|
+
"content": {
|
|
8461
|
+
"application/json": {
|
|
8462
|
+
"schema": {
|
|
8463
|
+
"$ref": "#/components/schemas/CreateTakeoutResponse"
|
|
8464
|
+
}
|
|
8465
|
+
}
|
|
8466
|
+
}
|
|
8467
|
+
},
|
|
8468
|
+
"422": {
|
|
8469
|
+
"description": "Validation Error",
|
|
8470
|
+
"content": {
|
|
8471
|
+
"application/json": {
|
|
8472
|
+
"schema": {
|
|
8473
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
8474
|
+
}
|
|
8475
|
+
}
|
|
8476
|
+
}
|
|
8477
|
+
}
|
|
8478
|
+
},
|
|
8479
|
+
"security": [
|
|
8480
|
+
{
|
|
8481
|
+
"APIKeyHeader": []
|
|
8482
|
+
}
|
|
8483
|
+
]
|
|
8484
|
+
}
|
|
8485
|
+
},
|
|
8486
|
+
"/api/v1/takeouts/get/{job_id}": {
|
|
8487
|
+
"get": {
|
|
8488
|
+
"tags": [
|
|
8489
|
+
"takeouts",
|
|
8490
|
+
"V1"
|
|
8491
|
+
],
|
|
8492
|
+
"summary": "Get Takeout",
|
|
8493
|
+
"operationId": "get_takeout_api_v1_takeouts_get__job_id__get",
|
|
8494
|
+
"security": [
|
|
8495
|
+
{
|
|
8496
|
+
"APIKeyHeader": []
|
|
8497
|
+
}
|
|
8498
|
+
],
|
|
8499
|
+
"parameters": [
|
|
8500
|
+
{
|
|
8501
|
+
"name": "job_id",
|
|
8502
|
+
"in": "path",
|
|
8503
|
+
"required": true,
|
|
8504
|
+
"schema": {
|
|
8505
|
+
"type": "string",
|
|
8506
|
+
"title": "Job Id"
|
|
8507
|
+
}
|
|
8508
|
+
}
|
|
8509
|
+
],
|
|
8510
|
+
"responses": {
|
|
8511
|
+
"200": {
|
|
8512
|
+
"description": "Successful Response",
|
|
8513
|
+
"content": {
|
|
8514
|
+
"application/json": {
|
|
8515
|
+
"schema": {
|
|
8516
|
+
"$ref": "#/components/schemas/TakeoutStatusResponse"
|
|
8517
|
+
}
|
|
8518
|
+
}
|
|
8519
|
+
}
|
|
8520
|
+
},
|
|
8521
|
+
"422": {
|
|
8522
|
+
"description": "Validation Error",
|
|
8523
|
+
"content": {
|
|
8524
|
+
"application/json": {
|
|
8525
|
+
"schema": {
|
|
8526
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
8527
|
+
}
|
|
8528
|
+
}
|
|
8529
|
+
}
|
|
8530
|
+
}
|
|
8531
|
+
}
|
|
8532
|
+
}
|
|
8131
8533
|
}
|
|
8132
8534
|
},
|
|
8133
8535
|
"components": {
|
|
8134
8536
|
"schemas": {
|
|
8135
|
-
"ActionMode": {
|
|
8136
|
-
"type": "string",
|
|
8137
|
-
"enum": [
|
|
8138
|
-
"BATCH",
|
|
8139
|
-
"INTERACTIVE"
|
|
8140
|
-
],
|
|
8141
|
-
"title": "ActionMode",
|
|
8142
|
-
"description": "Mode of outbound campaign."
|
|
8143
|
-
},
|
|
8144
8537
|
"AgentCreate": {
|
|
8145
8538
|
"properties": {
|
|
8146
8539
|
"name": {
|
|
@@ -9268,18 +9661,166 @@
|
|
|
9268
9661
|
"title": "AvailableTargetProperties",
|
|
9269
9662
|
"description": "Names of target fields supported for filtering/sorting on available targets list endpoint."
|
|
9270
9663
|
},
|
|
9664
|
+
"BatchDetails": {
|
|
9665
|
+
"properties": {
|
|
9666
|
+
"batch_id": {
|
|
9667
|
+
"type": "string",
|
|
9668
|
+
"title": "Batch Id",
|
|
9669
|
+
"description": "Unique ID for conversation batch",
|
|
9670
|
+
"examples": [
|
|
9671
|
+
"20250117.9"
|
|
9672
|
+
]
|
|
9673
|
+
},
|
|
9674
|
+
"campaign_id": {
|
|
9675
|
+
"type": "integer",
|
|
9676
|
+
"title": "Campaign Id",
|
|
9677
|
+
"description": "Unique ID for campaign",
|
|
9678
|
+
"examples": [
|
|
9679
|
+
1
|
|
9680
|
+
]
|
|
9681
|
+
},
|
|
9682
|
+
"expires_on": {
|
|
9683
|
+
"anyOf": [
|
|
9684
|
+
{
|
|
9685
|
+
"type": "string"
|
|
9686
|
+
},
|
|
9687
|
+
{
|
|
9688
|
+
"type": "null"
|
|
9689
|
+
}
|
|
9690
|
+
],
|
|
9691
|
+
"title": "Expires On",
|
|
9692
|
+
"description": "Timestamp of batch expiration",
|
|
9693
|
+
"examples": [
|
|
9694
|
+
"2024-01-01T00:00:00Z"
|
|
9695
|
+
]
|
|
9696
|
+
},
|
|
9697
|
+
"status": {
|
|
9698
|
+
"$ref": "#/components/schemas/BatchStatus",
|
|
9699
|
+
"description": "Status of batch",
|
|
9700
|
+
"default": "PENDING",
|
|
9701
|
+
"examples": [
|
|
9702
|
+
"PENDING",
|
|
9703
|
+
"ACTIVE",
|
|
9704
|
+
"PAUSED",
|
|
9705
|
+
"IDLE",
|
|
9706
|
+
"CANCELED",
|
|
9707
|
+
"EXPIRED"
|
|
9708
|
+
]
|
|
9709
|
+
},
|
|
9710
|
+
"count": {
|
|
9711
|
+
"anyOf": [
|
|
9712
|
+
{
|
|
9713
|
+
"type": "integer"
|
|
9714
|
+
},
|
|
9715
|
+
{
|
|
9716
|
+
"type": "null"
|
|
9717
|
+
}
|
|
9718
|
+
],
|
|
9719
|
+
"title": "Count",
|
|
9720
|
+
"description": "Number of requests in batch",
|
|
9721
|
+
"examples": [
|
|
9722
|
+
152
|
|
9723
|
+
]
|
|
9724
|
+
},
|
|
9725
|
+
"created_at": {
|
|
9726
|
+
"type": "string",
|
|
9727
|
+
"title": "Created At",
|
|
9728
|
+
"description": "Timestamp of batch creation",
|
|
9729
|
+
"examples": [
|
|
9730
|
+
"2024-01-01T00:00:00Z"
|
|
9731
|
+
]
|
|
9732
|
+
},
|
|
9733
|
+
"deleted_at": {
|
|
9734
|
+
"anyOf": [
|
|
9735
|
+
{
|
|
9736
|
+
"type": "string"
|
|
9737
|
+
},
|
|
9738
|
+
{
|
|
9739
|
+
"type": "null"
|
|
9740
|
+
}
|
|
9741
|
+
],
|
|
9742
|
+
"title": "Deleted At",
|
|
9743
|
+
"description": "Timestamp of batch deletion",
|
|
9744
|
+
"examples": [
|
|
9745
|
+
"2024-01-01T00:00:00Z"
|
|
9746
|
+
]
|
|
9747
|
+
},
|
|
9748
|
+
"deleted_reason": {
|
|
9749
|
+
"anyOf": [
|
|
9750
|
+
{
|
|
9751
|
+
"type": "string"
|
|
9752
|
+
},
|
|
9753
|
+
{
|
|
9754
|
+
"type": "null"
|
|
9755
|
+
}
|
|
9756
|
+
],
|
|
9757
|
+
"title": "Deleted Reason",
|
|
9758
|
+
"description": "Reason for batch deletion",
|
|
9759
|
+
"examples": [
|
|
9760
|
+
"User request"
|
|
9761
|
+
]
|
|
9762
|
+
},
|
|
9763
|
+
"last_worked_on": {
|
|
9764
|
+
"anyOf": [
|
|
9765
|
+
{
|
|
9766
|
+
"type": "string"
|
|
9767
|
+
},
|
|
9768
|
+
{
|
|
9769
|
+
"type": "null"
|
|
9770
|
+
}
|
|
9771
|
+
],
|
|
9772
|
+
"title": "Last Worked On",
|
|
9773
|
+
"description": "Timestamp of last batch activity",
|
|
9774
|
+
"examples": [
|
|
9775
|
+
"2024-01-01T00:00:00Z"
|
|
9776
|
+
]
|
|
9777
|
+
},
|
|
9778
|
+
"last_updated_by": {
|
|
9779
|
+
"type": "string",
|
|
9780
|
+
"title": "Last Updated By",
|
|
9781
|
+
"description": "Email of user who last updated campaign",
|
|
9782
|
+
"examples": [
|
|
9783
|
+
"user@email.com"
|
|
9784
|
+
]
|
|
9785
|
+
},
|
|
9786
|
+
"status_counts": {
|
|
9787
|
+
"anyOf": [
|
|
9788
|
+
{
|
|
9789
|
+
"type": "object"
|
|
9790
|
+
},
|
|
9791
|
+
{
|
|
9792
|
+
"type": "null"
|
|
9793
|
+
}
|
|
9794
|
+
],
|
|
9795
|
+
"title": "Status Counts",
|
|
9796
|
+
"description": "Counts of requests by status",
|
|
9797
|
+
"examples": [
|
|
9798
|
+
{
|
|
9799
|
+
"CANCELED": 7,
|
|
9800
|
+
"CONNECTED": 100,
|
|
9801
|
+
"DUPLICATE": 5,
|
|
9802
|
+
"FAILED": 10,
|
|
9803
|
+
"INITIATED": 20,
|
|
9804
|
+
"PENDING": 10
|
|
9805
|
+
}
|
|
9806
|
+
]
|
|
9807
|
+
}
|
|
9808
|
+
},
|
|
9809
|
+
"type": "object",
|
|
9810
|
+
"required": [
|
|
9811
|
+
"batch_id",
|
|
9812
|
+
"campaign_id",
|
|
9813
|
+
"last_updated_by"
|
|
9814
|
+
],
|
|
9815
|
+
"title": "BatchDetails"
|
|
9816
|
+
},
|
|
9271
9817
|
"BatchProperties": {
|
|
9272
9818
|
"type": "string",
|
|
9273
9819
|
"enum": [
|
|
9274
9820
|
"batch_id",
|
|
9275
9821
|
"campaign_id",
|
|
9276
9822
|
"status",
|
|
9277
|
-
"
|
|
9278
|
-
"source",
|
|
9279
|
-
"rate",
|
|
9280
|
-
"expires_on",
|
|
9281
|
-
"retry_count",
|
|
9282
|
-
"retry_interval"
|
|
9823
|
+
"expires_on"
|
|
9283
9824
|
],
|
|
9284
9825
|
"title": "BatchProperties"
|
|
9285
9826
|
},
|
|
@@ -9288,12 +9829,13 @@
|
|
|
9288
9829
|
"enum": [
|
|
9289
9830
|
"PENDING",
|
|
9290
9831
|
"ACTIVE",
|
|
9832
|
+
"PAUSED",
|
|
9291
9833
|
"IDLE",
|
|
9292
9834
|
"CANCELED",
|
|
9293
|
-
"
|
|
9835
|
+
"EXPIRED"
|
|
9294
9836
|
],
|
|
9295
9837
|
"title": "BatchStatus",
|
|
9296
|
-
"description": "Status of a communication batch.
|
|
9838
|
+
"description": "Status of a communication batch."
|
|
9297
9839
|
},
|
|
9298
9840
|
"Body_directory_member_bulk_load": {
|
|
9299
9841
|
"properties": {
|
|
@@ -9342,25 +9884,13 @@
|
|
|
9342
9884
|
"id",
|
|
9343
9885
|
"campaign_name",
|
|
9344
9886
|
"campaign_variables",
|
|
9345
|
-
"status",
|
|
9346
9887
|
"daily_start_time",
|
|
9347
9888
|
"daily_end_time",
|
|
9348
9889
|
"timezone",
|
|
9349
|
-
"
|
|
9890
|
+
"source"
|
|
9350
9891
|
],
|
|
9351
9892
|
"title": "CampaignProperties"
|
|
9352
9893
|
},
|
|
9353
|
-
"CampaignStatus": {
|
|
9354
|
-
"type": "string",
|
|
9355
|
-
"enum": [
|
|
9356
|
-
"PENDING",
|
|
9357
|
-
"ACTIVE",
|
|
9358
|
-
"PAUSED",
|
|
9359
|
-
"CANCELED"
|
|
9360
|
-
],
|
|
9361
|
-
"title": "CampaignStatus",
|
|
9362
|
-
"description": "Status of an outbound campaign."
|
|
9363
|
-
},
|
|
9364
9894
|
"Channel": {
|
|
9365
9895
|
"properties": {
|
|
9366
9896
|
"name": {
|
|
@@ -9728,32 +10258,6 @@
|
|
|
9728
10258
|
1
|
|
9729
10259
|
]
|
|
9730
10260
|
},
|
|
9731
|
-
"type": {
|
|
9732
|
-
"type": "string",
|
|
9733
|
-
"title": "Type",
|
|
9734
|
-
"description": "Method of communication for the batch",
|
|
9735
|
-
"examples": [
|
|
9736
|
-
"CALL",
|
|
9737
|
-
"SMS",
|
|
9738
|
-
"EMAIL"
|
|
9739
|
-
]
|
|
9740
|
-
},
|
|
9741
|
-
"source": {
|
|
9742
|
-
"type": "string",
|
|
9743
|
-
"title": "Source",
|
|
9744
|
-
"description": "Source phone number, email, or SMS number",
|
|
9745
|
-
"examples": [
|
|
9746
|
-
"account@email.com"
|
|
9747
|
-
]
|
|
9748
|
-
},
|
|
9749
|
-
"rate": {
|
|
9750
|
-
"type": "integer",
|
|
9751
|
-
"title": "Rate",
|
|
9752
|
-
"description": "Target number of outreach calls per minute",
|
|
9753
|
-
"examples": [
|
|
9754
|
-
5
|
|
9755
|
-
]
|
|
9756
|
-
},
|
|
9757
10261
|
"expires_on": {
|
|
9758
10262
|
"anyOf": [
|
|
9759
10263
|
{
|
|
@@ -9769,42 +10273,32 @@
|
|
|
9769
10273
|
"2024-01-01T00:00:00Z"
|
|
9770
10274
|
]
|
|
9771
10275
|
},
|
|
9772
|
-
"
|
|
9773
|
-
"
|
|
9774
|
-
"
|
|
9775
|
-
"
|
|
9776
|
-
"default": 0,
|
|
10276
|
+
"status": {
|
|
10277
|
+
"$ref": "#/components/schemas/BatchStatus",
|
|
10278
|
+
"description": "Status of batch",
|
|
10279
|
+
"default": "PENDING",
|
|
9777
10280
|
"examples": [
|
|
9778
|
-
|
|
10281
|
+
"PENDING",
|
|
10282
|
+
"ACTIVE",
|
|
10283
|
+
"PAUSED",
|
|
10284
|
+
"IDLE",
|
|
10285
|
+
"CANCELED",
|
|
10286
|
+
"EXPIRED"
|
|
9779
10287
|
]
|
|
9780
10288
|
},
|
|
9781
|
-
"
|
|
10289
|
+
"count": {
|
|
9782
10290
|
"anyOf": [
|
|
9783
10291
|
{
|
|
9784
|
-
"type": "
|
|
10292
|
+
"type": "integer"
|
|
9785
10293
|
},
|
|
9786
10294
|
{
|
|
9787
10295
|
"type": "null"
|
|
9788
10296
|
}
|
|
9789
10297
|
],
|
|
9790
|
-
"title": "
|
|
9791
|
-
"description": "
|
|
9792
|
-
"examples": [
|
|
9793
|
-
"30m",
|
|
9794
|
-
"12h",
|
|
9795
|
-
"7d"
|
|
9796
|
-
]
|
|
9797
|
-
},
|
|
9798
|
-
"status": {
|
|
9799
|
-
"$ref": "#/components/schemas/BatchStatus",
|
|
9800
|
-
"description": "Status of batch",
|
|
9801
|
-
"default": "PENDING",
|
|
10298
|
+
"title": "Count",
|
|
10299
|
+
"description": "Number of requests in batch",
|
|
9802
10300
|
"examples": [
|
|
9803
|
-
|
|
9804
|
-
"ACTIVE",
|
|
9805
|
-
"IDLE",
|
|
9806
|
-
"CANCELED",
|
|
9807
|
-
"COMPLETED"
|
|
10301
|
+
152
|
|
9808
10302
|
]
|
|
9809
10303
|
},
|
|
9810
10304
|
"created_at": {
|
|
@@ -9873,9 +10367,6 @@
|
|
|
9873
10367
|
"required": [
|
|
9874
10368
|
"batch_id",
|
|
9875
10369
|
"campaign_id",
|
|
9876
|
-
"type",
|
|
9877
|
-
"source",
|
|
9878
|
-
"rate",
|
|
9879
10370
|
"last_updated_by"
|
|
9880
10371
|
],
|
|
9881
10372
|
"title": "CommunicationBatch"
|
|
@@ -9898,32 +10389,6 @@
|
|
|
9898
10389
|
1
|
|
9899
10390
|
]
|
|
9900
10391
|
},
|
|
9901
|
-
"type": {
|
|
9902
|
-
"type": "string",
|
|
9903
|
-
"title": "Type",
|
|
9904
|
-
"description": "Method of communication for the batch",
|
|
9905
|
-
"examples": [
|
|
9906
|
-
"CALL",
|
|
9907
|
-
"SMS",
|
|
9908
|
-
"EMAIL"
|
|
9909
|
-
]
|
|
9910
|
-
},
|
|
9911
|
-
"source": {
|
|
9912
|
-
"type": "string",
|
|
9913
|
-
"title": "Source",
|
|
9914
|
-
"description": "Source phone number, email, or SMS number",
|
|
9915
|
-
"examples": [
|
|
9916
|
-
"account@email.com"
|
|
9917
|
-
]
|
|
9918
|
-
},
|
|
9919
|
-
"rate": {
|
|
9920
|
-
"type": "integer",
|
|
9921
|
-
"title": "Rate",
|
|
9922
|
-
"description": "Target number of outreach calls per minute",
|
|
9923
|
-
"examples": [
|
|
9924
|
-
5
|
|
9925
|
-
]
|
|
9926
|
-
},
|
|
9927
10392
|
"expires_on": {
|
|
9928
10393
|
"anyOf": [
|
|
9929
10394
|
{
|
|
@@ -9938,41 +10403,12 @@
|
|
|
9938
10403
|
"examples": [
|
|
9939
10404
|
"2024-01-01T00:00:00Z"
|
|
9940
10405
|
]
|
|
9941
|
-
},
|
|
9942
|
-
"retry_count": {
|
|
9943
|
-
"type": "integer",
|
|
9944
|
-
"title": "Retry Count",
|
|
9945
|
-
"description": "Number of retries per target",
|
|
9946
|
-
"default": 0,
|
|
9947
|
-
"examples": [
|
|
9948
|
-
1
|
|
9949
|
-
]
|
|
9950
|
-
},
|
|
9951
|
-
"retry_interval": {
|
|
9952
|
-
"anyOf": [
|
|
9953
|
-
{
|
|
9954
|
-
"type": "string"
|
|
9955
|
-
},
|
|
9956
|
-
{
|
|
9957
|
-
"type": "null"
|
|
9958
|
-
}
|
|
9959
|
-
],
|
|
9960
|
-
"title": "Retry Interval",
|
|
9961
|
-
"description": "How long to wait before retrying",
|
|
9962
|
-
"examples": [
|
|
9963
|
-
"30m",
|
|
9964
|
-
"12h",
|
|
9965
|
-
"7d"
|
|
9966
|
-
]
|
|
9967
10406
|
}
|
|
9968
10407
|
},
|
|
9969
10408
|
"type": "object",
|
|
9970
10409
|
"required": [
|
|
9971
10410
|
"batch_id",
|
|
9972
|
-
"campaign_id"
|
|
9973
|
-
"type",
|
|
9974
|
-
"source",
|
|
9975
|
-
"rate"
|
|
10411
|
+
"campaign_id"
|
|
9976
10412
|
],
|
|
9977
10413
|
"title": "CommunicationBatchInput"
|
|
9978
10414
|
},
|
|
@@ -10008,7 +10444,7 @@
|
|
|
10008
10444
|
"default": "PENDING",
|
|
10009
10445
|
"examples": [
|
|
10010
10446
|
"PENDING",
|
|
10011
|
-
"
|
|
10447
|
+
"DUPLICATE",
|
|
10012
10448
|
"INITIATED",
|
|
10013
10449
|
"CONNECTED",
|
|
10014
10450
|
"FAILED",
|
|
@@ -10062,7 +10498,7 @@
|
|
|
10062
10498
|
"default": "PENDING",
|
|
10063
10499
|
"examples": [
|
|
10064
10500
|
"PENDING",
|
|
10065
|
-
"
|
|
10501
|
+
"DUPLICATE",
|
|
10066
10502
|
"INITIATED",
|
|
10067
10503
|
"CONNECTED",
|
|
10068
10504
|
"FAILED",
|
|
@@ -10150,24 +10586,6 @@
|
|
|
10150
10586
|
"examples": [
|
|
10151
10587
|
1
|
|
10152
10588
|
]
|
|
10153
|
-
},
|
|
10154
|
-
"insights": {
|
|
10155
|
-
"anyOf": [
|
|
10156
|
-
{
|
|
10157
|
-
"type": "object"
|
|
10158
|
-
},
|
|
10159
|
-
{
|
|
10160
|
-
"type": "null"
|
|
10161
|
-
}
|
|
10162
|
-
],
|
|
10163
|
-
"title": "Insights",
|
|
10164
|
-
"description": "Insights from call",
|
|
10165
|
-
"examples": [
|
|
10166
|
-
{
|
|
10167
|
-
"rating": "Good",
|
|
10168
|
-
"summary": "The customer service agent successfully assisted the caller with their inquiry and the call ended positively."
|
|
10169
|
-
}
|
|
10170
|
-
]
|
|
10171
10589
|
}
|
|
10172
10590
|
},
|
|
10173
10591
|
"type": "object",
|
|
@@ -10337,6 +10755,25 @@
|
|
|
10337
10755
|
],
|
|
10338
10756
|
"title": "ConversationProperties"
|
|
10339
10757
|
},
|
|
10758
|
+
"CreateTakeoutResponse": {
|
|
10759
|
+
"properties": {
|
|
10760
|
+
"job_id": {
|
|
10761
|
+
"type": "string",
|
|
10762
|
+
"title": "Job Id"
|
|
10763
|
+
},
|
|
10764
|
+
"created_at": {
|
|
10765
|
+
"type": "string",
|
|
10766
|
+
"format": "date-time",
|
|
10767
|
+
"title": "Created At"
|
|
10768
|
+
}
|
|
10769
|
+
},
|
|
10770
|
+
"type": "object",
|
|
10771
|
+
"required": [
|
|
10772
|
+
"job_id",
|
|
10773
|
+
"created_at"
|
|
10774
|
+
],
|
|
10775
|
+
"title": "CreateTakeoutResponse"
|
|
10776
|
+
},
|
|
10340
10777
|
"CustomMessageCreateRequest": {
|
|
10341
10778
|
"properties": {
|
|
10342
10779
|
"name": {
|
|
@@ -10757,6 +11194,30 @@
|
|
|
10757
11194
|
"title": "CustomMessageUpdateRequest",
|
|
10758
11195
|
"description": "Request model to update an existing custom message."
|
|
10759
11196
|
},
|
|
11197
|
+
"DaoTakeoutCreate": {
|
|
11198
|
+
"properties": {
|
|
11199
|
+
"sub_organization_id": {
|
|
11200
|
+
"type": "integer",
|
|
11201
|
+
"title": "Sub Organization Id"
|
|
11202
|
+
},
|
|
11203
|
+
"requested_by": {
|
|
11204
|
+
"anyOf": [
|
|
11205
|
+
{
|
|
11206
|
+
"type": "integer"
|
|
11207
|
+
},
|
|
11208
|
+
{
|
|
11209
|
+
"type": "null"
|
|
11210
|
+
}
|
|
11211
|
+
],
|
|
11212
|
+
"title": "Requested By"
|
|
11213
|
+
}
|
|
11214
|
+
},
|
|
11215
|
+
"type": "object",
|
|
11216
|
+
"required": [
|
|
11217
|
+
"sub_organization_id"
|
|
11218
|
+
],
|
|
11219
|
+
"title": "DaoTakeoutCreate"
|
|
11220
|
+
},
|
|
10760
11221
|
"Dashboard": {
|
|
10761
11222
|
"properties": {
|
|
10762
11223
|
"embedded_id": {
|
|
@@ -12276,6 +12737,131 @@
|
|
|
12276
12737
|
],
|
|
12277
12738
|
"title": "InsightWorkflowProperties"
|
|
12278
12739
|
},
|
|
12740
|
+
"InsightsOutput": {
|
|
12741
|
+
"properties": {
|
|
12742
|
+
"id": {
|
|
12743
|
+
"type": "integer",
|
|
12744
|
+
"title": "Id",
|
|
12745
|
+
"description": "Unique ID for insight tool",
|
|
12746
|
+
"examples": [
|
|
12747
|
+
1
|
|
12748
|
+
]
|
|
12749
|
+
},
|
|
12750
|
+
"session_id": {
|
|
12751
|
+
"type": "integer",
|
|
12752
|
+
"title": "Session Id",
|
|
12753
|
+
"description": "Unique ID for session",
|
|
12754
|
+
"examples": [
|
|
12755
|
+
1
|
|
12756
|
+
]
|
|
12757
|
+
},
|
|
12758
|
+
"insight_tool_id": {
|
|
12759
|
+
"type": "integer",
|
|
12760
|
+
"title": "Insight Tool Id",
|
|
12761
|
+
"description": "Unique ID for insight tool",
|
|
12762
|
+
"examples": [
|
|
12763
|
+
1
|
|
12764
|
+
]
|
|
12765
|
+
},
|
|
12766
|
+
"insight_tool_version": {
|
|
12767
|
+
"type": "integer",
|
|
12768
|
+
"title": "Insight Tool Version",
|
|
12769
|
+
"description": "Version of insight tool",
|
|
12770
|
+
"examples": [
|
|
12771
|
+
1
|
|
12772
|
+
]
|
|
12773
|
+
},
|
|
12774
|
+
"insight_key": {
|
|
12775
|
+
"type": "string",
|
|
12776
|
+
"title": "Insight Key",
|
|
12777
|
+
"description": "Key for insight tool result",
|
|
12778
|
+
"examples": [
|
|
12779
|
+
"summary"
|
|
12780
|
+
]
|
|
12781
|
+
},
|
|
12782
|
+
"string_value": {
|
|
12783
|
+
"anyOf": [
|
|
12784
|
+
{
|
|
12785
|
+
"type": "string"
|
|
12786
|
+
},
|
|
12787
|
+
{
|
|
12788
|
+
"type": "null"
|
|
12789
|
+
}
|
|
12790
|
+
],
|
|
12791
|
+
"title": "String Value",
|
|
12792
|
+
"description": "String value of insight tool result",
|
|
12793
|
+
"examples": [
|
|
12794
|
+
"This is a summary of the call"
|
|
12795
|
+
]
|
|
12796
|
+
},
|
|
12797
|
+
"numeric_value": {
|
|
12798
|
+
"anyOf": [
|
|
12799
|
+
{
|
|
12800
|
+
"type": "number"
|
|
12801
|
+
},
|
|
12802
|
+
{
|
|
12803
|
+
"type": "null"
|
|
12804
|
+
}
|
|
12805
|
+
],
|
|
12806
|
+
"title": "Numeric Value",
|
|
12807
|
+
"description": "Numeric value of insight tool result",
|
|
12808
|
+
"examples": [
|
|
12809
|
+
1.0
|
|
12810
|
+
]
|
|
12811
|
+
},
|
|
12812
|
+
"json_value": {
|
|
12813
|
+
"type": "object",
|
|
12814
|
+
"title": "Json Value",
|
|
12815
|
+
"description": "JSON value of insight tool result",
|
|
12816
|
+
"examples": [
|
|
12817
|
+
{
|
|
12818
|
+
"content": " was there anything else that I can assist you with other than this",
|
|
12819
|
+
"role": "assistant",
|
|
12820
|
+
"start_time": 289
|
|
12821
|
+
}
|
|
12822
|
+
]
|
|
12823
|
+
},
|
|
12824
|
+
"created_at": {
|
|
12825
|
+
"type": "string",
|
|
12826
|
+
"format": "date-time",
|
|
12827
|
+
"title": "Created At",
|
|
12828
|
+
"description": "Timestamp at which insight tool result was created",
|
|
12829
|
+
"examples": [
|
|
12830
|
+
"2024-01-01T00:00:00Z"
|
|
12831
|
+
]
|
|
12832
|
+
},
|
|
12833
|
+
"updated_at": {
|
|
12834
|
+
"type": "string",
|
|
12835
|
+
"format": "date-time",
|
|
12836
|
+
"title": "Updated At",
|
|
12837
|
+
"description": "Timestamp at which insight tool result was last updated",
|
|
12838
|
+
"examples": [
|
|
12839
|
+
"2024-01-02T00:00:00Z"
|
|
12840
|
+
]
|
|
12841
|
+
}
|
|
12842
|
+
},
|
|
12843
|
+
"type": "object",
|
|
12844
|
+
"required": [
|
|
12845
|
+
"id",
|
|
12846
|
+
"session_id",
|
|
12847
|
+
"insight_tool_id",
|
|
12848
|
+
"insight_tool_version",
|
|
12849
|
+
"insight_key",
|
|
12850
|
+
"json_value"
|
|
12851
|
+
],
|
|
12852
|
+
"title": "InsightsOutput",
|
|
12853
|
+
"description": "Response model for an insight tool."
|
|
12854
|
+
},
|
|
12855
|
+
"InsightsProperties": {
|
|
12856
|
+
"type": "string",
|
|
12857
|
+
"enum": [
|
|
12858
|
+
"id",
|
|
12859
|
+
"session_id",
|
|
12860
|
+
"insight_key",
|
|
12861
|
+
"insight_tool_id"
|
|
12862
|
+
],
|
|
12863
|
+
"title": "InsightsProperties"
|
|
12864
|
+
},
|
|
12279
12865
|
"InternalTool": {
|
|
12280
12866
|
"properties": {
|
|
12281
12867
|
"type": {
|
|
@@ -12955,7 +13541,73 @@
|
|
|
12955
13541
|
"properties": {
|
|
12956
13542
|
"items": {
|
|
12957
13543
|
"items": {
|
|
12958
|
-
"$ref": "#/components/schemas/Conversation"
|
|
13544
|
+
"$ref": "#/components/schemas/Conversation"
|
|
13545
|
+
},
|
|
13546
|
+
"type": "array",
|
|
13547
|
+
"title": "Items",
|
|
13548
|
+
"description": "List of items returned from the query",
|
|
13549
|
+
"examples": []
|
|
13550
|
+
},
|
|
13551
|
+
"page": {
|
|
13552
|
+
"type": "integer",
|
|
13553
|
+
"title": "Page",
|
|
13554
|
+
"description": "The page number of the results (0-based)",
|
|
13555
|
+
"examples": [
|
|
13556
|
+
0
|
|
13557
|
+
]
|
|
13558
|
+
},
|
|
13559
|
+
"page_size": {
|
|
13560
|
+
"type": "integer",
|
|
13561
|
+
"title": "Page Size",
|
|
13562
|
+
"description": "The number of items returned per page",
|
|
13563
|
+
"examples": [
|
|
13564
|
+
25
|
|
13565
|
+
]
|
|
13566
|
+
},
|
|
13567
|
+
"total_pages": {
|
|
13568
|
+
"anyOf": [
|
|
13569
|
+
{
|
|
13570
|
+
"type": "integer"
|
|
13571
|
+
},
|
|
13572
|
+
{
|
|
13573
|
+
"type": "null"
|
|
13574
|
+
}
|
|
13575
|
+
],
|
|
13576
|
+
"title": "Total Pages",
|
|
13577
|
+
"description": "The total number of pages of results given the indicated page size",
|
|
13578
|
+
"examples": [
|
|
13579
|
+
4
|
|
13580
|
+
]
|
|
13581
|
+
},
|
|
13582
|
+
"total_count": {
|
|
13583
|
+
"anyOf": [
|
|
13584
|
+
{
|
|
13585
|
+
"type": "integer"
|
|
13586
|
+
},
|
|
13587
|
+
{
|
|
13588
|
+
"type": "null"
|
|
13589
|
+
}
|
|
13590
|
+
],
|
|
13591
|
+
"title": "Total Count",
|
|
13592
|
+
"description": "The total number of items returned from the query",
|
|
13593
|
+
"examples": [
|
|
13594
|
+
100
|
|
13595
|
+
]
|
|
13596
|
+
}
|
|
13597
|
+
},
|
|
13598
|
+
"type": "object",
|
|
13599
|
+
"required": [
|
|
13600
|
+
"items",
|
|
13601
|
+
"page",
|
|
13602
|
+
"page_size"
|
|
13603
|
+
],
|
|
13604
|
+
"title": "ListResponse[Conversation]"
|
|
13605
|
+
},
|
|
13606
|
+
"ListResponse_CustomMessageResponse_": {
|
|
13607
|
+
"properties": {
|
|
13608
|
+
"items": {
|
|
13609
|
+
"items": {
|
|
13610
|
+
"$ref": "#/components/schemas/CustomMessageResponse"
|
|
12959
13611
|
},
|
|
12960
13612
|
"type": "array",
|
|
12961
13613
|
"title": "Items",
|
|
@@ -13015,13 +13667,13 @@
|
|
|
13015
13667
|
"page",
|
|
13016
13668
|
"page_size"
|
|
13017
13669
|
],
|
|
13018
|
-
"title": "ListResponse[
|
|
13670
|
+
"title": "ListResponse[CustomMessageResponse]"
|
|
13019
13671
|
},
|
|
13020
|
-
"
|
|
13672
|
+
"ListResponse_DashboardResponse_": {
|
|
13021
13673
|
"properties": {
|
|
13022
13674
|
"items": {
|
|
13023
13675
|
"items": {
|
|
13024
|
-
"$ref": "#/components/schemas/
|
|
13676
|
+
"$ref": "#/components/schemas/DashboardResponse"
|
|
13025
13677
|
},
|
|
13026
13678
|
"type": "array",
|
|
13027
13679
|
"title": "Items",
|
|
@@ -13081,13 +13733,13 @@
|
|
|
13081
13733
|
"page",
|
|
13082
13734
|
"page_size"
|
|
13083
13735
|
],
|
|
13084
|
-
"title": "ListResponse[
|
|
13736
|
+
"title": "ListResponse[DashboardResponse]"
|
|
13085
13737
|
},
|
|
13086
|
-
"
|
|
13738
|
+
"ListResponse_DataSourceMetadataResponse_": {
|
|
13087
13739
|
"properties": {
|
|
13088
13740
|
"items": {
|
|
13089
13741
|
"items": {
|
|
13090
|
-
"$ref": "#/components/schemas/
|
|
13742
|
+
"$ref": "#/components/schemas/DataSourceMetadataResponse"
|
|
13091
13743
|
},
|
|
13092
13744
|
"type": "array",
|
|
13093
13745
|
"title": "Items",
|
|
@@ -13147,13 +13799,13 @@
|
|
|
13147
13799
|
"page",
|
|
13148
13800
|
"page_size"
|
|
13149
13801
|
],
|
|
13150
|
-
"title": "ListResponse[
|
|
13802
|
+
"title": "ListResponse[DataSourceMetadataResponse]"
|
|
13151
13803
|
},
|
|
13152
|
-
"
|
|
13804
|
+
"ListResponse_DirectoryMember_": {
|
|
13153
13805
|
"properties": {
|
|
13154
13806
|
"items": {
|
|
13155
13807
|
"items": {
|
|
13156
|
-
"$ref": "#/components/schemas/
|
|
13808
|
+
"$ref": "#/components/schemas/DirectoryMember"
|
|
13157
13809
|
},
|
|
13158
13810
|
"type": "array",
|
|
13159
13811
|
"title": "Items",
|
|
@@ -13213,13 +13865,13 @@
|
|
|
13213
13865
|
"page",
|
|
13214
13866
|
"page_size"
|
|
13215
13867
|
],
|
|
13216
|
-
"title": "ListResponse[
|
|
13868
|
+
"title": "ListResponse[DirectoryMember]"
|
|
13217
13869
|
},
|
|
13218
|
-
"
|
|
13870
|
+
"ListResponse_Event_": {
|
|
13219
13871
|
"properties": {
|
|
13220
13872
|
"items": {
|
|
13221
13873
|
"items": {
|
|
13222
|
-
"$ref": "#/components/schemas/
|
|
13874
|
+
"$ref": "#/components/schemas/Event"
|
|
13223
13875
|
},
|
|
13224
13876
|
"type": "array",
|
|
13225
13877
|
"title": "Items",
|
|
@@ -13279,13 +13931,13 @@
|
|
|
13279
13931
|
"page",
|
|
13280
13932
|
"page_size"
|
|
13281
13933
|
],
|
|
13282
|
-
"title": "ListResponse[
|
|
13934
|
+
"title": "ListResponse[Event]"
|
|
13283
13935
|
},
|
|
13284
|
-
"
|
|
13936
|
+
"ListResponse_InsightToolOutput_": {
|
|
13285
13937
|
"properties": {
|
|
13286
13938
|
"items": {
|
|
13287
13939
|
"items": {
|
|
13288
|
-
"$ref": "#/components/schemas/
|
|
13940
|
+
"$ref": "#/components/schemas/InsightToolOutput"
|
|
13289
13941
|
},
|
|
13290
13942
|
"type": "array",
|
|
13291
13943
|
"title": "Items",
|
|
@@ -13345,13 +13997,13 @@
|
|
|
13345
13997
|
"page",
|
|
13346
13998
|
"page_size"
|
|
13347
13999
|
],
|
|
13348
|
-
"title": "ListResponse[
|
|
14000
|
+
"title": "ListResponse[InsightToolOutput]"
|
|
13349
14001
|
},
|
|
13350
|
-
"
|
|
14002
|
+
"ListResponse_InsightWorkflowOutput_": {
|
|
13351
14003
|
"properties": {
|
|
13352
14004
|
"items": {
|
|
13353
14005
|
"items": {
|
|
13354
|
-
"$ref": "#/components/schemas/
|
|
14006
|
+
"$ref": "#/components/schemas/InsightWorkflowOutput"
|
|
13355
14007
|
},
|
|
13356
14008
|
"type": "array",
|
|
13357
14009
|
"title": "Items",
|
|
@@ -13411,13 +14063,13 @@
|
|
|
13411
14063
|
"page",
|
|
13412
14064
|
"page_size"
|
|
13413
14065
|
],
|
|
13414
|
-
"title": "ListResponse[
|
|
14066
|
+
"title": "ListResponse[InsightWorkflowOutput]"
|
|
13415
14067
|
},
|
|
13416
|
-
"
|
|
14068
|
+
"ListResponse_InsightsOutput_": {
|
|
13417
14069
|
"properties": {
|
|
13418
14070
|
"items": {
|
|
13419
14071
|
"items": {
|
|
13420
|
-
"$ref": "#/components/schemas/
|
|
14072
|
+
"$ref": "#/components/schemas/InsightsOutput"
|
|
13421
14073
|
},
|
|
13422
14074
|
"type": "array",
|
|
13423
14075
|
"title": "Items",
|
|
@@ -13477,7 +14129,7 @@
|
|
|
13477
14129
|
"page",
|
|
13478
14130
|
"page_size"
|
|
13479
14131
|
],
|
|
13480
|
-
"title": "ListResponse[
|
|
14132
|
+
"title": "ListResponse[InsightsOutput]"
|
|
13481
14133
|
},
|
|
13482
14134
|
"ListResponse_LanguageGroupResponse_": {
|
|
13483
14135
|
"properties": {
|
|
@@ -13905,17 +14557,6 @@
|
|
|
13905
14557
|
}
|
|
13906
14558
|
]
|
|
13907
14559
|
},
|
|
13908
|
-
"status": {
|
|
13909
|
-
"$ref": "#/components/schemas/CampaignStatus",
|
|
13910
|
-
"description": "Status of campaign",
|
|
13911
|
-
"default": "PENDING",
|
|
13912
|
-
"examples": [
|
|
13913
|
-
"PENDING",
|
|
13914
|
-
"ACTIVE",
|
|
13915
|
-
"PAUSED",
|
|
13916
|
-
"CANCELED"
|
|
13917
|
-
]
|
|
13918
|
-
},
|
|
13919
14560
|
"daily_start_time": {
|
|
13920
14561
|
"type": "string",
|
|
13921
14562
|
"title": "Daily Start Time",
|
|
@@ -13940,13 +14581,20 @@
|
|
|
13940
14581
|
"America/New_York"
|
|
13941
14582
|
]
|
|
13942
14583
|
},
|
|
13943
|
-
"
|
|
13944
|
-
"
|
|
13945
|
-
|
|
13946
|
-
|
|
14584
|
+
"source": {
|
|
14585
|
+
"anyOf": [
|
|
14586
|
+
{
|
|
14587
|
+
"type": "string"
|
|
14588
|
+
},
|
|
14589
|
+
{
|
|
14590
|
+
"type": "null"
|
|
14591
|
+
}
|
|
14592
|
+
],
|
|
14593
|
+
"title": "Source",
|
|
14594
|
+
"description": "Source phone number, email, or SMS number",
|
|
13947
14595
|
"examples": [
|
|
13948
|
-
"
|
|
13949
|
-
"
|
|
14596
|
+
"+19032900844",
|
|
14597
|
+
"account@email.com"
|
|
13950
14598
|
]
|
|
13951
14599
|
},
|
|
13952
14600
|
"caller_id": {
|
|
@@ -13964,6 +14612,41 @@
|
|
|
13964
14612
|
19995551234
|
|
13965
14613
|
]
|
|
13966
14614
|
},
|
|
14615
|
+
"rate": {
|
|
14616
|
+
"type": "integer",
|
|
14617
|
+
"title": "Rate",
|
|
14618
|
+
"description": "Target number of outreach calls per minute",
|
|
14619
|
+
"default": 1,
|
|
14620
|
+
"examples": [
|
|
14621
|
+
5
|
|
14622
|
+
]
|
|
14623
|
+
},
|
|
14624
|
+
"retry_count": {
|
|
14625
|
+
"type": "integer",
|
|
14626
|
+
"title": "Retry Count",
|
|
14627
|
+
"description": "Number of retries per target",
|
|
14628
|
+
"default": 0,
|
|
14629
|
+
"examples": [
|
|
14630
|
+
1
|
|
14631
|
+
]
|
|
14632
|
+
},
|
|
14633
|
+
"retry_interval": {
|
|
14634
|
+
"anyOf": [
|
|
14635
|
+
{
|
|
14636
|
+
"type": "string"
|
|
14637
|
+
},
|
|
14638
|
+
{
|
|
14639
|
+
"type": "null"
|
|
14640
|
+
}
|
|
14641
|
+
],
|
|
14642
|
+
"title": "Retry Interval",
|
|
14643
|
+
"description": "How long to wait before retrying",
|
|
14644
|
+
"examples": [
|
|
14645
|
+
"30m",
|
|
14646
|
+
"12h",
|
|
14647
|
+
"7d"
|
|
14648
|
+
]
|
|
14649
|
+
},
|
|
13967
14650
|
"pause_seconds": {
|
|
13968
14651
|
"anyOf": [
|
|
13969
14652
|
{
|
|
@@ -14046,17 +14729,6 @@
|
|
|
14046
14729
|
}
|
|
14047
14730
|
]
|
|
14048
14731
|
},
|
|
14049
|
-
"status": {
|
|
14050
|
-
"$ref": "#/components/schemas/CampaignStatus",
|
|
14051
|
-
"description": "Status of campaign",
|
|
14052
|
-
"default": "PENDING",
|
|
14053
|
-
"examples": [
|
|
14054
|
-
"PENDING",
|
|
14055
|
-
"ACTIVE",
|
|
14056
|
-
"PAUSED",
|
|
14057
|
-
"CANCELED"
|
|
14058
|
-
]
|
|
14059
|
-
},
|
|
14060
14732
|
"daily_start_time": {
|
|
14061
14733
|
"type": "string",
|
|
14062
14734
|
"title": "Daily Start Time",
|
|
@@ -14081,13 +14753,20 @@
|
|
|
14081
14753
|
"America/New_York"
|
|
14082
14754
|
]
|
|
14083
14755
|
},
|
|
14084
|
-
"
|
|
14085
|
-
"
|
|
14086
|
-
|
|
14087
|
-
|
|
14756
|
+
"source": {
|
|
14757
|
+
"anyOf": [
|
|
14758
|
+
{
|
|
14759
|
+
"type": "string"
|
|
14760
|
+
},
|
|
14761
|
+
{
|
|
14762
|
+
"type": "null"
|
|
14763
|
+
}
|
|
14764
|
+
],
|
|
14765
|
+
"title": "Source",
|
|
14766
|
+
"description": "Source phone number, email, or SMS number",
|
|
14088
14767
|
"examples": [
|
|
14089
|
-
"
|
|
14090
|
-
"
|
|
14768
|
+
"+19032900844",
|
|
14769
|
+
"account@email.com"
|
|
14091
14770
|
]
|
|
14092
14771
|
},
|
|
14093
14772
|
"caller_id": {
|
|
@@ -14105,6 +14784,41 @@
|
|
|
14105
14784
|
19995551234
|
|
14106
14785
|
]
|
|
14107
14786
|
},
|
|
14787
|
+
"rate": {
|
|
14788
|
+
"type": "integer",
|
|
14789
|
+
"title": "Rate",
|
|
14790
|
+
"description": "Target number of outreach calls per minute",
|
|
14791
|
+
"default": 1,
|
|
14792
|
+
"examples": [
|
|
14793
|
+
5
|
|
14794
|
+
]
|
|
14795
|
+
},
|
|
14796
|
+
"retry_count": {
|
|
14797
|
+
"type": "integer",
|
|
14798
|
+
"title": "Retry Count",
|
|
14799
|
+
"description": "Number of retries per target",
|
|
14800
|
+
"default": 0,
|
|
14801
|
+
"examples": [
|
|
14802
|
+
1
|
|
14803
|
+
]
|
|
14804
|
+
},
|
|
14805
|
+
"retry_interval": {
|
|
14806
|
+
"anyOf": [
|
|
14807
|
+
{
|
|
14808
|
+
"type": "string"
|
|
14809
|
+
},
|
|
14810
|
+
{
|
|
14811
|
+
"type": "null"
|
|
14812
|
+
}
|
|
14813
|
+
],
|
|
14814
|
+
"title": "Retry Interval",
|
|
14815
|
+
"description": "How long to wait before retrying",
|
|
14816
|
+
"examples": [
|
|
14817
|
+
"30m",
|
|
14818
|
+
"12h",
|
|
14819
|
+
"7d"
|
|
14820
|
+
]
|
|
14821
|
+
},
|
|
14108
14822
|
"pause_seconds": {
|
|
14109
14823
|
"anyOf": [
|
|
14110
14824
|
{
|
|
@@ -14189,7 +14903,10 @@
|
|
|
14189
14903
|
"description": "Names of tools to which the prompt has access",
|
|
14190
14904
|
"default": [],
|
|
14191
14905
|
"examples": [
|
|
14192
|
-
|
|
14906
|
+
[
|
|
14907
|
+
"summary",
|
|
14908
|
+
"hangup"
|
|
14909
|
+
]
|
|
14193
14910
|
]
|
|
14194
14911
|
},
|
|
14195
14912
|
"llm_config": {
|
|
@@ -14365,7 +15082,7 @@
|
|
|
14365
15082
|
}
|
|
14366
15083
|
],
|
|
14367
15084
|
"title": "Api Version",
|
|
14368
|
-
"description": "Version of the API.
|
|
15085
|
+
"description": "Version of the provider's API.",
|
|
14369
15086
|
"examples": [
|
|
14370
15087
|
"2024-06-01"
|
|
14371
15088
|
]
|
|
@@ -14658,7 +15375,10 @@
|
|
|
14658
15375
|
"description": "Names of tools to which the prompt has access",
|
|
14659
15376
|
"default": [],
|
|
14660
15377
|
"examples": [
|
|
14661
|
-
|
|
15378
|
+
[
|
|
15379
|
+
"summary",
|
|
15380
|
+
"hangup"
|
|
15381
|
+
]
|
|
14662
15382
|
]
|
|
14663
15383
|
},
|
|
14664
15384
|
"llm_config": {
|
|
@@ -14719,7 +15439,7 @@
|
|
|
14719
15439
|
"type": "string",
|
|
14720
15440
|
"enum": [
|
|
14721
15441
|
"PENDING",
|
|
14722
|
-
"
|
|
15442
|
+
"DUPLICATE",
|
|
14723
15443
|
"INITIATED",
|
|
14724
15444
|
"CONNECTED",
|
|
14725
15445
|
"FAILED",
|
|
@@ -15777,6 +16497,129 @@
|
|
|
15777
16497
|
"title": "StaticToolParameterType",
|
|
15778
16498
|
"description": "The expected type for a static tool parameter."
|
|
15779
16499
|
},
|
|
16500
|
+
"SupportedLlm": {
|
|
16501
|
+
"properties": {
|
|
16502
|
+
"provider": {
|
|
16503
|
+
"$ref": "#/components/schemas/PromptLlmProvider",
|
|
16504
|
+
"description": "Provider of the LLM model.",
|
|
16505
|
+
"default": "azure_openai",
|
|
16506
|
+
"examples": [
|
|
16507
|
+
"azure_openai"
|
|
16508
|
+
]
|
|
16509
|
+
},
|
|
16510
|
+
"model": {
|
|
16511
|
+
"type": "string",
|
|
16512
|
+
"title": "Model",
|
|
16513
|
+
"description": "Name of the model. Must match the deployment name in Azure AI Studio.",
|
|
16514
|
+
"default": "gpt-4o",
|
|
16515
|
+
"examples": [
|
|
16516
|
+
"gpt-4o"
|
|
16517
|
+
]
|
|
16518
|
+
},
|
|
16519
|
+
"display_name": {
|
|
16520
|
+
"type": "string",
|
|
16521
|
+
"title": "Display Name",
|
|
16522
|
+
"description": "Display name of the model. This is used for display purposes in the Console UI.",
|
|
16523
|
+
"examples": [
|
|
16524
|
+
"GPT-4o"
|
|
16525
|
+
]
|
|
16526
|
+
},
|
|
16527
|
+
"version": {
|
|
16528
|
+
"anyOf": [
|
|
16529
|
+
{
|
|
16530
|
+
"type": "string"
|
|
16531
|
+
},
|
|
16532
|
+
{
|
|
16533
|
+
"type": "null"
|
|
16534
|
+
}
|
|
16535
|
+
],
|
|
16536
|
+
"title": "Version",
|
|
16537
|
+
"description": "Model version.",
|
|
16538
|
+
"examples": [
|
|
16539
|
+
"2024-05-13"
|
|
16540
|
+
]
|
|
16541
|
+
},
|
|
16542
|
+
"api_version": {
|
|
16543
|
+
"anyOf": [
|
|
16544
|
+
{
|
|
16545
|
+
"type": "string"
|
|
16546
|
+
},
|
|
16547
|
+
{
|
|
16548
|
+
"type": "null"
|
|
16549
|
+
}
|
|
16550
|
+
],
|
|
16551
|
+
"title": "Api Version",
|
|
16552
|
+
"description": "Version of the provider's API.",
|
|
16553
|
+
"examples": [
|
|
16554
|
+
"2024-06-01"
|
|
16555
|
+
]
|
|
16556
|
+
},
|
|
16557
|
+
"deprecated": {
|
|
16558
|
+
"type": "boolean",
|
|
16559
|
+
"title": "Deprecated",
|
|
16560
|
+
"description": "Whether the LLM config is deprecated and should not be used.",
|
|
16561
|
+
"examples": [
|
|
16562
|
+
false
|
|
16563
|
+
]
|
|
16564
|
+
}
|
|
16565
|
+
},
|
|
16566
|
+
"type": "object",
|
|
16567
|
+
"required": [
|
|
16568
|
+
"display_name",
|
|
16569
|
+
"deprecated"
|
|
16570
|
+
],
|
|
16571
|
+
"title": "SupportedLlm",
|
|
16572
|
+
"description": "LLM config option that can be used on a prompt."
|
|
16573
|
+
},
|
|
16574
|
+
"TakeoutRequestStatus": {
|
|
16575
|
+
"type": "string",
|
|
16576
|
+
"enum": [
|
|
16577
|
+
"pending",
|
|
16578
|
+
"in_progress",
|
|
16579
|
+
"completed",
|
|
16580
|
+
"failed",
|
|
16581
|
+
"canceled"
|
|
16582
|
+
],
|
|
16583
|
+
"title": "TakeoutRequestStatus",
|
|
16584
|
+
"description": "Status of a takeout request."
|
|
16585
|
+
},
|
|
16586
|
+
"TakeoutStatusResponse": {
|
|
16587
|
+
"properties": {
|
|
16588
|
+
"job_id": {
|
|
16589
|
+
"type": "string",
|
|
16590
|
+
"title": "Job Id"
|
|
16591
|
+
},
|
|
16592
|
+
"status": {
|
|
16593
|
+
"$ref": "#/components/schemas/TakeoutRequestStatus"
|
|
16594
|
+
},
|
|
16595
|
+
"updated_at": {
|
|
16596
|
+
"type": "string",
|
|
16597
|
+
"format": "date-time",
|
|
16598
|
+
"title": "Updated At"
|
|
16599
|
+
},
|
|
16600
|
+
"download_links": {
|
|
16601
|
+
"anyOf": [
|
|
16602
|
+
{
|
|
16603
|
+
"items": {
|
|
16604
|
+
"type": "string"
|
|
16605
|
+
},
|
|
16606
|
+
"type": "array"
|
|
16607
|
+
},
|
|
16608
|
+
{
|
|
16609
|
+
"type": "null"
|
|
16610
|
+
}
|
|
16611
|
+
],
|
|
16612
|
+
"title": "Download Links"
|
|
16613
|
+
}
|
|
16614
|
+
},
|
|
16615
|
+
"type": "object",
|
|
16616
|
+
"required": [
|
|
16617
|
+
"job_id",
|
|
16618
|
+
"status",
|
|
16619
|
+
"updated_at"
|
|
16620
|
+
],
|
|
16621
|
+
"title": "TakeoutStatusResponse"
|
|
16622
|
+
},
|
|
15780
16623
|
"TargetModes": {
|
|
15781
16624
|
"type": "string",
|
|
15782
16625
|
"enum": [
|
|
@@ -16884,6 +17727,10 @@
|
|
|
16884
17727
|
"name": "events",
|
|
16885
17728
|
"description": "Operations related to events. An event represents a specific occurrence during a session. Currently the API/SDK only supports fetching logged events."
|
|
16886
17729
|
},
|
|
17730
|
+
{
|
|
17731
|
+
"name": "insights",
|
|
17732
|
+
"description": "Operations related to insights results. An insight is a tool that processes conversation data to extract information and generate reports."
|
|
17733
|
+
},
|
|
16887
17734
|
{
|
|
16888
17735
|
"name": "insights.tools",
|
|
16889
17736
|
"description": "Operations related to insights tools. An insight is a tool that processes conversation data to extract information and generate reports."
|