@telemai/sdk 0.3.0 → 0.3.2

package/README.md

@@ -204,7 +204,7 @@ A monitor runs a query on a schedule. Poll it to get the results that are new si
 your last poll. `poll` returns a `SearchResponse`:
 
 ```ts
-const monitor = await telem.monitors.create("Nvidia files a new 8-K with the SEC", { frequency: "1h" })
+const monitor = await telem.monitors.create("Nvidia files a new 8-K with the SEC", { frequency: "1h", ttl: "7d" })
 const response = await telem.monitors.poll(monitor.id)
 await telem.monitors.update(monitor.id, { status: "paused" })
 await telem.monitors.delete(monitor.id)

package/dist/index.cjs

@@ -60,7 +60,7 @@ var TimeoutError = class extends TelemError {
 };
 
 // src/version.ts
-var VERSION = "0.3.0";
+var VERSION = "0.3.2";
 
 // src/config.ts
 var DEFAULT_BASE_URL = "https://router.telem.ai";
@@ -588,6 +588,7 @@ function searchBlock(defaults, options) {
   if (topic !== void 0) block.topic = topic;
   if (options.publishedAfter !== void 0) block.published_after = isoDate(options.publishedAfter);
   if (options.publishedBefore !== void 0) block.published_before = isoDate(options.publishedBefore);
+  if (options.includeDomains !== void 0) block.include_domains = options.includeDomains;
   return block;
 }
 function isoDate(value) {
@@ -707,6 +708,7 @@ function monitorFrom(body) {
     sessionId: String(data.session_id ?? ""),
     createdAt: data.created_at ?? "",
     lastPolledAt: data.last_polled_at ?? null,
+    expiresAt: data.expires_at ?? null,
     webhookUrl: data.webhook_url ?? null,
     webhookSecret: data.webhook_secret ?? null,
     raw: data
@@ -719,10 +721,17 @@ function createMonitors(config) {
   };
   return {
     /** Create a monitor. Telem runs `query` on the schedule. */
-    async create(query, options) {
-      const body = { query, options: { frequency: options.frequency } };
+    async create(query, options = {}) {
+      const monitorOptions = {};
+      if (options.frequency !== void 0) monitorOptions.frequency = options.frequency;
+      if (options.includeDomains !== void 0) {
+        monitorOptions.include_domains = options.includeDomains;
+      }
+      if (options.search !== void 0) monitorOptions.search = searchBlock({}, options.search);
+      const body = { query, options: monitorOptions };
       if (options.metadata !== void 0) body.metadata = options.metadata;
       if (options.webhookUrl !== void 0) body.webhook_url = options.webhookUrl;
+      if (options.ttl !== void 0) body.ttl = options.ttl;
       const data = await request(config, "POST", "/v1/monitors", body, options.signal, "rate_limit");
       return monitorFrom(data);
     },
@@ -745,7 +754,7 @@ function createMonitors(config) {
       const route = path(monitorId);
       return monitorFrom(await request(config, "PATCH", route, body, options.signal));
     },
-    /** Get the results that are new since the last poll, one entry per provider. */
+    /** Get the results that are new since the last poll. */
     async poll(monitorId, options = {}) {
       const body = {};
       if (options.session !== void 0) body.session_id = options.session;

package/dist/index.d.cts

@@ -72,6 +72,9 @@ type SearchOptions = {
      *  includes that whole day. A `Date` is an exact instant; pass a "YYYY-MM-DD"
      *  string to include the whole day. */
     publishedBefore?: string | Date;
+    /** Only results from these domains: at most 20 hostnames such as `"linkedin.com"`.
+     *  A subdomain such as `"uk.linkedin.com"` matches its domain. Per-call only. */
+    includeDomains?: string[];
     /** Opt this request into the server's rerank stage. It is the only path where
      *  `context`, the reasoning on the last assistant entry of the lineage history
      *  (that entry only), and `goal` change result ORDER (in that precedence) —
@@ -222,14 +225,24 @@ type SessionsResource = {
     list(): Promise<SessionSummary[]>;
     results(sessionId: string): Promise<SessionResults>;
 };
+/** The search options a monitor can run on its schedule (`MonitorCreateOptions.search`). */
+type MonitorSearchOptions = Pick<SearchOptions, "tier" | "numResults">;
 /** Options for `monitors.create`. */
 type MonitorCreateOptions = {
-    /** `"1h"`, `"6h"`, `"1d"` or `"7d"`. */
-    frequency: string;
+    /** `"1h"`, `"6h"`, `"12h"`, `"1d"` or `"7d"`. If you leave it out, the monitor runs once a day. */
+    frequency?: string;
+    /** Also run a web search for the query on the schedule, with these options. `{}`
+     *  uses the defaults. Client search defaults do not apply. */
+    search?: MonitorSearchOptions;
+    /** Only results from these sites and their subdomains, such as `["sec.gov"]`,
+     *  from every source of the monitor. */
+    includeDomains?: string[];
     /** Request metadata (query lineage keys), sent as given. */
     metadata?: Json;
     /** An `https` URL that receives the new results. */
     webhookUrl?: string;
+    /** Delete the monitor after this long, such as `"12h"` or `"7d"` (at most `"30d"`). Without it, the monitor never expires. */
+    ttl?: string;
     signal?: AbortSignal;
 };
 /** Options for `monitors.update`. Send at least one field. */
@@ -259,6 +272,8 @@ type Monitor = {
     sessionId: string;
     createdAt: string;
     lastPolledAt: string | null;
+    /** When Telem deletes the monitor; `null`: never. */
+    expiresAt: string | null;
     webhookUrl: string | null;
     /** Signs the webhook deliveries. Only in the response that set `webhookUrl`. */
     webhookSecret: string | null;
@@ -266,7 +281,7 @@ type Monitor = {
 };
 /** The `telem.monitors` namespace. */
 type MonitorsResource = {
-    create(query: string, options: MonitorCreateOptions): Promise<Monitor>;
+    create(query: string, options?: MonitorCreateOptions): Promise<Monitor>;
     list(options?: {
         limit?: number;
         signal?: AbortSignal;

package/dist/index.d.ts

@@ -72,6 +72,9 @@ type SearchOptions = {
      *  includes that whole day. A `Date` is an exact instant; pass a "YYYY-MM-DD"
      *  string to include the whole day. */
     publishedBefore?: string | Date;
+    /** Only results from these domains: at most 20 hostnames such as `"linkedin.com"`.
+     *  A subdomain such as `"uk.linkedin.com"` matches its domain. Per-call only. */
+    includeDomains?: string[];
     /** Opt this request into the server's rerank stage. It is the only path where
      *  `context`, the reasoning on the last assistant entry of the lineage history
      *  (that entry only), and `goal` change result ORDER (in that precedence) —
@@ -222,14 +225,24 @@ type SessionsResource = {
     list(): Promise<SessionSummary[]>;
     results(sessionId: string): Promise<SessionResults>;
 };
+/** The search options a monitor can run on its schedule (`MonitorCreateOptions.search`). */
+type MonitorSearchOptions = Pick<SearchOptions, "tier" | "numResults">;
 /** Options for `monitors.create`. */
 type MonitorCreateOptions = {
-    /** `"1h"`, `"6h"`, `"1d"` or `"7d"`. */
-    frequency: string;
+    /** `"1h"`, `"6h"`, `"12h"`, `"1d"` or `"7d"`. If you leave it out, the monitor runs once a day. */
+    frequency?: string;
+    /** Also run a web search for the query on the schedule, with these options. `{}`
+     *  uses the defaults. Client search defaults do not apply. */
+    search?: MonitorSearchOptions;
+    /** Only results from these sites and their subdomains, such as `["sec.gov"]`,
+     *  from every source of the monitor. */
+    includeDomains?: string[];
     /** Request metadata (query lineage keys), sent as given. */
     metadata?: Json;
     /** An `https` URL that receives the new results. */
     webhookUrl?: string;
+    /** Delete the monitor after this long, such as `"12h"` or `"7d"` (at most `"30d"`). Without it, the monitor never expires. */
+    ttl?: string;
     signal?: AbortSignal;
 };
 /** Options for `monitors.update`. Send at least one field. */
@@ -259,6 +272,8 @@ type Monitor = {
     sessionId: string;
     createdAt: string;
     lastPolledAt: string | null;
+    /** When Telem deletes the monitor; `null`: never. */
+    expiresAt: string | null;
     webhookUrl: string | null;
     /** Signs the webhook deliveries. Only in the response that set `webhookUrl`. */
     webhookSecret: string | null;
@@ -266,7 +281,7 @@ type Monitor = {
 };
 /** The `telem.monitors` namespace. */
 type MonitorsResource = {
-    create(query: string, options: MonitorCreateOptions): Promise<Monitor>;
+    create(query: string, options?: MonitorCreateOptions): Promise<Monitor>;
     list(options?: {
         limit?: number;
         signal?: AbortSignal;

package/dist/index.js

@@ -22,7 +22,7 @@ import {
 } from "./chunk-DKTEG7EY.js";
 
 // src/version.ts
-var VERSION = "0.3.0";
+var VERSION = "0.3.2";
 
 // src/config.ts
 var DEFAULT_BASE_URL = "https://router.telem.ai";
@@ -221,6 +221,7 @@ function searchBlock(defaults, options) {
   if (topic !== void 0) block.topic = topic;
   if (options.publishedAfter !== void 0) block.published_after = isoDate(options.publishedAfter);
   if (options.publishedBefore !== void 0) block.published_before = isoDate(options.publishedBefore);
+  if (options.includeDomains !== void 0) block.include_domains = options.includeDomains;
   return block;
 }
 function isoDate(value) {
@@ -340,6 +341,7 @@ function monitorFrom(body) {
     sessionId: String(data.session_id ?? ""),
     createdAt: data.created_at ?? "",
     lastPolledAt: data.last_polled_at ?? null,
+    expiresAt: data.expires_at ?? null,
     webhookUrl: data.webhook_url ?? null,
     webhookSecret: data.webhook_secret ?? null,
     raw: data
@@ -352,10 +354,17 @@ function createMonitors(config) {
   };
   return {
     /** Create a monitor. Telem runs `query` on the schedule. */
-    async create(query, options) {
-      const body = { query, options: { frequency: options.frequency } };
+    async create(query, options = {}) {
+      const monitorOptions = {};
+      if (options.frequency !== void 0) monitorOptions.frequency = options.frequency;
+      if (options.includeDomains !== void 0) {
+        monitorOptions.include_domains = options.includeDomains;
+      }
+      if (options.search !== void 0) monitorOptions.search = searchBlock({}, options.search);
+      const body = { query, options: monitorOptions };
       if (options.metadata !== void 0) body.metadata = options.metadata;
       if (options.webhookUrl !== void 0) body.webhook_url = options.webhookUrl;
+      if (options.ttl !== void 0) body.ttl = options.ttl;
       const data = await request(config, "POST", "/v1/monitors", body, options.signal, "rate_limit");
       return monitorFrom(data);
     },
@@ -378,7 +387,7 @@ function createMonitors(config) {
       const route = path(monitorId);
       return monitorFrom(await request(config, "PATCH", route, body, options.signal));
     },
-    /** Get the results that are new since the last poll, one entry per provider. */
+    /** Get the results that are new since the last poll. */
     async poll(monitorId, options = {}) {
       const body = {};
       if (options.session !== void 0) body.session_id = options.session;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telemai/sdk",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Telem web search and fetch for JavaScript and TypeScript.",
   "type": "module",
   "license": "Apache-2.0",