lumnisai 0.1.7 → 0.1.8

package/dist/index.cjs

@@ -709,6 +709,35 @@ class ResponsesResource {
       queryParams.progress_id = options.progressId;
     return this.http.get(`/responses/${responseId}/feedback`, { params: queryParams });
   }
+  /**
+   * Perform a quick people search using the specialized quick_people_search agent
+   * @param query - Natural language search query (e.g., "Find engineers at Google in SF")
+   * @param options - Optional search parameters
+   * @param options.limit - Maximum number of results (1-100, default: 20)
+   * @param options.dataSources - Specific data sources to use: ["PDL", "CORESIGNAL", "CRUST_DATA"]
+   * @returns Response with structured_response containing:
+   *   - candidates: List of person results
+   *   - totalFound: Total unique candidates found
+   *   - appliedFilters: Extracted search filters
+   *   - executionTimeMs: Search duration
+   *   - dataSourcesUsed: Which sources were queried
+   */
+  async quickPeopleSearch(query, options) {
+    const request = {
+      messages: [{ role: "user", content: query }],
+      specializedAgent: "quick_people_search"
+    };
+    if (options) {
+      const params = {};
+      if (options.limit !== void 0)
+        params.limit = options.limit;
+      if (options.dataSources)
+        params.dataSources = options.dataSources;
+      if (Object.keys(params).length > 0)
+        request.specializedAgentParams = params;
+    }
+    return this.create(request);
+  }
 }
 
 class SkillsResource {

package/dist/index.d.cts

@@ -296,6 +296,170 @@ interface ModelAvailability {
     requiresApiKey: boolean;
 }
 
+/**
+ * Available people search data sources
+ */
+declare enum PeopleDataSource {
+    PDL = "PDL",
+    CORESIGNAL = "CORESIGNAL",
+    CRUST_DATA = "CRUST_DATA"
+}
+/**
+ * Salary range projection data.
+ * Note: Values represent total compensation (base salary + bonuses + equity),
+ * not just base salary. Only available for CoreSignal results.
+ */
+interface SalaryRange {
+    /** Minimum total compensation (includes base + bonuses + equity, etc.) */
+    min?: number;
+    /** Median total compensation projection */
+    median?: number;
+    /** Maximum total compensation (includes base + bonuses + equity, etc.) */
+    max?: number;
+    /** Currency code (e.g., "USD", "EUR") */
+    currency?: string;
+    /** Period (e.g., "yearly", "monthly") */
+    period?: string;
+}
+/**
+ * Simplified person result model returned in search results.
+ * Contains normalized data from multiple sources (PDL, CoreSignal, CrustData).
+ */
+interface PersonResult {
+    /** Unique identifier for the person */
+    id: string;
+    /** Full name */
+    name: string;
+    /** Current job title */
+    currentTitle?: string;
+    /** Current company name */
+    currentCompany?: string;
+    /** Current department */
+    currentDepartment?: string;
+    /** Full location string */
+    location?: string;
+    /** City */
+    city?: string;
+    /** Country */
+    country?: string;
+    /** Primary email address */
+    email?: string;
+    /** List of email addresses (up to 3) */
+    emails: string[];
+    /** LinkedIn profile URL */
+    linkedinUrl?: string;
+    /** Years of professional experience */
+    yearsExperience?: number;
+    /** List of skills (up to 15) */
+    skills: string[];
+    /** Seniority level (e.g., "Senior", "Director", "VP") */
+    seniorityLevel?: string;
+    /** Whether person is identified as a decision maker */
+    isDecisionMaker: boolean;
+    /** Number of LinkedIn connections */
+    connectionsCount?: number;
+    /** Whether person recently changed jobs */
+    recentlyChangedJobs: boolean;
+    /** Data source identifier ("PDL", "CORESIGNAL", or "CRUST_DATA") */
+    source: string;
+    /** Confidence score (0.0-1.0) if available */
+    confidenceScore?: number;
+    /** Salary range projection (CoreSignal only) */
+    salaryRange?: SalaryRange;
+    /** Number of certifications (CoreSignal only) */
+    certificationsCount?: number;
+    /** List of languages spoken (CoreSignal only) */
+    languages?: string[];
+    /** List of education degrees (CoreSignal only, up to 3) */
+    educationDegrees?: string[];
+}
+/**
+ * Request model for people search queries.
+ */
+interface PeopleSearchRequest {
+    /**
+     * Natural language search query describing the people you want to find.
+     * Examples:
+     * - "Senior software engineers in San Francisco with Python skills"
+     * - "Product managers at Google or Meta with MBA"
+     * - "Data scientists in NYC with 5+ years experience"
+     */
+    query: string;
+    /**
+     * Maximum number of results to return.
+     * Range: 1-100
+     * Default: 20
+     */
+    limit?: number;
+    /**
+     * Specific data sources to use for the search.
+     * If not provided, all available sources will be used.
+     * Valid values: "PDL", "CORESIGNAL", "CRUST_DATA"
+     *
+     * Note: The API accepts string values. SDKs should use enums for type safety
+     * but serialize them as strings when sending the request.
+     */
+    dataSources?: PeopleDataSource[];
+}
+/**
+ * Logic operator for filter values
+ */
+type FilterLogic = 'or' | 'and' | 'should';
+/**
+ * A filter with values and logic operator.
+ * Used in applied_filters response.
+ */
+interface FilterValue {
+    /** List of values for this filter */
+    values: string[];
+    /**
+     * Logic operator:
+     * - "or": ANY value matches (for alternatives like "SF or NYC")
+     * - "and": ALL values must match (for "must have Python AND Java")
+     * - "should": Optional/preferred (for "preferably PhD")
+     */
+    logic: FilterLogic;
+}
+/**
+ * Structure of the applied_filters field in the response.
+ * Contains extracted filters from the natural language query.
+ */
+interface AppliedFilters {
+    /** Cities for the search */
+    cities?: FilterValue;
+    /** Countries for the search */
+    countries?: FilterValue;
+    /** Job titles/roles */
+    jobTitles?: FilterValue;
+    /** Company names */
+    companies?: FilterValue;
+    /** Technical skills */
+    skills?: FilterValue;
+    /** Minimum years of professional experience */
+    minYearsExperience?: number;
+    /** Seniority levels (entry/junior/mid/senior/lead/principal/staff/director/vp/executive) */
+    seniorityLevels?: FilterValue;
+    /** Education levels (bachelors/masters/phd/mba) */
+    educationLevels?: FilterValue;
+    /** Industries/sectors */
+    industries?: FilterValue;
+}
+/**
+ * Response model for people search endpoint.
+ */
+interface PeopleSearchResponse {
+    /** List of matching candidates */
+    candidates: PersonResult[];
+    /** Total number of unique candidates found (may be more than returned) */
+    totalFound: number;
+    /** Filters extracted and applied from the query */
+    appliedFilters: AppliedFilters;
+    /** Execution time in milliseconds */
+    executionTimeMs: number;
+    /** List of data sources that were actually used */
+    dataSourcesUsed: string[];
+}
+
 type ResponseStatus = 'queued' | 'in_progress' | 'succeeded' | 'failed' | 'cancelled';
 interface FileAttachment {
     name: string;
@@ -320,6 +484,25 @@ interface AgentConfig {
 interface ModelOverrides {
     [key: string]: string;
 }
+/**
+ * Available specialized agents
+ */
+type SpecializedAgentType = 'quick_people_search';
+/**
+ * Parameters for specialized agent execution
+ */
+interface SpecializedAgentParams {
+    /**
+     * Maximum number of results (1-100)
+     * Agent-specific: For quick_people_search, limits the number of candidates returned
+     */
+    limit?: number;
+    /**
+     * Specific data sources to use (agent-specific)
+     * For quick_people_search: ["PDL", "CORESIGNAL", "CRUST_DATA"]
+     */
+    dataSources?: string[];
+}
 interface CreateResponseRequest {
     threadId?: UUID;
     messages: Message[];
@@ -330,6 +513,15 @@ interface CreateResponseRequest {
     responseFormat?: Record<string, any>;
     responseFormatInstructions?: string;
     modelOverrides?: ModelOverrides;
+    /**
+     * Route to a specialized agent instead of the main Lumnis agent
+     * Available agents: 'quick_people_search'
+     */
+    specializedAgent?: SpecializedAgentType;
+    /**
+     * Parameters specific to the specialized agent
+     */
+    specializedAgentParams?: SpecializedAgentParams;
 }
 interface ProgressEntry {
     ts: string;
@@ -430,6 +622,18 @@ interface FeedbackListResponse {
     feedback: FeedbackObject[];
     note: string;
 }
+/**
+ * Structured output from quick_people_search specialized agent
+ * This will be available in ResponseObject.structuredResponse
+ * Note: PersonResult is imported from './people' to avoid duplication
+ */
+interface QuickPeopleSearchOutput {
+    candidates: PersonResult[];
+    totalFound: number;
+    appliedFilters: Record<string, any>;
+    executionTimeMs: number;
+    dataSourcesUsed: string[];
+}
 
 interface SkillGuidelineBase {
     name: string;
@@ -1004,170 +1208,6 @@ declare class ModelPreferencesResource {
     }): Promise<TenantModelPreferencesResponse>;
 }
 
-/**
- * Available people search data sources
- */
-declare enum PeopleDataSource {
-    PDL = "PDL",
-    CORESIGNAL = "CORESIGNAL",
-    CRUST_DATA = "CRUST_DATA"
-}
-/**
- * Salary range projection data.
- * Note: Values represent total compensation (base salary + bonuses + equity),
- * not just base salary. Only available for CoreSignal results.
- */
-interface SalaryRange {
-    /** Minimum total compensation (includes base + bonuses + equity, etc.) */
-    min?: number;
-    /** Median total compensation projection */
-    median?: number;
-    /** Maximum total compensation (includes base + bonuses + equity, etc.) */
-    max?: number;
-    /** Currency code (e.g., "USD", "EUR") */
-    currency?: string;
-    /** Period (e.g., "yearly", "monthly") */
-    period?: string;
-}
-/**
- * Simplified person result model returned in search results.
- * Contains normalized data from multiple sources (PDL, CoreSignal, CrustData).
- */
-interface PersonResult {
-    /** Unique identifier for the person */
-    id: string;
-    /** Full name */
-    name: string;
-    /** Current job title */
-    currentTitle?: string;
-    /** Current company name */
-    currentCompany?: string;
-    /** Current department */
-    currentDepartment?: string;
-    /** Full location string */
-    location?: string;
-    /** City */
-    city?: string;
-    /** Country */
-    country?: string;
-    /** Primary email address */
-    email?: string;
-    /** List of email addresses (up to 3) */
-    emails: string[];
-    /** LinkedIn profile URL */
-    linkedinUrl?: string;
-    /** Years of professional experience */
-    yearsExperience?: number;
-    /** List of skills (up to 15) */
-    skills: string[];
-    /** Seniority level (e.g., "Senior", "Director", "VP") */
-    seniorityLevel?: string;
-    /** Whether person is identified as a decision maker */
-    isDecisionMaker: boolean;
-    /** Number of LinkedIn connections */
-    connectionsCount?: number;
-    /** Whether person recently changed jobs */
-    recentlyChangedJobs: boolean;
-    /** Data source identifier ("PDL", "CORESIGNAL", or "CRUST_DATA") */
-    source: string;
-    /** Confidence score (0.0-1.0) if available */
-    confidenceScore?: number;
-    /** Salary range projection (CoreSignal only) */
-    salaryRange?: SalaryRange;
-    /** Number of certifications (CoreSignal only) */
-    certificationsCount?: number;
-    /** List of languages spoken (CoreSignal only) */
-    languages?: string[];
-    /** List of education degrees (CoreSignal only, up to 3) */
-    educationDegrees?: string[];
-}
-/**
- * Request model for people search queries.
- */
-interface PeopleSearchRequest {
-    /**
-     * Natural language search query describing the people you want to find.
-     * Examples:
-     * - "Senior software engineers in San Francisco with Python skills"
-     * - "Product managers at Google or Meta with MBA"
-     * - "Data scientists in NYC with 5+ years experience"
-     */
-    query: string;
-    /**
-     * Maximum number of results to return.
-     * Range: 1-100
-     * Default: 20
-     */
-    limit?: number;
-    /**
-     * Specific data sources to use for the search.
-     * If not provided, all available sources will be used.
-     * Valid values: "PDL", "CORESIGNAL", "CRUST_DATA"
-     *
-     * Note: The API accepts string values. SDKs should use enums for type safety
-     * but serialize them as strings when sending the request.
-     */
-    dataSources?: PeopleDataSource[];
-}
-/**
- * Logic operator for filter values
- */
-type FilterLogic = 'or' | 'and' | 'should';
-/**
- * A filter with values and logic operator.
- * Used in applied_filters response.
- */
-interface FilterValue {
-    /** List of values for this filter */
-    values: string[];
-    /**
-     * Logic operator:
-     * - "or": ANY value matches (for alternatives like "SF or NYC")
-     * - "and": ALL values must match (for "must have Python AND Java")
-     * - "should": Optional/preferred (for "preferably PhD")
-     */
-    logic: FilterLogic;
-}
-/**
- * Structure of the applied_filters field in the response.
- * Contains extracted filters from the natural language query.
- */
-interface AppliedFilters {
-    /** Cities for the search */
-    cities?: FilterValue;
-    /** Countries for the search */
-    countries?: FilterValue;
-    /** Job titles/roles */
-    jobTitles?: FilterValue;
-    /** Company names */
-    companies?: FilterValue;
-    /** Technical skills */
-    skills?: FilterValue;
-    /** Minimum years of professional experience */
-    minYearsExperience?: number;
-    /** Seniority levels (entry/junior/mid/senior/lead/principal/staff/director/vp/executive) */
-    seniorityLevels?: FilterValue;
-    /** Education levels (bachelors/masters/phd/mba) */
-    educationLevels?: FilterValue;
-    /** Industries/sectors */
-    industries?: FilterValue;
-}
-/**
- * Response model for people search endpoint.
- */
-interface PeopleSearchResponse {
-    /** List of matching candidates */
-    candidates: PersonResult[];
-    /** Total number of unique candidates found (may be more than returned) */
-    totalFound: number;
-    /** Filters extracted and applied from the query */
-    appliedFilters: AppliedFilters;
-    /** Execution time in milliseconds */
-    executionTimeMs: number;
-    /** List of data sources that were actually used */
-    dataSourcesUsed: string[];
-}
-
 declare class PeopleResource {
     private readonly http;
     constructor(http: Http);
@@ -1257,6 +1297,23 @@ declare class ResponsesResource {
     listFeedback(responseId: string, options?: {
         progressId?: string;
     }): Promise<FeedbackListResponse>;
+    /**
+     * Perform a quick people search using the specialized quick_people_search agent
+     * @param query - Natural language search query (e.g., "Find engineers at Google in SF")
+     * @param options - Optional search parameters
+     * @param options.limit - Maximum number of results (1-100, default: 20)
+     * @param options.dataSources - Specific data sources to use: ["PDL", "CORESIGNAL", "CRUST_DATA"]
+     * @returns Response with structured_response containing:
+     *   - candidates: List of person results
+     *   - totalFound: Total unique candidates found
+     *   - appliedFilters: Extracted search filters
+     *   - executionTimeMs: Search duration
+     *   - dataSourcesUsed: Which sources were queried
+     */
+    quickPeopleSearch(query: string, options?: {
+        limit?: number;
+        dataSources?: string[];
+    }): Promise<CreateResponseResponse>;
 }
 
 declare class SkillsResource {
@@ -1604,4 +1661,4 @@ declare class ProgressTracker {
 }
 
 export = LumnisClient;
-export { type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BillingStatus, type BulkDeleteRequest, type BulkDeleteResponse, type BulkUploadResponse, type CancelResponseResponse, type CheckAppEnabledParams, type ChunkingStrategy, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ContentType, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type DatabaseStatus, type DeleteApiKeyResponse, type DisconnectRequest, type DisconnectResponse, type DuplicateHandling, type Email, type ErrorResponse, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, IntegrationsResource, InternalServerError, type ListProvidersResponse, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type Message, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NoDataSourcesError, NotFoundError, type PaginationInfo, type PaginationParams, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, ProviderType, RateLimitError, type RateLimitErrorOptions, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, SourcesNotAvailableError, type StoreApiKeyRequest, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type UUID, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, ValidationError, displayProgress, formatProgressEntry };
+export { type AgentConfig, type ApiKeyMode, type ApiKeyModeRequest, type ApiKeyModeResponse, type ApiProvider, type AppEnabledResponse, type AppliedFilters, type AppsListResponse, type ArtifactObject, type ArtifactsListResponse, AuthenticationError, type BaseResource, type BillingStatus, type BulkDeleteRequest, type BulkDeleteResponse, type BulkUploadResponse, type CancelResponseResponse, type CheckAppEnabledParams, type ChunkingStrategy, type ConnectionCallbackRequest, type ConnectionCallbackResponse, type ConnectionInfo, type ConnectionStatus, type ConnectionStatusResponse, type ContentType, type CreateFeedbackRequest, type CreateFeedbackResponse, type CreateResponseRequest, type CreateResponseResponse, type CreateThreadRequest, type DatabaseStatus, type DeleteApiKeyResponse, type DisconnectRequest, type DisconnectResponse, type DuplicateHandling, type Email, type ErrorResponse, ExternalAPIKeysResource, type ExternalApiKeyResponse, type FeedbackListResponse, type FeedbackObject, type FeedbackType, type FileAttachment, type FileChunk, type FileContentResponse, type FileListResponse, type FileMetadata, type FileScope, type FileScopeUpdateRequest, type FileSearchRequest, type FileSearchResponse, type FileSearchResult, type FileStatisticsResponse, type FileUploadResponse, FilesResource, type FilterLogic, type FilterValue, type GetConnectionStatusParams, type GetToolsRequest, type GetToolsResponse, type GetUserConnectionsParams, type InitiateConnectionRequest, type InitiateConnectionResponse, IntegrationsResource, InternalServerError, type ListProvidersResponse, LocalFileNotSupportedError, LumnisClient, type LumnisClientOptions, LumnisError, type LumnisErrorOptions, type MCPScope, type MCPServerCreateRequest, type MCPServerListResponse, type MCPServerResponse, type MCPServerUpdateRequest, MCPServersResource, type MCPToolListResponse, type MCPToolResponse, type MCPTransport, type Message, type ModelAvailability, type ModelOverrides, type ModelPreferenceCreate, type ModelPreferencesBulkUpdate, ModelPreferencesResource, type ModelProvider, type ModelType, NoDataSourcesError, NotFoundError, type PaginationInfo, type PaginationParams, PeopleDataSource, PeopleResource, type PeopleSearchRequest, type PeopleSearchResponse, type PersonResult, type Plan, type ProcessingStatus, type ProcessingStatusResponse, type ProgressEntry, ProgressTracker, ProviderType, type QuickPeopleSearchOutput, RateLimitError, type RateLimitErrorOptions, type ResponseArtifact, type ResponseListResponse, type ResponseObject, type ResponseStatus, ResponsesResource, type SalaryRange, type Scope, type SelectedSkill, type SkillAnalyticsRequest, type SkillEffectivenessMetrics, type SkillGuidelineBase, type SkillGuidelineCreate, type SkillGuidelineListResponse, type SkillGuidelineResponse, type SkillGuidelineUpdate, type SkillRetrievalMetadata, type SkillUsageBase, type SkillUsageCreate, type SkillUsageListResponse, type SkillUsageResponse, type SkillUsageUpdate, SkillsResource, SourcesNotAvailableError, type SpecializedAgentParams, type SpecializedAgentType, type StoreApiKeyRequest, type TenantDetailsResponse, TenantInfoResource, type TenantModelPreference, type TenantModelPreferencesResponse, type TestConnectionResponse, type ThreadListResponse, type ThreadObject, type ThreadResponsesParams, ThreadsResource, type ToolInfo, type UUID, type UpdateAppStatusParams, type UpdateAppStatusResponse, type UpdateThreadRequest, type UserConnectionsResponse, type UserCreateRequest, type UserDeleteResponse, type UserIdentifier, type UserListResponse, type UserResponse, type UserUpdateRequest, UsersResource, ValidationError, displayProgress, formatProgressEntry };