@airtop/sdk 0.1.4 → 0.1.5
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/api/resources/profiles/client/Client.js +4 -4
- package/api/resources/sessions/client/Client.d.ts +2 -2
- package/api/resources/sessions/client/Client.js +12 -12
- package/api/resources/windows/client/Client.d.ts +18 -2
- package/api/resources/windows/client/Client.js +85 -16
- package/api/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +3 -0
- package/api/resources/windows/client/requests/index.d.ts +0 -1
- package/api/types/PageQueryConfig.d.ts +7 -0
- package/api/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +1 -1
- package/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → types/SessionPageQueryHandlerRequestBody.d.ts} +6 -9
- package/api/types/SummaryConfig.d.ts +2 -2
- package/api/types/index.d.ts +3 -2
- package/api/types/index.js +3 -2
- package/dist/api/resources/profiles/client/Client.js +4 -4
- package/dist/api/resources/sessions/client/Client.d.ts +2 -2
- package/dist/api/resources/sessions/client/Client.js +12 -12
- package/dist/api/resources/windows/client/Client.d.ts +18 -2
- package/dist/api/resources/windows/client/Client.js +85 -16
- package/dist/api/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +3 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +0 -1
- package/dist/api/types/PageQueryConfig.d.ts +7 -0
- package/dist/api/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +1 -1
- package/dist/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → types/SessionPageQueryHandlerRequestBody.d.ts} +6 -9
- package/dist/api/types/SummaryConfig.d.ts +2 -2
- package/dist/api/types/index.d.ts +3 -2
- package/dist/api/types/index.js +3 -2
- package/dist/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +2 -0
- package/dist/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.js +2 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/windows/client/requests/index.js +1 -3
- package/dist/serialization/types/PageQueryConfig.d.ts +12 -0
- package/dist/serialization/types/{PromptContentConfig.js → PageQueryConfig.js} +3 -4
- package/dist/serialization/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +2 -2
- package/dist/serialization/types/{PromptContentExperimentalConfig.js → PageQueryExperimentalConfig.js} +2 -2
- package/dist/serialization/types/SessionPageQueryHandlerRequestBody.d.ts +18 -0
- package/{serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → dist/serialization/types/SessionPageQueryHandlerRequestBody.js} +5 -3
- package/dist/serialization/types/SummaryConfig.d.ts +1 -2
- package/dist/serialization/types/SummaryConfig.js +1 -2
- package/dist/serialization/types/index.d.ts +3 -2
- package/dist/serialization/types/index.js +3 -2
- package/dist/wrapper/AirtopClient.d.ts +6 -5
- package/dist/wrapper/AirtopClient.js +11 -10
- package/dist/wrapper/AirtopSessions.d.ts +11 -11
- package/dist/wrapper/AirtopSessions.js +16 -17
- package/dist/wrapper/AirtopWindows.d.ts +62 -14
- package/dist/wrapper/AirtopWindows.js +73 -31
- package/package.json +1 -1
- package/reference.md +99 -3
- package/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +2 -0
- package/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.js +2 -0
- package/serialization/resources/windows/client/requests/index.d.ts +0 -1
- package/serialization/resources/windows/client/requests/index.js +1 -3
- package/serialization/types/PageQueryConfig.d.ts +12 -0
- package/serialization/types/{PromptContentConfig.js → PageQueryConfig.js} +3 -4
- package/serialization/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +2 -2
- package/serialization/types/{PromptContentExperimentalConfig.js → PageQueryExperimentalConfig.js} +2 -2
- package/serialization/types/SessionPageQueryHandlerRequestBody.d.ts +18 -0
- package/{dist/serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → serialization/types/SessionPageQueryHandlerRequestBody.js} +5 -3
- package/serialization/types/SummaryConfig.d.ts +1 -2
- package/serialization/types/SummaryConfig.js +1 -2
- package/serialization/types/index.d.ts +3 -2
- package/serialization/types/index.js +3 -2
- package/wrapper/AirtopClient.d.ts +6 -5
- package/wrapper/AirtopClient.js +11 -10
- package/wrapper/AirtopSessions.d.ts +11 -11
- package/wrapper/AirtopSessions.js +16 -17
- package/wrapper/AirtopWindows.d.ts +62 -14
- package/wrapper/AirtopWindows.js +73 -31
- package/api/types/PromptContentConfig.d.ts +0 -8
- package/dist/api/types/PromptContentConfig.d.ts +0 -8
- package/dist/serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts +0 -16
- package/dist/serialization/types/PromptContentConfig.d.ts +0 -13
- package/serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts +0 -16
- package/serialization/types/PromptContentConfig.d.ts +0 -13
- /package/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → types/PageQueryConfig.js} +0 -0
- /package/api/types/{PromptContentConfig.js → PageQueryExperimentalConfig.js} +0 -0
- /package/api/types/{PromptContentExperimentalConfig.js → SessionPageQueryHandlerRequestBody.js} +0 -0
- /package/dist/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → types/PageQueryConfig.js} +0 -0
- /package/dist/api/types/{PromptContentConfig.js → PageQueryExperimentalConfig.js} +0 -0
- /package/dist/api/types/{PromptContentExperimentalConfig.js → SessionPageQueryHandlerRequestBody.js} +0 -0
@@ -77,8 +77,8 @@ class Profiles {
|
|
77
77
|
Authorization: yield this._getAuthorizationHeader(),
|
78
78
|
"X-Fern-Language": "JavaScript",
|
79
79
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
80
|
-
"X-Fern-SDK-Version": "0.1.
|
81
|
-
"User-Agent": "@airtop/sdk/0.1.
|
80
|
+
"X-Fern-SDK-Version": "0.1.5",
|
81
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
82
82
|
"X-Fern-Runtime": core.RUNTIME.type,
|
83
83
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
84
84
|
},
|
@@ -148,8 +148,8 @@ class Profiles {
|
|
148
148
|
Authorization: yield this._getAuthorizationHeader(),
|
149
149
|
"X-Fern-Language": "JavaScript",
|
150
150
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
151
|
-
"X-Fern-SDK-Version": "0.1.
|
152
|
-
"User-Agent": "@airtop/sdk/0.1.
|
151
|
+
"X-Fern-SDK-Version": "0.1.5",
|
152
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
153
153
|
"X-Fern-Runtime": core.RUNTIME.type,
|
154
154
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
155
155
|
},
|
@@ -58,9 +58,9 @@ export declare class Sessions {
|
|
58
58
|
* @throws {@link Airtop.InternalServerError}
|
59
59
|
*
|
60
60
|
* @example
|
61
|
-
* await client.sessions.
|
61
|
+
* await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
|
62
62
|
*/
|
63
|
-
|
63
|
+
getInfo(id: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionResponse>;
|
64
64
|
/**
|
65
65
|
* Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
66
66
|
*
|
@@ -94,8 +94,8 @@ class Sessions {
|
|
94
94
|
Authorization: yield this._getAuthorizationHeader(),
|
95
95
|
"X-Fern-Language": "JavaScript",
|
96
96
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
97
|
-
"X-Fern-SDK-Version": "0.1.
|
98
|
-
"User-Agent": "@airtop/sdk/0.1.
|
97
|
+
"X-Fern-SDK-Version": "0.1.5",
|
98
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
99
99
|
"X-Fern-Runtime": core.RUNTIME.type,
|
100
100
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
101
101
|
},
|
@@ -180,8 +180,8 @@ class Sessions {
|
|
180
180
|
Authorization: yield this._getAuthorizationHeader(),
|
181
181
|
"X-Fern-Language": "JavaScript",
|
182
182
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
183
|
-
"X-Fern-SDK-Version": "0.1.
|
184
|
-
"User-Agent": "@airtop/sdk/0.1.
|
183
|
+
"X-Fern-SDK-Version": "0.1.5",
|
184
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
185
185
|
"X-Fern-Runtime": core.RUNTIME.type,
|
186
186
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
187
187
|
},
|
@@ -233,9 +233,9 @@ class Sessions {
|
|
233
233
|
* @throws {@link Airtop.InternalServerError}
|
234
234
|
*
|
235
235
|
* @example
|
236
|
-
* await client.sessions.
|
236
|
+
* await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
|
237
237
|
*/
|
238
|
-
|
238
|
+
getInfo(id, requestOptions) {
|
239
239
|
var _a, _b;
|
240
240
|
return __awaiter(this, void 0, void 0, function* () {
|
241
241
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
@@ -245,8 +245,8 @@ class Sessions {
|
|
245
245
|
Authorization: yield this._getAuthorizationHeader(),
|
246
246
|
"X-Fern-Language": "JavaScript",
|
247
247
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
248
|
-
"X-Fern-SDK-Version": "0.1.
|
249
|
-
"User-Agent": "@airtop/sdk/0.1.
|
248
|
+
"X-Fern-SDK-Version": "0.1.5",
|
249
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
250
250
|
"X-Fern-Runtime": core.RUNTIME.type,
|
251
251
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
252
252
|
},
|
@@ -332,8 +332,8 @@ class Sessions {
|
|
332
332
|
Authorization: yield this._getAuthorizationHeader(),
|
333
333
|
"X-Fern-Language": "JavaScript",
|
334
334
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
335
|
-
"X-Fern-SDK-Version": "0.1.
|
336
|
-
"User-Agent": "@airtop/sdk/0.1.
|
335
|
+
"X-Fern-SDK-Version": "0.1.5",
|
336
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
337
337
|
"X-Fern-Runtime": core.RUNTIME.type,
|
338
338
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
339
339
|
},
|
@@ -380,8 +380,8 @@ class Sessions {
|
|
380
380
|
Authorization: yield this._getAuthorizationHeader(),
|
381
381
|
"X-Fern-Language": "JavaScript",
|
382
382
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
383
|
-
"X-Fern-SDK-Version": "0.1.
|
384
|
-
"User-Agent": "@airtop/sdk/0.1.
|
383
|
+
"X-Fern-SDK-Version": "0.1.5",
|
384
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
385
385
|
"X-Fern-Runtime": core.RUNTIME.type,
|
386
386
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
387
387
|
},
|
@@ -67,7 +67,21 @@ export declare class Windows {
|
|
67
67
|
/**
|
68
68
|
* @param {string} sessionId - The session id for the window.
|
69
69
|
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
70
|
-
* @param {Airtop.
|
70
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
71
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
72
|
+
*
|
73
|
+
* @example
|
74
|
+
* await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
75
|
+
* prompt: "What is the main idea of this page?"
|
76
|
+
* })
|
77
|
+
*/
|
78
|
+
pageQuery(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
79
|
+
/**
|
80
|
+
* This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
81
|
+
*
|
82
|
+
* @param {string} sessionId - The session id for the window.
|
83
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
84
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
71
85
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
72
86
|
*
|
73
87
|
* @example
|
@@ -75,7 +89,7 @@ export declare class Windows {
|
|
75
89
|
* prompt: "What is the main idea of this page?"
|
76
90
|
* })
|
77
91
|
*/
|
78
|
-
promptContent(sessionId: string, windowId: string, request: Airtop.
|
92
|
+
promptContent(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
79
93
|
/**
|
80
94
|
* @param {string} sessionId - The session id for the window.
|
81
95
|
* @param {string} windowId - The Airtop window id of the browser window to scrape.
|
@@ -87,6 +101,8 @@ export declare class Windows {
|
|
87
101
|
*/
|
88
102
|
scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.ScrapeResponse>;
|
89
103
|
/**
|
104
|
+
* This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
105
|
+
*
|
90
106
|
* @param {string} sessionId - The session id for the window.
|
91
107
|
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
92
108
|
* @param {Airtop.SessionSummaryHandlerRequestBody} request
|
@@ -66,8 +66,8 @@ class Windows {
|
|
66
66
|
Authorization: yield this._getAuthorizationHeader(),
|
67
67
|
"X-Fern-Language": "JavaScript",
|
68
68
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
69
|
-
"X-Fern-SDK-Version": "0.1.
|
70
|
-
"User-Agent": "@airtop/sdk/0.1.
|
69
|
+
"X-Fern-SDK-Version": "0.1.5",
|
70
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
71
71
|
"X-Fern-Runtime": core.RUNTIME.type,
|
72
72
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
73
73
|
},
|
@@ -140,8 +140,8 @@ class Windows {
|
|
140
140
|
Authorization: yield this._getAuthorizationHeader(),
|
141
141
|
"X-Fern-Language": "JavaScript",
|
142
142
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
143
|
-
"X-Fern-SDK-Version": "0.1.
|
144
|
-
"User-Agent": "@airtop/sdk/0.1.
|
143
|
+
"X-Fern-SDK-Version": "0.1.5",
|
144
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
145
145
|
"X-Fern-Runtime": core.RUNTIME.type,
|
146
146
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
147
147
|
},
|
@@ -203,8 +203,8 @@ class Windows {
|
|
203
203
|
Authorization: yield this._getAuthorizationHeader(),
|
204
204
|
"X-Fern-Language": "JavaScript",
|
205
205
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
206
|
-
"X-Fern-SDK-Version": "0.1.
|
207
|
-
"User-Agent": "@airtop/sdk/0.1.
|
206
|
+
"X-Fern-SDK-Version": "0.1.5",
|
207
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
208
208
|
"X-Fern-Runtime": core.RUNTIME.type,
|
209
209
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
210
210
|
},
|
@@ -263,8 +263,8 @@ class Windows {
|
|
263
263
|
Authorization: yield this._getAuthorizationHeader(),
|
264
264
|
"X-Fern-Language": "JavaScript",
|
265
265
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
266
|
-
"X-Fern-SDK-Version": "0.1.
|
267
|
-
"User-Agent": "@airtop/sdk/0.1.
|
266
|
+
"X-Fern-SDK-Version": "0.1.5",
|
267
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
268
268
|
"X-Fern-Runtime": core.RUNTIME.type,
|
269
269
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
270
270
|
},
|
@@ -307,7 +307,74 @@ class Windows {
|
|
307
307
|
/**
|
308
308
|
* @param {string} sessionId - The session id for the window.
|
309
309
|
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
310
|
-
* @param {Airtop.
|
310
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
311
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
312
|
+
*
|
313
|
+
* @example
|
314
|
+
* await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
315
|
+
* prompt: "What is the main idea of this page?"
|
316
|
+
* })
|
317
|
+
*/
|
318
|
+
pageQuery(sessionId, windowId, request, requestOptions) {
|
319
|
+
var _a, _b;
|
320
|
+
return __awaiter(this, void 0, void 0, function* () {
|
321
|
+
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
322
|
+
url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `sessions/${encodeURIComponent(sessionId)}/windows/${encodeURIComponent(windowId)}/page-query`),
|
323
|
+
method: "POST",
|
324
|
+
headers: {
|
325
|
+
Authorization: yield this._getAuthorizationHeader(),
|
326
|
+
"X-Fern-Language": "JavaScript",
|
327
|
+
"X-Fern-SDK-Name": "@airtop/sdk",
|
328
|
+
"X-Fern-SDK-Version": "0.1.5",
|
329
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
330
|
+
"X-Fern-Runtime": core.RUNTIME.type,
|
331
|
+
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
332
|
+
},
|
333
|
+
contentType: "application/json",
|
334
|
+
requestType: "json",
|
335
|
+
body: serializers.SessionPageQueryHandlerRequestBody.jsonOrThrow(request, {
|
336
|
+
unrecognizedObjectKeys: "strip",
|
337
|
+
}),
|
338
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
339
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
340
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
341
|
+
});
|
342
|
+
if (_response.ok) {
|
343
|
+
return serializers.AiPromptResponse.parseOrThrow(_response.body, {
|
344
|
+
unrecognizedObjectKeys: "passthrough",
|
345
|
+
allowUnrecognizedUnionMembers: true,
|
346
|
+
allowUnrecognizedEnumValues: true,
|
347
|
+
skipValidation: true,
|
348
|
+
breadcrumbsPrefix: ["response"],
|
349
|
+
});
|
350
|
+
}
|
351
|
+
if (_response.error.reason === "status-code") {
|
352
|
+
throw new errors.AirtopError({
|
353
|
+
statusCode: _response.error.statusCode,
|
354
|
+
body: _response.error.body,
|
355
|
+
});
|
356
|
+
}
|
357
|
+
switch (_response.error.reason) {
|
358
|
+
case "non-json":
|
359
|
+
throw new errors.AirtopError({
|
360
|
+
statusCode: _response.error.statusCode,
|
361
|
+
body: _response.error.rawBody,
|
362
|
+
});
|
363
|
+
case "timeout":
|
364
|
+
throw new errors.AirtopTimeoutError();
|
365
|
+
case "unknown":
|
366
|
+
throw new errors.AirtopError({
|
367
|
+
message: _response.error.errorMessage,
|
368
|
+
});
|
369
|
+
}
|
370
|
+
});
|
371
|
+
}
|
372
|
+
/**
|
373
|
+
* This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
374
|
+
*
|
375
|
+
* @param {string} sessionId - The session id for the window.
|
376
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
377
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
311
378
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
312
379
|
*
|
313
380
|
* @example
|
@@ -325,14 +392,14 @@ class Windows {
|
|
325
392
|
Authorization: yield this._getAuthorizationHeader(),
|
326
393
|
"X-Fern-Language": "JavaScript",
|
327
394
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
328
|
-
"X-Fern-SDK-Version": "0.1.
|
329
|
-
"User-Agent": "@airtop/sdk/0.1.
|
395
|
+
"X-Fern-SDK-Version": "0.1.5",
|
396
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
330
397
|
"X-Fern-Runtime": core.RUNTIME.type,
|
331
398
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
332
399
|
},
|
333
400
|
contentType: "application/json",
|
334
401
|
requestType: "json",
|
335
|
-
body: serializers.
|
402
|
+
body: serializers.SessionPageQueryHandlerRequestBody.jsonOrThrow(request, {
|
336
403
|
unrecognizedObjectKeys: "strip",
|
337
404
|
}),
|
338
405
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
@@ -388,8 +455,8 @@ class Windows {
|
|
388
455
|
Authorization: yield this._getAuthorizationHeader(),
|
389
456
|
"X-Fern-Language": "JavaScript",
|
390
457
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
391
|
-
"X-Fern-SDK-Version": "0.1.
|
392
|
-
"User-Agent": "@airtop/sdk/0.1.
|
458
|
+
"X-Fern-SDK-Version": "0.1.5",
|
459
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
393
460
|
"X-Fern-Runtime": core.RUNTIME.type,
|
394
461
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
395
462
|
},
|
@@ -431,6 +498,8 @@ class Windows {
|
|
431
498
|
});
|
432
499
|
}
|
433
500
|
/**
|
501
|
+
* This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
502
|
+
*
|
434
503
|
* @param {string} sessionId - The session id for the window.
|
435
504
|
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
436
505
|
* @param {Airtop.SessionSummaryHandlerRequestBody} request
|
@@ -449,8 +518,8 @@ class Windows {
|
|
449
518
|
Authorization: yield this._getAuthorizationHeader(),
|
450
519
|
"X-Fern-Language": "JavaScript",
|
451
520
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
452
|
-
"X-Fern-SDK-Version": "0.1.
|
453
|
-
"User-Agent": "@airtop/sdk/0.1.
|
521
|
+
"X-Fern-SDK-Version": "0.1.5",
|
522
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
454
523
|
"X-Fern-Runtime": core.RUNTIME.type,
|
455
524
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
456
525
|
},
|
@@ -1,12 +1,15 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
+
import * as Airtop from "../../../../index";
|
4
5
|
/**
|
5
6
|
* @example
|
6
7
|
* {}
|
7
8
|
*/
|
8
9
|
export interface SessionSummaryHandlerRequestBody {
|
9
10
|
clientRequestId?: string;
|
11
|
+
/** Request configuration */
|
12
|
+
configuration?: Airtop.SummaryConfig;
|
10
13
|
/** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
|
11
14
|
costThresholdCredits?: number;
|
12
15
|
/** An optional prompt providing the Airtop AI model with additional direction or constraints about the summary (such as desired length). */
|
@@ -1,6 +1,5 @@
|
|
1
1
|
export { type CreateWindowInputV1Body } from "./CreateWindowInputV1Body";
|
2
2
|
export { type GetWindowInfoRequest } from "./GetWindowInfoRequest";
|
3
3
|
export { type WindowLoadUrlV1Body } from "./WindowLoadUrlV1Body";
|
4
|
-
export { type SessionContentPromptHandlerRequestBody } from "./SessionContentPromptHandlerRequestBody";
|
5
4
|
export { type ScrapeContentRequest } from "./ScrapeContentRequest";
|
6
5
|
export { type SessionSummaryHandlerRequestBody } from "./SessionSummaryHandlerRequestBody";
|
@@ -1,7 +1,7 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
-
export interface
|
4
|
+
export interface PageQueryExperimentalConfig {
|
5
5
|
/** If set to 'enabled', Airtop AI will also analyze the web page visually when fulfilling the request. Note that this can add to both the execution time and cost of the operation. If the page is too large, the context window can be exceeded and the request will fail. If set to 'auto' or 'disabled', no visual analysis will be conducted. If 'followPaginationLinks' is set to true, visual analysis will be conducted unless 'includeVisualAnalysis' is explicitly set to 'disabled'. */
|
6
6
|
includeVisualAnalysis?: string;
|
7
7
|
}
|
@@ -1,22 +1,19 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
-
|
5
|
-
|
6
|
-
* {
|
7
|
-
* prompt: "What is the main idea of this page?"
|
8
|
-
* }
|
9
|
-
*/
|
10
|
-
export interface SessionContentPromptHandlerRequestBody {
|
4
|
+
import * as Airtop from "../index";
|
5
|
+
export interface SessionPageQueryHandlerRequestBody {
|
11
6
|
clientRequestId?: string;
|
12
|
-
/**
|
7
|
+
/** Request configuration */
|
8
|
+
configuration?: Airtop.PageQueryConfig;
|
9
|
+
/** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is _not_ a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
|
13
10
|
costThresholdCredits?: number;
|
14
11
|
/** Make a best effort attempt to load more content items than are originally displayed on the page, e.g. by following pagination links, clicking controls to load more content, utilizing infinite scrolling, etc. This can be quite a bit more costly, but may be necessary for sites that require additional interaction to show the needed results. You can provide constraints in your prompt (e.g. on the total number of pages or results to consider). */
|
15
12
|
followPaginationLinks?: boolean;
|
16
13
|
/** The prompt to submit about the content in the browser window. */
|
17
14
|
prompt: string;
|
18
15
|
/**
|
19
|
-
* A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is
|
16
|
+
* A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is _not_ a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
|
20
17
|
*
|
21
18
|
* This setting does not extend the maximum session duration provided at the time of session creation.
|
22
19
|
*/
|
@@ -1,7 +1,7 @@
|
|
1
1
|
/**
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
3
3
|
*/
|
4
|
-
import * as Airtop from "../index";
|
5
4
|
export interface SummaryConfig {
|
6
|
-
|
5
|
+
/** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
|
6
|
+
outputSchema?: string;
|
7
7
|
}
|
package/api/types/index.d.ts
CHANGED
@@ -16,10 +16,10 @@ export * from "./ExternalSessionAiResponseMetadataUsage";
|
|
16
16
|
export * from "./ExternalSessionConfig";
|
17
17
|
export * from "./ExternalSessionWithConnectionInfo";
|
18
18
|
export * from "./Issue";
|
19
|
+
export * from "./PageQueryConfig";
|
20
|
+
export * from "./PageQueryExperimentalConfig";
|
19
21
|
export * from "./Pagination";
|
20
22
|
export * from "./ProfilesResponse";
|
21
|
-
export * from "./PromptContentConfig";
|
22
|
-
export * from "./PromptContentExperimentalConfig";
|
23
23
|
export * from "./ScrapeResponse";
|
24
24
|
export * from "./ScrapeResponseContent";
|
25
25
|
export * from "./ScrapeResponseEnvelope";
|
@@ -29,6 +29,7 @@ export * from "./CustomProxy";
|
|
29
29
|
export * from "./SessionConfigV1ProxyItem";
|
30
30
|
export * from "./SessionConfigV1Proxy";
|
31
31
|
export * from "./SessionConfigV1";
|
32
|
+
export * from "./SessionPageQueryHandlerRequestBody";
|
32
33
|
export * from "./SessionResponse";
|
33
34
|
export * from "./SessionsResponse";
|
34
35
|
export * from "./SessionsWithPagination";
|
package/api/types/index.js
CHANGED
@@ -32,10 +32,10 @@ __exportStar(require("./ExternalSessionAiResponseMetadataUsage"), exports);
|
|
32
32
|
__exportStar(require("./ExternalSessionConfig"), exports);
|
33
33
|
__exportStar(require("./ExternalSessionWithConnectionInfo"), exports);
|
34
34
|
__exportStar(require("./Issue"), exports);
|
35
|
+
__exportStar(require("./PageQueryConfig"), exports);
|
36
|
+
__exportStar(require("./PageQueryExperimentalConfig"), exports);
|
35
37
|
__exportStar(require("./Pagination"), exports);
|
36
38
|
__exportStar(require("./ProfilesResponse"), exports);
|
37
|
-
__exportStar(require("./PromptContentConfig"), exports);
|
38
|
-
__exportStar(require("./PromptContentExperimentalConfig"), exports);
|
39
39
|
__exportStar(require("./ScrapeResponse"), exports);
|
40
40
|
__exportStar(require("./ScrapeResponseContent"), exports);
|
41
41
|
__exportStar(require("./ScrapeResponseEnvelope"), exports);
|
@@ -45,6 +45,7 @@ __exportStar(require("./CustomProxy"), exports);
|
|
45
45
|
__exportStar(require("./SessionConfigV1ProxyItem"), exports);
|
46
46
|
__exportStar(require("./SessionConfigV1Proxy"), exports);
|
47
47
|
__exportStar(require("./SessionConfigV1"), exports);
|
48
|
+
__exportStar(require("./SessionPageQueryHandlerRequestBody"), exports);
|
48
49
|
__exportStar(require("./SessionResponse"), exports);
|
49
50
|
__exportStar(require("./SessionsResponse"), exports);
|
50
51
|
__exportStar(require("./SessionsWithPagination"), exports);
|
@@ -77,8 +77,8 @@ class Profiles {
|
|
77
77
|
Authorization: yield this._getAuthorizationHeader(),
|
78
78
|
"X-Fern-Language": "JavaScript",
|
79
79
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
80
|
-
"X-Fern-SDK-Version": "0.1.
|
81
|
-
"User-Agent": "@airtop/sdk/0.1.
|
80
|
+
"X-Fern-SDK-Version": "0.1.5",
|
81
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
82
82
|
"X-Fern-Runtime": core.RUNTIME.type,
|
83
83
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
84
84
|
},
|
@@ -148,8 +148,8 @@ class Profiles {
|
|
148
148
|
Authorization: yield this._getAuthorizationHeader(),
|
149
149
|
"X-Fern-Language": "JavaScript",
|
150
150
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
151
|
-
"X-Fern-SDK-Version": "0.1.
|
152
|
-
"User-Agent": "@airtop/sdk/0.1.
|
151
|
+
"X-Fern-SDK-Version": "0.1.5",
|
152
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
153
153
|
"X-Fern-Runtime": core.RUNTIME.type,
|
154
154
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
155
155
|
},
|
@@ -58,9 +58,9 @@ export declare class Sessions {
|
|
58
58
|
* @throws {@link Airtop.InternalServerError}
|
59
59
|
*
|
60
60
|
* @example
|
61
|
-
* await client.sessions.
|
61
|
+
* await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
|
62
62
|
*/
|
63
|
-
|
63
|
+
getInfo(id: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionResponse>;
|
64
64
|
/**
|
65
65
|
* Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
66
66
|
*
|
@@ -94,8 +94,8 @@ class Sessions {
|
|
94
94
|
Authorization: yield this._getAuthorizationHeader(),
|
95
95
|
"X-Fern-Language": "JavaScript",
|
96
96
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
97
|
-
"X-Fern-SDK-Version": "0.1.
|
98
|
-
"User-Agent": "@airtop/sdk/0.1.
|
97
|
+
"X-Fern-SDK-Version": "0.1.5",
|
98
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
99
99
|
"X-Fern-Runtime": core.RUNTIME.type,
|
100
100
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
101
101
|
},
|
@@ -180,8 +180,8 @@ class Sessions {
|
|
180
180
|
Authorization: yield this._getAuthorizationHeader(),
|
181
181
|
"X-Fern-Language": "JavaScript",
|
182
182
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
183
|
-
"X-Fern-SDK-Version": "0.1.
|
184
|
-
"User-Agent": "@airtop/sdk/0.1.
|
183
|
+
"X-Fern-SDK-Version": "0.1.5",
|
184
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
185
185
|
"X-Fern-Runtime": core.RUNTIME.type,
|
186
186
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
187
187
|
},
|
@@ -233,9 +233,9 @@ class Sessions {
|
|
233
233
|
* @throws {@link Airtop.InternalServerError}
|
234
234
|
*
|
235
235
|
* @example
|
236
|
-
* await client.sessions.
|
236
|
+
* await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
|
237
237
|
*/
|
238
|
-
|
238
|
+
getInfo(id, requestOptions) {
|
239
239
|
var _a, _b;
|
240
240
|
return __awaiter(this, void 0, void 0, function* () {
|
241
241
|
const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
|
@@ -245,8 +245,8 @@ class Sessions {
|
|
245
245
|
Authorization: yield this._getAuthorizationHeader(),
|
246
246
|
"X-Fern-Language": "JavaScript",
|
247
247
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
248
|
-
"X-Fern-SDK-Version": "0.1.
|
249
|
-
"User-Agent": "@airtop/sdk/0.1.
|
248
|
+
"X-Fern-SDK-Version": "0.1.5",
|
249
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
250
250
|
"X-Fern-Runtime": core.RUNTIME.type,
|
251
251
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
252
252
|
},
|
@@ -332,8 +332,8 @@ class Sessions {
|
|
332
332
|
Authorization: yield this._getAuthorizationHeader(),
|
333
333
|
"X-Fern-Language": "JavaScript",
|
334
334
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
335
|
-
"X-Fern-SDK-Version": "0.1.
|
336
|
-
"User-Agent": "@airtop/sdk/0.1.
|
335
|
+
"X-Fern-SDK-Version": "0.1.5",
|
336
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
337
337
|
"X-Fern-Runtime": core.RUNTIME.type,
|
338
338
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
339
339
|
},
|
@@ -380,8 +380,8 @@ class Sessions {
|
|
380
380
|
Authorization: yield this._getAuthorizationHeader(),
|
381
381
|
"X-Fern-Language": "JavaScript",
|
382
382
|
"X-Fern-SDK-Name": "@airtop/sdk",
|
383
|
-
"X-Fern-SDK-Version": "0.1.
|
384
|
-
"User-Agent": "@airtop/sdk/0.1.
|
383
|
+
"X-Fern-SDK-Version": "0.1.5",
|
384
|
+
"User-Agent": "@airtop/sdk/0.1.5",
|
385
385
|
"X-Fern-Runtime": core.RUNTIME.type,
|
386
386
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
387
387
|
},
|
@@ -67,7 +67,21 @@ export declare class Windows {
|
|
67
67
|
/**
|
68
68
|
* @param {string} sessionId - The session id for the window.
|
69
69
|
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
70
|
-
* @param {Airtop.
|
70
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
71
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
72
|
+
*
|
73
|
+
* @example
|
74
|
+
* await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
75
|
+
* prompt: "What is the main idea of this page?"
|
76
|
+
* })
|
77
|
+
*/
|
78
|
+
pageQuery(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
79
|
+
/**
|
80
|
+
* This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
81
|
+
*
|
82
|
+
* @param {string} sessionId - The session id for the window.
|
83
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
84
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
71
85
|
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
72
86
|
*
|
73
87
|
* @example
|
@@ -75,7 +89,7 @@ export declare class Windows {
|
|
75
89
|
* prompt: "What is the main idea of this page?"
|
76
90
|
* })
|
77
91
|
*/
|
78
|
-
promptContent(sessionId: string, windowId: string, request: Airtop.
|
92
|
+
promptContent(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
79
93
|
/**
|
80
94
|
* @param {string} sessionId - The session id for the window.
|
81
95
|
* @param {string} windowId - The Airtop window id of the browser window to scrape.
|
@@ -87,6 +101,8 @@ export declare class Windows {
|
|
87
101
|
*/
|
88
102
|
scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.ScrapeResponse>;
|
89
103
|
/**
|
104
|
+
* This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
105
|
+
*
|
90
106
|
* @param {string} sessionId - The session id for the window.
|
91
107
|
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
92
108
|
* @param {Airtop.SessionSummaryHandlerRequestBody} request
|