@squidcloud/backend
    Preparing search index...

    Interface AiFunctionCallContextWithIntegration<AiConnectedIntegrationOptionsType, FunctionContextType, AgentContextType>

    AiFunctionContext for the connected integration function. Contains predefined integration data.

    interface AiFunctionCallContextWithIntegration<
        AiConnectedIntegrationOptionsType = unknown,
        FunctionContextType = unknown,
        AgentContextType = unknown,
    > {
        agentContext: AgentContextType;
        agentId: string;
        description?: string;
        functionContext: FunctionContextType;
        instructions?: string;
        integrationId: string;
        integrationType:
            | "api"
            | "ai_agents"
            | "active_directory"
            | "ai_chatbot"
            | "algolia"
            | "alloydb"
            | "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"
            | "databricks"
            | "mysql"
            | "newrelic"
            | "okta"
            | "onedrive"
            | "oracledb"
            | "pinecone"
            | "postgres"
            | "redis"
            | "s3"
            | "salesforce_crm"
            | "sap_hana"
            | "sentry"
            | "servicenow"
            | "snowflake"
            | "spanner"
            | "xata"
            | "zendesk"
            | "mail"
            | "slack"
            | "mcp"
            | "a2a";
        options?: AiConnectedIntegrationOptionsType;
        sessionOptions: AiSessionOptions;
    }

    Type Parameters

    • AiConnectedIntegrationOptionsType = unknown
    • FunctionContextType = unknown
    • AgentContextType = unknown

    Hierarchy (View Summary)

    Index

    Properties

    agentContext agentId description? functionContext instructions? integrationId integrationType options? sessionOptions

    Properties

    agentContext: AgentContextType

    Persistent context of the AI agent that calls the function. Same for all AI functions used by this agent.

    agentId: string

    Unique identifier for the AI agent making the call.

    description?: string

    An optional description of the integration for the parent agent context, used as AI function description.

    functionContext: FunctionContextType

    Context specific to each individual AI function call. Can contain parameters or data unique to the current function invocation or current function connection to the AI agent.

    instructions?: string

    Optional instructions for the connected integration agent, overriding the default if provided.

    integrationId: string

    The ID of the connected integration.

    integrationType:
        | "api"
        | "ai_agents"
        | "active_directory"
        | "ai_chatbot"
        | "algolia"
        | "alloydb"
        | "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"
        | "databricks"
        | "mysql"
        | "newrelic"
        | "okta"
        | "onedrive"
        | "oracledb"
        | "pinecone"
        | "postgres"
        | "redis"
        | "s3"
        | "salesforce_crm"
        | "sap_hana"
        | "sentry"
        | "servicenow"
        | "snowflake"
        | "spanner"
        | "xata"
        | "zendesk"
        | "mail"
        | "slack"
        | "mcp"
        | "a2a"

    The type of the connected integration (e.g., API, database).

    options?: AiConnectedIntegrationOptionsType

    Additional options for the connected integration. Squid Core or AI functions in connector packages may use these options to adjust behavior of the integration agent.

    sessionOptions: AiSessionOptions

    The session associated with this AI function call.

    Settings

    Member Visibility

    On This Page

    Properties