box-node-sdk 3.7.1 → 3.8.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.
Files changed (50) hide show
  1. package/README.md +22 -20
  2. package/lib/api-request.d.ts +1 -0
  3. package/lib/chunked-uploader.d.ts +1 -0
  4. package/lib/managers/ai.generated.d.ts +28 -2
  5. package/lib/managers/ai.generated.js +18 -1
  6. package/lib/managers/ai.generated.js.map +1 -1
  7. package/lib/managers/files.d.ts +1 -0
  8. package/lib/managers/users.d.ts +1 -0
  9. package/lib/schemas/ai-agent-ask.generated.d.ts +17 -0
  10. package/lib/schemas/ai-agent-ask.generated.js +3 -0
  11. package/lib/schemas/ai-agent-ask.generated.js.map +1 -0
  12. package/lib/schemas/ai-agent-basic-gen-tool.generated.d.ts +14 -0
  13. package/lib/schemas/ai-agent-basic-gen-tool.generated.js +3 -0
  14. package/lib/schemas/ai-agent-basic-gen-tool.generated.js.map +1 -0
  15. package/lib/schemas/ai-agent-basic-text-tool-ask.generated.d.ts +34 -0
  16. package/lib/schemas/ai-agent-basic-text-tool-ask.generated.js +3 -0
  17. package/lib/schemas/ai-agent-basic-text-tool-ask.generated.js.map +1 -0
  18. package/lib/schemas/ai-agent-basic-text-tool-text-gen.generated.d.ts +36 -0
  19. package/lib/schemas/ai-agent-basic-text-tool-text-gen.generated.js +3 -0
  20. package/lib/schemas/ai-agent-basic-text-tool-text-gen.generated.js.map +1 -0
  21. package/lib/schemas/ai-agent-long-text-tool.generated.d.ts +9 -0
  22. package/lib/schemas/ai-agent-long-text-tool.generated.js +3 -0
  23. package/lib/schemas/ai-agent-long-text-tool.generated.js.map +1 -0
  24. package/lib/schemas/ai-agent-text-gen.generated.d.ts +14 -0
  25. package/lib/schemas/ai-agent-text-gen.generated.js +3 -0
  26. package/lib/schemas/ai-agent-text-gen.generated.js.map +1 -0
  27. package/lib/schemas/ai-ask.generated.d.ts +13 -2
  28. package/lib/schemas/ai-citation.generated.d.ts +27 -0
  29. package/lib/schemas/ai-citation.generated.js +3 -0
  30. package/lib/schemas/ai-citation.generated.js.map +1 -0
  31. package/lib/schemas/ai-dialogue-history.generated.d.ts +22 -0
  32. package/lib/schemas/ai-dialogue-history.generated.js +3 -0
  33. package/lib/schemas/ai-dialogue-history.generated.js.map +1 -0
  34. package/lib/schemas/ai-llm-endpoint-params-google.generated.d.ts +31 -0
  35. package/lib/schemas/ai-llm-endpoint-params-google.generated.js +3 -0
  36. package/lib/schemas/ai-llm-endpoint-params-google.generated.js.map +1 -0
  37. package/lib/schemas/ai-llm-endpoint-params-open-ai.generated.d.ts +43 -0
  38. package/lib/schemas/ai-llm-endpoint-params-open-ai.generated.js +3 -0
  39. package/lib/schemas/ai-llm-endpoint-params-open-ai.generated.js.map +1 -0
  40. package/lib/schemas/ai-response-full.generated.d.ts +12 -0
  41. package/lib/schemas/ai-response-full.generated.js +3 -0
  42. package/lib/schemas/ai-response-full.generated.js.map +1 -0
  43. package/lib/schemas/ai-response.generated.d.ts +1 -1
  44. package/lib/schemas/ai-text-gen.generated.d.ts +5 -7
  45. package/lib/schemas/index.generated.d.ts +11 -0
  46. package/lib/schemas/index.generated.js +11 -0
  47. package/lib/schemas/index.generated.js.map +1 -1
  48. package/lib/util/config.d.ts +1 -0
  49. package/package.json +7 -2
  50. package/CHANGELOG.md +0 -612
package/README.md CHANGED
@@ -21,24 +21,26 @@ A Node.js interface to the [Box Content API](https://developer.box.com/reference
21
21
  <!-- START doctoc generated TOC please keep comment here to allow auto update -->
22
22
  <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
23
23
 
24
- - [Installation](#installation)
25
- - [Getting Started](#getting-started)
26
- - [Creating API Clients](#creating-api-clients)
27
- - [Basic Client](#basic-client)
28
- - [Persistent Client](#persistent-client)
29
- - [App Auth Client](#app-auth-client)
30
- - [Using the Client to Make API Calls](#using-the-client-to-make-api-calls)
31
- - [Constructing API Calls Manually](#constructing-api-calls-manually)
32
- - [FIPS 140-2 Compliance](#fips-140-2-compliance)
33
- - [Versions](#versions)
34
- - [Supported Version](#supported-version)
35
- - [Version schedule](#version-schedule)
36
- - [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
37
- - [Contributing to the Box Node.js SDK](#contributing-to-the-box-nodejs-sdk)
38
- - [Changelog](#changelog)
39
- - [Upgrades](#upgrades)
40
- - [Documentation](#documentation)
41
- - [Copyright and License](#copyright-and-license)
24
+ - [Deprecation notice](#deprecation-notice)
25
+ - [Box Node.js SDK](#box-nodejs-sdk)
26
+ - [Installation](#installation)
27
+ - [Getting Started](#getting-started)
28
+ - [Creating API Clients](#creating-api-clients)
29
+ - [Basic Client](#basic-client)
30
+ - [Persistent Client](#persistent-client)
31
+ - [App Auth Client](#app-auth-client)
32
+ - [Using the Client to Make API Calls](#using-the-client-to-make-api-calls)
33
+ - [Constructing API Calls Manually](#constructing-api-calls-manually)
34
+ - [FIPS 140-2 Compliance](#fips-140-2-compliance)
35
+ - [Versions](#versions)
36
+ - [Supported Version](#supported-version)
37
+ - [Version schedule](#version-schedule)
38
+ - [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
39
+ - [Contributing to the Box Node.js SDK](#contributing-to-the-box-nodejs-sdk)
40
+ - [Changelog](#changelog)
41
+ - [Upgrades](#upgrades)
42
+ - [Documentation](#documentation)
43
+ - [Copyright and License](#copyright-and-license)
42
44
 
43
45
  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
44
46
 
@@ -53,7 +55,7 @@ npm install --save box-node-sdk
53
55
 
54
56
 
55
57
  To get started with the SDK, get a Developer Token from the Configuration page
56
- of your app in the [Box Developer Console][dev-console].
58
+ of your platform app in the [Box Developer Console][dev-console].
57
59
  You can use this token to make test calls for your own Box account.
58
60
 
59
61
  ```js
@@ -129,7 +131,7 @@ Note that these methods don't pass in identifying information as arguments. You'
129
131
 
130
132
  ### App Auth Client
131
133
 
132
- App Auth allows an app to fully manage the Box accounts of its users; they do not
134
+ App Auth allows an platform app to fully manage the Box accounts of its users; they do not
133
135
  have direct login credentials to Box and all operations are performed through the API
134
136
  using a JWT grant.
135
137
 
@@ -3,6 +3,7 @@
3
3
  */
4
4
  /// <reference types="node" />
5
5
  /// <reference types="node" />
6
+ /// <reference types="node" />
6
7
  import { EventEmitter } from 'events';
7
8
  import Config from './util/config';
8
9
  /**
@@ -5,6 +5,7 @@
5
5
  /// <reference types="node" />
6
6
  /// <reference types="node" />
7
7
  /// <reference types="node" />
8
+ /// <reference types="node" />
8
9
  /**
9
10
  * Chunk uploaded event
10
11
  * @event Chunk#uploaded
@@ -15,9 +15,9 @@ declare class AIManager {
15
15
  * @param {schemas.AiAsk} body
16
16
  * @param {object} [options] Options for the request
17
17
  * @param {Function} [callback] Passed the result if successful, error otherwise
18
- * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
18
+ * @returns {Promise<schemas.AiResponseFull>} A promise resolving to the result or rejecting with an error
19
19
  */
20
- ask(body: schemas.AiAsk, options?: {}, callback?: Function): Promise<schemas.AiResponse>;
20
+ ask(body: schemas.AiAsk, options?: {}, callback?: Function): Promise<schemas.AiResponseFull>;
21
21
  /**
22
22
  * Send AI request to generate text
23
23
  *
@@ -28,5 +28,31 @@ declare class AIManager {
28
28
  * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
29
29
  */
30
30
  textGen(body: schemas.AiTextGen, options?: {}, callback?: Function): Promise<schemas.AiResponse>;
31
+ /**
32
+ * Get AI agent default configuration
33
+ *
34
+ * Get the AI agent default config
35
+ * @param {object} options Options for the request
36
+ * @param {"ask" | "text_gen"} options.mode The mode to filter the agent config to return.
37
+ * @param {string} [options.language] The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.
38
+ * @param {string} [options.model] The model to return the default agent config for.
39
+ * @param {Function} [callback] Passed the result if successful, error otherwise
40
+ * @returns {Promise<schemas.AiAgentAsk | schemas.AiAgentTextGen>} A promise resolving to the result or rejecting with an error
41
+ */
42
+ getAiAgentDefaultConfig(options: {
43
+ /**
44
+ * The mode to filter the agent config to return.
45
+ */
46
+ readonly mode: 'ask' | 'text_gen';
47
+ /**
48
+ * The ISO language code to return the agent config for.
49
+ * If the language is not supported the default agent config is returned.
50
+ */
51
+ readonly language?: string;
52
+ /**
53
+ * The model to return the default agent config for.
54
+ */
55
+ readonly model?: string;
56
+ }, callback?: Function): Promise<schemas.AiAgentAsk | schemas.AiAgentTextGen>;
31
57
  }
32
58
  export = AIManager;
@@ -30,7 +30,7 @@ var AIManager = /** @class */ (function () {
30
30
  * @param {schemas.AiAsk} body
31
31
  * @param {object} [options] Options for the request
32
32
  * @param {Function} [callback] Passed the result if successful, error otherwise
33
- * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
33
+ * @returns {Promise<schemas.AiResponseFull>} A promise resolving to the result or rejecting with an error
34
34
  */
35
35
  AIManager.prototype.ask = function (body, options, callback) {
36
36
  var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('ai', 'ask'), params = {
@@ -55,6 +55,23 @@ var AIManager = /** @class */ (function () {
55
55
  };
56
56
  return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
57
57
  };
58
+ /**
59
+ * Get AI agent default configuration
60
+ *
61
+ * Get the AI agent default config
62
+ * @param {object} options Options for the request
63
+ * @param {"ask" | "text_gen"} options.mode The mode to filter the agent config to return.
64
+ * @param {string} [options.language] The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.
65
+ * @param {string} [options.model] The model to return the default agent config for.
66
+ * @param {Function} [callback] Passed the result if successful, error otherwise
67
+ * @returns {Promise<schemas.AiAgentAsk | schemas.AiAgentTextGen>} A promise resolving to the result or rejecting with an error
68
+ */
69
+ AIManager.prototype.getAiAgentDefaultConfig = function (options, callback) {
70
+ var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('ai_agent_default'), params = {
71
+ qs: queryParams,
72
+ };
73
+ return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
74
+ };
58
75
  return AIManager;
59
76
  }());
60
77
  module.exports = AIManager;
@@ -1 +1 @@
1
- {"version":3,"file":"ai.generated.js","sourceRoot":"","sources":["../../src/managers/ai.generated.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,8DAAuC;AAEvC;GACG;AACH;IAEC;;OAEG;IACH,mBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD;;;;;;;;OAQG;IACH,uBAAG,GAAH,UACC,IAAmB,EACnB,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,IAAI,EAAE,KAAK,CAAC,EAC9B,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;OAQG;IACH,2BAAO,GAAP,UACC,IAAuB,EACvB,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,IAAI,EAAE,UAAU,CAAC,EACnC,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,gBAAC;AAAD,CAAC,AA5DD,IA4DC;AACD,iBAAS,SAAS,CAAC"}
1
+ {"version":3,"file":"ai.generated.js","sourceRoot":"","sources":["../../src/managers/ai.generated.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,8DAAuC;AAEvC;GACG;AACH;IAEC;;OAEG;IACH,mBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD;;;;;;;;OAQG;IACH,uBAAG,GAAH,UACC,IAAmB,EACnB,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,IAAI,EAAE,KAAK,CAAC,EAC9B,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;OAQG;IACH,2BAAO,GAAP,UACC,IAAuB,EACvB,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,IAAI,EAAE,UAAU,CAAC,EACnC,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;;;OAUG;IACH,2CAAuB,GAAvB,UACC,OAcC,EACD,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,kBAAkB,CAAC,EACrC,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;SACf,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,gBAAC;AAAD,CAAC,AApGD,IAoGC;AACD,iBAAS,SAAS,CAAC"}
@@ -3,6 +3,7 @@
3
3
  */
4
4
  /// <reference types="node" />
5
5
  /// <reference types="node" />
6
+ /// <reference types="node" />
6
7
  import Promise from 'bluebird';
7
8
  import { Readable, Writable } from 'stream';
8
9
  import BoxClient from '../box-client';
@@ -3,6 +3,7 @@
3
3
  */
4
4
  /// <reference types="node" />
5
5
  /// <reference types="node" />
6
+ /// <reference types="node" />
6
7
  import BoxClient from '../box-client';
7
8
  import { Readable } from 'stream';
8
9
  /**
@@ -0,0 +1,17 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI agent for question requests
4
+ *
5
+ * The AI agent used to handle queries.
6
+ */
7
+ export interface AiAgentAsk {
8
+ /**
9
+ * The type of AI agent used to handle queries.
10
+ * Example: ai_agent_ask
11
+ */
12
+ type: 'ai_agent_ask';
13
+ long_text?: schemas.AiAgentLongTextTool;
14
+ basic_text?: schemas.AiAgentBasicTextToolAsk;
15
+ long_text_multi?: schemas.AiAgentLongTextTool;
16
+ basic_text_multi?: schemas.AiAgentBasicTextToolAsk;
17
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-agent-ask.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-agent-ask.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-agent-ask.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,14 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI agent basic text generation tool
4
+ *
5
+ * AI agent basic tool used to generate text.
6
+ */
7
+ export interface AiAgentBasicGenTool extends schemas.AiAgentLongTextTool {
8
+ /**
9
+ * How the content should be included in a request to the LLM.
10
+ * When passing this parameter, you must include `{content}`.
11
+ * Example: ---{content}---
12
+ */
13
+ content_template?: string;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-agent-basic-gen-tool.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-agent-basic-gen-tool.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-agent-basic-gen-tool.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,34 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI agent basic text tool
4
+ *
5
+ * AI agent tool used to handle basic text.
6
+ */
7
+ export interface AiAgentBasicTextToolAsk {
8
+ /**
9
+ * The model used for the AI Agent for basic text.
10
+ * Example: openai__gpt_3_5_turbo
11
+ */
12
+ model?: string;
13
+ /**
14
+ * System messages try to help the LLM "understand" its role and what it is supposed to do.
15
+ * Example: You are a helpful travel assistant specialized in budget travel
16
+ */
17
+ system_message?: string;
18
+ /**
19
+ * The prompt template contains contextual information of the request and the user prompt.
20
+ *
21
+ * When passing `prompt_template` parameters, you **must include** inputs for `{current_date}`, `{user_question}`, and `{content}`.
22
+ * Example: It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. What should I see?
23
+ */
24
+ prompt_template?: string;
25
+ /**
26
+ * The number of tokens for completion.
27
+ * Example: 8400
28
+ */
29
+ num_tokens_for_completion?: number;
30
+ /**
31
+ * The parameters for the LLM endpoint specific to OpenAI / Google models.
32
+ */
33
+ llm_endpoint_params?: schemas.AiLlmEndpointParamsOpenAi | schemas.AiLlmEndpointParamsGoogle;
34
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-agent-basic-text-tool-ask.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-agent-basic-text-tool-ask.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-agent-basic-text-tool-ask.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,36 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI agent basic text tool
4
+ *
5
+ * AI agent tool used to handle basic text.
6
+ */
7
+ export interface AiAgentBasicTextToolTextGen {
8
+ /**
9
+ * The model to be used for the AI Agent for basic text.
10
+ * Example: openai__gpt_3_5_turbo
11
+ */
12
+ model?: string;
13
+ /**
14
+ * System messages try to help the LLM "understand" its role and what it is supposed to do.
15
+ * This parameter requires using `{current_date}`.
16
+ * Example: You are a helpful travel assistant specialized in budget travel
17
+ */
18
+ system_message?: string;
19
+ /**
20
+ * The prompt template contains contextual information of the request and the user prompt.
21
+ *
22
+ * When using the `prompt_template` parameter, you **must include** input for `{user_question}`.
23
+ * Inputs for `{current_date}` and`{content}` are optional, depending on the use.
24
+ * Example: It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. What should I see?
25
+ */
26
+ prompt_template?: string;
27
+ /**
28
+ * The number of tokens for completion.
29
+ * Example: 8400
30
+ */
31
+ num_tokens_for_completion?: number;
32
+ /**
33
+ * The parameters for the LLM endpoint specific to OpenAI / Google models.
34
+ */
35
+ llm_endpoint_params?: schemas.AiLlmEndpointParamsOpenAi | schemas.AiLlmEndpointParamsGoogle;
36
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-agent-basic-text-tool-text-gen.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-agent-basic-text-tool-text-gen.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-agent-basic-text-tool-text-gen.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,9 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI agent long text tool
4
+ *
5
+ * AI agent tool used to to handle longer text.
6
+ */
7
+ export interface AiAgentLongTextTool extends schemas.AiAgentBasicTextToolTextGen {
8
+ embeddings?: object;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-agent-long-text-tool.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-agent-long-text-tool.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-agent-long-text-tool.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,14 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI agent for text generation requests
4
+ *
5
+ * The AI agent used for generating text.
6
+ */
7
+ export interface AiAgentTextGen {
8
+ /**
9
+ * The type of AI agent used for generating text.
10
+ * Example: ai_agent_text_gen
11
+ */
12
+ type: 'ai_agent_text_gen';
13
+ basic_gen?: schemas.AiAgentBasicGenTool;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-agent-text-gen.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-agent-text-gen.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-agent-text-gen.generated.ts"],"names":[],"mappings":""}
@@ -1,7 +1,8 @@
1
+ import * as schemas from '.';
1
2
  /**
2
- * AI Ask Request
3
+ * AI ask request
3
4
  *
4
- * AI Ask request object
5
+ * AI ask request object
5
6
  */
6
7
  export interface AiAsk {
7
8
  /**
@@ -26,4 +27,14 @@ export interface AiAsk {
26
27
  type?: string;
27
28
  content?: string;
28
29
  }[];
30
+ /**
31
+ * The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response.
32
+ */
33
+ dialogue_history?: schemas.AiDialogueHistory[];
34
+ /**
35
+ * A flag to indicate whether citations should be returned.
36
+ * Example: true
37
+ */
38
+ include_citations?: boolean;
39
+ ai_agent?: schemas.AiAgentAsk;
29
40
  }
@@ -0,0 +1,27 @@
1
+ /**
2
+ * The citation of the LLM's answer reference
3
+ *
4
+ * The citation of the LLM's answer reference.
5
+ */
6
+ export interface AiCitation {
7
+ /**
8
+ * The specific content from where the answer was referenced.
9
+ * Example: Public APIs are key drivers of innovation and growth.
10
+ */
11
+ content?: string;
12
+ /**
13
+ * The id of the item.
14
+ * Example: 123
15
+ */
16
+ id?: string;
17
+ /**
18
+ * The type of the item.
19
+ * Example: file
20
+ */
21
+ type?: 'file';
22
+ /**
23
+ * The name of the item.
24
+ * Example: The importance of public APIs.pdf
25
+ */
26
+ name?: string;
27
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-citation.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-citation.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-citation.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Dialogue history
3
+ *
4
+ * A context object that can hold prior prompts and answers.
5
+ */
6
+ export interface AiDialogueHistory {
7
+ /**
8
+ * The prompt previously provided by the client and answered by the LLM.
9
+ * Example: Make my email about public APIs sound more professional.
10
+ */
11
+ prompt?: string;
12
+ /**
13
+ * The answer previously provided by the LLM.
14
+ * Example: Here is the first draft of your professional email about public APIs.
15
+ */
16
+ answer?: string;
17
+ /**
18
+ * The ISO date formatted timestamp of when the previous answer to the prompt was created.
19
+ * Example: 2012-12-12T10:53:43-08:00
20
+ */
21
+ created_at?: string;
22
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-dialogue-history.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-dialogue-history.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-dialogue-history.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,31 @@
1
+ /**
2
+ * AI LLM endpoint params Google
3
+ *
4
+ * AI LLM endpoint params Google object
5
+ */
6
+ export interface AiLlmEndpointParamsGoogle {
7
+ /**
8
+ * The type of the AI LLM endpoint params object for Google.
9
+ * This parameter is **required**.
10
+ * Example: google_params
11
+ */
12
+ type: 'google_params';
13
+ /**
14
+ * The temperature is used for sampling during response generation, which occurs when `top-P` and `top-K` are applied.
15
+ * Temperature controls the degree of randomness in token selection.
16
+ */
17
+ temperature?: number;
18
+ /**
19
+ * `Top-P` changes how the model selects tokens for output. Tokens are selected from the most (see `top-K`) to least probable
20
+ * until the sum of their probabilities equals the `top-P` value.
21
+ * Example: 1
22
+ */
23
+ top_p?: number;
24
+ /**
25
+ * `Top-K` changes how the model selects tokens for output. A `top-K` of 1 means the next selected token is
26
+ * the most probable among all tokens in the model's vocabulary (also called greedy decoding),
27
+ * while a `top-K` of 3 means that the next token is selected from among the three most probable tokens by using temperature.
28
+ * Example: 1
29
+ */
30
+ top_k?: number;
31
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-llm-endpoint-params-google.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-llm-endpoint-params-google.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-llm-endpoint-params-google.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,43 @@
1
+ /**
2
+ * AI LLM endpoint params OpenAI
3
+ *
4
+ * AI LLM endpoint params OpenAI object.
5
+ */
6
+ export interface AiLlmEndpointParamsOpenAi {
7
+ /**
8
+ * The type of the AI LLM endpoint params object for OpenAI.
9
+ * This parameter is **required**.
10
+ * Example: openai_params
11
+ */
12
+ type: 'openai_params';
13
+ /**
14
+ * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random,
15
+ * while lower values like 0.2 will make it more focused and deterministic.
16
+ * We generally recommend altering this or `top_p` but not both.
17
+ */
18
+ temperature?: number;
19
+ /**
20
+ * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results
21
+ * of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability
22
+ * mass are considered. We generally recommend altering this or temperature but not both.
23
+ * Example: 1
24
+ */
25
+ top_p?: number;
26
+ /**
27
+ * Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the
28
+ * text so far, decreasing the model's likelihood to repeat the same line verbatim.
29
+ * Example: 1.5
30
+ */
31
+ frequency_penalty?: number;
32
+ /**
33
+ * Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
34
+ * increasing the model's likelihood to talk about new topics.
35
+ * Example: 1.5
36
+ */
37
+ presence_penalty?: number;
38
+ /**
39
+ * Up to 4 sequences where the API will stop generating further tokens.
40
+ * Example: <|im_end|>
41
+ */
42
+ stop?: string;
43
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-llm-endpoint-params-open-ai.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-llm-endpoint-params-open-ai.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-llm-endpoint-params-open-ai.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,12 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * AI response (Full)
4
+ *
5
+ * AI ask response
6
+ */
7
+ export interface AiResponseFull extends schemas.AiResponse {
8
+ /**
9
+ * The citations of the LLM's answer reference.
10
+ */
11
+ citations?: schemas.AiCitation[];
12
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ai-response-full.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ai-response-full.generated.js","sourceRoot":"","sources":["../../src/schemas/ai-response-full.generated.ts"],"names":[],"mappings":""}
@@ -1,5 +1,5 @@
1
1
  /**
2
- * AI Response
2
+ * AI response
3
3
  *
4
4
  * AI response
5
5
  */
@@ -1,7 +1,8 @@
1
+ import * as schemas from '.';
1
2
  /**
2
- * AI Text Gen Request
3
+ * AI text gen request
3
4
  *
4
- * AI Text Gen Request object
5
+ * AI text gen request object
5
6
  */
6
7
  export interface AiTextGen {
7
8
  /**
@@ -24,9 +25,6 @@ export interface AiTextGen {
24
25
  /**
25
26
  * The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response.
26
27
  */
27
- dialogue_history?: {
28
- answer?: string;
29
- created_at?: string;
30
- prompt?: string;
31
- }[];
28
+ dialogue_history?: schemas.AiDialogueHistory[];
29
+ ai_agent?: schemas.AiAgentTextGen;
32
30
  }
@@ -1,4 +1,15 @@
1
+ export * from './ai-agent-ask.generated';
2
+ export * from './ai-agent-basic-gen-tool.generated';
3
+ export * from './ai-agent-basic-text-tool-ask.generated';
4
+ export * from './ai-agent-basic-text-tool-text-gen.generated';
5
+ export * from './ai-agent-long-text-tool.generated';
6
+ export * from './ai-agent-text-gen.generated';
1
7
  export * from './ai-ask.generated';
8
+ export * from './ai-citation.generated';
9
+ export * from './ai-dialogue-history.generated';
10
+ export * from './ai-llm-endpoint-params-open-ai.generated';
11
+ export * from './ai-llm-endpoint-params-google.generated';
12
+ export * from './ai-response-full.generated';
2
13
  export * from './ai-response.generated';
3
14
  export * from './ai-text-gen.generated';
4
15
  export * from './enterprise-base.generated';