@chatbotkit/sdk 1.26.5 → 1.28.0
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/dist/cjs/types/api/v1.d.ts +90 -0
- package/dist/esm/types/api/v1.d.ts +90 -0
- package/package.json +1 -1
|
@@ -4811,6 +4811,28 @@ export interface components {
|
|
|
4811
4811
|
/** @description The tokens used in this exchange */
|
|
4812
4812
|
token: number;
|
|
4813
4813
|
};
|
|
4814
|
+
/**
|
|
4815
|
+
* @description The reason why the completion ended
|
|
4816
|
+
* @enum {string}
|
|
4817
|
+
*/
|
|
4818
|
+
CompleteReason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
4819
|
+
/** @description Information about why the completion ended */
|
|
4820
|
+
CompleteEnd: {
|
|
4821
|
+
/**
|
|
4822
|
+
* @description The reason why the completion ended
|
|
4823
|
+
* @enum {string}
|
|
4824
|
+
*/
|
|
4825
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
4826
|
+
};
|
|
4827
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
4828
|
+
ExecutionLimits: {
|
|
4829
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
4830
|
+
iterations?: number;
|
|
4831
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
4832
|
+
continuations?: number;
|
|
4833
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
4834
|
+
calls?: number;
|
|
4835
|
+
};
|
|
4814
4836
|
/**
|
|
4815
4837
|
* @description The policy type
|
|
4816
4838
|
* @enum {string}
|
|
@@ -7734,6 +7756,15 @@ export interface operations {
|
|
|
7734
7756
|
};
|
|
7735
7757
|
}[];
|
|
7736
7758
|
};
|
|
7759
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
7760
|
+
limits?: {
|
|
7761
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
7762
|
+
iterations?: number;
|
|
7763
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
7764
|
+
continuations?: number;
|
|
7765
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
7766
|
+
calls?: number;
|
|
7767
|
+
};
|
|
7737
7768
|
};
|
|
7738
7769
|
};
|
|
7739
7770
|
};
|
|
@@ -7754,6 +7785,14 @@ export interface operations {
|
|
|
7754
7785
|
/** @description The tokens used in this exchange */
|
|
7755
7786
|
token: number;
|
|
7756
7787
|
};
|
|
7788
|
+
/** @description Information about why the completion ended */
|
|
7789
|
+
end: {
|
|
7790
|
+
/**
|
|
7791
|
+
* @description The reason why the completion ended
|
|
7792
|
+
* @enum {string}
|
|
7793
|
+
*/
|
|
7794
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
7795
|
+
};
|
|
7757
7796
|
};
|
|
7758
7797
|
"application/jsonl": {
|
|
7759
7798
|
/**
|
|
@@ -7771,6 +7810,14 @@ export interface operations {
|
|
|
7771
7810
|
/** @description The tokens used in this exchange */
|
|
7772
7811
|
token: number;
|
|
7773
7812
|
};
|
|
7813
|
+
/** @description Information about why the completion ended */
|
|
7814
|
+
end: {
|
|
7815
|
+
/**
|
|
7816
|
+
* @description The reason why the completion ended
|
|
7817
|
+
* @enum {string}
|
|
7818
|
+
*/
|
|
7819
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
7820
|
+
};
|
|
7774
7821
|
};
|
|
7775
7822
|
} | ({
|
|
7776
7823
|
/**
|
|
@@ -8099,6 +8146,15 @@ export interface operations {
|
|
|
8099
8146
|
};
|
|
8100
8147
|
}[];
|
|
8101
8148
|
};
|
|
8149
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
8150
|
+
limits?: {
|
|
8151
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
8152
|
+
iterations?: number;
|
|
8153
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
8154
|
+
continuations?: number;
|
|
8155
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
8156
|
+
calls?: number;
|
|
8157
|
+
};
|
|
8102
8158
|
/** @description A unique ID to deduplicate dispatch requests */
|
|
8103
8159
|
channelId?: string;
|
|
8104
8160
|
};
|
|
@@ -9585,6 +9641,15 @@ export interface operations {
|
|
|
9585
9641
|
};
|
|
9586
9642
|
}[];
|
|
9587
9643
|
};
|
|
9644
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
9645
|
+
limits?: {
|
|
9646
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
9647
|
+
iterations?: number;
|
|
9648
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
9649
|
+
continuations?: number;
|
|
9650
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
9651
|
+
calls?: number;
|
|
9652
|
+
};
|
|
9588
9653
|
} & ({
|
|
9589
9654
|
/** @description The ID of the bot this configuration is using */
|
|
9590
9655
|
botId?: string;
|
|
@@ -9622,6 +9687,14 @@ export interface operations {
|
|
|
9622
9687
|
/** @description The tokens used in this exchange */
|
|
9623
9688
|
token: number;
|
|
9624
9689
|
};
|
|
9690
|
+
/** @description Information about why the completion ended */
|
|
9691
|
+
end: {
|
|
9692
|
+
/**
|
|
9693
|
+
* @description The reason why the completion ended
|
|
9694
|
+
* @enum {string}
|
|
9695
|
+
*/
|
|
9696
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
9697
|
+
};
|
|
9625
9698
|
};
|
|
9626
9699
|
"application/jsonl": {
|
|
9627
9700
|
/**
|
|
@@ -9637,6 +9710,14 @@ export interface operations {
|
|
|
9637
9710
|
/** @description The tokens used in this exchange */
|
|
9638
9711
|
token: number;
|
|
9639
9712
|
};
|
|
9713
|
+
/** @description Information about why the completion ended */
|
|
9714
|
+
end: {
|
|
9715
|
+
/**
|
|
9716
|
+
* @description The reason why the completion ended
|
|
9717
|
+
* @enum {string}
|
|
9718
|
+
*/
|
|
9719
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
9720
|
+
};
|
|
9640
9721
|
};
|
|
9641
9722
|
} | ({
|
|
9642
9723
|
/**
|
|
@@ -9981,6 +10062,15 @@ export interface operations {
|
|
|
9981
10062
|
};
|
|
9982
10063
|
}[];
|
|
9983
10064
|
};
|
|
10065
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
10066
|
+
limits?: {
|
|
10067
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
10068
|
+
iterations?: number;
|
|
10069
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
10070
|
+
continuations?: number;
|
|
10071
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
10072
|
+
calls?: number;
|
|
10073
|
+
};
|
|
9984
10074
|
/** @description A unique channel ID to subscribe to for completion events */
|
|
9985
10075
|
channelId?: string;
|
|
9986
10076
|
} & ({
|
|
@@ -4811,6 +4811,28 @@ export interface components {
|
|
|
4811
4811
|
/** @description The tokens used in this exchange */
|
|
4812
4812
|
token: number;
|
|
4813
4813
|
};
|
|
4814
|
+
/**
|
|
4815
|
+
* @description The reason why the completion ended
|
|
4816
|
+
* @enum {string}
|
|
4817
|
+
*/
|
|
4818
|
+
CompleteReason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
4819
|
+
/** @description Information about why the completion ended */
|
|
4820
|
+
CompleteEnd: {
|
|
4821
|
+
/**
|
|
4822
|
+
* @description The reason why the completion ended
|
|
4823
|
+
* @enum {string}
|
|
4824
|
+
*/
|
|
4825
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
4826
|
+
};
|
|
4827
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
4828
|
+
ExecutionLimits: {
|
|
4829
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
4830
|
+
iterations?: number;
|
|
4831
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
4832
|
+
continuations?: number;
|
|
4833
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
4834
|
+
calls?: number;
|
|
4835
|
+
};
|
|
4814
4836
|
/**
|
|
4815
4837
|
* @description The policy type
|
|
4816
4838
|
* @enum {string}
|
|
@@ -7734,6 +7756,15 @@ export interface operations {
|
|
|
7734
7756
|
};
|
|
7735
7757
|
}[];
|
|
7736
7758
|
};
|
|
7759
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
7760
|
+
limits?: {
|
|
7761
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
7762
|
+
iterations?: number;
|
|
7763
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
7764
|
+
continuations?: number;
|
|
7765
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
7766
|
+
calls?: number;
|
|
7767
|
+
};
|
|
7737
7768
|
};
|
|
7738
7769
|
};
|
|
7739
7770
|
};
|
|
@@ -7754,6 +7785,14 @@ export interface operations {
|
|
|
7754
7785
|
/** @description The tokens used in this exchange */
|
|
7755
7786
|
token: number;
|
|
7756
7787
|
};
|
|
7788
|
+
/** @description Information about why the completion ended */
|
|
7789
|
+
end: {
|
|
7790
|
+
/**
|
|
7791
|
+
* @description The reason why the completion ended
|
|
7792
|
+
* @enum {string}
|
|
7793
|
+
*/
|
|
7794
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
7795
|
+
};
|
|
7757
7796
|
};
|
|
7758
7797
|
"application/jsonl": {
|
|
7759
7798
|
/**
|
|
@@ -7771,6 +7810,14 @@ export interface operations {
|
|
|
7771
7810
|
/** @description The tokens used in this exchange */
|
|
7772
7811
|
token: number;
|
|
7773
7812
|
};
|
|
7813
|
+
/** @description Information about why the completion ended */
|
|
7814
|
+
end: {
|
|
7815
|
+
/**
|
|
7816
|
+
* @description The reason why the completion ended
|
|
7817
|
+
* @enum {string}
|
|
7818
|
+
*/
|
|
7819
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
7820
|
+
};
|
|
7774
7821
|
};
|
|
7775
7822
|
} | ({
|
|
7776
7823
|
/**
|
|
@@ -8099,6 +8146,15 @@ export interface operations {
|
|
|
8099
8146
|
};
|
|
8100
8147
|
}[];
|
|
8101
8148
|
};
|
|
8149
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
8150
|
+
limits?: {
|
|
8151
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
8152
|
+
iterations?: number;
|
|
8153
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
8154
|
+
continuations?: number;
|
|
8155
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
8156
|
+
calls?: number;
|
|
8157
|
+
};
|
|
8102
8158
|
/** @description A unique ID to deduplicate dispatch requests */
|
|
8103
8159
|
channelId?: string;
|
|
8104
8160
|
};
|
|
@@ -9585,6 +9641,15 @@ export interface operations {
|
|
|
9585
9641
|
};
|
|
9586
9642
|
}[];
|
|
9587
9643
|
};
|
|
9644
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
9645
|
+
limits?: {
|
|
9646
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
9647
|
+
iterations?: number;
|
|
9648
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
9649
|
+
continuations?: number;
|
|
9650
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
9651
|
+
calls?: number;
|
|
9652
|
+
};
|
|
9588
9653
|
} & ({
|
|
9589
9654
|
/** @description The ID of the bot this configuration is using */
|
|
9590
9655
|
botId?: string;
|
|
@@ -9622,6 +9687,14 @@ export interface operations {
|
|
|
9622
9687
|
/** @description The tokens used in this exchange */
|
|
9623
9688
|
token: number;
|
|
9624
9689
|
};
|
|
9690
|
+
/** @description Information about why the completion ended */
|
|
9691
|
+
end: {
|
|
9692
|
+
/**
|
|
9693
|
+
* @description The reason why the completion ended
|
|
9694
|
+
* @enum {string}
|
|
9695
|
+
*/
|
|
9696
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
9697
|
+
};
|
|
9625
9698
|
};
|
|
9626
9699
|
"application/jsonl": {
|
|
9627
9700
|
/**
|
|
@@ -9637,6 +9710,14 @@ export interface operations {
|
|
|
9637
9710
|
/** @description The tokens used in this exchange */
|
|
9638
9711
|
token: number;
|
|
9639
9712
|
};
|
|
9713
|
+
/** @description Information about why the completion ended */
|
|
9714
|
+
end: {
|
|
9715
|
+
/**
|
|
9716
|
+
* @description The reason why the completion ended
|
|
9717
|
+
* @enum {string}
|
|
9718
|
+
*/
|
|
9719
|
+
reason: "length" | "stop" | "activity" | "error" | "iteration";
|
|
9720
|
+
};
|
|
9640
9721
|
};
|
|
9641
9722
|
} | ({
|
|
9642
9723
|
/**
|
|
@@ -9981,6 +10062,15 @@ export interface operations {
|
|
|
9981
10062
|
};
|
|
9982
10063
|
}[];
|
|
9983
10064
|
};
|
|
10065
|
+
/** @description Execution limits to control conversation processing bounds */
|
|
10066
|
+
limits?: {
|
|
10067
|
+
/** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */
|
|
10068
|
+
iterations?: number;
|
|
10069
|
+
/** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */
|
|
10070
|
+
continuations?: number;
|
|
10071
|
+
/** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */
|
|
10072
|
+
calls?: number;
|
|
10073
|
+
};
|
|
9984
10074
|
/** @description A unique channel ID to subscribe to for completion events */
|
|
9985
10075
|
channelId?: string;
|
|
9986
10076
|
} & ({
|