Dynamiq Docs
  • Welcome to Dynamiq
  • Low-Code Builder
    • Chat
    • Basics
    • Connecting Nodes
    • Conditional Nodes and Multiple Outputs
    • Input and Output Transformers
    • Error Handling and Retries
    • LLM Nodes
    • Validator Nodes
    • RAG Nodes
      • Indexing Workflow
        • Pre-processing Nodes
        • Document Splitting
        • Document Embedders
        • Document Writers
      • Inference RAG workflow
        • Text embedders
        • Document retrievers
          • Complex retrievers
        • LLM Answer Generators
    • LLM Agents
      • Basics
      • Guide to Implementing LLM Agents: ReAct and Simple Agents
      • Guide to Agent Orchestration: Linear and Adaptive Orchestrators
      • Guide to Advanced Agent Orchestration: Graph Orchestrator
    • Audio and voice
    • Tools and External Integrations
    • Python Code in Workflows
    • Memory
    • Guardrails
  • Deployments
    • Workflows
      • Tracing Workflow Execution
    • LLMs
      • Fine-tuned Adapters
      • Supported Models
    • Vector Databases
  • Prompts
    • Prompt Playground
  • Connections
  • LLM Fine-tuning
    • Basics
    • Using Adapters
    • Preparing Data
    • Supported Models
    • Parameters Guide
  • Knowledge Bases
  • Evaluations
    • Metrics
      • LLM-as-a-Judge
      • Predefined metrics
        • Faithfulness
        • Context Precision
        • Context Recall
        • Factual Correctness
        • Answer Correctness
      • Python Code Metrics
    • Datasets
    • Evaluation Runs
    • Examples
      • Build Accurate vs. Inaccurate Workflows
  • Examples
    • Building a Search Assistant
      • Approach 1: Single Agent with a Defined Role
      • Approach 2: Adaptive Orchestrator with Multiple Agents
      • Approach 3: Custom Logic Pipeline with a Straightforward Workflow
    • Building a Code Assistant
  • Platform Settings
    • Access Keys
    • Organizations
    • Settings
    • Billing
  • On-premise Deployment
    • AWS
    • IBM
  • Support Center
Powered by GitBook
On this page
  • Adding a New Connection
  • Updating Existing Connection
  • Removing a Connection

Connections

PreviousPrompt PlaygroundNextLLM Fine-tuning

Last updated 6 months ago

Connections in the Dynamiq platform are reusable configurations that enable seamless integration with external services, APIs, or data providers. By creating and managing connections, users can easily configure integrations once and reuse them across multiple workflows and other platform features. This approach minimizes redundancy and ensures a consistent setup for interacting with external resources.

Adding a New Connection

To add a new connection:

  1. Navigate to the Connections page and select Add new connection.

  2. Fill out the form on the right panel:

    • Name: Enter a descriptive name for the connection.

    • Type: Select the connection type from the dropdown (e.g., OpenAI).

    • Depending on the selected type, fill in configuration fields such (e.g., API Key, URL).

  3. Once all fields are filled out, click Create to save the connection.

Updating Existing Connection

To update an existing connection:

  1. Navigate to the Connections page.

  2. Find the connection you wish to update and click the Edit icon next to it. This will open the connection's configuration panel on the right side.

  3. Modify connection-specific fields, depending on the connection type, you may see different fields.

  4. After making the necessary changes, click Update to apply the updates to the connection.

Removing a Connection

In the Dynamiq platform, users can delete unused connections to keep their configurations clean and organized. However, before a connection is removed, the system will automatically check if it is actively in use within any workflows, deployments, or other platform components. If the connection is not in use, it will be removed successfully. If it is in use, an error message will appear, indicating that the connection cannot be deleted until it is no longer referenced.

To remove a connection:

  1. Navigate to the Connections page.

  2. Find the connection you wish to delete and click the Delete icon next to it.

  3. Outcome:

    • If the Connection is not in use: the connection will be removed immediately, and it will no longer appear in the list of connections.

    • If the Connection is in use: you will receive an error message indicating that the connection cannot be deleted while it is actively referenced. To remove the connection, first detach it from any associated workflows.