@squidcloud/client 1.0.352 → 1.0.354

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 (22) hide show
  1. package/dist/cjs/index.js +1 -1
  2. package/dist/internal-common/src/metric-name.d.ts +1 -1
  3. package/dist/internal-common/src/public-types/ai-agent-integrations.public-types.d.ts +14 -0
  4. package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +53 -2
  5. package/dist/internal-common/src/public-types/ai-assistant.public-types.d.ts +4 -4
  6. package/dist/internal-common/src/public-types/{integrations/api.public-types.d.ts → api.public-types.d.ts} +1 -1
  7. package/dist/internal-common/src/public-types/backend.public-types.d.ts +6 -1
  8. package/dist/internal-common/src/public-types/integration.public-types.d.ts +2 -2
  9. package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts +1 -1
  10. package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts +19 -1
  11. package/dist/internal-common/src/types/ai-agent.types.d.ts +2 -2
  12. package/dist/internal-common/src/types/ai-matchmaking.types.d.ts +1 -1
  13. package/dist/internal-common/src/utils/validation.d.ts +1 -1
  14. package/dist/typescript-client/src/ai-matchmaking-client.d.ts +1 -1
  15. package/dist/typescript-client/src/api-client.d.ts +1 -1
  16. package/dist/typescript-client/src/integration-client.d.ts +7 -0
  17. package/dist/typescript-client/src/public-types.d.ts +4 -3
  18. package/dist/typescript-client/src/squid.d.ts +12 -0
  19. package/dist/typescript-client/src/version.d.ts +1 -1
  20. package/package.json +1 -1
  21. /package/dist/internal-common/src/public-types/{ai-matchmaking.types.d.ts → ai-matchmaking.public-types.d.ts} +0 -0
  22. /package/dist/internal-common/src/public-types/{http-status.enum.d.ts → http-status.public-types.d.ts} +0 -0
@@ -3,7 +3,7 @@
3
3
  * Should be in sync with MetricName.kt.
4
4
  * See MetricName.kt for documentation on each value.
5
5
  */
6
- export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_built_in_db_size", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
6
+ export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "squid_built_in_db_size", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
7
7
  export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
8
8
  /** Common prefix for all Squid metrics. */
9
9
  export declare const SQUID_METRIC_NAME_PREFIX = "squid_";
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Configuration options for AI agent database integration.
3
+ */
4
+ export interface AiAgentDatabaseIntegrationOptions {
5
+ /**
6
+ * A list of collection (or table) name filters that the AI agent can query data from.
7
+ *
8
+ * Currently, the following filters are supported:
9
+ * - Exact match: Only collection names that exactly match the filter can be used for AI queries. This is case-sensitive.
10
+ *
11
+ * When this list is not provided (i.e., it is `undefined`) or is empty, the AI agent has access to all collections.
12
+ */
13
+ collectionsToUse?: string[];
14
+ }
@@ -164,6 +164,22 @@ export type AiAudioTranscribeOptions = OpenAiAudioTranscribeOptions;
164
164
  * @category AI
165
165
  */
166
166
  export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
167
+ /**
168
+ * @category AI
169
+ */
170
+ export declare const RAG_TYPES: readonly ["contextual", "basic"];
171
+ /**
172
+ * @category AI
173
+ */
174
+ export type AiRagType = (typeof RAG_TYPES)[number];
175
+ /**
176
+ * @category AI
177
+ */
178
+ export declare const RERANK_PROVIDERS: readonly ["cohere", "none"];
179
+ /**
180
+ * @category AI
181
+ */
182
+ export type AiRerankProvider = (typeof RERANK_PROVIDERS)[number];
167
183
  /**
168
184
  * Base options for generating images with an AI model.
169
185
  * @category AI
@@ -309,7 +325,7 @@ export interface AiFileUrl {
309
325
  * Metadata for an AI agent connected to an integration.
310
326
  * @category AI
311
327
  */
312
- export interface AiConnectedIntegrationMetadata {
328
+ export interface AiConnectedIntegrationMetadata<AiConnectedIntegrationOptionsType = unknown> {
313
329
  /** The ID of the connected integration. */
314
330
  integrationId: IntegrationId;
315
331
  /** The type of the connected integration (e.g., API, database). */
@@ -318,6 +334,11 @@ export interface AiConnectedIntegrationMetadata {
318
334
  description?: string;
319
335
  /** Optional instructions for the connected integration agent, overriding the default if provided. */
320
336
  instructions?: string;
337
+ /**
338
+ * Additional options for the connected integration.
339
+ * Squid Core or AI functions in connector packages may use these options to adjust behavior of the integration agent.
340
+ */
341
+ options?: AiConnectedIntegrationOptionsType;
321
342
  }
322
343
  /**
323
344
  * Metadata for a connected AI agent callable by the current agent.
@@ -348,7 +369,7 @@ export interface AiChatPromptQuotas {
348
369
  * @category AI
349
370
  */
350
371
  export interface BaseAiAgentChatOptions {
351
- /** The maximum number of tokens to use when making the request to the AI model. Default to the max tokens the model can accept. */
372
+ /** The maximum number of tokens to use when making the request to the AI model. Defaults to the max tokens the model can accept. */
352
373
  maxTokens?: number;
353
374
  /** A unique chat ID, if the same chat ID is used again and history is not disabled, it will continue the conversation. */
354
375
  chatId?: string;
@@ -395,6 +416,8 @@ export interface BaseAiAgentChatOptions {
395
416
  guardrails?: GuardrailsOptions;
396
417
  /** The LLM model to use. */
397
418
  model?: AiChatModelName;
419
+ /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
420
+ rerankProvider?: AiRerankProvider;
398
421
  }
399
422
  /**
400
423
  * Chat options specific to Gemini models, extending base options.
@@ -526,6 +549,8 @@ export interface AiSearchOptions {
526
549
  contextMetadataFilter?: AiContextMetadataFilter;
527
550
  /** The maximum number of results to return */
528
551
  limit?: number;
552
+ /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
553
+ rerankProvider?: AiRerankProvider;
529
554
  }
530
555
  /**
531
556
  * A single chunk of data returned from an AI search operation.
@@ -574,6 +599,18 @@ interface BaseContextRequest {
574
599
  type: AiContextType;
575
600
  metadata?: AiContextMetadata;
576
601
  }
602
+ /**
603
+ * Base options for upserting text content into the AI agent's context.
604
+ * @category AI
605
+ */
606
+ export interface AiContextTextOptions extends BaseAiContextOptions {
607
+ }
608
+ /**
609
+ * Base options for upserting file content into the AI agent's context.
610
+ * @category AI
611
+ */
612
+ export interface AiContextFileOptions extends BaseAiContextOptions {
613
+ }
577
614
  /**
578
615
  * @category AI
579
616
  */
@@ -589,6 +626,8 @@ export interface TextContextRequest extends BaseContextRequest {
589
626
  title: string;
590
627
  /** The text content to add to the context. */
591
628
  text: string;
629
+ /** General options for how to process the text. */
630
+ options?: AiContextTextOptions;
592
631
  }
593
632
  /**
594
633
  * Request structure for adding file-based context to an AI agent.
@@ -603,6 +642,8 @@ export interface FileContextRequest extends BaseContextRequest {
603
642
  imageMinSizePixels?: number;
604
643
  /** The AI model to use for extraction, if specified. */
605
644
  extractionModel?: AiChatModelName;
645
+ /** General options for how to process the file. */
646
+ options?: AiContextFileOptions;
606
647
  }
607
648
  /**
608
649
  * @category AI
@@ -671,6 +712,16 @@ export interface AiContextMetadataOrFilter {
671
712
  * @category AI
672
713
  */
673
714
  export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMetadataAndFilter | AiContextMetadataOrFilter;
715
+ /**
716
+ * Base options for how to deal with the content being upserted.
717
+ * @category AI
718
+ */
719
+ export type BaseAiContextOptions = {
720
+ /** The type of RAG to use for the content. */
721
+ ragType?: AiRagType;
722
+ /** Amount of chunk overlap, in characters. */
723
+ chunkOverlap?: number;
724
+ };
674
725
  /**
675
726
  * A record of metadata key-value pairs for AI context, where values are primitive types or undefined.
676
727
  * @category AI
@@ -1,5 +1,5 @@
1
- import { OpenAiChatModelName, OpenAiReasoningEffort, AiAgentResponseFormat } from './ai-agent.public-types';
2
- import { FunctionName } from './backend.public-types';
1
+ import { AiAgentResponseFormat, OpenAiChatModelName, OpenAiReasoningEffort } from './ai-agent.public-types';
2
+ import { AiFunctionId } from './backend.public-types';
3
3
  /**
4
4
  * The type of assistant tool.
5
5
  * @category AI
@@ -12,8 +12,8 @@ export type AssistantToolType = 'code_interpreter' | 'file_search';
12
12
  export interface QueryAssistantOptions {
13
13
  /** Additional context provided to all AI functions for processing. */
14
14
  agentContext?: Record<string, unknown>;
15
- /** Specific context provided per AI function, keyed by function name. */
16
- functionContexts?: Record<FunctionName, Record<string, unknown>>;
15
+ /** Specific context provided per AI function, keyed by function ID. */
16
+ functionContexts?: Record<AiFunctionId, Record<string, unknown>>;
17
17
  /** The desired format of the AI model's response; defaults to 'text'. */
18
18
  responseFormat?: AiAgentResponseFormat;
19
19
  /** The OpenAI chat model to use for the assistant, if specified. */
@@ -1,4 +1,4 @@
1
- import { FieldName } from '../document.public-types';
1
+ import { FieldName } from './document.public-types';
2
2
  /** Represents the HTTP methods supported by an API endpoint. */
3
3
  export type HttpMethod = 'post' | 'get' | 'delete' | 'patch' | 'put';
4
4
  /** An identifier string used to uniquely represent an API endpoint. */
@@ -14,10 +14,15 @@ export type FunctionName = string;
14
14
  * Function name with contextual data, where the data must be serializable as JSON.
15
15
  */
16
16
  export interface AiFunctionIdWithContext {
17
- /** The ID of the AI function as described in @aiFunction decorator. */
17
+ /**
18
+ * The ID of the AI function as described in @aiFunction decorator.
19
+ * Historically named as 'name' because AI function name is the default value for 'ID'.
20
+ */
18
21
  name: AiFunctionId;
19
22
  /** A record of contextual data associated with the function call. */
20
23
  context: Record<string, unknown>;
24
+ /** A list of predefined parameter values for the AI function. These parameters are hidden from the AI. */
25
+ predefinedParameters?: Record<string, unknown>;
21
26
  }
22
27
  /**
23
28
  * A combined service and function name in the format 'ServiceName:FunctionName'.
@@ -1,10 +1,10 @@
1
1
  import { IntegrationId } from './communication.public-types';
2
2
  /** List of all integration types supported by Squid. */
3
- export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elastic_enterprise_search", "elastic_observability", "elastic_search", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack"];
3
+ export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack"];
4
4
  /**
5
5
  * @category Database
6
6
  */
7
- export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "mysql", "oracledb", "postgres", "sap_hana", "snowflake"];
7
+ export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch"];
8
8
  /**
9
9
  * @category Auth
10
10
  */
@@ -1,4 +1,4 @@
1
- import { ApiEndpointId, HttpMethod } from '../public-types/integrations/api.public-types';
1
+ import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
2
2
  import { IntegrationId } from '../public-types/communication.public-types';
3
3
  import { ApiOptions } from '../public-types/api-client.public-types';
4
4
  /** The headers of an API call. */
@@ -34,9 +34,27 @@ export interface MongoNativeQueryContext extends BaseNativeQueryContext {
34
34
  /** Array of aggregation pipeline stages. */
35
35
  aggregationPipeline: Array<any | undefined>;
36
36
  }
37
+ /**
38
+ * Context for executing an Elasticsearch query.
39
+ * @category Database
40
+ */
41
+ export interface ElasticsearchNativeQueryContext {
42
+ /** Specifies that the query is for an Elasticsearch database. */
43
+ type: 'elasticsearch';
44
+ /** Elasticsearch index to query. */
45
+ index: string;
46
+ /** Elasticsearch query string. */
47
+ endpoint?: string;
48
+ /** HTTP method to use for the request. */
49
+ method?: 'GET' | 'POST';
50
+ /** Body of the request. */
51
+ body: Record<string, any>;
52
+ /** Headers to include in the request. */
53
+ integrationId: IntegrationId;
54
+ }
37
55
  /**
38
56
  * Union type representing either a relational or MongoDB native query context.
39
57
  * @category Database
40
58
  */
41
- export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext;
59
+ export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext;
42
60
  export {};
@@ -1,10 +1,10 @@
1
- import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiAudioCreateSpeechOptions, AiChatModelName, AiContextMetadata, AiContextMetadataFilter, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions } from '../public-types/ai-agent.public-types';
1
+ import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiAudioCreateSpeechOptions, AiChatModelName, AiContextMetadata, AiContextMetadataFilter, AiEmbeddingsModelName, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions } from '../public-types/ai-agent.public-types';
2
2
  import { AiAgentId, AppId, ClientRequestId } from '../public-types/communication.public-types';
3
3
  type ModelDataType = {
4
4
  maxTokens: number;
5
- defaultTokens: number;
6
5
  };
7
6
  export declare const AiModelData: Record<AiChatModelName, ModelDataType>;
7
+ export declare const AiEmbeddingModelData: Record<AiEmbeddingsModelName, ModelDataType>;
8
8
  export interface AiChatRequest {
9
9
  agentId: AiAgentId;
10
10
  clientRequestId: ClientRequestId;
@@ -1,4 +1,4 @@
1
- import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.types';
1
+ import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.public-types';
2
2
  export interface MmCreateMatchMakerRequest {
3
3
  matchMaker: MmMatchMaker;
4
4
  }
@@ -1,4 +1,4 @@
1
- import { HttpStatusCode } from '../public-types/http-status.enum';
1
+ import { HttpStatusCode } from '../public-types/http-status.public-types';
2
2
  export declare class ValidationError extends Error {
3
3
  readonly statusCode: HttpStatusCode;
4
4
  readonly details?: any;
@@ -1,4 +1,4 @@
1
- import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../../internal-common/src/public-types/ai-matchmaking.types';
1
+ import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../../internal-common/src/public-types/ai-matchmaking.public-types';
2
2
  /**
3
3
  * Client for the AI Matchmaking service. This service allows you to create matchmakers and insert entities into them.
4
4
  * The service will then find matches for the entities.
@@ -1,5 +1,5 @@
1
1
  import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
2
- import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/integrations/api.public-types';
2
+ import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/api.public-types';
3
3
  import { HttpResponse } from './squid-http-client';
4
4
  import { ApiOptions } from '../../internal-common/src/public-types/api-client.public-types';
5
5
  /**
@@ -21,6 +21,13 @@ export declare class IntegrationClient {
21
21
  * @returns A promise that resolves with the integration info, or `undefined` if not found.
22
22
  */
23
23
  get<ConfigurationType = Record<string, any>>(integrationId: IntegrationId): Promise<IntegrationInfo<ConfigurationType> | undefined>;
24
+ /**
25
+ * Retrieves the integration's schema by its ID.
26
+ *
27
+ * @param integrationId - The ID of the integration to retrieve.
28
+ * @returns A promise that resolves with the integration schema, or `undefined` if not found.
29
+ */
30
+ getIntegrationSchema<ConfigurationType = Record<string, any>>(integrationId: IntegrationId): Promise<IntegrationInfo<ConfigurationType> | undefined>;
24
31
  /**
25
32
  * Deletes the integration with the given ID.
26
33
  *
@@ -1,3 +1,4 @@
1
+ export * from '../../internal-common/src/public-types/ai-agent-integrations.public-types';
1
2
  export * from '../../internal-common/src/public-types/ai-assistant.public-types';
2
3
  export * from '../../internal-common/src/public-types/ai-agent.public-types';
3
4
  export * from '../../internal-common/src/public-types/api-client.public-types';
@@ -5,9 +6,9 @@ export * from '../../internal-common/src/public-types/code-executor.public-types
5
6
  export * from '../../internal-common/src/public-types/communication.public-types';
6
7
  export * from '../../internal-common/src/public-types/context.public-types';
7
8
  export * from '../../internal-common/src/public-types/document.public-types';
8
- export * from '../../internal-common/src/public-types/http-status.enum';
9
+ export * from '../../internal-common/src/public-types/http-status.public-types';
9
10
  export * from '../../internal-common/src/public-types/integration.public-types';
10
- export * from '../../internal-common/src/public-types/integrations/api.public-types';
11
+ export * from '../../internal-common/src/public-types/api.public-types';
11
12
  export * from '../../internal-common/src/public-types/metric.public-types';
12
13
  export * from '../../internal-common/src/public-types/openapi.public-types';
13
14
  export * from '../../internal-common/src/public-types/query.public-types';
@@ -19,6 +20,6 @@ export * from '../../internal-common/src/public-types/scheduler.public-types';
19
20
  export * from '../../internal-common/src/public-types/socket.public-types';
20
21
  export * from '../../internal-common/src/public-types/typescript.public-types';
21
22
  export * from '../../internal-common/src/public-types/extraction.public-types';
22
- export * from '../../internal-common/src/public-types/ai-matchmaking.types';
23
+ export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';
23
24
  export * from '../../internal-common/src/public-types/backend.public-types';
24
25
  export * from '../../internal-common/src/public-types/web.public-types';
@@ -213,6 +213,18 @@ export declare class Squid {
213
213
  * @returns A promise that resolves with the result of the query.
214
214
  */
215
215
  executeNativeMongoQuery<T = any>(integrationId: IntegrationId, collectionName: string, aggregationPipeline: Array<any | undefined>): Promise<Array<T>>;
216
+ /**
217
+ * Executes a native Elasticsearch query against the given index and endpoint.
218
+ * See https://docs.getsquid.ai/docs/client-sdk/database/native-queries#native-elasticsearch-queries.
219
+ *
220
+ * @param integrationId The id of the integration that the query is associated with.
221
+ * @param index The Elasticsearch index to query.
222
+ * @param body The raw request body to send (must be a valid ES query DSL object).
223
+ * @param endpoint The Elasticsearch endpoint to call (default: "_search").
224
+ * @param method The HTTP method to use (default: "GET").
225
+ * @returns A promise that resolves with the result array.
226
+ */
227
+ executeNativeElasticQuery<T = any>(integrationId: IntegrationId, index: string, body: Record<string, any>, endpoint?: string, method?: 'GET' | 'POST'): Promise<Array<T>>;
216
228
  /**
217
229
  * Returns a set of AI specific clients.
218
230
  *
@@ -2,4 +2,4 @@
2
2
  * The current version of the SquidCloud client package.
3
3
  * @category Platform
4
4
  */
5
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.352";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.354";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.352",
3
+ "version": "1.0.354",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "types": "dist/typescript-client/src/index.d.ts",