@letta-ai/letta-client 1.6.1 → 1.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +29 -0
- package/LICENSE +1 -1
- package/package.json +1 -1
- package/resources/agents/agents.d.mts +167 -11
- package/resources/agents/agents.d.mts.map +1 -1
- package/resources/agents/agents.d.ts +167 -11
- package/resources/agents/agents.d.ts.map +1 -1
- package/resources/agents/agents.js.map +1 -1
- package/resources/agents/agents.mjs.map +1 -1
- package/resources/agents/messages.d.mts +173 -1
- package/resources/agents/messages.d.mts.map +1 -1
- package/resources/agents/messages.d.ts +173 -1
- package/resources/agents/messages.d.ts.map +1 -1
- package/resources/batches/batches.d.mts +29 -0
- package/resources/batches/batches.d.mts.map +1 -1
- package/resources/batches/batches.d.ts +29 -0
- package/resources/batches/batches.d.ts.map +1 -1
- package/resources/batches/batches.js.map +1 -1
- package/resources/batches/batches.mjs.map +1 -1
- package/resources/blocks/blocks.d.mts +1 -1
- package/resources/blocks/blocks.d.ts +1 -1
- package/resources/folders/files.d.mts +87 -1
- package/resources/folders/files.d.mts.map +1 -1
- package/resources/folders/files.d.ts +87 -1
- package/resources/folders/files.d.ts.map +1 -1
- package/resources/folders/files.js +7 -0
- package/resources/folders/files.js.map +1 -1
- package/resources/folders/files.mjs +7 -0
- package/resources/folders/files.mjs.map +1 -1
- package/resources/folders/folders.d.mts +2 -2
- package/resources/folders/folders.d.mts.map +1 -1
- package/resources/folders/folders.d.ts +2 -2
- package/resources/folders/folders.d.ts.map +1 -1
- package/resources/folders/folders.js.map +1 -1
- package/resources/folders/folders.mjs.map +1 -1
- package/resources/folders/index.d.mts +1 -1
- package/resources/folders/index.d.mts.map +1 -1
- package/resources/folders/index.d.ts +1 -1
- package/resources/folders/index.d.ts.map +1 -1
- package/resources/folders/index.js.map +1 -1
- package/resources/folders/index.mjs.map +1 -1
- package/resources/groups/messages.d.mts +58 -0
- package/resources/groups/messages.d.mts.map +1 -1
- package/resources/groups/messages.d.ts +58 -0
- package/resources/groups/messages.d.ts.map +1 -1
- package/resources/models/models.d.mts +3 -3
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +3 -3
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs.map +1 -1
- package/resources/steps/steps.d.mts +4 -0
- package/resources/steps/steps.d.mts.map +1 -1
- package/resources/steps/steps.d.ts +4 -0
- package/resources/steps/steps.d.ts.map +1 -1
- package/resources/steps/steps.js.map +1 -1
- package/resources/steps/steps.mjs.map +1 -1
- package/src/resources/agents/agents.ts +222 -6
- package/src/resources/agents/messages.ts +192 -0
- package/src/resources/batches/batches.ts +31 -0
- package/src/resources/blocks/blocks.ts +1 -1
- package/src/resources/folders/files.ts +114 -0
- package/src/resources/folders/folders.ts +4 -0
- package/src/resources/folders/index.ts +2 -0
- package/src/resources/groups/messages.ts +62 -0
- package/src/resources/models/models.ts +6 -3
- package/src/resources/steps/steps.ts +5 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -312,12 +312,6 @@ export interface AgentState {
|
|
|
312
312
|
*/
|
|
313
313
|
blocks: Array<BlocksAPI.Block>;
|
|
314
314
|
|
|
315
|
-
/**
|
|
316
|
-
* @deprecated Deprecated: Use `embedding` field instead. The embedding
|
|
317
|
-
* configuration used by the agent.
|
|
318
|
-
*/
|
|
319
|
-
embedding_config: ModelsAPI.EmbeddingConfig;
|
|
320
|
-
|
|
321
315
|
/**
|
|
322
316
|
* @deprecated Deprecated: Use `model` field instead. The LLM configuration used by
|
|
323
317
|
* the agent.
|
|
@@ -395,6 +389,12 @@ export interface AgentState {
|
|
|
395
389
|
*/
|
|
396
390
|
embedding?: string | null;
|
|
397
391
|
|
|
392
|
+
/**
|
|
393
|
+
* @deprecated Configuration for embedding model connection and processing
|
|
394
|
+
* parameters.
|
|
395
|
+
*/
|
|
396
|
+
embedding_config?: ModelsAPI.EmbeddingConfig | null;
|
|
397
|
+
|
|
398
398
|
/**
|
|
399
399
|
* If set to True, memory management will move to a background agent thread.
|
|
400
400
|
*/
|
|
@@ -484,6 +484,7 @@ export interface AgentState {
|
|
|
484
484
|
| GoogleVertexModelSettings
|
|
485
485
|
| AzureModelSettings
|
|
486
486
|
| XaiModelSettings
|
|
487
|
+
| AgentState.ZaiModelSettings
|
|
487
488
|
| GroqModelSettings
|
|
488
489
|
| DeepseekModelSettings
|
|
489
490
|
| TogetherModelSettings
|
|
@@ -791,6 +792,7 @@ export namespace AgentState {
|
|
|
791
792
|
| AgentsAPI.GoogleVertexModelSettings
|
|
792
793
|
| AgentsAPI.AzureModelSettings
|
|
793
794
|
| AgentsAPI.XaiModelSettings
|
|
795
|
+
| CompactionSettings.ZaiModelSettings
|
|
794
796
|
| AgentsAPI.GroqModelSettings
|
|
795
797
|
| AgentsAPI.DeepseekModelSettings
|
|
796
798
|
| AgentsAPI.TogetherModelSettings
|
|
@@ -814,6 +816,76 @@ export namespace AgentState {
|
|
|
814
816
|
*/
|
|
815
817
|
sliding_window_percentage?: number;
|
|
816
818
|
}
|
|
819
|
+
|
|
820
|
+
export namespace CompactionSettings {
|
|
821
|
+
/**
|
|
822
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
823
|
+
*/
|
|
824
|
+
export interface ZaiModelSettings {
|
|
825
|
+
/**
|
|
826
|
+
* The maximum number of tokens the model can generate.
|
|
827
|
+
*/
|
|
828
|
+
max_output_tokens?: number;
|
|
829
|
+
|
|
830
|
+
/**
|
|
831
|
+
* Whether to enable parallel tool calling.
|
|
832
|
+
*/
|
|
833
|
+
parallel_tool_calls?: boolean;
|
|
834
|
+
|
|
835
|
+
/**
|
|
836
|
+
* The type of the provider.
|
|
837
|
+
*/
|
|
838
|
+
provider_type?: 'zai';
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* The response format for the model.
|
|
842
|
+
*/
|
|
843
|
+
response_format?:
|
|
844
|
+
| AgentsAPI.TextResponseFormat
|
|
845
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
846
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
847
|
+
| null;
|
|
848
|
+
|
|
849
|
+
/**
|
|
850
|
+
* The temperature of the model.
|
|
851
|
+
*/
|
|
852
|
+
temperature?: number;
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
/**
|
|
857
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
858
|
+
*/
|
|
859
|
+
export interface ZaiModelSettings {
|
|
860
|
+
/**
|
|
861
|
+
* The maximum number of tokens the model can generate.
|
|
862
|
+
*/
|
|
863
|
+
max_output_tokens?: number;
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* Whether to enable parallel tool calling.
|
|
867
|
+
*/
|
|
868
|
+
parallel_tool_calls?: boolean;
|
|
869
|
+
|
|
870
|
+
/**
|
|
871
|
+
* The type of the provider.
|
|
872
|
+
*/
|
|
873
|
+
provider_type?: 'zai';
|
|
874
|
+
|
|
875
|
+
/**
|
|
876
|
+
* The response format for the model.
|
|
877
|
+
*/
|
|
878
|
+
response_format?:
|
|
879
|
+
| AgentsAPI.TextResponseFormat
|
|
880
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
881
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
882
|
+
| null;
|
|
883
|
+
|
|
884
|
+
/**
|
|
885
|
+
* The temperature of the model.
|
|
886
|
+
*/
|
|
887
|
+
temperature?: number;
|
|
888
|
+
}
|
|
817
889
|
}
|
|
818
890
|
|
|
819
891
|
/**
|
|
@@ -1725,6 +1797,7 @@ export interface AgentCreateParams {
|
|
|
1725
1797
|
| GoogleVertexModelSettings
|
|
1726
1798
|
| AzureModelSettings
|
|
1727
1799
|
| XaiModelSettings
|
|
1800
|
+
| AgentCreateParams.ZaiModelSettings
|
|
1728
1801
|
| GroqModelSettings
|
|
1729
1802
|
| DeepseekModelSettings
|
|
1730
1803
|
| TogetherModelSettings
|
|
@@ -1877,6 +1950,7 @@ export namespace AgentCreateParams {
|
|
|
1877
1950
|
| AgentsAPI.GoogleVertexModelSettings
|
|
1878
1951
|
| AgentsAPI.AzureModelSettings
|
|
1879
1952
|
| AgentsAPI.XaiModelSettings
|
|
1953
|
+
| CompactionSettings.ZaiModelSettings
|
|
1880
1954
|
| AgentsAPI.GroqModelSettings
|
|
1881
1955
|
| AgentsAPI.DeepseekModelSettings
|
|
1882
1956
|
| AgentsAPI.TogetherModelSettings
|
|
@@ -1900,6 +1974,76 @@ export namespace AgentCreateParams {
|
|
|
1900
1974
|
*/
|
|
1901
1975
|
sliding_window_percentage?: number;
|
|
1902
1976
|
}
|
|
1977
|
+
|
|
1978
|
+
export namespace CompactionSettings {
|
|
1979
|
+
/**
|
|
1980
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
1981
|
+
*/
|
|
1982
|
+
export interface ZaiModelSettings {
|
|
1983
|
+
/**
|
|
1984
|
+
* The maximum number of tokens the model can generate.
|
|
1985
|
+
*/
|
|
1986
|
+
max_output_tokens?: number;
|
|
1987
|
+
|
|
1988
|
+
/**
|
|
1989
|
+
* Whether to enable parallel tool calling.
|
|
1990
|
+
*/
|
|
1991
|
+
parallel_tool_calls?: boolean;
|
|
1992
|
+
|
|
1993
|
+
/**
|
|
1994
|
+
* The type of the provider.
|
|
1995
|
+
*/
|
|
1996
|
+
provider_type?: 'zai';
|
|
1997
|
+
|
|
1998
|
+
/**
|
|
1999
|
+
* The response format for the model.
|
|
2000
|
+
*/
|
|
2001
|
+
response_format?:
|
|
2002
|
+
| AgentsAPI.TextResponseFormat
|
|
2003
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
2004
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
2005
|
+
| null;
|
|
2006
|
+
|
|
2007
|
+
/**
|
|
2008
|
+
* The temperature of the model.
|
|
2009
|
+
*/
|
|
2010
|
+
temperature?: number;
|
|
2011
|
+
}
|
|
2012
|
+
}
|
|
2013
|
+
|
|
2014
|
+
/**
|
|
2015
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
2016
|
+
*/
|
|
2017
|
+
export interface ZaiModelSettings {
|
|
2018
|
+
/**
|
|
2019
|
+
* The maximum number of tokens the model can generate.
|
|
2020
|
+
*/
|
|
2021
|
+
max_output_tokens?: number;
|
|
2022
|
+
|
|
2023
|
+
/**
|
|
2024
|
+
* Whether to enable parallel tool calling.
|
|
2025
|
+
*/
|
|
2026
|
+
parallel_tool_calls?: boolean;
|
|
2027
|
+
|
|
2028
|
+
/**
|
|
2029
|
+
* The type of the provider.
|
|
2030
|
+
*/
|
|
2031
|
+
provider_type?: 'zai';
|
|
2032
|
+
|
|
2033
|
+
/**
|
|
2034
|
+
* The response format for the model.
|
|
2035
|
+
*/
|
|
2036
|
+
response_format?:
|
|
2037
|
+
| AgentsAPI.TextResponseFormat
|
|
2038
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
2039
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
2040
|
+
| null;
|
|
2041
|
+
|
|
2042
|
+
/**
|
|
2043
|
+
* The temperature of the model.
|
|
2044
|
+
*/
|
|
2045
|
+
temperature?: number;
|
|
2046
|
+
}
|
|
1903
2047
|
}
|
|
1904
2048
|
|
|
1905
2049
|
export interface AgentRetrieveParams {
|
|
@@ -2055,6 +2199,7 @@ export interface AgentUpdateParams {
|
|
|
2055
2199
|
| GoogleVertexModelSettings
|
|
2056
2200
|
| AzureModelSettings
|
|
2057
2201
|
| XaiModelSettings
|
|
2202
|
+
| AgentUpdateParams.ZaiModelSettings
|
|
2058
2203
|
| GroqModelSettings
|
|
2059
2204
|
| DeepseekModelSettings
|
|
2060
2205
|
| TogetherModelSettings
|
|
@@ -2187,6 +2332,7 @@ export namespace AgentUpdateParams {
|
|
|
2187
2332
|
| AgentsAPI.GoogleVertexModelSettings
|
|
2188
2333
|
| AgentsAPI.AzureModelSettings
|
|
2189
2334
|
| AgentsAPI.XaiModelSettings
|
|
2335
|
+
| CompactionSettings.ZaiModelSettings
|
|
2190
2336
|
| AgentsAPI.GroqModelSettings
|
|
2191
2337
|
| AgentsAPI.DeepseekModelSettings
|
|
2192
2338
|
| AgentsAPI.TogetherModelSettings
|
|
@@ -2210,6 +2356,76 @@ export namespace AgentUpdateParams {
|
|
|
2210
2356
|
*/
|
|
2211
2357
|
sliding_window_percentage?: number;
|
|
2212
2358
|
}
|
|
2359
|
+
|
|
2360
|
+
export namespace CompactionSettings {
|
|
2361
|
+
/**
|
|
2362
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
2363
|
+
*/
|
|
2364
|
+
export interface ZaiModelSettings {
|
|
2365
|
+
/**
|
|
2366
|
+
* The maximum number of tokens the model can generate.
|
|
2367
|
+
*/
|
|
2368
|
+
max_output_tokens?: number;
|
|
2369
|
+
|
|
2370
|
+
/**
|
|
2371
|
+
* Whether to enable parallel tool calling.
|
|
2372
|
+
*/
|
|
2373
|
+
parallel_tool_calls?: boolean;
|
|
2374
|
+
|
|
2375
|
+
/**
|
|
2376
|
+
* The type of the provider.
|
|
2377
|
+
*/
|
|
2378
|
+
provider_type?: 'zai';
|
|
2379
|
+
|
|
2380
|
+
/**
|
|
2381
|
+
* The response format for the model.
|
|
2382
|
+
*/
|
|
2383
|
+
response_format?:
|
|
2384
|
+
| AgentsAPI.TextResponseFormat
|
|
2385
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
2386
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
2387
|
+
| null;
|
|
2388
|
+
|
|
2389
|
+
/**
|
|
2390
|
+
* The temperature of the model.
|
|
2391
|
+
*/
|
|
2392
|
+
temperature?: number;
|
|
2393
|
+
}
|
|
2394
|
+
}
|
|
2395
|
+
|
|
2396
|
+
/**
|
|
2397
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
2398
|
+
*/
|
|
2399
|
+
export interface ZaiModelSettings {
|
|
2400
|
+
/**
|
|
2401
|
+
* The maximum number of tokens the model can generate.
|
|
2402
|
+
*/
|
|
2403
|
+
max_output_tokens?: number;
|
|
2404
|
+
|
|
2405
|
+
/**
|
|
2406
|
+
* Whether to enable parallel tool calling.
|
|
2407
|
+
*/
|
|
2408
|
+
parallel_tool_calls?: boolean;
|
|
2409
|
+
|
|
2410
|
+
/**
|
|
2411
|
+
* The type of the provider.
|
|
2412
|
+
*/
|
|
2413
|
+
provider_type?: 'zai';
|
|
2414
|
+
|
|
2415
|
+
/**
|
|
2416
|
+
* The response format for the model.
|
|
2417
|
+
*/
|
|
2418
|
+
response_format?:
|
|
2419
|
+
| AgentsAPI.TextResponseFormat
|
|
2420
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
2421
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
2422
|
+
| null;
|
|
2423
|
+
|
|
2424
|
+
/**
|
|
2425
|
+
* The temperature of the model.
|
|
2426
|
+
*/
|
|
2427
|
+
temperature?: number;
|
|
2428
|
+
}
|
|
2213
2429
|
}
|
|
2214
2430
|
|
|
2215
2431
|
export interface AgentListParams extends ArrayPageParams {
|
|
@@ -799,6 +799,13 @@ export interface LettaRequest {
|
|
|
799
799
|
*/
|
|
800
800
|
assistant_message_tool_name?: string;
|
|
801
801
|
|
|
802
|
+
/**
|
|
803
|
+
* Client-side tools that the agent can call. When the agent calls a client-side
|
|
804
|
+
* tool, execution pauses and returns control to the client to execute the tool and
|
|
805
|
+
* provide the result via a ToolReturn.
|
|
806
|
+
*/
|
|
807
|
+
client_tools?: Array<LettaRequest.ClientTool> | null;
|
|
808
|
+
|
|
802
809
|
/**
|
|
803
810
|
* @deprecated If set to True, enables reasoning before responses or tool calls
|
|
804
811
|
* from the agent.
|
|
@@ -848,6 +855,30 @@ export interface LettaRequest {
|
|
|
848
855
|
}
|
|
849
856
|
|
|
850
857
|
export namespace LettaRequest {
|
|
858
|
+
/**
|
|
859
|
+
* Schema for a client-side tool passed in the request.
|
|
860
|
+
*
|
|
861
|
+
* Client-side tools are executed by the client, not the server. When the agent
|
|
862
|
+
* calls a client-side tool, execution pauses and returns control to the client to
|
|
863
|
+
* execute the tool and provide the result.
|
|
864
|
+
*/
|
|
865
|
+
export interface ClientTool {
|
|
866
|
+
/**
|
|
867
|
+
* The name of the tool function
|
|
868
|
+
*/
|
|
869
|
+
name: string;
|
|
870
|
+
|
|
871
|
+
/**
|
|
872
|
+
* Description of what the tool does
|
|
873
|
+
*/
|
|
874
|
+
description?: string | null;
|
|
875
|
+
|
|
876
|
+
/**
|
|
877
|
+
* JSON Schema for the function parameters
|
|
878
|
+
*/
|
|
879
|
+
parameters?: { [key: string]: unknown } | null;
|
|
880
|
+
}
|
|
881
|
+
|
|
851
882
|
/**
|
|
852
883
|
* The style of reasoning content returned by the OpenAI Responses API
|
|
853
884
|
*/
|
|
@@ -1000,6 +1031,13 @@ export interface LettaStreamingRequest {
|
|
|
1000
1031
|
*/
|
|
1001
1032
|
background?: boolean;
|
|
1002
1033
|
|
|
1034
|
+
/**
|
|
1035
|
+
* Client-side tools that the agent can call. When the agent calls a client-side
|
|
1036
|
+
* tool, execution pauses and returns control to the client to execute the tool and
|
|
1037
|
+
* provide the result via a ToolReturn.
|
|
1038
|
+
*/
|
|
1039
|
+
client_tools?: Array<LettaStreamingRequest.ClientTool> | null;
|
|
1040
|
+
|
|
1003
1041
|
/**
|
|
1004
1042
|
* @deprecated If set to True, enables reasoning before responses or tool calls
|
|
1005
1043
|
* from the agent.
|
|
@@ -1067,6 +1105,30 @@ export interface LettaStreamingRequest {
|
|
|
1067
1105
|
}
|
|
1068
1106
|
|
|
1069
1107
|
export namespace LettaStreamingRequest {
|
|
1108
|
+
/**
|
|
1109
|
+
* Schema for a client-side tool passed in the request.
|
|
1110
|
+
*
|
|
1111
|
+
* Client-side tools are executed by the client, not the server. When the agent
|
|
1112
|
+
* calls a client-side tool, execution pauses and returns control to the client to
|
|
1113
|
+
* execute the tool and provide the result.
|
|
1114
|
+
*/
|
|
1115
|
+
export interface ClientTool {
|
|
1116
|
+
/**
|
|
1117
|
+
* The name of the tool function
|
|
1118
|
+
*/
|
|
1119
|
+
name: string;
|
|
1120
|
+
|
|
1121
|
+
/**
|
|
1122
|
+
* Description of what the tool does
|
|
1123
|
+
*/
|
|
1124
|
+
description?: string | null;
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* JSON Schema for the function parameters
|
|
1128
|
+
*/
|
|
1129
|
+
parameters?: { [key: string]: unknown } | null;
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1070
1132
|
/**
|
|
1071
1133
|
* The style of reasoning content returned by the OpenAI Responses API
|
|
1072
1134
|
*/
|
|
@@ -1808,6 +1870,13 @@ export interface MessageCreateParamsBase {
|
|
|
1808
1870
|
*/
|
|
1809
1871
|
background?: boolean;
|
|
1810
1872
|
|
|
1873
|
+
/**
|
|
1874
|
+
* Client-side tools that the agent can call. When the agent calls a client-side
|
|
1875
|
+
* tool, execution pauses and returns control to the client to execute the tool and
|
|
1876
|
+
* provide the result via a ToolReturn.
|
|
1877
|
+
*/
|
|
1878
|
+
client_tools?: Array<MessageCreateParams.ClientTool> | null;
|
|
1879
|
+
|
|
1811
1880
|
/**
|
|
1812
1881
|
* @deprecated If set to True, enables reasoning before responses or tool calls
|
|
1813
1882
|
* from the agent.
|
|
@@ -1875,6 +1944,30 @@ export interface MessageCreateParamsBase {
|
|
|
1875
1944
|
}
|
|
1876
1945
|
|
|
1877
1946
|
export namespace MessageCreateParams {
|
|
1947
|
+
/**
|
|
1948
|
+
* Schema for a client-side tool passed in the request.
|
|
1949
|
+
*
|
|
1950
|
+
* Client-side tools are executed by the client, not the server. When the agent
|
|
1951
|
+
* calls a client-side tool, execution pauses and returns control to the client to
|
|
1952
|
+
* execute the tool and provide the result.
|
|
1953
|
+
*/
|
|
1954
|
+
export interface ClientTool {
|
|
1955
|
+
/**
|
|
1956
|
+
* The name of the tool function
|
|
1957
|
+
*/
|
|
1958
|
+
name: string;
|
|
1959
|
+
|
|
1960
|
+
/**
|
|
1961
|
+
* Description of what the tool does
|
|
1962
|
+
*/
|
|
1963
|
+
description?: string | null;
|
|
1964
|
+
|
|
1965
|
+
/**
|
|
1966
|
+
* JSON Schema for the function parameters
|
|
1967
|
+
*/
|
|
1968
|
+
parameters?: { [key: string]: unknown } | null;
|
|
1969
|
+
}
|
|
1970
|
+
|
|
1878
1971
|
/**
|
|
1879
1972
|
* The style of reasoning content returned by the OpenAI Responses API
|
|
1880
1973
|
*/
|
|
@@ -2015,6 +2108,7 @@ export namespace MessageCompactParams {
|
|
|
2015
2108
|
| AgentsAPI.GoogleVertexModelSettings
|
|
2016
2109
|
| AgentsAPI.AzureModelSettings
|
|
2017
2110
|
| AgentsAPI.XaiModelSettings
|
|
2111
|
+
| CompactionSettings.ZaiModelSettings
|
|
2018
2112
|
| AgentsAPI.GroqModelSettings
|
|
2019
2113
|
| AgentsAPI.DeepseekModelSettings
|
|
2020
2114
|
| AgentsAPI.TogetherModelSettings
|
|
@@ -2038,6 +2132,42 @@ export namespace MessageCompactParams {
|
|
|
2038
2132
|
*/
|
|
2039
2133
|
sliding_window_percentage?: number;
|
|
2040
2134
|
}
|
|
2135
|
+
|
|
2136
|
+
export namespace CompactionSettings {
|
|
2137
|
+
/**
|
|
2138
|
+
* Z.ai (ZhipuAI) model configuration (OpenAI-compatible).
|
|
2139
|
+
*/
|
|
2140
|
+
export interface ZaiModelSettings {
|
|
2141
|
+
/**
|
|
2142
|
+
* The maximum number of tokens the model can generate.
|
|
2143
|
+
*/
|
|
2144
|
+
max_output_tokens?: number;
|
|
2145
|
+
|
|
2146
|
+
/**
|
|
2147
|
+
* Whether to enable parallel tool calling.
|
|
2148
|
+
*/
|
|
2149
|
+
parallel_tool_calls?: boolean;
|
|
2150
|
+
|
|
2151
|
+
/**
|
|
2152
|
+
* The type of the provider.
|
|
2153
|
+
*/
|
|
2154
|
+
provider_type?: 'zai';
|
|
2155
|
+
|
|
2156
|
+
/**
|
|
2157
|
+
* The response format for the model.
|
|
2158
|
+
*/
|
|
2159
|
+
response_format?:
|
|
2160
|
+
| AgentsAPI.TextResponseFormat
|
|
2161
|
+
| AgentsAPI.JsonSchemaResponseFormat
|
|
2162
|
+
| AgentsAPI.JsonObjectResponseFormat
|
|
2163
|
+
| null;
|
|
2164
|
+
|
|
2165
|
+
/**
|
|
2166
|
+
* The temperature of the model.
|
|
2167
|
+
*/
|
|
2168
|
+
temperature?: number;
|
|
2169
|
+
}
|
|
2170
|
+
}
|
|
2041
2171
|
}
|
|
2042
2172
|
|
|
2043
2173
|
export interface MessageCreateAsyncParams {
|
|
@@ -2059,6 +2189,13 @@ export interface MessageCreateAsyncParams {
|
|
|
2059
2189
|
*/
|
|
2060
2190
|
callback_url?: string | null;
|
|
2061
2191
|
|
|
2192
|
+
/**
|
|
2193
|
+
* Client-side tools that the agent can call. When the agent calls a client-side
|
|
2194
|
+
* tool, execution pauses and returns control to the client to execute the tool and
|
|
2195
|
+
* provide the result via a ToolReturn.
|
|
2196
|
+
*/
|
|
2197
|
+
client_tools?: Array<MessageCreateAsyncParams.ClientTool> | null;
|
|
2198
|
+
|
|
2062
2199
|
/**
|
|
2063
2200
|
* @deprecated If set to True, enables reasoning before responses or tool calls
|
|
2064
2201
|
* from the agent.
|
|
@@ -2108,6 +2245,30 @@ export interface MessageCreateAsyncParams {
|
|
|
2108
2245
|
}
|
|
2109
2246
|
|
|
2110
2247
|
export namespace MessageCreateAsyncParams {
|
|
2248
|
+
/**
|
|
2249
|
+
* Schema for a client-side tool passed in the request.
|
|
2250
|
+
*
|
|
2251
|
+
* Client-side tools are executed by the client, not the server. When the agent
|
|
2252
|
+
* calls a client-side tool, execution pauses and returns control to the client to
|
|
2253
|
+
* execute the tool and provide the result.
|
|
2254
|
+
*/
|
|
2255
|
+
export interface ClientTool {
|
|
2256
|
+
/**
|
|
2257
|
+
* The name of the tool function
|
|
2258
|
+
*/
|
|
2259
|
+
name: string;
|
|
2260
|
+
|
|
2261
|
+
/**
|
|
2262
|
+
* Description of what the tool does
|
|
2263
|
+
*/
|
|
2264
|
+
description?: string | null;
|
|
2265
|
+
|
|
2266
|
+
/**
|
|
2267
|
+
* JSON Schema for the function parameters
|
|
2268
|
+
*/
|
|
2269
|
+
parameters?: { [key: string]: unknown } | null;
|
|
2270
|
+
}
|
|
2271
|
+
|
|
2111
2272
|
/**
|
|
2112
2273
|
* The style of reasoning content returned by the OpenAI Responses API
|
|
2113
2274
|
*/
|
|
@@ -2175,6 +2336,13 @@ export interface MessageStreamParams {
|
|
|
2175
2336
|
*/
|
|
2176
2337
|
background?: boolean;
|
|
2177
2338
|
|
|
2339
|
+
/**
|
|
2340
|
+
* Client-side tools that the agent can call. When the agent calls a client-side
|
|
2341
|
+
* tool, execution pauses and returns control to the client to execute the tool and
|
|
2342
|
+
* provide the result via a ToolReturn.
|
|
2343
|
+
*/
|
|
2344
|
+
client_tools?: Array<MessageStreamParams.ClientTool> | null;
|
|
2345
|
+
|
|
2178
2346
|
/**
|
|
2179
2347
|
* @deprecated If set to True, enables reasoning before responses or tool calls
|
|
2180
2348
|
* from the agent.
|
|
@@ -2242,6 +2410,30 @@ export interface MessageStreamParams {
|
|
|
2242
2410
|
}
|
|
2243
2411
|
|
|
2244
2412
|
export namespace MessageStreamParams {
|
|
2413
|
+
/**
|
|
2414
|
+
* Schema for a client-side tool passed in the request.
|
|
2415
|
+
*
|
|
2416
|
+
* Client-side tools are executed by the client, not the server. When the agent
|
|
2417
|
+
* calls a client-side tool, execution pauses and returns control to the client to
|
|
2418
|
+
* execute the tool and provide the result.
|
|
2419
|
+
*/
|
|
2420
|
+
export interface ClientTool {
|
|
2421
|
+
/**
|
|
2422
|
+
* The name of the tool function
|
|
2423
|
+
*/
|
|
2424
|
+
name: string;
|
|
2425
|
+
|
|
2426
|
+
/**
|
|
2427
|
+
* Description of what the tool does
|
|
2428
|
+
*/
|
|
2429
|
+
description?: string | null;
|
|
2430
|
+
|
|
2431
|
+
/**
|
|
2432
|
+
* JSON Schema for the function parameters
|
|
2433
|
+
*/
|
|
2434
|
+
parameters?: { [key: string]: unknown } | null;
|
|
2435
|
+
}
|
|
2436
|
+
|
|
2245
2437
|
/**
|
|
2246
2438
|
* The style of reasoning content returned by the OpenAI Responses API
|
|
2247
2439
|
*/
|
|
@@ -179,6 +179,13 @@ export namespace BatchCreateParams {
|
|
|
179
179
|
*/
|
|
180
180
|
assistant_message_tool_name?: string;
|
|
181
181
|
|
|
182
|
+
/**
|
|
183
|
+
* Client-side tools that the agent can call. When the agent calls a client-side
|
|
184
|
+
* tool, execution pauses and returns control to the client to execute the tool and
|
|
185
|
+
* provide the result via a ToolReturn.
|
|
186
|
+
*/
|
|
187
|
+
client_tools?: Array<Request.ClientTool> | null;
|
|
188
|
+
|
|
182
189
|
/**
|
|
183
190
|
* @deprecated If set to True, enables reasoning before responses or tool calls
|
|
184
191
|
* from the agent.
|
|
@@ -228,6 +235,30 @@ export namespace BatchCreateParams {
|
|
|
228
235
|
}
|
|
229
236
|
|
|
230
237
|
export namespace Request {
|
|
238
|
+
/**
|
|
239
|
+
* Schema for a client-side tool passed in the request.
|
|
240
|
+
*
|
|
241
|
+
* Client-side tools are executed by the client, not the server. When the agent
|
|
242
|
+
* calls a client-side tool, execution pauses and returns control to the client to
|
|
243
|
+
* execute the tool and provide the result.
|
|
244
|
+
*/
|
|
245
|
+
export interface ClientTool {
|
|
246
|
+
/**
|
|
247
|
+
* The name of the tool function
|
|
248
|
+
*/
|
|
249
|
+
name: string;
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* Description of what the tool does
|
|
253
|
+
*/
|
|
254
|
+
description?: string | null;
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* JSON Schema for the function parameters
|
|
258
|
+
*/
|
|
259
|
+
parameters?: { [key: string]: unknown } | null;
|
|
260
|
+
}
|
|
261
|
+
|
|
231
262
|
/**
|
|
232
263
|
* The style of reasoning content returned by the OpenAI Responses API
|
|
233
264
|
*/
|
|
@@ -410,7 +410,7 @@ export interface BlockListParams extends ArrayPageParams {
|
|
|
410
410
|
identity_id?: string | null;
|
|
411
411
|
|
|
412
412
|
/**
|
|
413
|
-
* Label to include (alphanumeric, hyphens, underscores
|
|
413
|
+
* Label to include (alphanumeric, hyphens, underscores, forward slashes)
|
|
414
414
|
*/
|
|
415
415
|
label?: string | null;
|
|
416
416
|
|