@nimble-way/nimble-js 0.12.0 → 0.14.0

package/src/resources/agent.ts

@@ -8,6 +8,11 @@ import { path } from '../internal/utils/path';
 export class Agent extends APIResource {
   /**
    * List Agent Templates
+   *
+   * @example
+   * ```ts
+   * const agents = await client.agent.list();
+   * ```
    */
   list(
     query: AgentListParams | null | undefined = {},
@@ -18,6 +23,14 @@ export class Agent extends APIResource {
 
   /**
    * Create Agent Generation
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.generate({
+   *   prompt: 'prompt',
+   *   url: 'url',
+   * });
+   * ```
    */
   generate(body: AgentGenerateParams, options?: RequestOptions): APIPromise<AgentGenerateResponse> {
     return this._client.post('/v1/agents/generations', { body, ...options });
@@ -25,6 +38,11 @@ export class Agent extends APIResource {
 
   /**
    * Get Agent Template
+   *
+   * @example
+   * ```ts
+   * const agent = await client.agent.get('template_name');
+   * ```
    */
   get(templateName: string, options?: RequestOptions): APIPromise<AgentGetResponse> {
     return this._client.get(path`/v1/agents/${templateName}`, options);
@@ -32,6 +50,13 @@ export class Agent extends APIResource {
 
   /**
    * Get Agent Generation
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.getGeneration(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   getGeneration(generationID: string, options?: RequestOptions): APIPromise<AgentGetGenerationResponse> {
     return this._client.get(path`/v1/agents/generations/${generationID}`, options);
@@ -39,6 +64,8 @@ export class Agent extends APIResource {
 
   /**
    * Publish Agent Version
+   *
+   * @deprecated
    */
   publish(
     agentName: string,
@@ -50,6 +77,14 @@ export class Agent extends APIResource {
 
   /**
    * Execute WSA Realtime Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.run({
+   *   agent: 'agent',
+   *   params: { foo: 'bar' },
+   * });
+   * ```
    */
   run(body: AgentRunParams, options?: RequestOptions): APIPromise<AgentRunResponse> {
     return this._client.post('/v1/agents/run', { body, ...options });
@@ -57,6 +92,14 @@ export class Agent extends APIResource {
 
   /**
    * Execute WSA Async Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.runAsync({
+   *   agent: 'agent',
+   *   params: { foo: 'bar' },
+   * });
+   * ```
    */
   runAsync(body: AgentRunAsyncParams, options?: RequestOptions): APIPromise<AgentRunAsyncResponse> {
     return this._client.post('/v1/agents/async', { body, ...options });
@@ -64,6 +107,14 @@ export class Agent extends APIResource {
 
   /**
    * Execute WSA Batch Endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.runBatch({
+   *   inputs: [{}],
+   *   shared_inputs: { agent: 'agent' },
+   * });
+   * ```
    */
   runBatch(body: AgentRunBatchParams, options?: RequestOptions): APIPromise<AgentRunBatchResponse> {
     return this._client.post('/v1/agents/batch', { body, ...options });
@@ -105,7 +156,7 @@ export interface AgentGenerateResponse {
 
   error?: string | null;
 
-  generated_version?: unknown | null;
+  generated_version?: AgentGenerateResponse.GeneratedVersion | null;
 
   generated_version_id?: string | null;
 
@@ -116,6 +167,46 @@ export interface AgentGenerateResponse {
   summary?: string | null;
 }
 
+export namespace AgentGenerateResponse {
+  export interface GeneratedVersion {
+    id: string;
+
+    agent_name: string;
+
+    created_at: string;
+
+    input_schema: unknown;
+
+    metadata: GeneratedVersion.Metadata;
+
+    output_schema: unknown;
+
+    steps: Array<unknown>;
+
+    version_number: number;
+
+    output_sample_data?: unknown;
+  }
+
+  export namespace GeneratedVersion {
+    export interface Metadata {
+      data_source?: string | null;
+
+      description?: string | null;
+
+      display_name?: string | null;
+
+      domain?: string | null;
+
+      entity_type?: string | null;
+
+      tags?: Array<string>;
+
+      vertical?: string | null;
+    }
+  }
+}
+
 export interface AgentGetResponse {
   display_name: string;
 
@@ -148,14 +239,16 @@ export namespace AgentGetResponse {
   }
 
   export interface InputProperty {
-    default?: string | null;
+    default?: string | boolean | number | null;
 
     description?: string | null;
 
-    examples?: Array<string> | null;
+    examples?: Array<unknown> | null;
 
     is_localization_param?: boolean;
 
+    is_pagination_param?: boolean;
+
     name?: string;
 
     required?: boolean;
@@ -179,7 +272,7 @@ export interface AgentGetGenerationResponse {
 
   error?: string | null;
 
-  generated_version?: unknown | null;
+  generated_version?: AgentGetGenerationResponse.GeneratedVersion | null;
 
   generated_version_id?: string | null;
 
@@ -190,6 +283,46 @@ export interface AgentGetGenerationResponse {
   summary?: string | null;
 }
 
+export namespace AgentGetGenerationResponse {
+  export interface GeneratedVersion {
+    id: string;
+
+    agent_name: string;
+
+    created_at: string;
+
+    input_schema: unknown;
+
+    metadata: GeneratedVersion.Metadata;
+
+    output_schema: unknown;
+
+    steps: Array<unknown>;
+
+    version_number: number;
+
+    output_sample_data?: unknown;
+  }
+
+  export namespace GeneratedVersion {
+    export interface Metadata {
+      data_source?: string | null;
+
+      description?: string | null;
+
+      display_name?: string | null;
+
+      domain?: string | null;
+
+      entity_type?: string | null;
+
+      tags?: Array<string>;
+
+      vertical?: string | null;
+    }
+  }
+}
+
 export interface AgentPublishResponse {
   agent_name: string;
 
@@ -267,6 +400,11 @@ export namespace AgentRunResponse {
      */
     html?: string;
 
+    /**
+     * List of all unique URLs found on the page.
+     */
+    links?: Array<string>;
+
     /**
      * The Markdown version of the HTML content.
      */
@@ -689,19 +827,29 @@ export type AgentGenerateParams =
 
 export declare namespace AgentGenerateParams {
   export interface CreateAgentGenerationRequest {
-    agent_name: string;
-
     prompt: string;
 
     url: string;
 
+    agent_name?: string | null;
+
     input_schema?: unknown;
 
-    metadata?: unknown | null;
+    metadata?: CreateAgentGenerationRequest.Metadata | null;
 
     output_schema?: unknown;
   }
 
+  export namespace CreateAgentGenerationRequest {
+    export interface Metadata {
+      description?: string | null;
+
+      display_name?: string | null;
+
+      tags?: Array<string>;
+    }
+  }
+
   export interface CreateAgentRefinementRequest {
     from_agent: string;
 
@@ -721,7 +869,7 @@ export interface AgentRunParams {
   /**
    * Response formats to include. All disabled by default.
    */
-  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
   localization?: boolean;
 }
@@ -739,7 +887,7 @@ export interface AgentRunAsyncParams {
   /**
    * Response formats to include. All disabled by default.
    */
-  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
   localization?: boolean;
 
@@ -775,7 +923,7 @@ export namespace AgentRunBatchParams {
     /**
      * Response formats to include. All disabled by default.
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     localization?: boolean;
 
@@ -788,7 +936,7 @@ export namespace AgentRunBatchParams {
     /**
      * Response formats to include. All disabled by default.
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     localization?: boolean;
 

package/src/resources/crawl.ts

@@ -9,6 +9,11 @@ import { path } from '../internal/utils/path';
 export class Crawl extends APIResource {
   /**
    * Crawl by Filter
+   *
+   * @example
+   * ```ts
+   * const crawls = await client.crawl.list();
+   * ```
    */
   list(
     query: CrawlListParams | null | undefined = {},
@@ -19,6 +24,11 @@ export class Crawl extends APIResource {
 
   /**
    * Create crawl task
+   *
+   * @example
+   * ```ts
+   * const response = await client.crawl.run({ url: 'url' });
+   * ```
    */
   run(body: CrawlRunParams, options?: RequestOptions): APIPromise<CrawlRunResponse> {
     return this._client.post('/v1/crawl', { body, ...options });
@@ -26,6 +36,13 @@ export class Crawl extends APIResource {
 
   /**
    * Get crawl data
+   *
+   * @example
+   * ```ts
+   * const response = await client.crawl.status(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
    */
   status(id: string, options?: RequestOptions): APIPromise<CrawlStatusResponse> {
     return this._client.get(path`/v1/crawl/${id}`, options);
@@ -33,6 +50,13 @@ export class Crawl extends APIResource {
 
   /**
    * Cancel Crawl
+   *
+   * @example
+   * ```ts
+   * const response = await client.crawl.terminate(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   * );
+   * ```
    */
   terminate(id: string, options?: RequestOptions): APIPromise<CrawlTerminateResponse> {
     return this._client.delete(path`/v1/crawl/${id}`, options);
@@ -708,7 +732,7 @@ export namespace CrawlRunParams {
     /**
      * Browser driver to use
      */
-    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
 
     /**
      * Expected HTTP status codes for successful requests
@@ -718,7 +742,7 @@ export namespace CrawlRunParams {
     /**
      * List of acceptable response formats in order of preference
      */
-    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers' | 'links'>;
 
     /**
      * Custom HTTP headers to include in the request
@@ -1273,6 +1297,13 @@ export namespace CrawlRunParams {
       | 'zu-ZA'
       | 'auto';
 
+    /**
+     * Selects which markdown conversion strategy to use. "full_page" converts the
+     * entire HTML page. "main_content" uses Mozilla Readability to extract the main
+     * article content before converting.
+     */
+    markdown_backend?: 'full_page' | 'main_content';
+
     /**
      * HTTP method for the request
      */

package/src/resources/domain-knowledge.ts

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class DomainKnowledge extends APIResource {
+  /**
+   * Resolves the suggested driver for a given URL or agent name. Exactly one of
+   * `url` or `agent` must be provided.
+   */
+  getDriver(
+    query: DomainKnowledgeGetDriverParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DomainKnowledgeGetDriverResponse> {
+    return this._client.get('/v1/domain-knowledge/driver', { query, ...options });
+  }
+}
+
+export interface DomainKnowledgeGetDriverResponse {
+  /**
+   * List of detected antibots for the domain
+   */
+  antibots: Array<string>;
+
+  /**
+   * Description of the driver
+   */
+  description: string;
+
+  /**
+   * Resolved driver name
+   */
+  driver: string;
+
+  /**
+   * The input agent name (present when agent query param was used)
+   */
+  agent?: string;
+
+  /**
+   * Whether the page needs to be rendered to be properly resolved.
+   */
+  need_to_render?: boolean;
+
+  /**
+   * The input URL (present when url query param was used)
+   */
+  url?: string;
+}
+
+export interface DomainKnowledgeGetDriverParams {
+  /**
+   * Agent name to resolve driver for (e.g. nimble-ecommerce).
+   */
+  agent?: string;
+
+  /**
+   * Target domain to resolve driver for (e.g. amazon.com).
+   */
+  url?: string;
+}
+
+export declare namespace DomainKnowledge {
+  export {
+    type DomainKnowledgeGetDriverResponse as DomainKnowledgeGetDriverResponse,
+    type DomainKnowledgeGetDriverParams as DomainKnowledgeGetDriverParams,
+  };
+}

package/src/resources/index.ts

@@ -28,6 +28,27 @@ export {
   type CrawlListParams,
   type CrawlRunParams,
 } from './crawl';
+export {
+  DomainKnowledge,
+  type DomainKnowledgeGetDriverResponse,
+  type DomainKnowledgeGetDriverParams,
+} from './domain-knowledge';
+export {
+  Media,
+  type MediaRunResponse,
+  type MediaRunAsyncResponse,
+  type MediaRunParams,
+  type MediaRunAsyncParams,
+} from './media';
+export {
+  Serp,
+  type SerpRunResponse,
+  type SerpRunAsyncResponse,
+  type SerpRunBatchResponse,
+  type SerpRunParams,
+  type SerpRunAsyncParams,
+  type SerpRunBatchParams,
+} from './serp';
 export {
   Tasks,
   type TaskListResponse,