Create Relationship

POST

Creates a new relationship in the graph.

Path parameters

collection_idstringRequired

The collection ID corresponding to the graph to add the relationship to.

Headers

X-API-KeystringRequired

Request

This endpoint expects an object.

subjectstringRequired

The subject of the relationship to create.

subject_idstringRequiredformat: "uuid"

The ID of the subject of the relationship to create.

predicatestringRequired

The predicate of the relationship to create.

objectstringRequired

The object of the relationship to create.

object_idstringRequiredformat: "uuid"

The ID of the object of the relationship to create.

descriptionstringRequired

The description of the relationship to create.

weightdoubleOptionalDefaults to 1

The weight of the relationship to create.

metadatamap from strings to anyOptional

The metadata of the relationship to create.

Response

Successful Response

resultsobject

A relationship between two entities. This is a generic relationship, and can be used to represent any type of relationship between any two entities.

Errors

POST

1 curl -X POST https://api.cloud.sciphi.ai/v3/graphs/collection_id/relationships \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "subject": "subject",
6   "subject_id": "subject_id",
7   "predicate": "predicate",
8   "object": "object",
9   "object_id": "object_id",
10   "description": "description"
11 }'

1 {
2   "results": {
3     "subject": "subject",
4     "predicate": "predicate",
5     "object": "object",
6     "id": "id",
7     "description": "description",
8     "subject_id": "subject_id",
9     "object_id": "object_id",
10     "weight": 1.1,
11     "chunk_ids": [
12       "chunk_ids"
13     ],
14     "parent_id": "parent_id",
15     "description_embedding": [
16       1.1
17     ],
18     "metadata": {
19       "key": "value"
20     }
21   }
22 }

Built with

1	curl -X POST https://api.cloud.sciphi.ai/v3/graphs/collection_id/relationships \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"subject": "subject",
6	"subject_id": "subject_id",
7	"predicate": "predicate",
8	"object": "object",
9	"object_id": "object_id",
10	"description": "description"
11	}'

1	{
2	"results": {
3	"subject": "subject",
4	"predicate": "predicate",
5	"object": "object",
6	"id": "id",
7	"description": "description",
8	"subject_id": "subject_id",
9	"object_id": "object_id",
10	"weight": 1.1,
11	"chunk_ids": [
12	"chunk_ids"
13	],
14	"parent_id": "parent_id",
15	"description_embedding": [
16	1.1
17	],
18	"metadata": {
19	"key": "value"
20	}
21	}
22	}