Skip to main content

Integrating with Weaviate in Orkes Conductor

To effectively utilize AI and LLM tasks in Orkes Conductor, it's essential to integrate your Orkes Conductor cluster with the necessary Vector Database models.

Weaviate is a renowned vector database celebrated for its efficiency and adaptability in managing extensive vector data. This integration equips you to seamlessly access, query, and manipulate vector data, thereby bolstering the capabilities of Orkes Conductor in a wide array of natural language processing and artificial intelligence applications.

This guide will provide the steps for integrating Weaviate with Orkes Conductor.

Steps to integrate with Weaviate Database​

Before beginning to integrate with Weaviate, you need to generate the API key. The API Keys can be obtained from the Weaviate cluster created. Check out the official Weaviate documentation on how to create clusters.

Get the Weaviate API key & Endpoint​

Once the clusters are created, you can get the API keys from the cluster details.

  1. Navigate to the Weaviate console.
  2. Choose your cluster, and click the Details tab to expand the cluster details.

Get Weaviate API Key

  1. Under Enabled option, click API keys and copy your keys.
  2. Copy the Cluster URL, which is your Weaviate Endpoint, while configuring in Orkes Conductor.

Integrating with Weaviate as a provider​

Now, you have the API key. Let’s integrate this with Orkes Conductor.

  1. Navigate to Integrations from the left menu on your Orkes Conductor cluster.
  2. Click +New integration button from the top-right corner.
  3. Under the Vector Databases section, choose Weaviate.
  4. Click +Add and provide the following parameters:

Create Weaviate Integration

ParametersDescription
Integration nameA name for the integration.
API KeyThe API key copied previously.
EndpointThe cluster URL copied previously.
DescriptionA description of your integration.
  1. You can toggle-on the Active button to activate the integration instantly.
  2. Click Save.

Adding Classes to Weaviate Integration​

Now, you have integrated your Orkes Conductor cluster with the Weaviate provider. The next step is integrating with the specific classes.

To add a new class to the Weaviate integration:

  1. Navigate to the integrations page and click the '+' button next to the integration you created.

Create Classes for Weaviate Integration

  1. Click +New Class.
  2. Provide the class name and an optional description.

Create New Class for Weaviate Integration Model

  1. Toggle-on the Active button to enable immediately.
  2. Click Save.

This ensures the integration model is saved for future use in LLM tasks within Orkes Conductor.

RBAC - Governance on who can use Integrations​

Now, the integration with the required models is ready. Next, we should determine the access control to these models.

The permission can be granted to applications/groups within the Orkes Conductor cluster.

To provide explicit permission to Groups:

  1. Navigate to Access Control > Groups from the left menu on your Orkes Conductor cluster.
  2. Create a new group or choose an existing group.
  3. Under the Permissions section, click +Add Permission.
  4. Under the Integrations tab, select the required integrations with the required permissions.

Add Permissions for Weaviate Database Integration

  1. Click Add Permissions. This ensures that all the group members can access these integration models in their workflows.

Similarly, you can also provide permissions to applications.