Weaviate

App · 16 actions

Manage Weaviate collections, tenants and objects and run GraphQL queries.

Actions

ActionWhat it does
Add a collection propertyAdd a collection property.
Create a collectionCreate a collection.
Create an objectCreate an object.
Delete a collectionDelete a collection.
Delete an objectDelete an object.
Get a collectionGet a collection.
Get a collection tenantGet a collection tenant.
Get an objectGet an object.
Get cluster metadataGet cluster metadata.
List collection shardsList collection shards.
List collection tenantsList collection tenants.
List collectionsList collections.
List objectsList objects.
Run a GraphQL queryRun a GraphQL query.
Update object propertiesUpdate object properties.
Validate an objectValidate an object.

Add a collection property

Add a collection property.

Inputs

CollectioncollectiontextRequired
Collection.
NamenametextRequired
Name.
Data typesdata_typeslistRequired
Data types.One or more of: text, text[], int, int[], number, number[], boolean, boolean[], date, date[], and 7 more.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "dataType": [
      "example"
    ],
    "name": "example"
  }
}

Create a collection

Create a collection.

Inputs

CollectioncollectiontextRequired
Collection.
Descriptiondescriptiontext
Description.
Propertiespropertieslist
Properties.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "class": "example",
    "description": "example",
    "properties": [
      {
        "dataType": [
          "example"
        ],
        "name": "example"
      }
    ]
  }
}

Create an object

Create an object.

Inputs

CollectioncollectiontextRequired
Collection.
PropertiespropertiesobjectRequired
Properties.
Object IDobject_idtext
Object ID.
Tenanttenanttext
Tenant.
Vectorvectorlist
Vector.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "class": "example",
    "creationTimeUnix": 1,
    "id": "example",
    "lastUpdateTimeUnix": 1,
    "properties": {},
    "tenant": "example"
  }
}

Delete a collection

Delete a collection.

Inputs

CollectioncollectiontextRequired
Collection.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {}
}

Delete an object

Delete an object.

Inputs

CollectioncollectiontextRequired
Collection.
Object IDobject_idtextRequired
Object ID.
Tenanttenanttext
Tenant.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {}
}

Get a collection

Get a collection.

Inputs

CollectioncollectiontextRequired
Collection.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "class": "example",
    "description": "example",
    "properties": [
      {
        "dataType": [
          "example"
        ],
        "name": "example"
      }
    ]
  }
}

Get a collection tenant

Get a collection tenant.

Inputs

CollectioncollectiontextRequired
Collection.
TenanttenanttextRequired
Tenant.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "activityStatus": "example",
    "name": "example"
  }
}

Get an object

Get an object.

Inputs

CollectioncollectiontextRequired
Collection.
Object IDobject_idtextRequired
Object ID.
Tenanttenanttext
Tenant.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "class": "example",
    "creationTimeUnix": 1,
    "id": "example",
    "lastUpdateTimeUnix": 1,
    "properties": {},
    "tenant": "example"
  }
}

Get cluster metadata

Get cluster metadata.

Inputs

None.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "hostname": "example",
    "modules": {},
    "version": "example"
  }
}

List collection shards

List collection shards.

Inputs

CollectioncollectiontextRequired
Collection.

Outputs

datalist
The response from Weaviate.
Example output
{
  "data": [
    {
      "name": "example",
      "status": "example"
    }
  ]
}

List collection tenants

List collection tenants.

Inputs

CollectioncollectiontextRequired
Collection.

Outputs

datalist
The response from Weaviate.
Example output
{
  "data": [
    {
      "activityStatus": "example",
      "name": "example"
    }
  ]
}

List collections

List collections.

Inputs

None.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "classes": [
      {
        "class": "example",
        "description": "example",
        "properties": [
          {
            "dataType": [
              "example"
            ],
            "name": "example"
          }
        ]
      }
    ]
  }
}

List objects

List objects.

Inputs

Collectioncollectiontext
Collection.
Tenanttenanttext
Tenant.
Limitlimitnumber
Limit.From 1 to 1000.
Afteraftertext
After.
Offsetoffsetnumber
Offset.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "objects": [
      {
        "class": "example",
        "creationTimeUnix": 1,
        "id": "example",
        "lastUpdateTimeUnix": 1,
        "properties": {},
        "tenant": "example"
      }
    ],
    "totalResults": 1
  }
}

Run a GraphQL query

Run a GraphQL query.

Inputs

QueryquerytextRequired
Query.
Variablesvariablesobject
Variables.
Operation nameoperation_nametext
Operation name.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {
    "data": {}
  }
}

Update object properties

Update object properties.

Inputs

CollectioncollectiontextRequired
Collection.
Object IDobject_idtextRequired
Object ID.
PropertiespropertiesobjectRequired
Properties.
Tenanttenanttext
Tenant.
Vectorvectorlist
Vector.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {}
}

Validate an object

Validate an object.

Inputs

CollectioncollectiontextRequired
Collection.
PropertiespropertiesobjectRequired
Properties.
Tenanttenanttext
Tenant.

Outputs

dataobject
The response from Weaviate.
Example output
{
  "data": {}
}

On this page