@squidcloud/client 1.0.395 → 1.0.396

package/dist/internal-common/src/metric-name.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Names of the Squid metrics.
+ * Should be in sync with MetricName.kt.
+ * See MetricName.kt for documentation on each value.
+ */
+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_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_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"];
+export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
+/** Common prefix for all Squid metrics. */
+export declare const SQUID_METRIC_NAME_PREFIX = "squid_";

package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts

@@ -250,7 +250,15 @@ export interface AiAgentMemoryOptions {
      *   - 'read-write': The agent can both read from and write to memory.
      */
     memoryMode: 'none' | 'read-only' | 'read-write';
-    /** A unique id for managing the memory */
+    /**
+     * A unique ID to store the chat memory.
+     *
+     * The full chat memory key is constructed as a combination of 'appId', 'agentId', and 'memoryId'.
+     * If not provided the Squid client instance ID used as a memoryId.
+     *
+     * Important: the memory ID should be treated with the same security measures as Access Token because it unblocks
+     * direct access to the agent chat history. A good practice is to use a non-trivial and a unique value.
+     */
     memoryId?: string;
 }
 /**

package/dist/internal-common/src/public-types/integration.public-types.d.ts

@@ -12,7 +12,7 @@ export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_
 /** Supported integration types for GraphQL-based services. */
 export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
 /** Supported integration types for HTTP-based services. */
-export declare const HTTP_INTEGRATION_TYPES: readonly ["api", "confluence"];
+export declare const HTTP_INTEGRATION_TYPES: readonly ["api"];
 /** Represents a supported integration type identifier, such as 'postgres', 'auth0', or 's3'. */
 export type IntegrationType = (typeof INTEGRATION_TYPES)[number];
 /** Supported schema types for integrations */

package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts

@@ -0,0 +1,30 @@
+import { ApiOptions } from '../public-types/api-client.public-types';
+import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
+import { IntegrationId } from '../public-types/communication.public-types';
+/** The headers of an API call. */
+export type ApiHeaders = Record<string, string | number | boolean>;
+/** The context of an API call. */
+export declare class ApiCallContext {
+    readonly integrationId: IntegrationId;
+    readonly endpointId: ApiEndpointId;
+    readonly url: string;
+    readonly method: HttpMethod;
+    readonly body: unknown;
+    readonly options: ApiOptions;
+}
+/**
+ * Represents a request to call an API through a specified integration and endpoint.
+ * Includes optional method override and additional request options.
+ */
+export interface CallApiRequest<BodyType = any> {
+    /** The identifier of the integration through which the API is called. */
+    integrationId: IntegrationId;
+    /** Target API endpoint to invoke. */
+    endpointId: ApiEndpointId;
+    /** Optional request payload. */
+    body?: BodyType;
+    /** Optional HTTP method override. Default is POST. */
+    overrideMethod?: HttpMethod;
+    /** Additional request options. */
+    options: ApiOptions;
+}

package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts

@@ -0,0 +1,148 @@
+import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
+import { Paths } from '../public-types/typescript.public-types';
+/**
+ * The mutation type.
+ * @category Database
+ */
+export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
+/**
+ * @category Database
+ */
+export type MutationType = (typeof MUTATION_TYPES)[number];
+interface BaseMutation {
+    type: MutationType;
+    squidDocIdObj: SquidDocIdObj;
+}
+/**
+ * A mutation on a document.
+ * @category Database
+ */
+export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
+/**
+ * Represents a delete mutation on a document.
+ * @category Database
+ */
+export interface DeleteMutation extends BaseMutation {
+    /** Specifies that the mutation is a deletion. */
+    type: 'delete';
+}
+/**
+ * Represents an update mutation on a document.
+ * @category Database
+ */
+export interface UpdateMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an update. */
+    type: 'update';
+    /** The updated properties */
+    properties: {
+        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
+    };
+}
+/**
+ * Represents an insert mutation on a document.
+ * @category Database
+ */
+export interface InsertMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an insertion. */
+    type: 'insert';
+    /** The inserted document */
+    properties: T;
+}
+/**
+ * A representation of a single property update.
+ * @category Database
+ */
+export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
+/**
+ * A value update property mutation.
+ * @category Database
+ */
+export interface ValueUpdatePropertyMutation<Value = any> {
+    /** Specifies that the mutation updates a value. */
+    type: 'update';
+    /** New value to be set. */
+    value: Value;
+}
+/**
+ * Applying a numeric function to a property.
+ * @category Database
+ */
+export interface ApplyNumericFnPropertyMutation {
+    /** Specifies that the mutation applies a numeric function. */
+    type: 'applyNumericFn';
+    /** Numeric function to apply. */
+    fn: 'increment';
+    /** Value to use in the numeric function. */
+    value: number;
+}
+/**
+ * A property update that removes a property from a document.
+ * @category Database
+ */
+export interface RemovePropertyMutation {
+    /** Specifies that the mutation removes a property. */
+    type: 'removeProperty';
+}
+interface ApplyExtendString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to extend the existing string. */
+    fn: 'extendString';
+    /** String value to append. */
+    value: string;
+}
+interface ApplyTrimString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to trim the existing string. */
+    fn: 'trim';
+}
+/**
+ * A property mutation that modifies a string.
+ * @category Database
+ */
+export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
+/**
+ * The before and after documents of a document change.
+ * @category Database
+ */
+export interface BeforeAndAfterDocs<T = SquidDocument> {
+    /** Document state before the mutation. */
+    before: T | undefined;
+    /** Document state after the mutation. */
+    after: T | undefined;
+}
+/**
+ * The mutation context that will be provided to the security function.
+ * @category Database
+ */
+export declare class MutationContext<T = any> {
+    readonly mutation: Mutation<T>;
+    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
+    readonly serverTimeStamp: Date;
+    /**
+     * Returns the type of the mutation (insert, update, or delete).
+     */
+    getMutationType(): MutationType;
+    /**
+     * Returns the state of the document before the mutation was applied.
+     */
+    get before(): T | undefined;
+    /**
+     * Returns the state of the document after the mutation was applied.
+     */
+    get after(): T | undefined;
+    /** Returns true if the mutation affects the provided path. */
+    affectsPath(path: Paths<T>): boolean;
+    /**
+     * Find all affected paths starting from a root path.
+     *
+     * @example
+     * doc before - { a: { b: 1, c: 2 }, d: 3 }
+     * doc after - { a: { b: 1, c: 3 }, d: 4 }
+     * doc.affectedPaths('a') // ['a.c']
+     */
+    affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
+    private checkPath;
+}
+export {};

package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts

@@ -0,0 +1,60 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+/**
+ * Represents the type of native query request, either relational, elastic or MongoDB.
+ * @category Database
+ */
+export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch';
+interface BaseNativeQueryContext {
+    /** Type of the native query request. */
+    type: NativeQueryRequestType;
+    /** Identifier for the integration. */
+    integrationId: IntegrationId;
+}
+/**
+ * Context for executing a relational database query.
+ * @category Database
+ */
+export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a relational database. */
+    type: 'relational';
+    /** SQL query string to be executed. */
+    query: string;
+    /** Parameters to be used in the query. */
+    params: Record<string, any>;
+}
+/**
+ * Context for executing a MongoDB query.
+ * @category Database
+ */
+export interface MongoNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a Mongo database. */
+    type: 'mongo';
+    /** Name of the MongoDB collection to query. */
+    collectionName: string;
+    /** Array of aggregation pipeline stages. */
+    aggregationPipeline: Array<any | undefined>;
+}
+/**
+ * Context for executing an Elasticsearch query.
+ * @category Database
+ */
+export interface ElasticsearchNativeQueryContext {
+    /** Specifies that the query is for an Elasticsearch database. */
+    type: 'elasticsearch';
+    /** Elasticsearch index to query. */
+    index: string;
+    /** Elasticsearch query string. */
+    endpoint?: string;
+    /** HTTP method to use for the request. */
+    method?: 'GET' | 'POST';
+    /** Body of the request. */
+    body: Record<string, any>;
+    /** Headers to include in the request. */
+    integrationId: IntegrationId;
+}
+/**
+ * Union type representing either a relational or MongoDB native query context.
+ * @category Database
+ */
+export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext;
+export {};

package/dist/internal-common/src/public-types-backend/query.public-context.d.ts

@@ -0,0 +1,166 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+import { CollectionName, DocumentData } from '../public-types/document.public-types';
+import { FieldSort, Operator, Query, SimpleCondition } from '../public-types/query.public-types';
+import { DeepRecord, FieldOf, PartialBy, Paths } from '../public-types/typescript.public-types';
+/**
+ * Represents the Squid query context.
+ * Passed to methods that require query details, such as those annotated with the `@secureCollection` annotation.
+ * @category Database
+ */
+export declare class QueryContext<T extends DocumentData = any> {
+    readonly query: Query<T>;
+    /**
+     * The ID of the integration being queried.
+     */
+    get integrationId(): IntegrationId;
+    /**
+     * The name of the collection being queried.
+     */
+    get collectionName(): CollectionName;
+    /**
+     * The query limit if one exists, -1 otherwise.
+     */
+    get limit(): number;
+    /**
+     * Verifies that the query's sort order aligns with the provided field sorts. The fields specified in the `sorts`
+     * parameter must appear in the exact order at the beginning of the query's sort sequence. The query can include
+     * additional fields in its sort order, but only after the specified sorts.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts matches the provided field sorts.
+     */
+    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query's sort order exactly matches the provided field sorts. The fields specified in the
+     * `sorts` parameter must appear in the exact order in the query's sort sequence. No additional sorts may be present
+     * in the query.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts exactly match the provided field sorts.
+     */
+    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param fieldName The name of the field for the condition.
+     * @param operator The operator of the condition.
+     * @param value The value of the condition.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOf<F extends Paths<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param condition The condition to validate.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOfCondition(condition: GeneralCondition<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified conditions. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent conditions. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param conditions The conditions to validate.
+     * @returns Whether the query includes subquery of the parent conditions.
+     */
+    isSubqueryOfConditions(conditions: GeneralConditions<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified query. A subquery is defined as a query that evaluates
+     * to a subset of the results that obtained for the parent query, including sorts and limits.
+     *
+     * @param query The query to validate.
+     * @returns Whether the query is a subquery of the parent query.
+     */
+    isSubqueryOfQuery(query: Query<T>): boolean;
+    /**
+     * Returns all conditions that apply to any of the specified field names. This method
+     * provides a convenient way to retrieve all conditions that involve a specific set of fields.
+     *
+     * @param fieldNames The field names for which to retrieve conditions.
+     * @returns An array of conditions that involve any of the specified field names.
+     */
+    getConditionsFor<K extends Paths<T>>(...fieldNames: Array<K>): ContextConditions<T, K>;
+    /**
+     * Returns all conditions that apply to the specified field name. This method provides
+     * a convenient way to retrieve all conditions that involve a specific field.
+     *
+     * @param fieldName The field name for which to retrieve conditions.
+     * @returns An array of conditions that involve the specified field name.
+     */
+    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
+    /**
+     * Returns true if the given document can be a result of the query.
+     * The method does not account for limit and sort order.
+     */
+    documentMatchesQuery(doc: DocumentData): boolean;
+}
+/**
+ * A list of context conditions.
+ * @category Database
+ */
+export type ContextConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<ContextCondition<Doc, F>>;
+/**
+ * A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'.
+ * @category Database
+ */
+export type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
+/**
+ * A condition using the 'in' operator to match values within a set.
+ * @category Database
+ */
+export interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
+    /** Specifies the 'in' operator to check if a value exists within an array. */
+    operator: 'in';
+    /** An array of values to match against the field. */
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+/**
+ * A condition using the 'not in' operator to exclude values within a set.
+ * @category Database
+ */
+export interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
+    /** Specifies the 'not in' operator to check if a value does not exist within an array. */
+    operator: 'not in';
+    /** An array of values to exclude from the field. */
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+/**
+ * A condition using operators other than 'in' or 'not in' for field comparisons.
+ * @category Database
+ */
+export interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
+    /** The operator to use for the comparison, excluding 'in' and 'not in'. */
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+    /** The value to compare against the field. */
+    value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
+}
+/**
+ * A condition that includes all operators, including 'in' and 'not in', for general use.
+ * @category Database
+ */
+export interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
+    /** The operator to apply to the condition, including all possible operators. */
+    operator: AllOperators;
+    /** The value to use in the condition comparison. */
+    value: any;
+}
+/**
+ * A list of general conditions.
+ * @category Database
+ */
+export type GeneralConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<GeneralCondition<Doc, F>>;
+/**
+ * @category Database
+ */
+export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
+type AllOperators = Operator | 'in' | 'not in';
+/**
+ * A generic value that can exist in a query.
+ * @category Database
+ */
+export type GenericValue<Doc = any, F extends Paths<Doc> = Paths<Doc>, O extends AllOperators = any> = O extends 'in' ? Array<DeepRecord<Doc>[F]> | null : O extends 'not in' ? Array<DeepRecord<Doc>[F]> | null : DeepRecord<Doc>[F] | null;
+export {};

package/dist/internal-common/src/types/ai-agent.types.d.ts

@@ -0,0 +1,159 @@
+import { AgentContextRequest, AiAgent, AiAgentContext, AiAnnotation, AiAudioCreateSpeechOptions, AiChatOptions, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions, ApplicationAiSettings } from '../public-types/ai-agent.public-types';
+import { AiChatModelName, AiEmbeddingsModelName, AiProviderType } from '../public-types/ai-common.public-types';
+import { AiContextMetadata, AiContextMetadataFilter } from '../public-types/ai-knowledge-base.public-types';
+import { AiAgentId, AiKnowledgeBaseId, AppId, ClientRequestId } from '../public-types/communication.public-types';
+import { JobId } from '../public-types/job.public-types';
+import { SecretKey } from '../public-types/secret.public-types';
+/** Specification for an AI model, defining its operational parameters. */
+export type AiModelSpec = {
+    /** Maximum tokens the model can generate in a single response. */
+    maxOutputTokens: number;
+    /** Total context window size: input (aka prompt) + output (aka completion) tokens combined. */
+    contextWindowTokens: number;
+};
+/** Map of AI model details by model name. */
+export declare const AI_VENDOR_MODEL_SPECS: Record<AiChatModelName, AiModelSpec>;
+/** Map of embedding AI model specs by model name. */
+export declare const AI_VENDOR_EMBEDDING_MODEL_SPECS: Record<AiEmbeddingsModelName, AiModelSpec>;
+export interface AiChatRequest {
+    agentId: AiAgentId;
+    clientRequestId: ClientRequestId;
+    prompt?: string;
+    options?: AllAiAgentChatOptions;
+    jobId: JobId;
+}
+export interface AiAskRequest {
+    agentId: AiAgentId;
+    prompt?: string;
+    options?: AllAiAgentChatOptions;
+    jobId: JobId;
+}
+export interface AiGenerateImageRequest {
+    prompt: string;
+    options: AiGenerateImageOptions;
+}
+export interface AiAskQuestionInternalRequest {
+    appId: AppId;
+    prompt: string;
+    options: AiChatOptions;
+}
+export interface AiAskQuestionInternalResponse {
+    answer: string;
+}
+export interface AiContextSizeRequest {
+    appId: AppId;
+    agentId: AiAgentId;
+}
+export interface AiContextSizeResponse {
+    sizeBytes: number;
+}
+export interface AiAskResponse {
+    responseString: string;
+    annotations?: Record<string, AiAnnotation>;
+}
+export interface AiAskWithVoiceResponse {
+    responseString: string;
+    voiceResponse: AiAudioCreateSpeechResponse;
+    annotations?: Record<string, AiAnnotation>;
+}
+export interface AiTranscribeAndAskWithVoiceResponse {
+    transcribedPrompt: string;
+    responseString: string;
+    voiceResponse: AiAudioCreateSpeechResponse;
+    annotations?: Record<string, AiAnnotation>;
+}
+export interface AiTranscribeAndChatResponse {
+    transcribedPrompt: string;
+}
+export interface AiSearchRequest {
+    options: AiSearchOptions;
+    agentId: AiAgentId;
+}
+export interface AiSearchResponse {
+    chunks: Array<AiSearchResultChunk>;
+}
+export interface AiAudioCreateSpeechResponse {
+    mimeType: string;
+    extension: string;
+    base64File: string;
+}
+export interface AiAudioCreateSpeechRequest {
+    input: string;
+    options: AiAudioCreateSpeechOptions;
+}
+export interface GetAgentRequest {
+    agentId: AiAgentId;
+}
+export interface GetAgentResponse {
+    agent: AiAgent | undefined;
+}
+export interface GetAgentContextRequest {
+    agentId: AiAgentId;
+    contextId: string;
+}
+export interface ConnectAgentKnowledgeBaseRequest {
+    agentId: AiAgentId;
+    knowledgeBaseId: AiKnowledgeBaseId;
+    description: string;
+}
+export interface DisconnectAgentKnowledgeBaseRequest {
+    agentId: AiAgentId;
+    knowledgeBaseId: AiKnowledgeBaseId;
+}
+export interface DeleteAgentRequest {
+    agentId: AiAgentId;
+}
+export interface ListAgentContextsRequest {
+    agentId: AiAgentId;
+}
+export interface ListAgentContextsResponse {
+    contexts: Array<AiAgentContext>;
+}
+export interface DeleteAgentContextsRequest {
+    agentId: AiAgentId;
+    contextIds: Array<string>;
+}
+export interface UpsertAgentContextsRequest {
+    agentId: AiAgentId;
+    contextRequests: Array<AgentContextRequest>;
+}
+export interface UpsertAgentCustomGuardrailsRequest {
+    agentId: AiAgentId;
+    customGuardrail: string;
+}
+export interface DeleteAgentCustomGuardrailsRequest {
+    agentId: AiAgentId;
+}
+export interface ProvideAgentFeedbackRequest {
+    agentId: AiAgentId;
+    feedback: string;
+}
+export interface ResetAgentFeedbackRequest {
+    agentId: AiAgentId;
+}
+export interface ListAgentsResponse {
+    agents: Array<AiAgent>;
+}
+export interface GetApplicationAiSettingsResponse {
+    settings: ApplicationAiSettings;
+}
+export interface GetApplicationAiSettingsResponse {
+    settings: ApplicationAiSettings;
+}
+export interface SetApplicationAiSettingsRequest {
+    settings: ApplicationAiSettings;
+}
+export interface SetAiProviderApiKeySecretRequest {
+    providerType: AiProviderType;
+    secretKey: SecretKey | undefined;
+}
+export interface SetAiProviderApiKeySecretResponse {
+    settings: ApplicationAiSettings;
+}
+export declare function validateAiContextMetadata(metadata: AiContextMetadata): void;
+export declare function validateAiContextMetadataFilter(filter: AiContextMetadataFilter): void;
+export declare const METADATA_SERVICE_FUNCTION_NAME = "default:metadata";
+export interface UpdateApplicationAiSettingsWebhookPayload {
+    appId: AppId;
+    aiSettings: ApplicationAiSettings;
+}

package/dist/internal-common/src/types/ai-assistant.types.d.ts

@@ -0,0 +1 @@
+export {};